communication-react-19/dist/dist-esm/react-components/src/localization/LocalizationProvider.d.ts

React library for building modern communication user experiences utilizing Azure Communication Services (React 19 compatible fork)

import React from 'react';
import { CameraButtonStrings, EndCallButtonStrings, ErrorBarStrings, MessageStatusIndicatorStrings, MessageThreadStrings, MicrophoneButtonStrings, DevicesButtonStrings, ParticipantsButtonStrings, ParticipantItemStrings, ScreenShareButtonStrings, SendBoxStrings, TypingIndicatorStrings, VideoGalleryStrings, CaptionsSettingsModalStrings, CaptionsBannerStrings, StartCaptionsButtonStrings } from '../components';
import { NotificationStackStrings } from '../components';
import { RaiseHandButtonStrings } from '../components';
import { HoldButtonStrings } from '../components';
import { DialpadStrings } from '../components';
import { SitePermissionsStrings } from '../components/DevicePermissions/SitePermissionsScaffolding';
import { BrowserPermissionDeniedStrings } from '../components/DevicePermissions/BrowserPermissionDenied';
import { BrowserPermissionDeniedIOSStrings } from '../components/DevicePermissions/BrowserPermissionDeniedIOS';
import { UnsupportedBrowserStrings } from '../components/UnsupportedBrowser';
import { VideoTileStrings } from '../components/VideoTile';
import { UnsupportedBrowserVersionStrings } from '../components/UnsupportedBrowserVersion';
import { UnsupportedOperatingSystemStrings } from '../components/UnsupportedOperatingSystem';
import { VerticalGalleryStrings } from '../components/VerticalGallery';
import { ParticipantListStrings } from '../components/ParticipantList';
import { MentionPopoverStrings } from '../components/MentionPopover';
import { ImageOverlayStrings } from '../components/ImageOverlay';
import { ReactionButtonStrings } from '../components';
import { RichTextSendBoxStrings } from '../components/RichTextEditor/RichTextSendBox';
import { MeetingConferencePhoneInfoModalStrings } from '../components/MeetingConferencePhoneInfo';
import { IncomingCallNotificationStrings } from '../components/IncomingCallNotification';
import { RealTimeTextModalStrings } from '../components/RealTimeTextModal';
import { RealTimeTextStrings } from '../components/RealTimeText';
import { CaptionLanguageStrings, SpokenLanguageStrings } from '../types';
import { StartRealTimeTextButtonStrings } from '../components/StartRealTimeTextButton';
/**
 * Locale information for all components exported from this library.
 *
 * @public
 */
export interface ComponentLocale {
    /** Strings for components */
    strings: ComponentStrings;
    /**
     * Optional function to provide customized date format.
     * @beta
     */
    onDisplayDateTimeString?: (messageDate: Date) => string;
}
/**
 * Strings used by all components exported from this library.
 *
 * @public
 */
