Interface ConfirmHereModalOptions

Configuration options for the ConfirmHereModal component.

ConfirmHereModalOptions

Modal Control:

interface ConfirmHereModalOptions {
    isConfirmHereModalVisible: boolean;
    onConfirmHereClose: (() => void);
    backgroundColor?: string;
    countdownDuration?: number;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    member: string;
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isConfirmHereModalVisible onConfirmHereClose backgroundColor? countdownDuration? socket localSocket? roomName member style? renderContent? renderContainer?

Properties

isConfirmHereModalVisible

isConfirmHereModalVisible: boolean

Controls modal visibility

onConfirmHereClose

onConfirmHereClose: (() => void)

Callback when modal is closed (after confirmation or timeout)

Countdown Configuration:

OptionalbackgroundColor

backgroundColor?: string

Modal background color

OptionalcountdownDuration

countdownDuration?: number

Duration in seconds for user to confirm presence before auto-disconnect

Session Context:

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Primary Socket.io instance for disconnect event emission

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

Optional local Socket.io instance for additional disconnect notification

roomName

roomName: string

Room identifier for disconnect event

member

member: string

Member name/ID to disconnect if no confirmation received

Customization:

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