Dialog

7.1.10

Dialogs fill the entire screen.

Demo

NamnTypBeskrivning

AppBarProps

AppBarPropsObject to set props for the app bar in full screen mode.

ariaLabel *

stringProvides a screen reader name for the dialog. Mandatory for WCAG 2.1 compliance.

customAttributes

CustomAttribute[]Array of custom attributes that can be used for testing purposes.

customWidth

stringIndicating if it's possible to set a custom width. If no customWidth is set, it uses the default value depending on variant.

disableEnforceFocus

booleanIf true, the modal will not prevent focus from leaving the modal while open. Default value is false

disableFocusHeading

booleanIf true, the dialog will not automatically focus the first heading

enteringDirection

EnteringDirectionTypeDirection the dialog will enter from.

open *

booleanBoolean indicating if the dialog is open. Default value is false.

shouldCloseOnBackdropClick

booleanClose dialog on background click. Default value is false.

variant

"alert" | "fullscreen" | "bottom-alert"Layout variants of the dialog.

Installation

npm install @sj-ab/component-library.ui.dialog

Länkar

Best practices

Adaptive design

Adaptive design

Tillgänglighet

WAI-ARIA

Dialog-komponenten baseras till stor del på designmönstret "Dialog (Modal)" från WAI-ARIA Authoring practices guide.

Det innebär att komponenten flyttar och begränsar användarens fokus till enbart det som finns i dialogen när det öppnas. Användaren ska inte kunna tabba till dolt innehåll i bakgrunden, eller hitta dolt innehåll med skärmläsare.

Dialog-komponenten använder bland annat:

  • role="dialog" eller "alertdialog" på behållaren för att berätta för hjälpmedel att det är en dialog.

  • aria-label på behållaren för att ge den ett unikt namn

  • aria-hidden="true" på allt innehåll i bakgrunden för att dölja det för skärmläsare (sker automatiskt)

  • Ett inbyggt "fokuslås" som loopar tangentbordsfokus inom Sheetet (sker automatiskt)

Change log

Statistik

  • Importer av Dialog

    58
  • Repos med Dialog

    40%
  • Senaste installerade version av Dialog

    7.1.5
  • Äldsta installerade version av Dialog

    2.3.18