stream-chat-react-native-core 5.4.3-beta.1 → 5.4.3

package/lib/commonjs/contexts/imageGalleryContext/ImageGalleryContext.md

@@ -1,38 +0,0 @@
-Please check the `ImageGalleryContextValue` in [ImageGalleryContext](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/imageGalleryContext/ImageGalleryContext.tsx), for consumable values.
-Provider for this context exists in `OverlayProvider` component. And so, any child component of OverlayProvider
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { useChannelsContext } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const { selectedMessage, setSelectedMessage, setMessages } = useImageGalleryContext();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withChannelsContext } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.image);
-    console.log(props.setImage);
-    console.log(props.setImages);
-  }
-
-  // UI Logic
-}
-
-export withImageGalleryContext(SomeChildComponent);
-```

package/lib/commonjs/contexts/keyboardContext/KeyboardContext.md

@@ -1,5 +0,0 @@
-When user focuses on input box, keyboard opens up on mobile devices. When keyboard opens, it is necessary to update the position of input box and height of content on screen
-so that it doesn't get hidden behind keyboard. This is handled by [KeyboardCompatibleView](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/components/KeyboardCompatibleView/KeyboardCompatibleView.tsx) which
-is a HOC. It creates a context which contain following function.
-
-- **dismissKeyboard** Dismisses the keyboard and adjusts the height of content on screen.

package/lib/commonjs/contexts/keyboardContext/withKeyboardContext.md

@@ -1,18 +0,0 @@
-Any component can be made a consumer of [KeyboardContext](#keyboardcontext) by using function `withKeyboardContext`.
-
-e.g.,
-
-```js static
-import { Button } from 'react-native';
-
-import { withKeyboardContext } from './KeyboardContext';
-
-const DemoComponentWithKeyboardContext = withKeyboardContext(DemoComponent);
-
-const DemoComponent = (props) => (
-  <Button
-    onPress={props.dismissKeyboard}
-    title='Button to dismiss keyboard'
-  />
-);
-```

package/lib/commonjs/contexts/messageContext/MessageContext.md

@@ -1,43 +0,0 @@
-Please check the `MessageContextValue` in [MessageContext](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/messageContext/MessageContext.tsx), for consumable values.
-Provider for this context exists in `Message` component. And so, any child component of `Message`
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { useMessageContext } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const {
-    handleDeleteMessage,
-    handleEditMessage,
-    handleQuotedReplyMessage,
-    handleResendMessage,
-    handleToggleBanUser,
-    handleToggleMuteUser,
-    handleToggleReaction,
-  } = useMessageContext();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withMessageContext } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.handleDeleteMessage);
-    console.log(props.handleEditMessage);
-    console.log(props.handleToggleReaction);
-  }
-
-  // UI Logic
-}

package/lib/commonjs/contexts/messageInputContext/MessageInputContext.md

@@ -1,40 +0,0 @@
-Please check the `MessageInputContextValue` in [MessageInputContext](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/messageInputContext/MessageInputContext.tsx), for consumable values.
-Provider for this context exists in `Channel` component. And so, any child component of `Channel`
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { useMessageInputContext } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const {
-    openAttachmentPicker,
-    openCommandsPicker,
-    openFilePicker,
-    openMentionsPicker,
-  } = useMessageInputContext();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withMessageInputContext } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.openAttachmentPicker);
-    console.log(props.openCommandsPicker);
-    console.log(props.openFilePicker);
-  }
-
-  // UI Logic
-}

package/lib/commonjs/contexts/messagesContext/MessagesContext.md

@@ -1,35 +0,0 @@
-Please check the `MessagesContextValue` in [MessagesContext](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/messageContext/MessageContext.tsx), for consumable values.
-Provider for this context exists in `Channel` component. And so, any child component of Channel
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { useMessagesContext } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const { handleDelete, handleRetry } = useMessagesContext();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withMessagesContext } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.handleDelete);
-    console.log(props.handleRetry);
-    console.log(props.refreshing);
-  }
-
-  // UI Logic
-}

package/lib/commonjs/contexts/messagesContext/withMessagesContext.md

@@ -1,26 +0,0 @@
-Any component can consume the [MessagesContext](#messagescontext) and receive its values through props by using the higher order component `withMessagesContext`.
-
-**Example:**
-
-```js static
-import { Text, View } from 'react-native';
-
-import { withMessagesContext } from './MessagesContext';
-
-const DemoComponentWithMessagesContext = withMessagesContext(DemoComponent);
-
-const DemoComponent = (props) => {
-  const { loadingMore, messages } = props;
-
-  return (
-    <View>
-      <Text>
-        MessageList is currently loading more: {loadingMore}
-      </Text>
-      <Text>
-        Number of messages in demo component: {messages.length}
-      </Text>
-    </View>
-  );
-};
-```

package/lib/commonjs/contexts/overlayContext/OverlayContext.md

@@ -1,34 +0,0 @@
-Please check the `OverlayContextValue` in [OverlayContext](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/overlayContext/OverlayContext.tsx), for consumable values.
-Provider for this context exists in `OverlayProvider` component. And so, any child component of OverlayProvider
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { useOverlayContext } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const { openPicker, closePicker } = useOverlayContext();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withOverlayContext } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.openPicker);
-    console.log(props.closePicker);
-  }
-
-  // UI Logic
-}

package/lib/commonjs/contexts/overlayContext/withOverlayContext.md

@@ -1 +0,0 @@
-Any component can be made a consumer of the [OverlayContext](#overlaycontext) by using the `withOverlayContext` higher order component.

package/lib/commonjs/contexts/paginatedMessageListContext/PaginatedMessageListContext.md

@@ -1,34 +0,0 @@
-Please check the `PaginatedMessageListContextValue` in [PaginatedMessageListContext](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/paginatedMessageListContext/PaginatedMessageListContext.tsx), for consumable values.
-Provider for this context exists in `Channel` component. And so, any child component of Channel
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { usePaginatedMessageListContext } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const { loadMore, loadingMore, loadMoreRecent, loadingMoreRecent } = usePaginatedMessageListContext();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withPaginatedMessageListContext } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.loadMore);
-    console.log(props.loadMoreRecent);
-  }
-
-  // UI Logic
-}

package/lib/commonjs/contexts/suggestionsContext/SuggestionsContext.md

@@ -1,28 +0,0 @@
-The MessageInput component supports a suggestions feature. Suggestions are displayed using a popup which contains a list of the suggestion items. All functionality is saved in the SuggestionsContext and can be accessed through the [SuggestionsProvider](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/suggestionsContext/SuggestionsContext.tsx) higher order component. This HOC provides the following functions to its underlying child components:
-
-- **closeSuggestions** {function} Closes the suggestions popup above the input box
-- **openSuggestions** {function} Opens the suggestions popup above the input box
-
-  **Params:**
-
-  - **title:** Title for the suggestions popup
-  - **component:** UI component used to display each item in the suggestions list
-- **setInputBoxContainerRef** {function} Sets a ref on the text input box container
-- **updateSuggestions** {function} Updates the suggestions in the suggestions popup
-
-  **Params:**
-
-  - **suggestions:** Array of suggestion objects
-
-  **Example:**
-
-  ```json
-  {
-    data: [
-      'suggestion 1',
-      'suggestion 2',
-      'suggestion 3',
-    ],
-    onSelect: (suggestionItem) => { ... }
-  }
-  ```

package/lib/commonjs/contexts/suggestionsContext/withSuggestionsContext.md

@@ -1 +0,0 @@
-Any component can be made a consumer of the [SuggestionsContext](#suggestionscontext) by using the `withSuggestionsContext` higher order component.

package/lib/commonjs/contexts/threadContext/ThreadContext.md

@@ -1,34 +0,0 @@
-Please check the `ThreadContexttValue` in [ThreadContextt](), for consumable values.
-Provider for this context exists in `Channel` component. And so, any child component of Channel
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { useThreadContextt } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const { openThread, threadMessages } = useThreadContextt();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withThreadContextt } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.openThread);
-    console.log(props.threadMessages);
-  }
-
-  // UI Logic
-}

package/lib/commonjs/contexts/typingContext/TypingContext.md

@@ -1,33 +0,0 @@
-Please check the `TypingContextValue` in [TypingContext](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/contexts/TypingContext/TypingContext.tsx), for consumable values.
-Provider for this context exists in `Channel` component. And so, any child component of Channel
-can get access to context as following:
-
-- Functional component
-
-```tsx static
-import { useTypingContext } from 'stream-chat-react-native';
-
-const SomeChildComponent = () => {
-  const { typing } = useTypingContext();
-
-  return (
-    <View />
-  )
-}
-```
-
-- Class component
-
-```tsx static
-import React from 'react';
-import { withTypingContext } from 'stream-chat-react-native';
-
-class SomeChildComponent extends React.Component {
-  constructor(props) {
-    super(props);
-
-    console.log(props.typing);
-  }
-
-  // UI Logic
-}