Overlay

Last updated: 2.0.0 (22/01/2024)

BackdropFilter

type BackdropFilter = "blur" | "dot-blur" | "none";

GenericOverlayBackgroundProps

Extends GenericProps and PolymorphicLayoutProps.

Property	Type	Description
closeOnClick	boolean	Whether to close this overlay when it is clicked.
backdropFilter	BackdropFilter	A filter to apply to the page contents behind the overlay.
backgroundColor	CSSProperties["backgroundColor"]	Sets background-color css property.
padding	CSSProperties["padding"]	Sets padding css property.
zIndex	CSSProperties["zIndex"]	Sets z-index css property.

GenericOverlayHeaderProps

Property	Type	Description
title (required)	string	The title of this overlay.

GenericOverlayProps

Extends GenericLayoutProps and PolymorphicLayoutProps.

Property	Type	Description
title (required)	string	The title of this overlay.
header	(props: GenericOverlayHeaderProps) => ReactNode	Optionally replace the default header with a custom component.
closeOnOverlayClick	boolean	Whether to close this overlay when the overlay is clicked.
closeOnEscape	boolean	Whether to close this overlay when the escape key is pressed.
lockScroll	boolean	Whether to lock scrolling when this overlay is open.
withShadow	boolean	Whether to include a shadow underneath the overlay.
radius	ComponentSize	Sets the border-radius css property.
overlayBackgroundProps	GenericOverlayBackgroundProps	Optional props to pass to the overlay background component.