Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps-dev): bump stream-chat from 8.36.0 to 8.37.0 #2437

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 4 additions & 3 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"babel",
"jest-dom",
"jest",
"markdown",
"prettier",
"react-hooks",
"import",
Expand All @@ -17,6 +16,8 @@
"plugin:jest/all",
"plugin:jest-dom/recommended"
],
// Next.js example comes with its own ESLint setup
"ignorePatterns": "examples/nextjs",
"rules": {
"array-callback-return": 2,
"arrow-body-style": 2,
Expand Down Expand Up @@ -154,7 +155,6 @@
"plugins": [
"@typescript-eslint",
"babel",
"markdown",
"prettier",
"react",
"typescript-sort-keys",
Expand All @@ -171,7 +171,8 @@
"array-callback-return": 2,
"arrow-body-style": 2,
"comma-dangle": 0,
"babel/no-invalid-this": 2,
"babel/no-invalid-this": 0,
"@typescript-eslint/no-invalid-this": 2,
"default-case": 2,
"eqeqeq": [2, "smart"],
"linebreak-style": [2, "unix"],
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ jobs:
key: ${{ runner.os }}-${{ matrix.node }}-modules-${{ hashFiles('**/yarn.lock') }}

- name: 🔨 Install Dependencies & Build
run: yarn install --frozen-lockfile --ignore-engines
run: |
yarn install --frozen-lockfile --ignore-engines
yarn build

- name: 🧪 Lint and Test with ${{ matrix.node }}
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: E2E

on: [push]
on: [workflow_dispatch]

jobs:
e2e:
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: 'lts/*'
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Install dependencies & Build
run: |
yarn install --frozen-lockfile
yarn run build
- name: Validate CommonJS bundle
run: yarn validate-cjs
- name: Release
Expand Down
5 changes: 0 additions & 5 deletions .postcssrc

This file was deleted.

2 changes: 1 addition & 1 deletion .releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"name": "master",
"channel": "rc",
"prerelease": true
"prerelease": "rc"
},
{
"name": "release-v11",
Expand Down
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
## [12.0.0-rc.2](https://github.com/GetStream/stream-chat-react/compare/v12.0.0-rc.1...v12.0.0-rc.2) (2024-06-21)


### Chores

* **deps:** bump @stream-io/stream-chat-css to version 5.0.0-rc.1nvm ([fd27c74](https://github.com/GetStream/stream-chat-react/commit/fd27c74c14d8571bbf97b3b8eee52540e30500c4))

## [12.0.0-rc.1](https://github.com/GetStream/stream-chat-react/compare/v11.21.0...v12.0.0-rc.1) (2024-06-17)


### ⚠ BREAKING CHANGES

* The VirtualizedMessageList does not provide default
Footer component
* The VirtualizedMessageList markup has changed as
TypingIndicator is rendered as a child of MessageListMainPanel
* stylesheet import path changed & v1 stylesheet has been dropped, see release guide for more information
* theme v1 related markup and classNames have been removed
* `themeVersion` property has been removed from `ChatContext`

### Bug Fixes

* render typing indicator outside the VirtualizedMessageList scroll container ([#2406](https://github.com/GetStream/stream-chat-react/issues/2406)) ([fcaafb6](https://github.com/GetStream/stream-chat-react/commit/fcaafb6a1d41249b904350f9ccdb6527d7e881e5))


### Features

* remove legacy style components ([#2394](https://github.com/GetStream/stream-chat-react/issues/2394)) ([9410153](https://github.com/GetStream/stream-chat-react/commit/94101535d1de9de23a1ab8913423af0e7009bab9))

## [11.21.0](https://github.com/GetStream/stream-chat-react/compare/v11.20.0...v11.21.0) (2024-06-14)


Expand Down
1 change: 1 addition & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable no-undef */
module.exports = {
env: {
production: {
Expand Down
5 changes: 3 additions & 2 deletions docusaurus/docs/React/basics/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@ Use cases include team and social messaging, virtual events, livestream gaming,
- Text input commands (ex: Giphy and @mentions)
- Image and file uploads
- Video playback
- Audio recording
- Read state and typing indicators
- Channel and message lists

## Where to get started

If you are new to our SDK it is best to go through a of our [tutorial](https://getstream.io/chat/react-chat/tutorial/).
If you are new to our SDK it is best to go through our [tutorial](https://getstream.io/chat/react-chat/tutorial/).

After that, our [getting started page](./getting-started.mdx) is a great next step.

Expand All @@ -32,4 +33,4 @@ If you are integrating our SDK, please pay attention to our [Theming](../theming
A common pattern in the library is the use of context provider hooks. These custom hooks allow for effective value sharing between parent components and their children.
This makes customization straightforward, as you can use our exported hooks in your custom components to receive the exact values needed, while also subscribing to context changes.

The left navigation will guide you to the various documentation sections for information on everything regarding our robust component library. Check out the instructions below for adding the library to your React project.
The left navigation will guide you to the various documentation sections for information on everything regarding our robust component library. Check out the instructions for adding the library to your React project.
61 changes: 30 additions & 31 deletions docusaurus/docs/React/components/contexts/channel-state-context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const { channel, watchers } = useChannelStateContext();

### acceptedFiles

A list of accepted file upload types.
The value is forwarded to the context from the `Channel` component [prop `acceptedFiles`](../../components/core-components/channel.mdx#acceptedfiles).

| Type |
| -------- |
Expand Down Expand Up @@ -48,9 +48,24 @@ The configurations object for the currently active channel.
| ------ |
| object |

### channelUnreadUiState

The read state maintained for use by components representing channel unread state (for example `UnreadMessagesSeparator`, `UnreadMessagesNotification`).

| Property | Type | Description |
| --------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **last_read** | `Date` | Date when the channel was marked read the last time. |
| **unread_messages** | `number` | The count of unread messages in a given channel. Unread count refers only to foreign (not own) unread messages. |
| **first_unread_message_id** | `string` or `undefined` | The ID of the message that was marked unread (`notification.mark_unread` event). The value is available only when a message is marked unread. Therefore, cannot be relied on to place unread messages UI. |
| **last_read_message_id** | `string` or `undefined` | The ID of the message preceding the first unread message. |

| Type |
| ---------------------- |
| `ChannelUnreadUiState` |

### dragAndDropWindow

If true, chat users will be able to drag and drop file uploads to the entire channel window.
The value is forwarded to the context from the `Channel` component [prop `dragAndDropWindow`](../../components/core-components/channel.mdx#draganddropwindow).

| Type | Default |
| ------- | ------- |
Expand All @@ -66,8 +81,7 @@ Number of milliseconds to debounce firing the URL enrichment queries when typing

### enrichURLForPreview

A global flag to toggle the URL enrichment and link previews in `MessageInput`. By default, the feature is disabled. It can be overridden on Thread and MessageList level through `additionalMessageInputProps`
or directly on `MessageInput` level through `urlEnrichmentConfig` prop.
The value is forwarded to the context from the `Channel` component [prop `enrichURLForPreview`](../../components/core-components/channel.mdx#enrichurlforpreview).

| Type | Default |
| ------- | ------- |
Expand All @@ -91,18 +105,18 @@ Custom function to identify URLs in a string for later generation of link previe

### giphyVersion

The giphy version to use when displaying giphies.
The value is forwarded to the context from the `Channel` component [prop `giphyVersion`](../../components/core-components/channel.mdx#giphyversion).

| Type |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `'original'` \| `'fixed_height'` \| `'fixed_height_still'` \| `'fixed_height_downsampled'` \| `'fixed_width'` \| `'fixed_width_still'` \| `'fixed_width_downsampled'` |
| Type | Default |
| ------ | -------------- |
| string | 'fixed_height' |

### imageAttachmentSizeHandler

A custom function to provide size configuration for image attachments
The value is forwarded to the context from the `Channel` component [prop `imageAttachmentSizeHandler`](../../components/core-components/channel.mdx#imageattachmentsizehandler).

| Type |
| ---------------------------------------------------------------- |
| Type |
| ----------------------------------------------------------------- |
| `(a: Attachment, e: HTMLElement) => ImageAttachmentConfiguration` |

### hasMore
Expand Down Expand Up @@ -145,7 +159,7 @@ Boolean for the `channel` loading more messages.
| ------- |
| boolean |

### loadingMoreNewer?
### loadingMoreNewer

Flag signalling whether newer messages are being loaded as the user scrolls down in the message list. Used internally by `VirtualizedMessageList`.

Expand All @@ -155,7 +169,7 @@ Flag signalling whether newer messages are being loaded as the user scrolls down

### maxNumberOfFiles

The maximum number of attachments allowed per `message`, defaults to the Stream Chat API maximum.
The value is forwarded to the context from the `Channel` component [prop `maxNumberOfFiles`](../../components/core-components/channel.mdx#maxnumberoffiles).

| Type | Default |
| ------ | ------- |
Expand All @@ -179,7 +193,7 @@ Array of [message objects](https://getstream.io/chat/docs/javascript/message_for

### multipleUploads

Whether to allow multiple attachment uploads on a message.
The value is forwarded to the context from the `Channel` component [prop `multipleUploads`](../../components/core-components/channel.mdx#multipleuploads).

| Type | Default |
| ------- | ------- |
Expand Down Expand Up @@ -209,21 +223,6 @@ Custom function to react to link preview dismissal. See the guide [Link Previews
| ------------------------------------ |
| `(linkPreview: LinkPreview) => void` |

### channelUnreadUiState

The read state maintained for use by components representing channel unread state (for example `UnreadMessagesSeparator`, `UnreadMessagesNotification`).

| Property | Type | Description |
|-----------------------------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **last_read** | `Date` | Date when the channel was marked read the last time. |
| **unread_messages** | `number` | The count of unread messages in a given channel. Unread count refers only to foreign (not own) unread messages. |
| **first_unread_message_id** | `string` or `undefined` | The ID of the message that was marked unread (`notification.mark_unread` event). The value is available only when a message is marked unread. Therefore, cannot be relied on to place unread messages UI. |
| **last_read_message_id** | `string` or `undefined` | The ID of the message preceding the first unread message. |

| Type |
|-----------------------|
| `ChannelUnreadUiState` |

### pinnedMessages

The messages that are pinned in the `channel`.
Expand Down Expand Up @@ -258,7 +257,7 @@ Flag signalling whether the scroll to the bottom is prevented. Used internally b

### shouldGenerateVideoThumbnail

You can turn on/off thumbnail generation for video attachments
The value is forwarded to the context from the `Channel` component [prop `shouldGenerateVideoThumbnail`](../../components/core-components/channel.mdx#shouldgeneratevideothumbnail).

| Type |
| --------- |
Expand Down Expand Up @@ -306,7 +305,7 @@ Flag signalling whether the scroll to the bottom is prevented in thread. Used in

### videoAttachmentSizeHandler

A custom function to provide size configuration for video attachments
The value is forwarded to the context from the `Channel` component [prop `videoAttachmentSizeHandler`](../../components/core-components/channel.mdx#videoattachmentsizehandler).

| Type |
| ----------------------------------------------------------------- |
Expand Down
27 changes: 8 additions & 19 deletions docusaurus/docs/React/components/contexts/chat-context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const { client, setActiveChannel } = useChatContext();

### client

The `StreamChat` client instance. Any methods from the `stream-chat-js` API interface can be run off this object.
The value is forwarded to the context from the `Chat` component [prop `client`](../../components/core-components/chat.mdx#client).

| Type |
| ------ |
Expand Down Expand Up @@ -49,7 +49,7 @@ The `queryInProgress` values are:
- `null` - at least one channels page has been loaded and there is no query in progress at the moment

| Type |
|----------------------|
| -------------------- |
| `ChannelsQueryState` |

### closeMobileNav
Expand All @@ -62,8 +62,7 @@ The function to close mobile navigation.

### customClasses

Object containing custom CSS classnames to override the library's default container CSS. See [CSS and Theming](../../guides/theming/css-and-theming.mdx)
for implementation assistance.
The value is forwarded to the context from the `Chat` component [prop `customClasses`](../../components/core-components/chat.mdx#customclasses)

| Type |
| ------ |
Expand Down Expand Up @@ -120,25 +119,15 @@ You can override the default behavior by pulling it from context and then utiliz

### theme

Deprecated and to be removed in a future major release. Use the `customStyles` prop to adjust CSS variables and [customize the theme](../../guides/theming/css-and-theming.mdx#css-variables) of your app.
The value is forwarded to the context from the `Chat` component [prop `theme`](../../components/core-components/chat.mdx#theme)

| Type |
| ----- |
| Theme |

### themeVersion

Stream chat theme version 2 has been introduced with the release of stream-chat-react v10.0.0. This flag is used internally by some UI components of the SDK and the integrators shouldn't need to use it. The value is extracted from a CSS variable `--str-chat__theme-version`. You can set it to values `'1'` or `'2'` in your stylesheets and import the corresponding v2 stylesheet from `stream-chat-react/dist`. Find out more about benefits that the theme version 2 brings to the integrators with [the theming guide](../../theming/introduction.mdx).

| Type | Default |
| -------------- | ------- |
| `'1'` \| `'2'` | `'1'` |
| Type |
| ------ |
| string |

### useImageFlagEmojisOnWindow

Windows 10 does not support country flag emojis out of the box. It chooses to render these emojis as characters instead.
Stream Chat can override this behavior by loading a custom web font that will render images instead (PNGs or SVGs depending
on the platform). Set this prop to true if you want to use these custom emojis for Windows users.
The value is forwarded to the context from the `Chat` component [prop `useImageFlagEmojisOnWindow`](../../components/core-components/chat.mdx#useimageflagemojisonwindow).

| Type | Default |
| ------- | ------- |
Expand Down
16 changes: 4 additions & 12 deletions docusaurus/docs/React/components/contexts/component-context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,6 @@ Custom UI component to display a attachment previews in `MessageInput`.
| --------- | ---------------------------------------------------------------------------------------------- |
| component | <GHComponentLink text='AttachmentPreviewList' path='/MessageInput/AttachmentPreviewList.tsx'/> |

### AutocompleteSuggestionHeader

Custom UI component to override the default suggestion header component.

| Type | Default |
| --------- | ------------------------------------------------------------------------ |
| component | <GHComponentLink text='Header' path='/AutoCompleteTextarea/Header.tsx'/> |

### AutocompleteSuggestionItem

Custom UI component to override the default suggestion Item component.
Expand Down Expand Up @@ -346,11 +338,11 @@ Custom UI component to display the header of a `Thread`.

### ThreadInput

Custom UI component to replace the `MessageInput` of a `Thread`. For the applications using [theme version 1](../../guides/theming/css-and-theming.mdx), the default is `MessageInputSmall`. Applications using [theme version 2](../../theming/introduction.mdx) will use `MessageInputFlat` by default.
Custom UI component to replace the `MessageInput` of a `Thread`. The component uses `MessageInputFlat` by default.

| Type | Default |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| component | <GHComponentLink text='MessageInputSmall (theme v1)' path='/MessageInput/MessageInputSmall.tsx'/> / <GHComponentLink text='MessageInputFlat (theme v2)' path='/MessageInput/MessageInputFlat.tsx'/> |
| Type | Default |
| --------- | ------------------------------------------------------------------------------------ |
| component | <GHComponentLink text='MessageInputFlat' path='/MessageInput/MessageInputFlat.tsx'/> |

### ThreadStart

Expand Down
Loading
Loading