AttachmentPickerContext

AttachmentPickerContext is provided by Channel. If you are not familiar with the React Context API, see the React docs.

Best Practices

• Use useAttachmentPickerContext for consistent access and typings.
• Manage picker visibility through openPicker/closePicker to keep state aligned.
• Prefer setting topInset and bottomInset on Channel for normal screen layout, and keep those values consistent with your layout.
• Avoid using the picker context outside Channel to prevent undefined state.
• Keep custom picker UI lightweight to preserve input performance.

Basic Usage

Consume AttachmentPickerContext in any child of Channel:

import { useContext } from "react";
import { AttachmentPickerContext } from "stream-chat-react-native";

const { openPicker, closePicker } = useContext(AttachmentPickerContext);

Alternatively, use the useAttachmentPickerContext hook.

import { useAttachmentPickerContext } from "stream-chat-react-native";

const { openPicker, closePicker } = useAttachmentPickerContext();

Value

AttachmentPickerContent

Custom UI component to render the attachment picker content area.

AttachmentPickerIOSSelectMorePhotos

Custom UI component to render the "select more photos" option for limited gallery access on iOS.

AttachmentPickerSelectionBar

Custom UI component to render the selection bar within the attachment picker.

attachmentPickerBottomSheetHeight

Height of the attachment picker bottom sheet.

attachmentPickerStore

State store instance that manages the internal state of the attachment picker, including selected images and picker type.

attachmentSelectionBarHeight

Height of the attachment selection bar.

bottomInset

Height of items located below the MessageComposer when present. This inset determines the underlying shift to the MessageList when it is opened.

For most apps, set this through Channel. Update it from the context only when the inset needs to change dynamically after mount.

bottomSheetRef

Reference to the attachment picker bottom sheet.

closePicker

Function to close the attachment picker bottom sheet.

disableAttachmentPicker

When true, the attachment picker is disabled entirely.

ImageOverlaySelectedComponent

Custom UI component to render the overlay on top of selected images (with tick mark).

numberOfAttachmentImagesToLoadPerCall

Number of images to load per pagination call in the attachment picker.

numberOfAttachmentPickerImageColumns

Number of columns to display in the attachment picker image grid.

openPicker

Function to open the attachment picker bottom sheet.

topInset

Distance from the top of the screen the attachment picker should open to when expanded. This is often set to the header height.

For most apps, set this through Channel. Update it from the context only when the inset needs to change dynamically after mount.