Interface CoHostModalOptions

Configuration options for the CoHostModal component.

CoHostModalOptions

Modal Control:

interface CoHostModalOptions {
    isCoHostModalVisible: boolean;
    currentCohost?: string;
    participants: Participant[];
    coHostResponsibility: CoHostResponsibility[];
    position?: string;
    backgroundColor?: string;
    roomName: string;
    showAlert?: ShowAlert;
    updateCoHostResponsibility: ((coHostResponsibility: CoHostResponsibility[]) => void);
    updateCoHost: ((coHost: string) => void);
    updateIsCoHostModalVisible: ((isCoHostModalVisible: boolean) => void);
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    onCoHostClose: (() => void);
    onModifyEventSettings?: ((settings: ModifyCoHostSettingsOptions) => void);
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isCoHostModalVisible currentCohost? participants coHostResponsibility position? backgroundColor? roomName showAlert? updateCoHostResponsibility updateCoHost updateIsCoHostModalVisible socket onCoHostClose onModifyEventSettings? style? renderContent? renderContainer?

Properties

isCoHostModalVisible

isCoHostModalVisible: boolean

Controls modal visibility

OptionalcurrentCohost

currentCohost?: string

Name of currently assigned co-host

participants

participants: Participant[]

List of event participants eligible for co-host assignment

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of co-host responsibility items with enable/disable status

Optionalposition

position?: string

Modal position on screen

OptionalbackgroundColor

backgroundColor?: string

Modal background color

roomName

roomName: string

Room identifier for event

OptionalshowAlert

showAlert?: ShowAlert

Alert display function for user feedback

Customization:

updateCoHostResponsibility

updateCoHostResponsibility: ((coHostResponsibility: CoHostResponsibility[]) => void)

Updates co-host responsibility settings

updateCoHost

updateCoHost: ((coHost: string) => void)

Sets new co-host by name

updateIsCoHostModalVisible

updateIsCoHostModalVisible: ((isCoHostModalVisible: boolean) => void)

Toggles modal visibility state

Settings Handler:

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io instance for real-time co-host updates

onCoHostClose

onCoHostClose: (() => void)

Callback when modal is closed

Co-Host Management:

OptionalonModifyEventSettings

onModifyEventSettings?: ((settings: ModifyCoHostSettingsOptions) => void)

Custom handler for applying co-host settings (defaults to modifyCoHostSettings)

Session Context:

Optionalstyle

style?: object

Additional custom styles for modal container

Advanced Render Overrides:

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: Element;
    dimensions: {
        width: number;
        height: number;
    };
}) => Element)

Custom render function for modal content

OptionalrenderContainer

renderContainer?: ((options: {
    defaultContainer: Element;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Custom render function for modal container

Settings

Member Visibility

On This Page

Properties