Module @sendbird/uikit-react-native - v1.0.0

@sendbird/uikit-react-native

Platform React-Native Language TypeScript

React-Native based UI kit based on sendbird javascript SDK

Installation

Install uikit

npm i @sendbird/uikit-react-native

Install required dependencies

npm i sendbird date-fns react-native-safe-area-context
npx pod-install

(Optional) Install native modules

Local caching

Install if you want to use local caching.

npm i @react-native-async-storage/async-storage @react-native-community/netinfo
npx pod-isntall

React-Native-CLI

Install if you want to use createNativeClipboardService, createNativeNotificationService and createNativeFileService.

npm i react-native-permissions \
react-native-image-picker \
react-native-document-picker \
@react-native-community/cameraroll \
react-native-file-access \
@react-native-clipboard/clipboard \
@react-native-firebase/messaging \
@react-native-firebase/app

npx pod-isntall

Expo-CLI

Install if you want to use createExpoClipboardService, createExpoNotificationService and createExpoFileService.

expo install expo-image-picker \
expo-document-picker \
expo-media-library \
expo-file-system \
expo-clipboard \
expo-notifications

Getting Started

With Sendbird UIKit for React Native, we export these components: (See src/index.ts)

  • SendbirdUIKitContainer - The context provider container that passes the data required for UIKit down to the child components

  • useSendbirdChat - Hook to access SendbirdChatContext

  • useConnection - Hook allows the Chat SDK to either connect or disconnect the user from the Sendbird server.

  • createGroupChannelFragment - A function that builds a group channel screen

  • createGroupChannelListFragment - A function that builds a group channel list screen

  • createGroupChannelSettingsFragment - A function that builds a group channel settings screen

  • createGroupChannelInviteFragment - A function that builds a group channel invite screen

  • createGroupChannelMembersFragment - A function that builds a group channel members screen

  • createNativeClipboardService - A function that create a basic clipboard service

  • createNativeNotificationService - A function that create a basic notification service

  • createNativeFileService - A function that create a basic file service

and many more...

Index

Interfaces

Type Aliases

Variables

Functions

Generated using TypeDoc