Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
stream-ci-bot committed Oct 24, 2024
1 parent ef867f3 commit fbf7dc9
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Boolean to enable/disable the message underlay background when there are unread messages in the Message List.

| Type | Default |
| ---------------------- | ------- |
| `boolean`\|`undefined` | `true` |
5 changes: 5 additions & 0 deletions docusaurus/docs/reactnative/contexts/messages-context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ import OverlayReactionList from '../common-content/ui-components/overlay-provide
import ReactionList from '../common-content/ui-components/channel/props/reaction-list.mdx';
import Reply from '../common-content/ui-components/channel/props/reply.mdx';
import ScrollToBottomButton from '../common-content/ui-components/channel/props/scroll-to-bottom-button.mdx';
import ShouldShowUnreadUnderlay from '../common-content/ui-components/channel/props/should_show_unread_underlay.mdx';
import SelectReaction from '../common-content/ui-components/channel/props/select_reaction.mdx';
import SupportedReactions from '../common-content/ui-components/channel/props/supported_reactions.mdx';
import TypingIndicator from '../common-content/ui-components/channel/props/typing_indicator.mdx';
Expand Down Expand Up @@ -235,6 +236,10 @@ Enables quoted-reply state on given message.
| ------------------- |
| `(message) => void` |

### <div class="label description">_forwarded from [Channel](../../core-components/channel#shouldshowunreadunderlay)_ props</div> shouldShowUnreadUnderlay {#shouldshowunreadunderlay}

<ShouldShowUnreadUnderlay />

### <div class="label description">_forwarded from [Channel](../../core-components/channel#supportedreactions)_ props</div> supportedReactions {#supportedreactions}

<SupportedReactions />
Expand Down
4 changes: 4 additions & 0 deletions docusaurus/docs/reactnative/core-components/channel-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ export const App = () => <OverlayProvider>
</OverlayProvider>;
```

:::note
When receiving channel information from channel events, the filters are not respected; the reason for this is that channel filters can get very complex, and implementing that filtering logic that supports all of the custom filter would be very hard to do. Implementing this on the backend side isn't an option as it is inefficient and has to cater to different filters. So, to help you with it, you will have to override the `notification.message_new` event using the [`onNewMessageNotification`](./channel-list.mdx#onnewmessagenotification) and `message.new` event handlers using the [`onNewMessage`](./channel-list.mdx#onnewmessage) prop of the `ChannelList` component.
:::

## Context Providers

`ChannelList` contains the provider for the `ChannelsContext`. This can be accessed using the corresponding hook.
Expand Down
5 changes: 5 additions & 0 deletions docusaurus/docs/reactnative/core-components/channel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ import ScrollToBottomButton from '../common-content/ui-components/channel/props/
import SelectReaction from '../common-content/ui-components/channel/props/select_reaction.mdx';
import SendButton from '../common-content/ui-components/channel/props/send_button.mdx';
import SendMessageDisallowedIndicator from '../common-content/ui-components/channel/props/send_message_disallowed_indicator.mdx';
import ShouldShowUnreadUnderlay from '../common-content/ui-components/channel/props/should_show_unread_underlay.mdx';
import ShowThreadMessageInChannelButton from '../common-content/ui-components/channel/props/show_thread_message_in_channel_button.mdx';
import StartAudioRecordingButton from '../common-content/ui-components/channel/props/start_audio_recording_button.mdx';
import StateUpdateThrottleInterval from '../common-content/ui-components/channel/props/state_update_throttle_interval.mdx';
Expand Down Expand Up @@ -702,6 +703,10 @@ Callback function to set the [ref](https://reactjs.org/docs/refs-and-the-dom.htm
| --------- | -------------------- |
| ref | ref of the TextInput |

### `shouldShowUnreadUnderlay`

<ShouldShowUnreadUnderlay />

### stateUpdateThrottleInterval

<StateUpdateThrottleInterval />
Expand Down

0 comments on commit fbf7dc9

Please sign in to comment.