Modal

A modal presents important information or simple tasks to the user in an overlay.

Anatomy

1. Modal container - the modal container provides a boundary for the contents of the modal.
2. Title (recommended) - the name of the modal lets the user know what to expect from it and functions as a header for the body of the modal.
3. Close Button (optional) - a button that will always close the modal.
   • This should always be included when no other controls exist inside the modal.
4. Body - the main content of the modal presents important information to the user or asks them to perform simple tasks before exiting the modal.
5. Action Buttons (optional) - one or more actions that will result in the dismissal of the modal.
6. Backdrop Overlay - an overlay that prevents the user from interacting with the page’s main content.

Usage

Use modals to present important information or simple tasks to the user, disabling all access to the main content while the modal is active. Modals are sometimes called "modal dialogs" because they create a dialog between the application and the user in a different modality from the main content.

Do

• Do use a modal to confirm irreversible actions, such as deleting content.
• Do use a modal to interrupt the user when it will help them accomplish their tasks.
• Do be careful about ambiguous action buttons, such as "Yes" or "No".

Don't

• Don't overuse modals. They should be used sparingly and thoughtfully.
• Don't write long titles for modals. They should be clear and concise.

React API

import { Modal } from '@wwnds/react';

Modal

Live Editor

function ModalWithButton() {
	const [isOpen, setIsOpen] = React.useState(false);
	const open = () => setIsOpen(true);
	const close = () => setIsOpen(false);
	return (
		<>
			<Button variant="solid" onClick={open}>Open the modal</Button>
			<Modal
				title="Confirm the prompt"
				isOpen={isOpen}
				onRequestClose={close}
				actions={(
					<>
						<Button variant="outline" color="base" onClick={close}>
							Also confirm
						</Button>
						<Button variant="solid" onClick={close}>
							Confirm
						</Button>
					</>
				)}
			>
				<p>
					This is a demo modal.
					Real modals should have useful information here.
				</p>
			</Modal>
		</>
	);
}

Result

Loading...

Name	Description	Type
isOpen	Indicates whether the Modal dialog is open.	boolean
title (required)	The name of the Modal dialog. Required for accessibility but can be visually hidden with the hideTitle prop.	string
hideTitle	Indicates that the title should be visually hidden. It will still be accessible to screen reader users.	boolean
hideCloseButton	Indicates that the built-in close button in the top right should not be rendered.	boolean
actions	A list of actions or React Fragment that will be set inside an action bar at the bottom of the Modal dialog.	ReactElement<any, string | JSXElementConstructor<any>> | ReactElement<ButtonProps, string | JSXElementConstructor<any>>[] | ReactFragment
stickyHeader	Indicates whether the header should stick to the top of the screen. Only has an effect when the modal's content is longer than the window height and the user scrolls enough to move the header above to top of the screen.	boolean
stickyActionBar	Indicates whether the footer should stick to the bottom of the screen. Only has an effect when the modal's content is longer than the window height and the footer is below the bottom of the screen.	boolean
focusOnOpen	An element that should be focused on open. If none is specified, the first focusable element in the Modal will be focused. If none can be found, the header or content will be focused.	HTMLElement
closeOnBackdropClick	Indicates whether clicking the backdrop should close the Modal dialog.	boolean
closeOnEscape	Indicates whether Escape should close the Modal dialog.	boolean
mountPoint	A function that returns an element where the Modal dialog should be attached to the DOM. Default is the body.	(() => HTMLElement)
baseName		string
backdropClass		string
headerClass		string
titleClass		string
closeButtonClass		string
contentClass		string
actionBarClass		string
portalClass		string
onRequestClose	Callback function that is called when the Modal would like to close. This will happen under the following conditions: if closeOnBackdropClick is true and the user clicks the backdrop. if closeOnEscape is true and the user presses Escape. if hideCloseButton is not true and the user clicks the close button. To close the Modal when onRequestClose triggers, simply update the isOpen prop to false.	(() => void)
onOpen		(() => void)
headerRef		Ref<HTMLElement>
contentRef		Ref<HTMLElement>
actionBarRef		Ref<HTMLElement>
modal		boolean