export interface ComponentStrings {
    /** Strings for MessageThread */
    messageThread: MessageThreadStrings;
    /** Strings for ParticipantItem */
    participantItem: ParticipantItemStrings;
    /** Strings for CameraButton */
    cameraButton: CameraButtonStrings;
    /** Strings for MicrophoneButton */
    microphoneButton: MicrophoneButtonStrings;
    /** Strings for EndCallButton */
    endCallButton: EndCallButtonStrings;
    /** Strings for DevicesButton */
    devicesButton: DevicesButtonStrings;
    /** Strings for ParticipantsButton */
    participantsButton: ParticipantsButtonStrings;
    /** Strings for ScreenShareButton */
    screenShareButton: ScreenShareButtonStrings;
    /** Strings for RaiseHandButton */
    raiseHandButton: RaiseHandButtonStrings;
    /**
     * Strings for ReactionButton
     * */
    reactionButton: ReactionButtonStrings;
    /** Strings for TypingIndicator */
    typingIndicator: TypingIndicatorStrings;
    /** Strings for SendBox */
    sendBox: SendBoxStrings;
    /** Strings for RichTextSendBox */
    richTextSendBox: RichTextSendBoxStrings;
    /** Strings for MentionPopover */
    mentionPopover: MentionPopoverStrings;
    /** Strings for ImageOverlay */
    imageOverlay: ImageOverlayStrings;
    /** Strings for MessageStatusIndicator */
    messageStatusIndicator: MessageStatusIndicatorStrings;
    /** Strings for ErrorBar */
    errorBar: ErrorBarStrings;
    /** Strings for NotificationStack */
    notificationStack: NotificationStackStrings;
    /** Strings for VideoGallery */
    videoGallery: VideoGalleryStrings;
    /** Strings for Dialpad */
    dialpad: DialpadStrings;
    /** Strings for VideoTile */
    videoTile: VideoTileStrings;
    /** Strings for HoldButton */
    holdButton: HoldButtonStrings;
    /** Strings for a site's permission request prompt */
    CameraAndMicrophoneSitePermissionsRequest: SitePermissionsStrings;
    /** Strings for a site's permission request prompt */
    CameraSitePermissionsRequest: SitePermissionsStrings;
    /** Strings for a site's permission request prompt */
    MicrophoneSitePermissionsRequest: SitePermissionsStrings;
    /** Strings for a site's permission generic checking prompt */
    CameraAndMicrophoneSitePermissionsCheck: SitePermissionsStrings;
    /** Strings for a site's permission generic checking prompt */
    CameraSitePermissionsCheck: SitePermissionsStrings;
    /** Strings for a site's permission generic checking prompt */
    MicrophoneSitePermissionsCheck: SitePermissionsStrings;
    /** Strings for a site's permission denied prompt */
    CameraAndMicrophoneSitePermissionsDenied: SitePermissionsStrings;
    /** Strings for a site's permission denied prompt for safari browsers*/
    CameraAndMicrophoneSitePermissionsDeniedSafari: SitePermissionsStrings;
    /** Strings for a site's permission denied prompt */
    CameraSitePermissionsDenied: SitePermissionsStrings;
    /** Strings for a site's permission denied prompt */
    MicrophoneSitePermissionsDenied: SitePermissionsStrings;
    /** Strings for a site's permission denied prompt for safari browsers*/
    CameraSitePermissionsDeniedSafari: SitePermissionsStrings;
    /** Strings for a site's permission denied prompt for safari browsers*/
    MicrophoneSitePermissionsDeniedSafari: SitePermissionsStrings;
    /** Strings for unsupported browser UI */
    UnsupportedBrowser: UnsupportedBrowserStrings;
    /** Strings for unsupported browser version UI */
    UnsupportedBrowserVersion: UnsupportedBrowserVersionStrings;
    /** Strings for unsupported browser version UI */
    UnsupportedOperatingSystem: UnsupportedOperatingSystemStrings;
    /** Strings for BrowserPemissionDenied */
    BrowserPermissionDenied: BrowserPermissionDeniedStrings;
    /** Strings for BrowserPemissionDeniedIOS */
    BrowserPermissionDeniedIOS: BrowserPermissionDeniedIOSStrings;
    /**
     * Strings for the VerticalGallery.
     */
    verticalGallery: VerticalGalleryStrings;
    /** Strings for the participant list component */
    ParticipantList: ParticipantListStrings;
    /** Strings for the MeetingConferencePhoneInfoModal */
    meetingConferencePhoneInfo: MeetingConferencePhoneInfoModalStrings;
    IncomingCallNotification: IncomingCallNotificationStrings;
    /** Strings for the RealTimeTextModal */
    realTimeTextModal: RealTimeTextModalStrings;
    /** Strings for RealTimeText */
    realTimeText: RealTimeTextStrings;
    /** Strings for Captions Setting Modal */
    captionsSettingsModal: CaptionsSettingsModalStrings;
    /**
     * 1 to 1 mapping between language code and language string for spoken languages
     */
    spokenLanguages: SpokenLanguageStrings;
    /**
     * 1 to 1 mapping between language code and language string for caption languages
     */
    captionLanguages: CaptionLanguageStrings;
    /** Strings for CaptionsBanner */
    captionsBanner: CaptionsBannerStrings;
    /** Strings for Start Captions Button */
    startCaptionsButton: StartCaptionsButtonStrings;
    /** Strings for Start RealTimeText Button */
    startRealTimeTextButton: StartRealTimeTextButtonStrings;
}
/**
 * Context for providing localized strings to components exported from this library.
 *
 * @public
 */
export declare const LocaleContext: React.Context<ComponentLocale>;
/**
 * Props for {@link LocalizationProvider}.
 *
 * @public
 */
export type LocalizationProviderProps = {
    /** Locale context to provide components */
    locale: ComponentLocale;
    /** Children to provide locale context. */
    children: React.ReactNode;
};
/**
 * Provider to provide localized strings for this library's react components.
 *
 * @remarks Components will be provided localized strings in English (US) by default if this
 * provider is not used.
 *
 * @public
 */
export declare const LocalizationProvider: (props: LocalizationProviderProps) => JSX.Element;
/** React hook to access locale */
export declare const useLocale: () => ComponentLocale;
//# sourceMappingURL=LocalizationProvider.d.ts.map