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?: string;
    parameters: RequestsModalParameters;
    title?: ReactNode;
    overlayProps?: HTMLAttributes<HTMLDivElement>;
    contentProps?: HTMLAttributes<HTMLDivElement>;
    headerProps?: HTMLAttributes<HTMLDivElement>;
    titleProps?: HTMLAttributes<HTMLDivElement>;
    badgeWrapperProps?: HTMLAttributes<HTMLDivElement>;
    badgeProps?: HTMLAttributes<HTMLSpanElement>;
    closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    closeIconComponent?: ReactNode;
    bodyProps?: HTMLAttributes<HTMLDivElement>;
    searchWrapperProps?: HTMLAttributes<HTMLDivElement>;
    searchInputProps?: InputHTMLAttributes<HTMLInputElement>;
    requestsWrapperProps?: HTMLAttributes<HTMLDivElement>;
    requestItemWrapperProps?: HTMLAttributes<HTMLDivElement>;
    emptyState?: ReactNode | ((context: {
        counter: number;
    }) => ReactNode);
    renderHeader?: ((options: {
        defaultHeader: ReactNode;
        counter: number;
        onClose: (() => void);
    }) => ReactNode);
    renderSearch?: ((options: {
        defaultSearch: ReactNode;
        onFilter: ((value: string) => void);
    }) => ReactNode);
    renderRequest?: ((options: {
        request: Request;
        index: number;
        defaultRequest: ReactNode;
        handleRespond: ((action: "accepted" | "rejected") => void);
    }) => ReactNode);
    renderBody?: ((options: {
        defaultBody: ReactNode;
        counter: number;
    }) => ReactNode);
    renderContent?: ((options: {
        defaultContent: ReactNode;
        counter: number;
    }) => ReactNode);
}

Properties

isRequestsModalVisible onRequestClose requestCounter onRequestFilterChange onRequestItemPress? requestList updateRequestList roomName socket renderRequestComponent? backgroundColor? position? parameters title? overlayProps? contentProps? headerProps? titleProps? badgeWrapperProps? badgeProps? closeButtonProps? closeIconComponent? bodyProps? searchWrapperProps? searchInputProps? requestsWrapperProps? requestItemWrapperProps? emptyState? renderHeader? renderSearch? renderRequest? renderBody? renderContent?

Properties

isRequestsModalVisible

isRequestsModalVisible: boolean

onRequestClose

onRequestClose: (() => void)

requestCounter

requestCounter: number

onRequestFilterChange

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

OptionalonRequestItemPress

onRequestItemPress?: RespondToRequestsType

requestList

requestList: Request[]

updateRequestList

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

roomName

roomName: string

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

OptionalrenderRequestComponent

renderRequestComponent?: FC<RenderRequestComponentOptions>

OptionalbackgroundColor

backgroundColor?: string

Optionalposition

position?: string

parameters

parameters: RequestsModalParameters

Optionaltitle

title?: ReactNode

OptionaloverlayProps

overlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontentProps

contentProps?: HTMLAttributes<HTMLDivElement>

OptionalheaderProps

headerProps?: HTMLAttributes<HTMLDivElement>

OptionaltitleProps

titleProps?: HTMLAttributes<HTMLDivElement>

OptionalbadgeWrapperProps

badgeWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalbadgeProps

badgeProps?: HTMLAttributes<HTMLSpanElement>

OptionalcloseButtonProps

closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalcloseIconComponent

closeIconComponent?: ReactNode

OptionalbodyProps

bodyProps?: HTMLAttributes<HTMLDivElement>

OptionalsearchWrapperProps

searchWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalsearchInputProps

searchInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionalrequestsWrapperProps

requestsWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalrequestItemWrapperProps

requestItemWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalemptyState

emptyState?: ReactNode | ((context: {
    counter: number;
}) => ReactNode)

OptionalrenderHeader

renderHeader?: ((options: {
    defaultHeader: ReactNode;
    counter: number;
    onClose: (() => void);
}) => ReactNode)

OptionalrenderSearch

renderSearch?: ((options: {
    defaultSearch: ReactNode;
    onFilter: ((value: string) => void);
}) => ReactNode)

OptionalrenderRequest

renderRequest?: ((options: {
    request: Request;
    index: number;
    defaultRequest: ReactNode;
    handleRespond: ((action: "accepted" | "rejected") => void);
}) => ReactNode)

OptionalrenderBody

renderBody?: ((options: {
    defaultBody: ReactNode;
    counter: number;
}) => ReactNode)

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: ReactNode;
    counter: number;
}) => ReactNode)

Settings

Member Visibility

On This Page

Properties