Interface RequestsModalOptions

Configuration options for the RequestsModal component.

RequestsModalOptions

Modal Control:

interface RequestsModalOptions {
    isRequestsModalVisible: boolean;
    onRequestClose: (() => void);
    requestCounter: number;
    onRequestFilterChange: ((text: string) => void);
    onRequestItemPress?: RespondToRequestsType;
    requestList: Request[];
    updateRequestList: ((newRequestList: Request[]) => void);
    roomName: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    renderRequestComponent?: FC<RenderRequestComponentOptions>;
    backgroundColor?: string;
    position?:
        | "center"
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    parameters: RequestsModalParameters;
    style?: object;
    renderContent?: ((options: {
        defaultContent: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => Element);
    renderContainer?: ((options: {
        defaultContainer: Element;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

isRequestsModalVisible onRequestClose requestCounter onRequestFilterChange onRequestItemPress? requestList updateRequestList roomName socket renderRequestComponent? backgroundColor? position? parameters style? renderContent? renderContainer?

Properties

isRequestsModalVisible

isRequestsModalVisible: boolean

Controls modal visibility

onRequestClose

onRequestClose: (() => void)

Callback when modal is closed

Request Management:

requestCounter

requestCounter: number

Current count of pending requests (for badge display)

onRequestFilterChange

onRequestFilterChange: ((text: string) => void)

Handler for filter input changes

OptionalonRequestItemPress

onRequestItemPress?: RespondToRequestsType

Handler for accept/reject actions (defaults to respondToRequests)

Session Context:

requestList

requestList: Request[]

Array of participant requests to display

updateRequestList

updateRequestList: ((newRequestList: Request[]) => void)

Updates request list state

roomName

roomName: string

Room identifier for request processing

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io instance for real-time request responses

State Parameters:

OptionalrenderRequestComponent

renderRequestComponent?: FC<RenderRequestComponentOptions>

Custom component for rendering each request item (defaults to RenderRequestComponent)

Advanced Render Overrides:

OptionalbackgroundColor

backgroundColor?: string

Modal background color

Optionalposition

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

Modal position on screen

parameters

parameters: RequestsModalParameters

Additional modal parameters (filtered request list)

Customization:

Optionalstyle

style?: object

Additional custom styles for 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 modal container

Settings

Member Visibility

On This Page

Properties