Skip to content

Commit bc3c952

Browse files
committed
docs: rename setImages and setImage
1 parent 6b24648 commit bc3c952

File tree

5 files changed

+27
-27
lines changed

5 files changed

+27
-27
lines changed

docusaurus/docs/reactnative/common-content/contexts/image-gallery-context/set_image.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Setter for value [`images`](../../../contexts/image_gallery_context.mdx#images).
1+
Setter for value [`messages`](../../../contexts/image_gallery_context.mdx#messages).
22

33
| Type |
44
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5-
| `(messageWithImages: [MessageType](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/components/MessageList/hooks/useMessageList.ts)[]) => void` |
5+
| `(messages: [MessageType](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/components/MessageList/hooks/useMessageList.ts)[]) => void` |
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Setter for value [`selectedMessage`](../../../contexts/image_gallery_context.mdx#selectedmessage).
2+
3+
| Type |
4+
| ------------------------------------------------------ |
5+
| `(selectedMessage: {messageId?: string; url?: string;}) => void` |

docusaurus/docs/reactnative/contexts/image_gallery_context.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: image-gallery-context
33
title: ImageGalleryContext
44
---
55

6-
import SetImage from '../common-content/contexts/image-gallery-context/set_image.mdx';
6+
import SetSelectedMessage from '../common-content/contexts/image-gallery-context/set_selected_message.mdx';
77

88
`ImageGalleryContext` is provided by [`OverlayProvider`](../core-components/overlay_provider.mdx) component. If you are not familiar with React Context API, please read about it on [React docs](https://reactjs.org/docs/context.html).
99

@@ -15,27 +15,27 @@ import SetImage from '../common-content/contexts/image-gallery-context/set_image
1515
import { useContext } from 'react';
1616
import { ImageGalleryContext } from 'stream-chat-react-native';
1717

18-
const { images, setImages } = useContext(ImageGalleryContext);
18+
const { messages, setMessages } = useContext(ImageGalleryContext);
1919
```
2020

2121
Alternatively, you can also use `useImageGalleryContext` hook provided by library to consume ImageGalleryContext.
2222

2323
```tsx
2424
import { useImageGalleryContext } from 'stream-chat-react-native';
2525

26-
const { images, setImages } = useImageGalleryContext();
26+
const { messages, setMessages } = useImageGalleryContext();
2727
```
2828

2929
This context can be useful if you are planning to build a separate screen for channel images, where you may want to open image viewer/gallery when user presses on image.
3030
You can use this `ImageGalleryContext` in combination with `OverlayContext` to open image viewer and show pressed image.
3131

3232
```tsx
33-
const { images, setImages } = useImageGalleryContext();
33+
const { messages, setMessages, setSelectedMessage } = useImageGalleryContext();
3434
const { setOverlay } = useOverlayContext();
3535

3636
onPress={() => {
37-
setImages(messagesWithImage);
38-
setImage({
37+
setMessages(messagesWithImage);
38+
setSelectedMessage({
3939
messageId: selectedItem.messageId,
4040
url: selectedItem.uri,
4141
});
@@ -47,9 +47,9 @@ Please check the implementation of [`ChannelImagesScreen`](https://github.com/Ge
4747

4848
## Value
4949

50-
### image
50+
### selectedMessage
5151

52-
Current active image in image viewer/gallery.
52+
Current active message in image viewer/gallery.
5353

5454
```tsx
5555
{
@@ -62,22 +62,22 @@ Current active image in image viewer/gallery.
6262
| ------ |
6363
| object |
6464

65-
### images
65+
### messages
6666

6767
All the messages in channel which contain image attachments. Image viewer/gallery uses this array to navigate to next or previous image.
6868

6969
| Type |
7070
| ------------------------------------------------------------------------------------------------------------------------------------------- |
7171
| [MessageType](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/components/MessageList/hooks/useMessageList.ts)[] |
7272

73-
### setImage
73+
### setSelectedMessage
7474

75-
<SetImage />
75+
<SetSelectedMessage />
7676

77-
### setImages
77+
### setMessages
7878

79-
Setter for value [images](#images).
79+
Setter for value [messages](#messages).
8080

8181
| Type |
8282
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
83-
| (messageWithImages: [MessageType](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/components/MessageList/hooks/useMessageList.ts)[]) => void |
83+
| (messages: [MessageType](https://github.com/GetStream/stream-chat-react-native/blob/main/package/src/components/MessageList/hooks/useMessageList.ts)[]) => void |

docusaurus/docs/reactnative/ui-components/giphy.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ import HandleAction from '../common-content/contexts/message-context/handle_acti
77
import OnLongPress from '../common-content/contexts/message-context/on_long_press.mdx';
88
import OnPress from '../common-content/contexts/message-context/on_press.mdx';
99
import OnPressIn from '../common-content/contexts/message-context/on_press_in.mdx';
10-
import SetImage from '../common-content/contexts/image-gallery-context/set_image.mdx';
11-
import SetImages from '../common-content/contexts/image-gallery-context/set_images.mdx';
10+
import SetSelectedMessage from '../common-content/contexts/image-gallery-context/set_selected_message.mdx';
11+
import SetMessages from '../common-content/contexts/image-gallery-context/set_messages.mdx';
1212

1313
import AdditionalTouchableProps from '../common-content/core-components/channel/props/additional_touchable_props.mdx';
1414
import SetOverlay from '../common-content/contexts/overlay-context/set_overlay.mdx';
@@ -47,13 +47,13 @@ Attachment object for `giphy` type attachment.
4747

4848
<OnPressIn />
4949

50-
### <div class="label description">_overrides the value from [ImageGalleryContext](../contexts/image_gallery_context.mdx#setimage)_</div> setImage {#setimage}
50+
### <div class="label description">_overrides the value from [ImageGalleryContext](../contexts/image_gallery_context.mdx#setimage)_</div> setSelectedMessage {#setselectedmessage}
5151

52-
<SetImage />
52+
<SetSelectedMessage />
5353

54-
### <div class="label description">_overrides the value from [ImageGalleryContext](../contexts/image_gallery_context.mdx#setimages)_</div> setImages {#setimages}
54+
### <div class="label description">_overrides the value from [ImageGalleryContext](../contexts/image_gallery_context.mdx#setimages)_</div> setMessages {#setmessages}
5555

56-
<SetImages />
56+
<SetMessages />
5757

5858
### <div class="label description">_overrides the value from [OverlayContext](../contexts/overlay_context.mdx#setoverlay)_</div> setOverlay {#setoverlay}
5959

0 commit comments

Comments
 (0)