Interface EventSettingsModalOptions

interface EventSettingsModalOptions {
    isEventSettingsModalVisible: boolean;
    onEventSettingsClose: (() => void);
    onModifyEventSettings?: ((options: ModifySettingsOptions) => Promise<void>);
    position?:
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    audioSetting: string;
    videoSetting: string;
    screenshareSetting: string;
    chatSetting: string;
    updateAudioSetting: ((setting: string) => void);
    updateVideoSetting: ((setting: string) => void);
    updateScreenshareSetting: ((setting: string) => void);
    updateChatSetting: ((setting: string) => void);
    updateIsSettingsModalVisible: ((isVisible: boolean) => void);
    roomName: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    showAlert?: ShowAlert;
    title?: ReactNode;
    overlayProps?: HTMLAttributes<HTMLDivElement>;
    contentProps?: HTMLAttributes<HTMLDivElement>;
    headerProps?: HTMLAttributes<HTMLDivElement>;
    titleProps?: HTMLAttributes<HTMLDivElement>;
    closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    closeIconComponent?: ReactNode;
    headerDividerProps?: HTMLAttributes<HTMLHRElement>;
    bodyProps?: HTMLAttributes<HTMLDivElement>;
    settingFieldProps?: HTMLAttributes<HTMLDivElement>;
    audioFieldProps?: HTMLAttributes<HTMLDivElement>;
    videoFieldProps?: HTMLAttributes<HTMLDivElement>;
    screenshareFieldProps?: HTMLAttributes<HTMLDivElement>;
    chatFieldProps?: HTMLAttributes<HTMLDivElement>;
    settingLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    audioLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    videoLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    screenshareLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    chatLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    settingSelectProps?: SelectHTMLAttributes<HTMLSelectElement>;
    audioSelectProps?: SelectHTMLAttributes<HTMLSelectElement>;
    videoSelectProps?: SelectHTMLAttributes<HTMLSelectElement>;
    screenshareSelectProps?: SelectHTMLAttributes<HTMLSelectElement>;
    chatSelectProps?: SelectHTMLAttributes<HTMLSelectElement>;
    separatorProps?: HTMLAttributes<HTMLDivElement>;
    footerProps?: HTMLAttributes<HTMLDivElement>;
    saveButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    saveButtonLabel?: ReactNode;
    audioLabel?: ReactNode;
    videoLabel?: ReactNode;
    screenshareLabel?: ReactNode;
    chatLabel?: ReactNode;
    disallowOptionLabel?: ReactNode;
    allowOptionLabel?: ReactNode;
    approvalOptionLabel?: ReactNode;
    chatDisallowOptionLabel?: ReactNode;
    chatAllowOptionLabel?: ReactNode;
    audioOptions?: EventSettingOption[];
    videoOptions?: EventSettingOption[];
    screenshareOptions?: EventSettingOption[];
    chatOptions?: EventSettingOption[];
    renderHeader?: ((params: {
        defaultHeader: ReactNode;
    }) => ReactNode);
    renderBody?: ((params: {
        defaultBody: ReactNode;
    }) => ReactNode);
    renderSettings?: ((params: {
        defaultSettings: ReactNode;
        sections: EventSettingSectionRenderInfo[];
    }) => ReactNode);
    renderSettingSection?: ((params: RenderSettingSectionParams) => ReactNode);
    renderSeparator?: ((params: {
        defaultSeparator: ReactNode;
        index: number;
    }) => ReactNode);
    renderFooter?: ((params: {
        defaultFooter: ReactNode;
    }) => ReactNode);
    renderContent?: ((params: {
        defaultContent: ReactNode;
    }) => ReactNode);
}

Properties

isEventSettingsModalVisible onEventSettingsClose onModifyEventSettings? position? backgroundColor? audioSetting videoSetting screenshareSetting chatSetting updateAudioSetting updateVideoSetting updateScreenshareSetting updateChatSetting updateIsSettingsModalVisible roomName socket showAlert? title? overlayProps? contentProps? headerProps? titleProps? closeButtonProps? closeIconComponent? headerDividerProps? bodyProps? settingFieldProps? audioFieldProps? videoFieldProps? screenshareFieldProps? chatFieldProps? settingLabelProps? audioLabelProps? videoLabelProps? screenshareLabelProps? chatLabelProps? settingSelectProps? audioSelectProps? videoSelectProps? screenshareSelectProps? chatSelectProps? separatorProps? footerProps? saveButtonProps? saveButtonLabel? audioLabel? videoLabel? screenshareLabel? chatLabel? disallowOptionLabel? allowOptionLabel? approvalOptionLabel? chatDisallowOptionLabel? chatAllowOptionLabel? audioOptions? videoOptions? screenshareOptions? chatOptions? renderHeader? renderBody? renderSettings? renderSettingSection? renderSeparator? renderFooter? renderContent?

Properties

isEventSettingsModalVisible

isEventSettingsModalVisible: boolean

onEventSettingsClose

onEventSettingsClose: (() => void)

OptionalonModifyEventSettings

onModifyEventSettings?: ((options: ModifySettingsOptions) => Promise<void>)

Optionalposition

position?:
    | "topLeft"
    | "topRight"
    | "bottomLeft"
    | "bottomRight"

OptionalbackgroundColor

backgroundColor?: string

audioSetting

audioSetting: string

videoSetting

videoSetting: string

screenshareSetting

screenshareSetting: string

chatSetting

chatSetting: string

updateAudioSetting

updateAudioSetting: ((setting: string) => void)

updateVideoSetting

updateVideoSetting: ((setting: string) => void)

updateScreenshareSetting

updateScreenshareSetting: ((setting: string) => void)

