Interface BreakoutRoomsModalOptions

interface BreakoutRoomsModalOptions {
    isVisible: boolean;
    onBreakoutRoomsClose: (() => void);
    parameters: BreakoutRoomsModalParameters;
    position?:
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    title?: ReactNode;
    overlayProps?: HTMLAttributes<HTMLDivElement>;
    contentProps?: HTMLAttributes<HTMLDivElement>;
    headerProps?: HTMLAttributes<HTMLDivElement>;
    titleProps?: HTMLAttributes<HTMLHeadingElement>;
    closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    closeIconComponent?: ReactNode;
    headerDividerProps?: HTMLAttributes<HTMLHRElement>;
    bodyProps?: HTMLAttributes<HTMLDivElement>;
    controlsWrapperProps?: HTMLAttributes<HTMLDivElement>;
    numRoomsFieldProps?: HTMLAttributes<HTMLDivElement>;
    numRoomsLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    numRoomsInputProps?: InputHTMLAttributes<HTMLInputElement>;
    actionsWrapperProps?: HTMLAttributes<HTMLDivElement>;
    randomAssignButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    manualAssignButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    addRoomButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    saveRoomsButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    newParticipantFieldProps?: HTMLAttributes<HTMLDivElement>;
    newParticipantLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    newParticipantSelectProps?: SelectHTMLAttributes<HTMLSelectElement>;
    roomsContainerProps?: HTMLAttributes<HTMLDivElement>;
    startButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    stopButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    numRoomsLabel?: ReactNode;
    newParticipantActionLabel?: ReactNode;
    randomAssignButtonLabel?: ReactNode;
    manualAssignButtonLabel?: ReactNode;
    addRoomButtonLabel?: ReactNode;
    saveRoomsButtonLabel?: ReactNode;
    startBreakoutButtonLabel?: ReactNode;
    updateBreakoutButtonLabel?: ReactNode;
    stopBreakoutButtonLabel?: ReactNode;
    renderHeader?: ((options: {
        defaultHeader: ReactNode;
    }) => ReactNode);
    renderControls?: ((options: {
        defaultControls: ReactNode;
    }) => ReactNode);
    renderRoomList?: ((options: {
        defaultRoomList: ReactNode;
        rooms: BreakoutParticipant[][];
    }) => ReactNode);
    renderStartButton?: ((options: {
        defaultStartButton: ReactNode;
        isUpdating: boolean;
    }) => ReactNode);
    renderStopButton?: ((options: {
        defaultStopButton: ReactNode;
    }) => ReactNode);
    renderBody?: ((options: {
        defaultBody: ReactNode;
    }) => ReactNode);
    renderContent?: ((options: {
        defaultContent: ReactNode;
    }) => ReactNode);
}

Properties

isVisible onBreakoutRoomsClose parameters position? backgroundColor? title? overlayProps? contentProps? headerProps? titleProps? closeButtonProps? closeIconComponent? headerDividerProps? bodyProps? controlsWrapperProps? numRoomsFieldProps? numRoomsLabelProps? numRoomsInputProps? actionsWrapperProps? randomAssignButtonProps? manualAssignButtonProps? addRoomButtonProps? saveRoomsButtonProps? newParticipantFieldProps? newParticipantLabelProps? newParticipantSelectProps? roomsContainerProps? startButtonProps? stopButtonProps? numRoomsLabel? newParticipantActionLabel? randomAssignButtonLabel? manualAssignButtonLabel? addRoomButtonLabel? saveRoomsButtonLabel? startBreakoutButtonLabel? updateBreakoutButtonLabel? stopBreakoutButtonLabel? renderHeader? renderControls? renderRoomList? renderStartButton? renderStopButton? renderBody? renderContent?

Properties

isVisible

isVisible: boolean

onBreakoutRoomsClose

onBreakoutRoomsClose: (() => void)

parameters

parameters: BreakoutRoomsModalParameters

Optionalposition

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

OptionalbackgroundColor

backgroundColor?: string

Optionaltitle

title?: ReactNode

OptionaloverlayProps

overlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontentProps

contentProps?: HTMLAttributes<HTMLDivElement>

OptionalheaderProps

headerProps?: HTMLAttributes<HTMLDivElement>

OptionaltitleProps

titleProps?: HTMLAttributes<HTMLHeadingElement>

OptionalcloseButtonProps

closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalcloseIconComponent

closeIconComponent?: ReactNode

OptionalheaderDividerProps

headerDividerProps?: HTMLAttributes<HTMLHRElement>

OptionalbodyProps

bodyProps?: HTMLAttributes<HTMLDivElement>

OptionalcontrolsWrapperProps

controlsWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalnumRoomsFieldProps

numRoomsFieldProps?: HTMLAttributes<HTMLDivElement>

OptionalnumRoomsLabelProps

numRoomsLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionalnumRoomsInputProps

numRoomsInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionalactionsWrapperProps

actionsWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalrandomAssignButtonProps

randomAssignButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalmanualAssignButtonProps

manualAssignButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionaladdRoomButtonProps

addRoomButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalsaveRoomsButtonProps

saveRoomsButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalnewParticipantFieldProps

newParticipantFieldProps?: HTMLAttributes<HTMLDivElement>

OptionalnewParticipantLabelProps

newParticipantLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionalnewParticipantSelectProps

newParticipantSelectProps?: SelectHTMLAttributes<HTMLSelectElement>

OptionalroomsContainerProps

roomsContainerProps?: HTMLAttributes<HTMLDivElement>

OptionalstartButtonProps

startButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalstopButtonProps

stopButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalnumRoomsLabel

numRoomsLabel?: ReactNode

OptionalnewParticipantActionLabel

newParticipantActionLabel?: ReactNode

OptionalrandomAssignButtonLabel

randomAssignButtonLabel?: ReactNode

OptionalmanualAssignButtonLabel

manualAssignButtonLabel?: ReactNode

OptionaladdRoomButtonLabel

addRoomButtonLabel?: ReactNode

OptionalsaveRoomsButtonLabel

saveRoomsButtonLabel?: ReactNode

OptionalstartBreakoutButtonLabel

startBreakoutButtonLabel?: ReactNode

OptionalupdateBreakoutButtonLabel

updateBreakoutButtonLabel?: ReactNode

OptionalstopBreakoutButtonLabel

stopBreakoutButtonLabel?: ReactNode

OptionalrenderHeader

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

OptionalrenderControls

renderControls?: ((options: {
    defaultControls: ReactNode;
}) => ReactNode)

OptionalrenderRoomList

renderRoomList?: ((options: {
    defaultRoomList: ReactNode;
    rooms: BreakoutParticipant[][];
}) => ReactNode)

OptionalrenderStartButton

renderStartButton?: ((options: {
    defaultStartButton: ReactNode;
    isUpdating: boolean;
}) => ReactNode)

OptionalrenderStopButton

renderStopButton?: ((options: {
    defaultStopButton: ReactNode;
}) => ReactNode)

OptionalrenderBody

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

OptionalrenderContent

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

Settings

Member Visibility

On This Page

Properties