Interface RequestsModalOptions

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;
}

Properties

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

Properties

isRequestsModalVisible

isRequestsModalVisible: boolean

Flag to control the visibility of the modal.

onRequestClose

onRequestClose: (() => void)

Callback function to handle the closing of the modal.

requestCounter

requestCounter: number

Initial count of requests.

onRequestFilterChange

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

Function to handle the filter input changes.

OptionalonRequestItemPress

onRequestItemPress?: RespondToRequestsType

Function to handle the action when a request item is pressed.

requestList

requestList: Request[]

List of requests.

updateRequestList

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

Function to update the request list.

roomName

roomName: string

Name of the room.

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket instance for real-time communication.

OptionalrenderRequestComponent

renderRequestComponent?: FC<RenderRequestComponentOptions>

Component to render each request item. Defaults to RenderRequestComponent.

OptionalbackgroundColor

backgroundColor?: string

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

Optionalposition

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

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

parameters

parameters: RequestsModalParameters

Additional parameters for the modal.

Settings

Member Visibility

On This Page

Properties