diff --git a/README.md b/README.md index 29cc3ec25..f5507095f 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,14 @@ Sendbird UIKit for React-Native is a development kit with an user interface that This mono-repository the UIKit source code is consists as explained below. - [**packages/uikit-react-native**](/packages/uikit-react-native) is where you can find the open source code. Check out [UIKit Open Source Guidelines](/OPENSOURCE_GUIDELINES.md) for more information regarding our stance on open source. -- [**sample**](/sample) is a chat app with UIKit’s core features in which you can see items such as push notifications, total unread message count and auto sign-in are demonstrated. When you sign in to the sample app, you will only see a list of channels rendered by the [GroupChannelListFragment](https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels) on the screen. +- [**sample**](/sample) is a chat app with UIKit’s core features in which you can see items such as push notifications, total unread message count and auto sign-in are demonstrated. When you sign in to the sample app, you will only see a list of channels rendered by the [GroupChannelListFragment](https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/list-channels) on the screen. - [**packages/uikit-react-native-foundation**](/packages/uikit-react-native-foundation) is a UI package for `uikit-react-native`. - [**packages/uikit-chat-hooks**](/packages/uikit-chat-hooks) is a react hooks package for `uikit-react-native`. - [**packages/uikit-utils**](/packages/uikit-utils) is a utility package for `uikit-react-native`. ### More about Sendbird UIKit for React-Native -Find out more about Sendbird UIKit for React-Native at [UIKit for React Native doc](https://sendbird.com/docs/uikit/v3/react-native/overview). +Find out more about Sendbird UIKit for React-Native at [UIKit for React Native doc](https://sendbird.com/docs/chat/uikit/v3/react-native/overview). If you need any help in resolving any issues or have questions, visit [our community](https://community.sendbird.com).
diff --git a/docs-validation/1_introduction/Authentication.tsx b/docs-validation/1_introduction/Authentication.tsx index fedc77e01..3a3950f68 100644 --- a/docs-validation/1_introduction/Authentication.tsx +++ b/docs-validation/1_introduction/Authentication.tsx @@ -5,7 +5,7 @@ const PROFILE_FILE: FileType = { name: '', size: 0, type: '', uri: '' }; /** * Connect to the Sendbird server - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/authentication#2-connect-to-the-sendbird-server} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/authentication#2-connect-to-the-sendbird-server} * */ import { useConnection } from '@sendbird/uikit-react-native'; @@ -27,7 +27,7 @@ const Component = () => { /** * Disconnect from the Sendbird server - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/authentication#2-disconnect-from-the-sendbird-server} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/authentication#2-disconnect-from-the-sendbird-server} * */ const Component2 = () => { const { disconnect } = useConnection(); @@ -37,7 +37,7 @@ const Component2 = () => { /** * Retrieve online status of current user - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/authentication#2-retrieve-online-status-of-current-user} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/authentication#2-retrieve-online-status-of-current-user} * */ import { useSendbirdChat } from '@sendbird/uikit-react-native'; @@ -54,7 +54,7 @@ const Component3 = () => { /** * Register for push notifications - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/authentication#2-register-for-push-notifications} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/authentication#2-register-for-push-notifications} * */ import RNFBMessaging from '@react-native-firebase/messaging'; import * as Permissions from 'react-native-permissions'; @@ -77,7 +77,7 @@ const App = () => { /** * Unregister push notifications - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/authentication#2-unregister-push-notifications} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/authentication#2-unregister-push-notifications} * */ const App2 = () => { return ( @@ -92,7 +92,7 @@ const App2 = () => { /** * Update user profile - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/authentication#2-update-user-profile} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/authentication#2-update-user-profile} * */ const Component4 = () => { const { updateCurrentUserInfo } = useSendbirdChat(); diff --git a/docs-validation/1_introduction/NativeModules.tsx b/docs-validation/1_introduction/NativeModules.tsx index dbd0e1019..decadec9c 100644 --- a/docs-validation/1_introduction/NativeModules.tsx +++ b/docs-validation/1_introduction/NativeModules.tsx @@ -15,7 +15,7 @@ import { /** * Helper functions#React Native CLI - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/native-modules#2-helper-functions-3-react-native-cli} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/native-modules#2-helper-functions-3-react-native-cli} * */ import Clipboard from '@react-native-clipboard/clipboard'; import { CameraRoll } from '@react-native-camera-roll/camera-roll'; @@ -60,7 +60,7 @@ const nativePlatformServices = { /** * Helper functions#Expo CLI - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/native-modules#2-helper-functions-3-expo-cli} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/native-modules#2-helper-functions-3-expo-cli} * */ import * as ExpoClipboard from 'expo-clipboard'; import * as ExpoDocumentPicker from 'expo-document-picker'; diff --git a/docs-validation/1_introduction/ScreenNavigation.tsx b/docs-validation/1_introduction/ScreenNavigation.tsx index 8b70eef4b..04bf96822 100644 --- a/docs-validation/1_introduction/ScreenNavigation.tsx +++ b/docs-validation/1_introduction/ScreenNavigation.tsx @@ -4,7 +4,7 @@ const GroupChannelScreen = () => ; /** * Set up navigation in a fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/screen-navigation#2-set-up-navigation-in-a-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/screen-navigation#2-set-up-navigation-in-a-fragment} * */ // @ts-ignore import { Navigation } from 'react-native-navigation'; @@ -34,7 +34,7 @@ const GroupChannelListScreen = (props: { componentId: string }) => { /** * Integrate navigation library - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/screen-navigation#2-integrate-navigation-library} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/screen-navigation#2-integrate-navigation-library} * */ Navigation.registerComponent('GroupChannel', () => GroupChannelScreen); Navigation.registerComponent('GroupChannelList', () => GroupChannelListScreen); diff --git a/docs-validation/1_introduction/SendYourFirstMessage.tsx b/docs-validation/1_introduction/SendYourFirstMessage.tsx index c5be54c16..07023e5c1 100644 --- a/docs-validation/1_introduction/SendYourFirstMessage.tsx +++ b/docs-validation/1_introduction/SendYourFirstMessage.tsx @@ -2,7 +2,7 @@ import React from 'react'; /** * Implement platform service interfaces using native modules - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-4-implement-platform-service-interfaces-using-native-modules} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-4-implement-platform-service-interfaces-using-native-modules} * */ import { createNativeClipboardService, @@ -58,7 +58,7 @@ export const platformServices: SendbirdUIKitContainerProps['platformServices'] = /** * Wrap your app in SendbirdUIKitContainer - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-5-wrap-your-app-in-sendbirduikitcontainer} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-5-wrap-your-app-in-sendbirduikitcontainer} * */ import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; import AsyncStorage from '@react-native-async-storage/async-storage'; @@ -78,7 +78,7 @@ const App = () => { /** * Create a fragment and module components - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-7-create-a-fragment-and-module-components} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-7-create-a-fragment-and-module-components} * */ import { useNavigation, useRoute } from '@react-navigation/native'; import { useGroupChannel } from '@sendbird/uikit-chat-hooks'; @@ -156,7 +156,7 @@ const GroupChannelScreen = () => { /** * Register navigation library to the screen - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-8-register-navigation-library-to-the-screen} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-8-register-navigation-library-to-the-screen} * */ import { NavigationContainer } from '@react-navigation/native'; import { createNativeStackNavigator } from '@react-navigation/native-stack'; @@ -197,7 +197,7 @@ const App2 = () => { /** * Connect to the Sendbird server - * {@link https://sendbird.com/docs/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-9-connect-to-the-sendbird-server} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/send-first-message#2-get-started-3-step-9-connect-to-the-sendbird-server} * */ import { Pressable, Text, View } from 'react-native'; import { useConnection } from '@sendbird/uikit-react-native'; diff --git a/docs-validation/2_features/DeliveryReceipt.tsx b/docs-validation/2_features/DeliveryReceipt.tsx index bf773d338..11b0a280d 100644 --- a/docs-validation/2_features/DeliveryReceipt.tsx +++ b/docs-validation/2_features/DeliveryReceipt.tsx @@ -1,6 +1,6 @@ /** * How to use - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/delivery-receipt#2-how-to-use} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/delivery-receipt#2-how-to-use} * */ import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; @@ -12,7 +12,7 @@ const App = () => { /** * Icon resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/delivery-receipt#2-customize-the-ui-for-delivery-receipt-3-icon-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/delivery-receipt#2-customize-the-ui-for-delivery-receipt-3-icon-resource} * */ import { Icon } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/2_features/FileSharing.tsx b/docs-validation/2_features/FileSharing.tsx index 2d6debc75..5bec6f2ba 100644 --- a/docs-validation/2_features/FileSharing.tsx +++ b/docs-validation/2_features/FileSharing.tsx @@ -9,7 +9,7 @@ const isImageFile = (x: string) => x; /** * Customize the UI for file sharing - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing} * */ import { createGroupChannelFragment, GroupChannelMessageRenderer } from '@sendbird/uikit-react-native'; @@ -32,7 +32,7 @@ const GroupChannelScreen = () => { /** * Color resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing-3-color-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing-3-color-resource} * */ function _colorResource(colors: UIKitColors) { colors.ui.groupChannelMessage; @@ -50,7 +50,7 @@ function _colorResource(colors: UIKitColors) { /** * Icon resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing-3-icon-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing-3-icon-resource} * */ Icon.Assets['add'] = require('your_icons/add_icon.png'); Icon.Assets['document'] = require('your_icons/document_icon.png'); @@ -61,7 +61,7 @@ Icon.Assets['play'] = require('your_icons/play_icon.png'); /** * String resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing-3-string-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/file-sharing#2-customize-the-ui-for-file-sharing-3-string-resource} * */ function _stringResource(str: StringSet) { str.GROUP_CHANNEL; @@ -83,7 +83,7 @@ function _stringResource(str: StringSet) { /** * Image compression - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/file-sharing#2-image-compression} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/file-sharing#2-image-compression} * */ import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; diff --git a/docs-validation/2_features/ReadReceipt.tsx b/docs-validation/2_features/ReadReceipt.tsx index 29c31d531..0dec7b514 100644 --- a/docs-validation/2_features/ReadReceipt.tsx +++ b/docs-validation/2_features/ReadReceipt.tsx @@ -1,6 +1,6 @@ /** * How to use - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/read-receipt#2-how-to-use} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/read-receipt#2-how-to-use} * */ import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; const App = () => { @@ -11,7 +11,7 @@ const App = () => { /** * Icon resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/read-receipt#2-customize-the-ui-for-delivery-receipt-3-icon-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/read-receipt#2-customize-the-ui-for-delivery-receipt-3-icon-resource} * */ import { Icon } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/2_features/TypingIndicator.tsx b/docs-validation/2_features/TypingIndicator.tsx index 7a6985a2c..5d79b9fec 100644 --- a/docs-validation/2_features/TypingIndicator.tsx +++ b/docs-validation/2_features/TypingIndicator.tsx @@ -2,7 +2,7 @@ import type { StringSet } from '@sendbird/uikit-react-native'; /** * How to use - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/typing-indicator#2-how-to-use} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/typing-indicator#2-how-to-use} * */ import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; const App = () => { @@ -13,7 +13,7 @@ const App = () => { /** * String resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/typing-indicator#2-customize-the-ui-for-typing-indicator-3-string-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/typing-indicator#2-customize-the-ui-for-typing-indicator-3-string-resource} * */ type TypingIndicatorTypings = StringSet['LABELS']['TYPING_INDICATOR_TYPINGS']; /** ------------------ **/ diff --git a/docs-validation/3_core-components/Hooks.tsx b/docs-validation/3_core-components/Hooks.tsx index aaf7feaf0..1bb6a7caf 100644 --- a/docs-validation/3_core-components/Hooks.tsx +++ b/docs-validation/3_core-components/Hooks.tsx @@ -1,6 +1,6 @@ /** * useSendbirdChat - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-usesendbirdchat-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-usesendbirdchat-} * */ import { useSendbirdChat } from '@sendbird/uikit-react-native'; @@ -15,7 +15,7 @@ const Component = () => { /** * useConnection - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-useconnection-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-useconnection-} * */ import { useConnection, SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; @@ -38,7 +38,7 @@ const App = () => { /** * useUIKitTheme - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-useuikittheme-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-useuikittheme-} * */ import { useUIKitTheme } from '@sendbird/uikit-react-native-foundation'; @@ -52,7 +52,7 @@ const Component3 = () => { /** * usePlatformService - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-useplatformservice-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-useplatformservice-} * */ import { usePlatformService } from '@sendbird/uikit-react-native'; @@ -70,7 +70,7 @@ const Component4 = () => { /** * useLocalization - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-uselocalization-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-uselocalization-} * */ import { useLocalization } from '@sendbird/uikit-react-native'; @@ -81,7 +81,7 @@ const Component5 = () => { /** * useToast - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-usetoast-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-usetoast-} * */ import { useToast } from '@sendbird/uikit-react-native-foundation'; @@ -93,7 +93,7 @@ const Component6 = () => { /** * usePrompt - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-useprompt-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-useprompt-} * */ import { usePrompt } from '@sendbird/uikit-react-native-foundation'; @@ -109,7 +109,7 @@ const Component7 = () => { /** * useBottomSheet - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-usebottomsheet-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-usebottomsheet-} * */ import { useBottomSheet } from '@sendbird/uikit-react-native-foundation'; @@ -128,7 +128,7 @@ const Component8 = () => { /** * useActionMenu - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-useactionmenu-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-useactionmenu-} * */ import { useActionMenu } from '@sendbird/uikit-react-native-foundation'; @@ -147,7 +147,7 @@ const Component9 = () => { /** * useAlert - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks#-3-usealert-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks#-3-usealert-} * */ import { useAlert } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/3_core-components/Provider/PlatformServiceProvider.tsx b/docs-validation/3_core-components/Provider/PlatformServiceProvider.tsx index be839c91e..d7b940515 100644 --- a/docs-validation/3_core-components/Provider/PlatformServiceProvider.tsx +++ b/docs-validation/3_core-components/Provider/PlatformServiceProvider.tsx @@ -13,7 +13,7 @@ type GetFileRes = null | FileCompat; /** * FileServiceInterface - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/provider/platformserviceprovider#2-fileserviceinterface} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/provider/platformserviceprovider#2-fileserviceinterface} * */ async function fileServiceInterface(service: FileServiceInterface) { const mediaType = '' as 'photo' | 'video' | 'all' | undefined; @@ -49,7 +49,7 @@ async function mediaServiceInterface(service: MediaServiceInterface) { /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/provider/platformserviceprovider#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/provider/platformserviceprovider#2-usage} * */ import { usePlatformService } from '@sendbird/uikit-react-native'; @@ -60,7 +60,7 @@ const Component = () => { /** * Direct implementation - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/provider/platformserviceprovider#2-direct-implementation} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/provider/platformserviceprovider#2-direct-implementation} * */ import { FilePickerResponse, diff --git a/docs-validation/3_core-components/Provider/SendbirdChatProvider.tsx b/docs-validation/3_core-components/Provider/SendbirdChatProvider.tsx index 0e314f89f..c96147ffa 100644 --- a/docs-validation/3_core-components/Provider/SendbirdChatProvider.tsx +++ b/docs-validation/3_core-components/Provider/SendbirdChatProvider.tsx @@ -3,7 +3,7 @@ import React from 'react'; /** * SendbirdChatProvider - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/provider/sendbirdchatprovider#1-sendbirdchatprovider} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/provider/sendbirdchatprovider#1-sendbirdchatprovider} * */ import { useConnection, useSendbirdChat } from '@sendbird/uikit-react-native'; import { Button, Text } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/3_core-components/SendbirdUIKitContainer.tsx b/docs-validation/3_core-components/SendbirdUIKitContainer.tsx index 6f11550c7..d4b9ca528 100644 --- a/docs-validation/3_core-components/SendbirdUIKitContainer.tsx +++ b/docs-validation/3_core-components/SendbirdUIKitContainer.tsx @@ -3,7 +3,7 @@ import React from 'react'; /** * SendbirdUIKitContainer - * {@link https://sendbird.com/docs/uikit/v3/react-native/core-components/sendbirduikitcontainer#1-sendbirduikitcontainer} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/sendbirduikitcontainer#1-sendbirduikitcontainer} * */ import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; diff --git a/docs-validation/4_key-functions/Architecture/Context.tsx b/docs-validation/4_key-functions/Architecture/Context.tsx index 0a24f9ba3..902e0b5f5 100644 --- a/docs-validation/4_key-functions/Architecture/Context.tsx +++ b/docs-validation/4_key-functions/Architecture/Context.tsx @@ -1,6 +1,6 @@ /** * How to use context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/architecture/context#2-how-to-use-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/architecture/context#2-how-to-use-context} * */ import React, { useContext } from 'react'; import { Text } from 'react-native'; diff --git a/docs-validation/4_key-functions/Architecture/Fragment.tsx b/docs-validation/4_key-functions/Architecture/Fragment.tsx index d390f4518..eab6a14cd 100644 --- a/docs-validation/4_key-functions/Architecture/Fragment.tsx +++ b/docs-validation/4_key-functions/Architecture/Fragment.tsx @@ -5,7 +5,7 @@ const FriendComponent = (_: { user: SendbirdUser }) => <>; /** * Customize a Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/architecture/fragment#2-customize-a-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/architecture/fragment#2-customize-a-fragment} * */ import { CustomQuery, useUserList } from '@sendbird/uikit-chat-hooks'; import { createUserListModule, useSendbirdChat } from '@sendbird/uikit-react-native'; diff --git a/docs-validation/4_key-functions/Architecture/Module.tsx b/docs-validation/4_key-functions/Architecture/Module.tsx index a2d471558..639522324 100644 --- a/docs-validation/4_key-functions/Architecture/Module.tsx +++ b/docs-validation/4_key-functions/Architecture/Module.tsx @@ -4,7 +4,7 @@ const CustomHeader = () => <>; /** * Create a module - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/architecture/module#2-create-a-module} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/architecture/module#2-create-a-module} * */ import { createGroupChannelModule } from '@sendbird/uikit-react-native'; const GroupChannelModule = createGroupChannelModule(); @@ -26,7 +26,7 @@ const RenderModule = () => { /** * Customize a module - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/architecture/module#2-customize-a-module} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/architecture/module#2-customize-a-module} * */ import { createGroupChannelFragment } from '@sendbird/uikit-react-native'; @@ -38,7 +38,7 @@ const GroupChannelFragment = createGroupChannelFragment({ Header: CustomHeader } /** * Customize a module component - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/architecture/module#2-customize-a-module-3-customize-a-module-component} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/architecture/module#2-customize-a-module-3-customize-a-module-component} * */ import { Text } from 'react-native'; import type { GroupChannelProps } from '@sendbird/uikit-react-native'; diff --git a/docs-validation/4_key-functions/ChattingInAChannel/ChatInAGroupChannel.tsx b/docs-validation/4_key-functions/ChattingInAChannel/ChatInAGroupChannel.tsx index 08622bc17..bef2841cd 100644 --- a/docs-validation/4_key-functions/ChattingInAChannel/ChatInAGroupChannel.tsx +++ b/docs-validation/4_key-functions/ChattingInAChannel/ChatInAGroupChannel.tsx @@ -4,7 +4,7 @@ const AdvertiseMessage = (_:object) => <> /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-usage} * */ import { useSendbirdChat, createGroupChannelFragment } from "@sendbird/uikit-react-native"; import { useGroupChannel } from "@sendbird/uikit-chat-hooks"; @@ -33,7 +33,7 @@ const GroupChannelScreen = ({ route: { params } }: any) => { /** * Context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context} * */ function _context(_: GroupChannelContextsType) { const fragment = useContext(_.Fragment); @@ -52,7 +52,7 @@ function _context(_: GroupChannelContextsType) { /** * Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context-3-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context-3-fragment} * */ const Component = () => { const { @@ -69,7 +69,7 @@ const Component = () => { /** * TypingIndicator - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context-3-typeselector} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context-3-typeselector} * */ const Component2 = () => { const { typingUsers } = useContext(GroupChannelContexts.TypingIndicator); @@ -78,7 +78,7 @@ const Component2 = () => { /** * Customization - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-customization} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-customization} * */ import React, { useContext, useLayoutEffect } from 'react'; import { Pressable } from 'react-native'; diff --git a/docs-validation/4_key-functions/ChattingInAChannel/ChatInAnOpenChannel.tsx b/docs-validation/4_key-functions/ChattingInAChannel/ChatInAnOpenChannel.tsx index b444ee305..ca766ea5d 100644 --- a/docs-validation/4_key-functions/ChattingInAChannel/ChatInAnOpenChannel.tsx +++ b/docs-validation/4_key-functions/ChattingInAChannel/ChatInAnOpenChannel.tsx @@ -4,7 +4,7 @@ const DonationMessage = (_:object) => <> /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-an-open-channel#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-an-open-channel#2-usage} * */ import { useSendbirdChat, createOpenChannelFragment } from "@sendbird/uikit-react-native"; import { useOpenChannel } from "@sendbird/uikit-chat-hooks"; @@ -35,7 +35,7 @@ const OpenChannelScreen = ({ route: { params } }: any) => { /** * Context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context} * */ function _context(_: OpenChannelContextsType) { const fragment = useContext(_.Fragment); @@ -49,7 +49,7 @@ function _context(_: OpenChannelContextsType) { /** * Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context-3-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-context-3-fragment} * */ const Component = () => { const { @@ -64,7 +64,7 @@ const Component = () => { /** * Customization - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-customization} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/chatting-in-a-channel/chat-in-a-group-channel#2-customization} * */ import React, { useContext, useLayoutEffect } from 'react'; import { Pressable } from 'react-native'; diff --git a/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureGroupChannelSettings.tsx b/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureGroupChannelSettings.tsx index 52d12d54f..25b87bb6e 100644 --- a/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureGroupChannelSettings.tsx +++ b/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureGroupChannelSettings.tsx @@ -2,7 +2,7 @@ import type { GroupChannelSettingsContextsType } from '@sendbird/uikit-react-nat /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-usage} * */ import React, { useState } from 'react'; import { useSendbirdChat, createGroupChannelSettingsFragment } from '@sendbird/uikit-react-native'; @@ -41,7 +41,7 @@ const GroupChannelSettingsScreen = ({ route: { params } }: any) => { /** * Context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-context} * */ function _context(_: GroupChannelSettingsContextsType) { const fragment = useContext(_.Fragment); @@ -54,7 +54,7 @@ function _context(_: GroupChannelSettingsContextsType) { /** * Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-context-3-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-context-3-fragment} * */ import { useContext } from 'react'; import { GroupChannelSettingsContexts } from '@sendbird/uikit-react-native'; @@ -66,7 +66,7 @@ const Component = () => { /** * Customization - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-customization} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-group-channel-settings#2-customization} * */ import { Share } from 'react-native'; diff --git a/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureOpenChannelSettings.tsx b/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureOpenChannelSettings.tsx index 59bc40108..36360fcc8 100644 --- a/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureOpenChannelSettings.tsx +++ b/docs-validation/4_key-functions/ConfiguringChannelSettings/ConfigureOpenChannelSettings.tsx @@ -2,7 +2,7 @@ import type { OpenChannelSettingsContextsType } from '@sendbird/uikit-react-nati /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-usage} * */ import React, { useState } from 'react'; import { useSendbirdChat, createOpenChannelSettingsFragment } from '@sendbird/uikit-react-native'; @@ -35,7 +35,7 @@ const OpenChannelSettingsScreen = ({ route: { params } }: any) => { /** * Context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-context} * */ function _context(_: OpenChannelSettingsContextsType) { const fragment = useContext(_.Fragment); @@ -48,7 +48,7 @@ function _context(_: OpenChannelSettingsContextsType) { /** * Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-context-3-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-context-3-fragment} * */ import { useContext } from 'react'; import { OpenChannelSettingsContexts } from '@sendbird/uikit-react-native'; @@ -60,7 +60,7 @@ const Component = () => { /** * Customization - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-customization} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/configuring-channel-settings/configure-open-channel-settings#2-customization} * */ import { Share } from 'react-native'; diff --git a/docs-validation/4_key-functions/CreatingAChannel/CreateAGroupChannel.tsx b/docs-validation/4_key-functions/CreatingAChannel/CreateAGroupChannel.tsx index 65e4164ec..90d77d0d1 100644 --- a/docs-validation/4_key-functions/CreatingAChannel/CreateAGroupChannel.tsx +++ b/docs-validation/4_key-functions/CreatingAChannel/CreateAGroupChannel.tsx @@ -11,7 +11,7 @@ const createMyAppUserQuery = () => ({ /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-usage} * */ import type { GroupChannelType, UserListContextsType } from "@sendbird/uikit-react-native"; import type { SendbirdUser } from '@sendbird/uikit-utils'; @@ -34,7 +34,7 @@ const GroupChannelCreateScreen = ({ route: { params } }: any) => { /** * Context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context} * */ function _context(_: UserListContextsType) { const fragment = useContext(_.Fragment); @@ -49,7 +49,7 @@ function _context(_: UserListContextsType) { /** * Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-fragment} * */ import { UserListContexts } from "@sendbird/uikit-react-native"; const Component = () => { @@ -59,7 +59,7 @@ const Component = () => { /** * List - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-list} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-list} * */ const Component2 = () => { @@ -69,7 +69,7 @@ const Component2 = () => { /** * Customization - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-customization} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-customization} * */ import type { UserStruct } from '@sendbird/uikit-utils'; import { CustomQuery } from '@sendbird/uikit-chat-hooks'; diff --git a/docs-validation/4_key-functions/InviteUsers.tsx b/docs-validation/4_key-functions/InviteUsers.tsx index 656b83cac..75af96f71 100644 --- a/docs-validation/4_key-functions/InviteUsers.tsx +++ b/docs-validation/4_key-functions/InviteUsers.tsx @@ -11,7 +11,7 @@ const createMyAppUserQuery = () => ({ /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-usage} * */ import { useState } from 'react'; import { useSendbirdChat, createGroupChannelInviteFragment } from "@sendbird/uikit-react-native"; @@ -39,7 +39,7 @@ const GroupChannelInviteScreen = ({ route: { params } }: any) => { /** * Context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context} * */ import type { UserListContextsType } from "@sendbird/uikit-react-native"; @@ -56,7 +56,7 @@ function _context(_: UserListContextsType) { /** * Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-fragment} * */ import { useContext } from 'react'; import { UserListContexts } from "@sendbird/uikit-react-native"; @@ -68,7 +68,7 @@ const Component = () => { /** * List - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-list} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-context-3-list} * */ // import { useContext } from 'react'; // import { UserListContexts } from "@sendbird/uikit-react-native"; @@ -80,7 +80,7 @@ const Component2 = () => { /** * Customization - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-customization} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/creating-a-channel/create-a-group-channel#2-customization} * */ import type { UserStruct } from '@sendbird/uikit-utils'; import { CustomQuery } from '@sendbird/uikit-chat-hooks'; diff --git a/docs-validation/4_key-functions/ListChannels.tsx b/docs-validation/4_key-functions/ListChannels.tsx index 72e049d7b..2f46e79fa 100644 --- a/docs-validation/4_key-functions/ListChannels.tsx +++ b/docs-validation/4_key-functions/ListChannels.tsx @@ -3,7 +3,7 @@ import React, { useContext, useLayoutEffect } from 'react'; /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/list-channels#2-usage} * */ import { createGroupChannelListFragment } from '@sendbird/uikit-react-native'; @@ -23,7 +23,7 @@ const GroupChannelListScreen = () => { /** * Context - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels#2-context} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/list-channels#2-context} * */ function _context(_: GroupChannelListContextsType) { const fragment = useContext(_.Fragment); @@ -39,7 +39,7 @@ function _context(_: GroupChannelListContextsType) { /** * Fragment - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels#2-context-3-fragment} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/list-channels#2-context-3-fragment} * */ // import { useContext } from 'react'; import { GroupChannelListContexts } from '@sendbird/uikit-react-native'; @@ -51,7 +51,7 @@ const Component = () => { /** * TypeSelector - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels#2-context-3-typeselector} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/list-channels#2-context-3-typeselector} * */ // import { useContext } from 'react'; // import { GroupChannelListContexts } from '@sendbird/uikit-react-native'; @@ -63,7 +63,7 @@ const Component2 = () => { /** * Customization - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels#2-customization} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/list-channels#2-customization} * */ // import React, { useContext, useLayoutEffect } from 'react'; import { Pressable } from 'react-native'; diff --git a/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateGroupChannelsAndMembers.tsx b/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateGroupChannelsAndMembers.tsx index 5892e8af6..045d3a5d1 100644 --- a/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateGroupChannelsAndMembers.tsx +++ b/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateGroupChannelsAndMembers.tsx @@ -2,7 +2,7 @@ const MyHeader = () => null; /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} * */ import React from 'react'; @@ -33,7 +33,7 @@ const GroupChannelModerationScreen = ({ route: { params } }: any) => { /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} * */ const GroupChannelModerationFragment2 = createGroupChannelModerationFragment({ Header: () => , // Use custom header diff --git a/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateOpenChannelsAndParticipants.tsx b/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateOpenChannelsAndParticipants.tsx index 876c6ba9d..27f9bc66e 100644 --- a/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateOpenChannelsAndParticipants.tsx +++ b/docs-validation/4_key-functions/ModeratingChannelsAndMembers/ModerateOpenChannelsAndParticipants.tsx @@ -2,7 +2,7 @@ const MyHeader = () => null; /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} * */ import React from 'react'; @@ -33,7 +33,7 @@ const OpenChannelModerationScreen = ({ route: { params } }: any) => { /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/moderating-channels-and-members/moderate-group-channels-and-members} * */ const OpenChannelModerationFragment2 = createOpenChannelModerationFragment({ Header: () => , // Use custom header diff --git a/docs-validation/4_key-functions/Overview.tsx b/docs-validation/4_key-functions/Overview.tsx index 11aafcdaf..4c65017df 100644 --- a/docs-validation/4_key-functions/Overview.tsx +++ b/docs-validation/4_key-functions/Overview.tsx @@ -3,7 +3,7 @@ const useHooksForChat = () => ({ dataA: '', dataB: '' }); /** * Key functions - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/overview} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/overview} * */ import React, { createContext, useContext } from 'react'; import { Text } from 'react-native'; diff --git a/docs-validation/4_key-functions/RegisteringAsOperator/RegisterMemberAsOperators.tsx b/docs-validation/4_key-functions/RegisteringAsOperator/RegisterMemberAsOperators.tsx index dec42689c..8fc0dce28 100644 --- a/docs-validation/4_key-functions/RegisteringAsOperator/RegisterMemberAsOperators.tsx +++ b/docs-validation/4_key-functions/RegisteringAsOperator/RegisterMemberAsOperators.tsx @@ -2,7 +2,7 @@ const MyHeader = () => null; /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/registering-as-operator-register-member-as-operators} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/registering-as-operator-register-member-as-operators} * */ import React from 'react'; @@ -29,7 +29,7 @@ const GroupChannelRegisterOperatorScreen = ({ route: { params } }: any) => { /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/registering-as-operator-register-member-as-operators} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/registering-as-operator-register-member-as-operators} * */ const GroupChannelRegisterOperatorFragment2 = createGroupChannelRegisterOperatorFragment({ Header: () => , // Use custom header diff --git a/docs-validation/4_key-functions/RegisteringAsOperator/RegisterParticipantsAsOperators.tsx b/docs-validation/4_key-functions/RegisteringAsOperator/RegisterParticipantsAsOperators.tsx index 6c3707f07..abec02d61 100644 --- a/docs-validation/4_key-functions/RegisteringAsOperator/RegisterParticipantsAsOperators.tsx +++ b/docs-validation/4_key-functions/RegisteringAsOperator/RegisterParticipantsAsOperators.tsx @@ -2,7 +2,7 @@ const MyHeader = () => null; /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/registering-as-operator-register-participants-as-operators} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/registering-as-operator-register-participants-as-operators} * */ import React from 'react'; @@ -29,7 +29,7 @@ const OpenChannelRegisterOperatorScreen = ({ route: { params } }: any) => { /** * - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/registering-as-operator-register-participants-as-operators} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/registering-as-operator-register-participants-as-operators} * */ const OpenChannelRegisterOperatorFragment2 = createOpenChannelRegisterOperatorFragment({ Header: () => , // Use custom header diff --git a/docs-validation/4_key-functions/SearchMessage.tsx b/docs-validation/4_key-functions/SearchMessage.tsx index 1b85229e5..fc20278d0 100644 --- a/docs-validation/4_key-functions/SearchMessage.tsx +++ b/docs-validation/4_key-functions/SearchMessage.tsx @@ -1,6 +1,6 @@ /** * Usage - * {@link https://sendbird.com/docs/uikit/v3/react-native/key-functions/list-channels#2-usage} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/key-functions/list-channels#2-usage} * */ import React from 'react'; diff --git a/docs-validation/5_customization/Overview.tsx b/docs-validation/5_customization/Overview.tsx index 31f1b7042..28e3c0c37 100644 --- a/docs-validation/5_customization/Overview.tsx +++ b/docs-validation/5_customization/Overview.tsx @@ -4,7 +4,7 @@ const Analytics = { logError: (_: unknown) => 0 }; /** * HeaderComponent - * {@link https://sendbird.com/docs/uikit/v3/react-native/customization/overview#2-sendbirduikitcontainer-3-headercomponent} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/customization/overview#2-sendbirduikitcontainer-3-headercomponent} * */ import React, { useEffect } from 'react'; import { Pressable } from 'react-native'; @@ -43,7 +43,7 @@ const App = () => { /** * ErrorBoundary - * {@link https://sendbird.com/docs/uikit/v3/react-native/customization/overview#2-sendbirduikitcontainer-3-errorboundary} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/customization/overview#2-sendbirduikitcontainer-3-errorboundary} * */ import { View } from 'react-native'; // import { Text, Button } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/6_themes/Overview.tsx b/docs-validation/6_themes/Overview.tsx index 6f707846d..64e70319b 100644 --- a/docs-validation/6_themes/Overview.tsx +++ b/docs-validation/6_themes/Overview.tsx @@ -12,7 +12,7 @@ const CustomPalette: UIKitPalette = Palette; /** * Themes - * {@link https://sendbird.com/docs/uikit/v3/react-native/themes/overview#1-themes} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/themes/overview#1-themes} * */ import { useColorScheme, View, Text } from 'react-native'; @@ -34,7 +34,7 @@ const App = () => { /** * UIKitTheme - * {@link https://sendbird.com/docs/uikit/v3/react-native/themes/overview#2-uikittheme} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/themes/overview#2-uikittheme} * */ function colorScheme(_: UIKitColorScheme) { switch (_) { @@ -53,7 +53,7 @@ function theme(_: UIKitTheme) { /** * How to use - * {@link https://sendbird.com/docs/uikit/v3/react-native/themes/overview#2-how-to-use} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/themes/overview#2-how-to-use} * */ import { useUIKitTheme } from '@sendbird/uikit-react-native-foundation'; @@ -69,7 +69,7 @@ const Component = () => { /** * Customize the theme - * {@link https://sendbird.com/docs/uikit/v3/react-native/themes/overview#2-customize-the-theme} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/themes/overview#2-customize-the-theme} * */ // import { DarkUIKitTheme, createTheme } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/7_resources/ColorResource.tsx b/docs-validation/7_resources/ColorResource.tsx index c32c42d2e..60dcb79f2 100644 --- a/docs-validation/7_resources/ColorResource.tsx +++ b/docs-validation/7_resources/ColorResource.tsx @@ -10,7 +10,7 @@ import { /** * UIKitPalette - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/color-resource#2-uikitpalette} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/color-resource#2-uikitpalette} * */ import type { UIKitPalette } from '@sendbird/uikit-react-native-foundation'; @@ -63,7 +63,7 @@ const Palette: UIKitPalette = { /** * UIKitColors - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/color-resource#2-uikitpalette} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/color-resource#2-uikitpalette} * */ function uikitColors(_: UIKitColors) { const { @@ -99,7 +99,7 @@ const Component = () => { /** * How to use - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/color-resource#2-how-to-use} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/color-resource#2-how-to-use} * */ // import { useUIKitTheme } from '@sendbird/uikit-react-native-foundation'; // import { View, Text } from 'react-native'; @@ -117,7 +117,7 @@ const Component2 = () => { /** * Customize with default themes - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/color-resource#2-customize-the-colors-3-customize-with-default-themes} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/color-resource#2-customize-the-colors-3-customize-with-default-themes} * */ // import { LightUIKitTheme, Palette } from '@sendbird/uikit-react-native-foundation'; @@ -148,7 +148,7 @@ LightUIKitTheme.colors.ui.button.contained = { /** * Customize the createTheme() - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/color-resource#2-customize-the-colors-3-customize-with-createtheme-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/color-resource#2-customize-the-colors-3-customize-with-createtheme-} * */ import { SendbirdUIKitContainer } from '@sendbird/uikit-react-native'; // import { createTheme } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/7_resources/IconResource.tsx b/docs-validation/7_resources/IconResource.tsx index 447564f54..464c7e61c 100644 --- a/docs-validation/7_resources/IconResource.tsx +++ b/docs-validation/7_resources/IconResource.tsx @@ -5,7 +5,7 @@ import { Icon } from '@sendbird/uikit-react-native-foundation'; /** * Icon component - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/icon-resource#2-how-to-use-3-icon-component} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/icon-resource#2-how-to-use-3-icon-component} * */ // import { Pressable } from 'react-native'; // import { Icon } from '@sendbird/uikit-react-native-foundation'; @@ -21,7 +21,7 @@ const CameraButton = (props: object) => { /** * Icon.Assets - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/icon-resource#2-how-to-use-3-icon-assets} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/icon-resource#2-how-to-use-3-icon-assets} * */ // import { Image, Pressable } from 'react-native'; // import { Icon } from '@sendbird/uikit-react-native-foundation'; @@ -37,7 +37,7 @@ const CameraButton2 = (props: object) => { /** * Customize the icons - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/icon-resource#2-customize-the-icons} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/icon-resource#2-customize-the-icons} * */ // import { Icon } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/7_resources/StringResource.tsx b/docs-validation/7_resources/StringResource.tsx index b755e479f..7ec370e62 100644 --- a/docs-validation/7_resources/StringResource.tsx +++ b/docs-validation/7_resources/StringResource.tsx @@ -4,7 +4,7 @@ const Navigations = () => <>; /** * Customize the StringSet - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/string-resource#2-customize-the-stringset} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/string-resource#2-customize-the-stringset} * */ import { View } from 'react-native'; import dateLocale from 'date-fns/locale/ko'; diff --git a/docs-validation/7_resources/TypographyResource.tsx b/docs-validation/7_resources/TypographyResource.tsx index 0039d0aa4..3a1aca347 100644 --- a/docs-validation/7_resources/TypographyResource.tsx +++ b/docs-validation/7_resources/TypographyResource.tsx @@ -3,7 +3,7 @@ import { Text, createTheme } from '@sendbird/uikit-react-native-foundation'; /** * Text component - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/typography-resource#2-how-to-use-3-text-component} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/typography-resource#2-how-to-use-3-text-component} * */ const TextList = () => { return ( @@ -21,7 +21,7 @@ const TextList = () => { /** * Typography property - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/typography-resource#2-how-to-use-3-typography-property} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/typography-resource#2-how-to-use-3-typography-property} * */ import { useUIKitTheme } from '@sendbird/uikit-react-native-foundation'; // import { Text } from 'react-native'; @@ -35,7 +35,7 @@ const Component = () => { /** * Customize with default themes - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/typography-resource#2-customize-the-typography-3-customize-with-default-themes} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/typography-resource#2-customize-the-typography-3-customize-with-default-themes} * */ import { LightUIKitTheme, createTypography } from '@sendbird/uikit-react-native-foundation'; @@ -63,7 +63,7 @@ LightUIKitTheme.typography.h1 = {}; /** * Customize with createTheme() - * {@link https://sendbird.com/docs/uikit/v3/react-native/resources/typography-resource#2-customize-the-typography-3-customize-with-createtheme-} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/resources/typography-resource#2-customize-the-typography-3-customize-with-createtheme-} * */ // import { createTheme, LightUIKitTheme } from '@sendbird/uikit-react-native-foundation'; diff --git a/docs-validation/8_beta-features/MessageSearch.tsx b/docs-validation/8_beta-features/MessageSearch.tsx index 149a2d2f5..e8859fa82 100644 --- a/docs-validation/8_beta-features/MessageSearch.tsx +++ b/docs-validation/8_beta-features/MessageSearch.tsx @@ -24,7 +24,7 @@ const App = () => { /** * Customize the UI for message search - * {@link https://sendbird.com/docs/uikit/v3/react-native/beta-features/message-search#2-customize-the-ui-for-message-search} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/beta-features/message-search#2-customize-the-ui-for-message-search} * */ const MessageSearchFragment = createMessageSearchFragment(); @@ -42,7 +42,7 @@ const MessageSearchScreen = () => { /** * String resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/message-search#2-customize-the-ui-for-message-search-3-string-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/message-search#2-customize-the-ui-for-message-search-3-string-resource} * */ function _stringResource(str: StringSet) { str.MESSAGE_SEARCH.HEADER_INPUT_PLACEHOLDER @@ -57,7 +57,7 @@ function _stringResource(str: StringSet) { /** * Icon resource - * {@link https://sendbird.com/docs/uikit/v3/react-native/features/message-search#2-customize-the-ui-for-message-search-3-icon-resource} + * {@link https://sendbird.com/docs/chat/uikit/v3/react-native/features/message-search#2-customize-the-ui-for-message-search-3-icon-resource} * */ Icon.Assets['photo'] = require('your_icons/photo_icon.png'); Icon.Assets['play'] = require('your_icons/play_icon.png'); diff --git a/packages/uikit-react-native/README.md b/packages/uikit-react-native/README.md index 926c9239e..6b4713793 100644 --- a/packages/uikit-react-native/README.md +++ b/packages/uikit-react-native/README.md @@ -137,7 +137,7 @@ const App = () => { In order to implement the interfaces to your React Native app more easily, we provide various helper functions for each interface. > **NOTE**: Helper function is not required! You can implement it with native modules you're using. -> More details about PlatformService interfaces, please see [here](https://sendbird.com/docs/uikit/v3/react-native/core-components/provider/platformserviceprovider) +> More details about PlatformService interfaces, please see [here](https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/provider/platformserviceprovider) **Using React Native CLI** @@ -303,7 +303,7 @@ const App = () => { ### Integration with navigation library Now you can create a screen and integrate it with a navigation library like [`react-navigation`](https://reactnavigation.org/). -See more details on [here](https://st.sendbird.com/docs/uikit/v3/react-native/introduction/screen-navigation) +See more details on [here](https://sendbird.com/docs/chat/uikit/v3/react-native/introduction/screen-navigation) The example below shows how to integrate using `react-navigation`. @@ -454,4 +454,4 @@ const App = () => { ``` > You can use sendbird sdk using `useSendbirdChat()` hook, and you can connect or disconnect using `useConnection()` hook. -> for more details about hooks, please refer to our [docs](https://sendbird.com/docs/uikit/v3/react-native/core-components/hooks) +> for more details about hooks, please refer to our [docs](https://sendbird.com/docs/chat/uikit/v3/react-native/core-components/hooks) diff --git a/sample/src/App.tsx b/sample/src/App.tsx index 68b196ddc..e617fe5a1 100644 --- a/sample/src/App.tsx +++ b/sample/src/App.tsx @@ -195,7 +195,7 @@ const Navigations = () => { * * @example How to customize UIKit global navigation * ``` - * const UseReactNavigationHeader: HeaderStyleContextType['HeaderComponent'] = ({ + * const ReactNavigationHeader: HeaderStyleContextType['HeaderComponent'] = ({ * title, * right, * left, @@ -220,9 +220,7 @@ const Navigations = () => { * return ( * * * @@ -232,4 +230,39 @@ const Navigations = () => { * ``` * */ +/** + * @example How to implement custom local cache storage + * ``` + * import { MMKV } from 'react-native-mmkv'; + * import { LocalCacheStorage } from '@sendbird/uikit-react-native'; + * + * const mmkvStorage = new MMKV(); + * const localCacheStorage: LocalCacheStorage = { + * async getAllKeys() { + * return mmkvStorage.getAllKeys(); + * }, + * async setItem(key: string, value: string) { + * return mmkvStorage.set(key, value); + * }, + * async getItem(key: string) { + * return mmkvStorage.getString(key) ?? null; + * }, + * async removeItem(key: string) { + * return mmkvStorage.delete(key); + * }, + * }; + * + * const App = () => { + * return ( + * + * + * + * ); + * }; + * ``` + * */ + export default App;