Interface ConfirmExitModalOptions

Configuration options for the ConfirmExitModal component.

ConfirmExitModalOptions

Modal Control:

interface ConfirmExitModalOptions {
    isConfirmExitModalVisible: boolean;
    onConfirmExitClose: (() => void);
    position?:
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    exitEventOnConfirm?: ((options: ConfirmExitOptions) => void);
    member: string;
    ban?: boolean;
    roomName: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    islevel: string;
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isConfirmExitModalVisible onConfirmExitClose position? backgroundColor? exitEventOnConfirm? member ban? roomName socket islevel style? renderContent? renderContainer?

Properties

isConfirmExitModalVisible

isConfirmExitModalVisible: boolean

Controls modal visibility

onConfirmExitClose

onConfirmExitClose: (() => void)

Callback when modal is closed

Exit Action:

Optionalposition

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

Modal position on screen

OptionalbackgroundColor

backgroundColor?: string

Modal background color

OptionalexitEventOnConfirm

exitEventOnConfirm?: ((options: ConfirmExitOptions) => void)

Custom handler for confirming exit (defaults to confirmExit)

User Context:

member

member: string

Name of member exiting or being removed

Optionalban

ban?: boolean

Whether this is a ban action (removes from room permanently)

roomName

roomName: string

Room identifier for exit event

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io instance for exit notification

Customization:

islevel

islevel: string

User level ('0'=participant, '1'=co-host, '2'=host) - determines if "End Event for All" option is shown

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