Interface WaitingRoomModalOptions

interface WaitingRoomModalOptions {
    isWaitingModalVisible: boolean;
    onWaitingRoomClose: (() => void);
    waitingRoomCounter: number;
    onWaitingRoomFilterChange: ((filter: string) => void);
    waitingRoomList: WaitingRoomParticipant[];
    updateWaitingList: ((updatedList: WaitingRoomParticipant[]) => void);
    roomName: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    position?:
        | "center"
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    parameters: WaitingRoomModalParameters;
    onWaitingRoomItemPress?: RespondToWaitingType;
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isWaitingModalVisible onWaitingRoomClose waitingRoomCounter onWaitingRoomFilterChange waitingRoomList updateWaitingList roomName socket position? backgroundColor? parameters onWaitingRoomItemPress? style? renderContent? renderContainer?

Properties

isWaitingModalVisible

isWaitingModalVisible: boolean

Flag to control the visibility of the modal.

onWaitingRoomClose

onWaitingRoomClose: (() => void)

Callback function to handle the closing of the modal.

waitingRoomCounter

waitingRoomCounter: number

Initial count of participants in the waiting room.

onWaitingRoomFilterChange

onWaitingRoomFilterChange: ((filter: string) => void)

Function to handle changes in the search input.

waitingRoomList

waitingRoomList: WaitingRoomParticipant[]

List of participants in the waiting room.

updateWaitingList

updateWaitingList: ((updatedList: WaitingRoomParticipant[]) => void)

Function to update the waiting room list.

roomName

roomName: string

Name of the room.

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket instance for real-time communication.

Optionalposition

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

Position of the modal on the screen. Possible values: 'topLeft', 'topRight', 'bottomLeft', 'bottomRight', 'center'. Defaults to 'topRight'.

OptionalbackgroundColor

backgroundColor?: string

Background color of the modal. Defaults to '#83c0e9'.

parameters

parameters: WaitingRoomModalParameters

Additional parameters for the modal.

OptionalonWaitingRoomItemPress

onWaitingRoomItemPress?: RespondToWaitingType

Function to handle participant item press. Defaults to respondToWaiting.

Optionalstyle

style?: object

Optional custom style for the modal container.

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 the modal container.

Settings

Member Visibility

On This Page

Properties