Skip to content
@maas/docs

Usage Guidelines

Rules for using a component, each with its weight, read from the page’s front matter.

View source View as Markdown

Usage guidelines state the rules for using a component, each with a level. The items live in the page’s front matter, where tools can read them as data.

  • Give every dialog an accessible name, through a Dialog.Title or an aria-label.must
  • Keep the trigger in the document while the dialog is open.should
  • Nest a dialog in another only when the second one completes the first, such as a confirmation.may
  • Open a dialog without a user action.must not

Usage

---
guidelines:
  - statement: Give every dialog an accessible name.
    level: must
---

::usage-guidelines
::

The levels are must, must-not, should, should-not and may. An item with framing: when-to-use stays in the data and off the page, because the opening paragraph says the same.