Interface BackgroundModalOptions

interface BackgroundModalOptions {
    isVisible: boolean;
    onClose: (() => void);
    parameters: BackgroundModalParameters;
    position?: string;
    backgroundColor?: string;
    title?: ReactNode;
    overlayProps?: HTMLAttributes<HTMLDivElement>;
    contentProps?: HTMLAttributes<HTMLDivElement>;
    headerProps?: HTMLAttributes<HTMLDivElement>;
    titleProps?: HTMLAttributes<HTMLHeadingElement>;
    closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    closeIconComponent?: ReactNode;
    headerDividerProps?: HTMLAttributes<HTMLHRElement>;
    bodyProps?: HTMLAttributes<HTMLDivElement>;
    defaultImagesContainerProps?: HTMLAttributes<HTMLDivElement>;
    uploadWrapperProps?: HTMLAttributes<HTMLDivElement>;
    uploadLabelProps?: LabelHTMLAttributes<HTMLLabelElement>;
    uploadLabel?: ReactNode;
    uploadInputProps?: InputHTMLAttributes<HTMLInputElement>;
    mainCanvasProps?: CanvasHTMLAttributes<HTMLCanvasElement>;
    backgroundCanvasProps?: CanvasHTMLAttributes<HTMLCanvasElement>;
    captureVideoProps?: VideoHTMLAttributes<HTMLVideoElement>;
    previewVideoProps?: VideoHTMLAttributes<HTMLVideoElement>;
    loadingOverlayProps?: HTMLAttributes<HTMLDivElement>;
    loadingSpinner?: ReactNode;
    buttonsWrapperProps?: HTMLAttributes<HTMLDivElement>;
    applyButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    saveButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    applyButtonLabel?: string;
    applyButtonAppliedLabel?: string;
    saveButtonLabel?: string;
    renderHeader?: ((options: {
        defaultHeader: ReactNode;
        onClose: (() => void);
    }) => ReactNode);
    renderButtons?: ((options: {
        defaultButtons: ReactNode;
        applyButtonRef: RefObject<null | HTMLButtonElement>;
        saveButtonRef: RefObject<null | HTMLButtonElement>;
    }) => ReactNode);
    renderBody?: ((options: {
        defaultBody: ReactNode;
    }) => ReactNode);
    renderContent?: ((options: {
        defaultContent: ReactNode;
    }) => ReactNode);
}

Properties

isVisible onClose parameters position? backgroundColor? title? overlayProps? contentProps? headerProps? titleProps? closeButtonProps? closeIconComponent? headerDividerProps? bodyProps? defaultImagesContainerProps? uploadWrapperProps? uploadLabelProps? uploadLabel? uploadInputProps? mainCanvasProps? backgroundCanvasProps? captureVideoProps? previewVideoProps? loadingOverlayProps? loadingSpinner? buttonsWrapperProps? applyButtonProps? saveButtonProps? applyButtonLabel? applyButtonAppliedLabel? saveButtonLabel? renderHeader? renderButtons? renderBody? renderContent?

Properties

isVisible

isVisible: boolean

onClose

onClose: (() => void)

parameters

parameters: BackgroundModalParameters

Optionalposition

position?: string

OptionalbackgroundColor

backgroundColor?: string

Optionaltitle

title?: ReactNode

OptionaloverlayProps

overlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontentProps

contentProps?: HTMLAttributes<HTMLDivElement>

OptionalheaderProps

headerProps?: HTMLAttributes<HTMLDivElement>

OptionaltitleProps

titleProps?: HTMLAttributes<HTMLHeadingElement>

OptionalcloseButtonProps

closeButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalcloseIconComponent

closeIconComponent?: ReactNode

OptionalheaderDividerProps

headerDividerProps?: HTMLAttributes<HTMLHRElement>

OptionalbodyProps

bodyProps?: HTMLAttributes<HTMLDivElement>

OptionaldefaultImagesContainerProps

defaultImagesContainerProps?: HTMLAttributes<HTMLDivElement>

OptionaluploadWrapperProps

uploadWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionaluploadLabelProps

uploadLabelProps?: LabelHTMLAttributes<HTMLLabelElement>

OptionaluploadLabel

uploadLabel?: ReactNode

OptionaluploadInputProps

uploadInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionalmainCanvasProps

mainCanvasProps?: CanvasHTMLAttributes<HTMLCanvasElement>

OptionalbackgroundCanvasProps

backgroundCanvasProps?: CanvasHTMLAttributes<HTMLCanvasElement>

OptionalcaptureVideoProps

captureVideoProps?: VideoHTMLAttributes<HTMLVideoElement>

OptionalpreviewVideoProps

previewVideoProps?: VideoHTMLAttributes<HTMLVideoElement>

OptionalloadingOverlayProps

loadingOverlayProps?: HTMLAttributes<HTMLDivElement>

OptionalloadingSpinner

loadingSpinner?: ReactNode

OptionalbuttonsWrapperProps

buttonsWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalapplyButtonProps

applyButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalsaveButtonProps

saveButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalapplyButtonLabel

applyButtonLabel?: string

OptionalapplyButtonAppliedLabel

applyButtonAppliedLabel?: string

OptionalsaveButtonLabel

saveButtonLabel?: string

OptionalrenderHeader

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

OptionalrenderButtons

renderButtons?: ((options: {
    defaultButtons: ReactNode;
    applyButtonRef: RefObject<null | HTMLButtonElement>;
    saveButtonRef: RefObject<null | HTMLButtonElement>;
}) => ReactNode)

OptionalrenderBody

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

OptionalrenderContent

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

Settings

Member Visibility

On This Page

Properties