Type alias SendbirdUIKitContainerProps

Type declaration

• appId: string

• chatOptions: {
      localCacheStorage: LocalCacheStorage;
      onInitialized?: ((sdkInstance) => SendbirdChatSDK);
  } & Partial<ChatOmittedInitParams> & Partial<ChatRelatedFeaturesInUIKit>

• Optional errorBoundary?: {
      ErrorInfoComponent?: ((props) => React.ReactNode);
      disabled?: boolean;
      onError?: ((props) => void);
  }

  • Optional ErrorInfoComponent?: ((props) => React.ReactNode)

    • • (props): React.ReactNode

      • Parameters

        • props: ErrorBoundaryProps

        Returns React.ReactNode

  • Optional disabled?: boolean

  • Optional onError?: ((props) => void)

    • • (props): void

      • Parameters

        • props: ErrorBoundaryProps

        Returns void

• Optional imageCompression?: Partial<ImageCompressionConfigInterface>

• Optional localization?: {
      stringSet?: StringSet;
  }

  • Optional stringSet?: StringSet

• platformServices: {
      clipboard: ClipboardServiceInterface;
      file: FileServiceInterface;
      media: MediaServiceInterface;
      notification: NotificationServiceInterface;
      player: PlayerServiceInterface;
      recorder: RecorderServiceInterface;
  }

  • clipboard: ClipboardServiceInterface

  • file: FileServiceInterface

  • media: MediaServiceInterface

  • notification: NotificationServiceInterface

  • player: PlayerServiceInterface

  • recorder: RecorderServiceInterface

• Optional reaction?: {
      onPressUserProfile?: ((user) => void);
  }

  • Optional onPressUserProfile?: ((user) => void)

    • • (user): void

      • Parameters

        • user: SendbirdUser | SendbirdMember

        Returns void

• Optional styles?: {
      HeaderComponent?: HeaderStyleContextType["HeaderComponent"];
      defaultHeaderHeight?: number;
      defaultHeaderTitleAlign?: "left" | "center";
      statusBarTranslucent?: boolean;
      theme?: UIKitTheme;
  }

  • Optional HeaderComponent?: HeaderStyleContextType["HeaderComponent"]

  • Optional defaultHeaderHeight?: number

  • Optional defaultHeaderTitleAlign?: "left" | "center"

  • Optional statusBarTranslucent?: boolean

  • Optional theme?: UIKitTheme

• Optional toast?: {
      dismissTimeout?: number;
  }

  • Optional dismissTimeout?: number

• Optional uikitOptions?: PartialDeep<{
      common: SBUConfig["common"];
      groupChannel: Omit<SBUConfig["groupChannel"]["channel"], UnimplementedFeatures> & {
          replyType: Extract<SBUConfig["groupChannel"]["channel"]["replyType"], "none" | "quote_reply">;
      };
      groupChannelList: SBUConfig["groupChannel"]["channelList"];
      groupChannelSettings: SBUConfig["groupChannel"]["setting"];
      openChannel: SBUConfig["openChannel"]["channel"];
  }>

• Optional userMention?: Pick<Partial<MentionConfigInterface>, "mentionLimit" | "suggestionLimit" | "debounceMills">

• Optional userProfile?: {
      onBeforeCreateChannel?: ((channelParams, users) => SendbirdGroupChannelCreateParams | Promise<SendbirdGroupChannelCreateParams>);
      onCreateChannel: ((channel) => void);
  }

  • Optional onBeforeCreateChannel?: ((channelParams, users) => SendbirdGroupChannelCreateParams | Promise<SendbirdGroupChannelCreateParams>)

    • • (channelParams, users): SendbirdGroupChannelCreateParams | Promise<SendbirdGroupChannelCreateParams>

      • Parameters

        • channelParams: SendbirdGroupChannelCreateParams

        • users: SendbirdUser[] | SendbirdMember[]

        Returns SendbirdGroupChannelCreateParams | Promise<SendbirdGroupChannelCreateParams>

  • onCreateChannel: ((channel) => void)

    • • (channel): void

      • Parameters

        • channel: SendbirdGroupChannel

        Returns void

• Optional voiceMessage?: PartialDeep<VoiceMessageConfigInterface>