Skip to content

Commit

Permalink
docs: update uikit url path
Browse files Browse the repository at this point in the history
  • Loading branch information
bang9 committed Oct 20, 2023
1 parent 97c4f9e commit a9a3d96
Show file tree
Hide file tree
Showing 38 changed files with 152 additions and 119 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<br/>
Expand Down
12 changes: 6 additions & 6 deletions docs-validation/1_introduction/Authentication.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand All @@ -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();
Expand All @@ -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';

Expand All @@ -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';
Expand All @@ -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 (
Expand All @@ -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();
Expand Down
4 changes: 2 additions & 2 deletions docs-validation/1_introduction/NativeModules.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down
4 changes: 2 additions & 2 deletions docs-validation/1_introduction/ScreenNavigation.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const GroupChannelScreen = () => <React.Fragment />;

/**
* 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';
Expand Down Expand Up @@ -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);
Expand Down
10 changes: 5 additions & 5 deletions docs-validation/1_introduction/SendYourFirstMessage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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';
Expand All @@ -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';
Expand Down Expand Up @@ -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';
Expand Down Expand Up @@ -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';
Expand Down
4 changes: 2 additions & 2 deletions docs-validation/2_features/DeliveryReceipt.tsx
Original file line number Diff line number Diff line change
@@ -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';

Expand All @@ -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';

Expand Down
10 changes: 5 additions & 5 deletions docs-validation/2_features/FileSharing.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand All @@ -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;
Expand All @@ -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');
Expand All @@ -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;
Expand All @@ -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';

Expand Down
4 changes: 2 additions & 2 deletions docs-validation/2_features/ReadReceipt.tsx
Original file line number Diff line number Diff line change
@@ -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 = () => {
Expand All @@ -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';

Expand Down
4 changes: 2 additions & 2 deletions docs-validation/2_features/TypingIndicator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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 = () => {
Expand All @@ -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'];
/** ------------------ **/
20 changes: 10 additions & 10 deletions docs-validation/3_core-components/Hooks.tsx
Original file line number Diff line number Diff line change
@@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand All @@ -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';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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';

Expand All @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down
2 changes: 1 addition & 1 deletion docs-validation/4_key-functions/Architecture/Context.tsx
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
2 changes: 1 addition & 1 deletion docs-validation/4_key-functions/Architecture/Fragment.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
Loading

0 comments on commit a9a3d96

Please sign in to comment.