@sendbird/uikit-react/types/modules/App/types.d.ts

Sendbird UIKit for React: A feature-rich and customizable chat UI kit with messaging, channel management, and user authentication.

/// <reference types="react" />
import type { User } from '@sendbird/chat';
import { GroupChannel } from '@sendbird/chat/groupChannel';
import type { Locale } from 'date-fns';
import { ReplyType, UserListQuery, RenderUserProfileProps, SendBirdProviderConfig, HTMLTextDirection } from '../../types';
import { CustomExtensionParams, SBUEventHandlers, SendbirdChatInitParams } from '../../lib/Sendbird/types';
import { SendableMessageType } from '../../utils';
export interface AppLayoutProps {
    isReactionEnabled?: boolean;
    replyType?: 'NONE' | 'QUOTE_REPLY' | 'THREAD';
    htmlTextDirection?: HTMLTextDirection;
    forceLeftToRightMessageLayout?: boolean;
    isMessageGroupingEnabled?: boolean;
    isMultipleFilesMessageEnabled?: boolean;
    allowProfileEdit?: boolean;
    showSearchIcon?: boolean;
    onProfileEditSuccess?(user: User): void;
    disableAutoSelect?: boolean;
    currentChannel?: GroupChannel;
    setCurrentChannel: React.Dispatch<GroupChannel | undefined>;
    enableLegacyChannelModules: boolean;
}
interface SubLayoutCommonProps {
    highlightedMessage?: number | null;
    setHighlightedMessage?: React.Dispatch<number | null>;
    startingPoint?: number | null;
    setStartingPoint: React.Dispatch<number | null>;
    threadTargetMessage: SendableMessageType | null;
    setThreadTargetMessage: React.Dispatch<SendableMessageType>;
}
export interface MobileLayoutProps extends AppLayoutProps, SubLayoutCommonProps {
}
export interface DesktopLayoutProps extends AppLayoutProps, SubLayoutCommonProps {
    showSettings: boolean;
    setShowSettings: React.Dispatch<boolean>;
    showSearch: boolean;
    setShowSearch: React.Dispatch<boolean>;
    showThread: boolean;
    setShowThread: React.Dispatch<boolean>;
}
export default interface AppProps {
    appId: string;
    userId: string;
    accessToken?: string;
    customApiHost?: string;
    customWebSocketHost?: string;
    theme?: 'light' | 'dark';
    userListQuery?(): UserListQuery;
    nickname?: string;
    profileUrl?: string;
    dateLocale?: Locale;
    allowProfileEdit?: boolean;
    disableUserProfile?: boolean;
    showSearchIcon?: boolean;
    renderUserProfile?: (props: RenderUserProfileProps) => React.ReactElement;
    onProfileEditSuccess?(user: User): void;
    config?: SendBirdProviderConfig;
    isReactionEnabled?: boolean;
    isMessageGroupingEnabled?: boolean;
    stringSet?: Record<string, string>;
    colorSet?: Record<string, string>;
    imageCompression?: {
        compressionRate?: number;
        resizingWidth?: number | string;
        resizingHeight?: number | string;
    };
    replyType?: ReplyType;
    disableAutoSelect?: boolean;
    isTypingIndicatorEnabledOnChannelList?: boolean;
    isMessageReceiptStatusEnabledOnChannelList?: boolean;
    sdkInitParams?: SendbirdChatInitParams;
    customExtensionParams?: CustomExtensionParams;
    eventHandlers?: SBUEventHandlers;
}
export {};