Modal

Modal is an overlay that focuses people on a task above the page, such as confirming changes or renaming a project.

Import

import { Modal } from '@vortexlabs/vortex';
import type { ModalProps } from '@vortexlabs/vortex';

Allied components

Other links

Modal props
Prop	Type	Default
`children`	`React.ReactNode`	No default value
`width`	`string`	No default value
`padding`	`number`	`5`
`overflow`	`"visible"`	No default value
`onClose`	`callback`	No default value
`variant`	`union`	`dim`
`disableCloseOnOutsideClick`	`boolean`	No default value
`autoFocus`	`boolean`	`true`
`ariaLabel`	`string`	No default value
`className`	`union`	No default value
`backdropClassName`	`union`	No default value
`attributes`	`object`	No default value
`onOpen`	`callback`	No default value
`onAfterOpen`	`callback`	No default value
`onAfterClose`	`callback`	No default value
`active`	`boolean`	No default value
`containerRef`	`ref`	No default value

Modal.Title props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value

Modal.Description props
Prop	Type	Default	Attributes
`children`	`React.ReactNode`	No default value

Modal.Dismissible props
Prop	Type	Default
`children`	`React.ReactNode`	No default value
`closeAriaLabel`	`string`	No default value
`size`	`union`	`md`
`rounded`	`boolean`	`false`
`variant`	`union`	`plain`