Interface ConfirmHereModalOptions

interface ConfirmHereModalOptions {
    isConfirmHereModalVisible: boolean;
    onConfirmHereClose: (() => void);
    backgroundColor?: string;
    countdownDuration?: number;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    member: string;
    title?: ReactNode;
    message?: ReactNode | ((context: {
        counter: number;
        countdownDuration: number;
    }) => ReactNode);
    countdownLabel?: ReactNode;
    confirmButtonLabel?: ReactNode;
    onTimeout?: (() => void);
    overlayProps?: HTMLAttributes<HTMLDivElement>;
    contentProps?: HTMLAttributes<HTMLDivElement>;
    containerProps?: HTMLAttributes<HTMLDivElement>;
    spinnerWrapperProps?: HTMLAttributes<HTMLDivElement>;
    spinnerIcon?: ReactNode;
    spinnerIconProps?: Partial<FontAwesomeIconProps>;
    titleProps?: HTMLAttributes<HTMLHeadingElement>;
    messageProps?: HTMLAttributes<HTMLParagraphElement>;
    countdownWrapperProps?: HTMLAttributes<HTMLParagraphElement>;
    countdownValueProps?: HTMLAttributes<HTMLSpanElement>;
    confirmButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    renderSpinner?: ((options: {
        defaultSpinner: ReactNode;
    }) => ReactNode);
    renderTitle?: ((options: {
        defaultTitle: ReactNode;
    }) => ReactNode);
    renderMessage?: ((options: {
        defaultMessage: ReactNode;
        counter: number;
        countdownDuration: number;
    }) => ReactNode);
    renderCountdown?: ((options: {
        defaultCountdown: ReactNode;
        counter: number;
        countdownLabel: ReactNode;
    }) => ReactNode);
    renderConfirmButton?: ((options: {
        defaultButton: ReactNode;
    }) => ReactNode);
    renderBody?: ((options: {
        defaultBody: ReactNode;
        spinner: ReactNode;
        title: ReactNode;
        message: ReactNode;
        countdown: ReactNode;
        confirmButton: ReactNode;
    }) => ReactNode);
    renderContent?: ((options: {
        defaultContent: ReactNode;
    }) => ReactNode);
}

Properties

isConfirmHereModalVisible onConfirmHereClose backgroundColor? countdownDuration? socket localSocket? roomName member title? message? countdownLabel? confirmButtonLabel? onTimeout? overlayProps? contentProps? containerProps? spinnerWrapperProps? spinnerIcon? spinnerIconProps? titleProps? messageProps? countdownWrapperProps? countdownValueProps? confirmButtonProps? renderSpinner? renderTitle? renderMessage? renderCountdown? renderConfirmButton? renderBody? renderContent?

Properties

isConfirmHereModalVisible

isConfirmHereModalVisible: boolean

onConfirmHereClose

onConfirmHereClose: (() => void)

OptionalbackgroundColor

backgroundColor?: string

OptionalcountdownDuration

countdownDuration?: number

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

roomName

roomName: string

member

member: string

Optionaltitle

title?: ReactNode

Optionalmessage

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

OptionalcountdownLabel

countdownLabel?: ReactNode

OptionalconfirmButtonLabel

confirmButtonLabel?: ReactNode

OptionalonTimeout

onTimeout?: (() => void)

OptionaloverlayProps

overlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontentProps

contentProps?: HTMLAttributes<HTMLDivElement>

OptionalcontainerProps

containerProps?: HTMLAttributes<HTMLDivElement>

OptionalspinnerWrapperProps

spinnerWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalspinnerIcon

spinnerIcon?: ReactNode

OptionalspinnerIconProps

spinnerIconProps?: Partial<FontAwesomeIconProps>

OptionaltitleProps

titleProps?: HTMLAttributes<HTMLHeadingElement>

OptionalmessageProps

messageProps?: HTMLAttributes<HTMLParagraphElement>

OptionalcountdownWrapperProps

countdownWrapperProps?: HTMLAttributes<HTMLParagraphElement>

OptionalcountdownValueProps

countdownValueProps?: HTMLAttributes<HTMLSpanElement>

OptionalconfirmButtonProps

confirmButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalrenderSpinner

renderSpinner?: ((options: {
    defaultSpinner: ReactNode;
}) => ReactNode)

OptionalrenderTitle

renderTitle?: ((options: {
    defaultTitle: ReactNode;
}) => ReactNode)

OptionalrenderMessage

renderMessage?: ((options: {
    defaultMessage: ReactNode;
    counter: number;
    countdownDuration: number;
}) => ReactNode)

OptionalrenderCountdown

renderCountdown?: ((options: {
    defaultCountdown: ReactNode;
    counter: number;
    countdownLabel: ReactNode;
}) => ReactNode)

OptionalrenderConfirmButton

renderConfirmButton?: ((options: {
    defaultButton: ReactNode;
}) => ReactNode)

OptionalrenderBody

renderBody?: ((options: {
    defaultBody: ReactNode;
    spinner: ReactNode;
    title: ReactNode;
    message: ReactNode;
    countdown: ReactNode;
    confirmButton: ReactNode;
}) => ReactNode)

OptionalrenderContent

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

Settings

Member Visibility

On This Page

Properties