updateChatSetting

updateChatSetting: ((setting: string) => void)

updateIsSettingsModalVisible

updateIsSettingsModalVisible: ((isVisible: boolean) => void)

roomName

roomName: string

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

OptionalshowAlert

showAlert?: ShowAlert

Optionaltitle

title?: ReactNode

OptionaloverlayProps

overlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontentProps

contentProps?: HTMLAttributes<HTMLDivElement>

OptionalheaderProps

headerProps?: HTMLAttributes<HTMLDivElement>

OptionaltitleProps

titleProps?: HTMLAttributes<HTMLDivElement>

OptionalcloseButtonProps

closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalcloseIconComponent

closeIconComponent?: ReactNode

OptionalheaderDividerProps

headerDividerProps?: HTMLAttributes<HTMLHRElement>

OptionalbodyProps

bodyProps?: HTMLAttributes<HTMLDivElement>

OptionalsettingFieldProps

settingFieldProps?: HTMLAttributes<HTMLDivElement>

OptionalaudioFieldProps

audioFieldProps?: HTMLAttributes<HTMLDivElement>

OptionalvideoFieldProps

videoFieldProps?: HTMLAttributes<HTMLDivElement>

OptionalscreenshareFieldProps

screenshareFieldProps?: HTMLAttributes<HTMLDivElement>

OptionalchatFieldProps

chatFieldProps?: HTMLAttributes<HTMLDivElement>

OptionalsettingLabelProps

settingLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionalaudioLabelProps

audioLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionalvideoLabelProps

videoLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionalscreenshareLabelProps

screenshareLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionalchatLabelProps

chatLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionalsettingSelectProps

settingSelectProps?: SelectHTMLAttributes<HTMLSelectElement>

OptionalaudioSelectProps

audioSelectProps?: SelectHTMLAttributes<HTMLSelectElement>

OptionalvideoSelectProps

videoSelectProps?: SelectHTMLAttributes<HTMLSelectElement>

OptionalscreenshareSelectProps

screenshareSelectProps?: SelectHTMLAttributes<HTMLSelectElement>

OptionalchatSelectProps

chatSelectProps?: SelectHTMLAttributes<HTMLSelectElement>

OptionalseparatorProps

separatorProps?: HTMLAttributes<HTMLDivElement>

OptionalfooterProps

footerProps?: HTMLAttributes<HTMLDivElement>

OptionalsaveButtonProps

saveButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalsaveButtonLabel

saveButtonLabel?: ReactNode

OptionalaudioLabel

audioLabel?: ReactNode

OptionalvideoLabel

videoLabel?: ReactNode

OptionalscreenshareLabel

screenshareLabel?: ReactNode

OptionalchatLabel

chatLabel?: ReactNode

OptionaldisallowOptionLabel

disallowOptionLabel?: ReactNode

OptionalallowOptionLabel

allowOptionLabel?: ReactNode

OptionalapprovalOptionLabel

approvalOptionLabel?: ReactNode

OptionalchatDisallowOptionLabel

chatDisallowOptionLabel?: ReactNode

OptionalchatAllowOptionLabel

chatAllowOptionLabel?: ReactNode

OptionalaudioOptions

audioOptions?: EventSettingOption[]

OptionalvideoOptions

videoOptions?: EventSettingOption[]

OptionalscreenshareOptions

screenshareOptions?: EventSettingOption[]

OptionalchatOptions

chatOptions?: EventSettingOption[]

OptionalrenderHeader

renderHeader?: ((params: {
    defaultHeader: ReactNode;
}) => ReactNode)

OptionalrenderBody

renderBody?: ((params: {
    defaultBody: ReactNode;
}) => ReactNode)

OptionalrenderSettings

renderSettings?: ((params: {
    defaultSettings: ReactNode;
    sections: EventSettingSectionRenderInfo[];
}) => ReactNode)

OptionalrenderSettingSection

renderSettingSection?: ((params: RenderSettingSectionParams) => ReactNode)

OptionalrenderSeparator

renderSeparator?: ((params: {
    defaultSeparator: ReactNode;
    index: number;
}) => ReactNode)

OptionalrenderFooter

renderFooter?: ((params: {
    defaultFooter: ReactNode;
}) => ReactNode)

OptionalrenderContent

renderContent?: ((params: {
    defaultContent: ReactNode;
}) => ReactNode)

Settings

Member Visibility

On This Page

Properties
isEventSettingsModalVisibleonEventSettingsCloseonModifyEventSettingspositionbackgroundColoraudioSettingvideoSettingscreenshareSettingchatSettingupdateAudioSettingupdateVideoSettingupdateScreenshareSettingupdateChatSettingupdateIsSettingsModalVisibleroomNamesocketshowAlerttitleoverlayPropscontentPropsheaderPropstitlePropscloseButtonPropscloseIconComponentheaderDividerPropsbodyPropssettingFieldPropsaudioFieldPropsvideoFieldPropsscreenshareFieldPropschatFieldPropssettingLabelPropsaudioLabelPropsvideoLabelPropsscreenshareLabelPropschatLabelPropssettingSelectPropsaudioSelectPropsvideoSelectPropsscreenshareSelectPropschatSelectPropsseparatorPropsfooterPropssaveButtonPropssaveButtonLabelaudioLabelvideoLabelscreenshareLabelchatLabeldisallowOptionLabelallowOptionLabelapprovalOptionLabelchatDisallowOptionLabelchatAllowOptionLabelaudioOptionsvideoOptionsscreenshareOptionschatOptionsrenderHeaderrenderBodyrenderSettingsrenderSettingSectionrenderSeparatorrenderFooterrenderContent