Components
Dialog
There are two types of dialogs: modal and non-modal. A modal dialog requires users to take action before they can continue using the page. A non-modal dialog allows users to continue using the page, even while the dialog is open.
React
Unable to parse html
const Preview = () => { return ( <Dialog.TriggerContext> <Dialog.Trigger>Open Dialog</Dialog.Trigger> <Dialog> <Heading style={{ marginBottom: 'var(--ds-size-2)' }}> Dialog header </Heading> <Paragraph style={{ marginBottom: 'var(--ds-size-2)' }}> Lorem ipsum dolor sit, amet consectetur adipisicing elit. Blanditiis doloremque obcaecati assumenda odio ducimus sunt et. </Paragraph> <Paragraph data-size='sm'>Dialog footer</Paragraph> </Dialog> </Dialog.TriggerContext> ); }; render(<Preview />)
- closeButton
- Description
Screen reader label of close button. Set false to hide the close button.
- Type
string | false- Default
Lukk dialogvindu
- closedby
- Description
Light dismiss behavior, allowing to close on backdrop click by setting `closedby="any"`. @see [mdn closedBy](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/closedBy)
- Type
"none" | "closerequest" | "any"- Default
'closerequest'
- placement
- Description
When not center, displays dialog as a "drawer" from the specified side.
- Type
"center" | "left" | "right" | "top" | "bottom"- Default
center
- modal
- Description
Toogle modal and non-modal dialog. @see [mdn modal dialog](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dialog#creating_a_modal_dialog)
- Type
boolean- Default
true
- open
- Description
@note Unlike standard html, where the open attribute always opens a non-modal dialog, Dialog's open prop uses the `modal` prop to determine whether the Dialog is modal or non-modal
- Type
boolean
- onClose
- Description
Callback that is called when the dialog is closed.
- Type
((event: Event) => void)
- asChild
- Description
Change the default rendered element for the one passed as a child, merging their props and behavior. @deprecated Will be removed in the next major version. Should always be a `<dialog>` element
- Type
boolean- Default
false
| Name | Type | Default | Description |
|---|---|---|---|
| closeButton | string | false | Lukk dialogvindu | Screen reader label of close button. Set false to hide the close button. |
| closedby | "none" | "closerequest" | "any" | 'closerequest' | Light dismiss behavior, allowing to close on backdrop click by setting `closedby="any"`. @see [mdn closedBy](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement/closedBy) |
| placement | "center" | "left" | "right" | "top" | "bottom" | center | When not center, displays dialog as a "drawer" from the specified side. |
| modal | boolean | true | Toogle modal and non-modal dialog. @see [mdn modal dialog](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dialog#creating_a_modal_dialog) |
| open | boolean | - | @note Unlike standard html, where the open attribute always opens a non-modal dialog, Dialog's open prop uses the `modal` prop to determine whether the Dialog is modal or non-modal |
| onClose | ((event: Event) => void) | - | Callback that is called when the dialog is closed. |
| asChild | boolean | false | Change the default rendered element for the one passed as a child, merging their props and behavior. @deprecated Will be removed in the next major version. Should always be a `<dialog>` element |
DialogBlock
- asChild
- Description
Change the default rendered element for the one passed as a child, merging their props and behavior.
- Type
boolean- Default
false
| Name | Type | Default | Description |
|---|---|---|---|
| asChild | boolean | false | Change the default rendered element for the one passed as a child, merging their props and behavior. |
DialogTrigger
- type
- Description
Specify the type of button. Unset when `asChild` is true
- Type
"submit" | "reset" | "button"- Default
'button'
- command
- Type
string
- commandfor
- Type
string
- variant
- Description
Specify which variant to use
- Type
"primary" | "secondary" | "tertiary"- Default
'primary'
- icon
- Description
Toggle icon only styling, pass icon as children When combined with loading, the loading-icon will be shown instead of the icon.
- Type
boolean- Default
false
- loading
- Description
Toggle loading state. Pass an element if you want to display a custom loader.
- Type
ReactNode- Default
false
- asChild
- Description
Change the default rendered element for the one passed as a child, merging their props and behavior.
- Type
boolean- Default
false
| Name | Type | Default | Description |
|---|---|---|---|
| type | "submit" | "reset" | "button" | 'button' | Specify the type of button. Unset when `asChild` is true |
| command | string | - | - |
| commandfor | string | - | - |
| variant | "primary" | "secondary" | "tertiary" | 'primary' | Specify which variant to use |
| icon | boolean | false | Toggle icon only styling, pass icon as children When combined with loading, the loading-icon will be shown instead of the icon. |
| loading | ReactNode | false | Toggle loading state. Pass an element if you want to display a custom loader. |
| asChild | boolean | false | Change the default rendered element for the one passed as a child, merging their props and behavior. |
Usage
To add your own close button, you can either use command="close" commandfor="DIALOG-ID" or ref and Dialog.close() on a button you create yourself.
If the button is empty, it will get an icon.
If the button is a direct child of the dialog and the first element, it will float to the top right.
The attributes command (developer.mozilla.org) and commandfor are a relatively new part of the web-platform. They allow buttons to perform actions on other elements declaratively. We automatically add invokers-polyfill (npmjs.com) to support older browsers.
Examples
Med command og uten context
If you don't want to use Dialog.TriggerContext, you can use command="show-modal" or command="--show-non-modal" and commandfor="DIALOG-ID" to open the dialog from an external trigger.
React
Unable to parse html
const WithCommand = () => ( <> <Button command='show-modal' commandfor='my-dialog-commant'> Open Dialog with ref </Button> <Dialog id='my-dialog-commant'> <Heading style={{ marginBottom: 'var(--ds-size-2)' }}> Dialog header </Heading> <Paragraph style={{ marginBottom: 'var(--ds-size-2)' }}> Lorem ipsum dolor sit, amet consectetur adipisicing elit. Blanditiis doloremque obcaecati assumenda odio ducimus sunt et. </Paragraph> </Dialog> </> ); render(<WithCommand />)
With ref and without context
If you don't want to use Dialog.TriggerContext, you can use ref to open the dialog from an external trigger.
You then use native methods on the <dialog> element, such as showModal() or show().
Note that you should add aria-haspopup="dialog" to the button that opens the dialog for better accessibility.
React
Unable to parse html
const WithRef = () => { const dialogRef = useRef<HTMLDialogElement>(null); return ( <> <Button aria-haspopup='dialog' onClick={() => dialogRef.current?.showModal()} > Open Dialog with ref </Button> <Dialog ref={dialogRef}> <Heading style={{ marginBottom: 'var(--ds-size-2)' }}> Dialog header </Heading> <Paragraph style={{ marginBottom: 'var(--ds-size-2)' }}> Lorem ipsum dolor sit, amet consectetur adipisicing elit. Blanditiis doloremque obcaecati assumenda odio ducimus sunt et. </Paragraph> </Dialog> </> ); }; render(<WithRef />)
With form and focus
If you want a field in a form inside the dialog to get focus when the dialog opens, you can use the native autofocus attribute on the input element.
When using this with React, you must write it in lowercase as autofocus, not autoFocus.
This prop does not exist in React's type definitions, so we have ignored the error with an @ts-expect-error comment in the example below.
React
Unable to parse html
const WithForm = () => { const [input, setInput] = useState(''); return ( <Dialog.TriggerContext> <Dialog.Trigger>Open Dialog</Dialog.Trigger> <Dialog onClose={() => setInput('')} closedby='any' id='my-dialog-form'> <Heading style={{ marginBottom: 'var(--ds-size-2)' }}> Dialog med skjema </Heading> <Textfield label='Navn' value={input} onChange={(e) => setInput(e.target.value)} // @ts-expect-error We want the native "autofocus" and Reacts onMount smartness (see https://react.dev/reference/react-dom/components/input#input) autofocus='true' /> <div style={{ display: 'flex', gap: 'var(--ds-size-4)', marginTop: 'var(--ds-size-4)', }} > <Button command='close' commandfor='my-dialog-form' onClick={() => alert(`Du har sendt inn skjema med navn: ${input}`)} > Send inn skjema </Button> <Button variant='secondary' data-color='danger' command='close' commandfor='my-dialog-form' > Avbryt </Button> </div> </Dialog> </Dialog.TriggerContext> ); }; render(<WithForm />)
With blocks
Use multiple Dialog.Block if you want to divide the dialog with dividers into, for example, a top and bottom area. Note that content cannot be placed directly in Dialog if you use Dialog.Block; then all content should be inside one of the dialog's Dialog.Block sections.
React
Unable to parse html
const WithBlocks = () => ( <Dialog.TriggerContext> <Dialog.Trigger>Open Dialog</Dialog.Trigger> <Dialog id='my-dialog-blocks'> <Dialog.Block> <Paragraph data-size='sm'>Dialog subtitle</Paragraph> <Heading>Dialog with dividers</Heading> </Dialog.Block> <Dialog.Block> <Paragraph> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur sodales eros justo. </Paragraph> </Dialog.Block> <Dialog.Block> <Button variant='secondary' command='close' commandfor='my-dialog-blocks' > Lukk </Button> </Dialog.Block> </Dialog> </Dialog.TriggerContext> ); render(<WithBlocks />)
Close on click outside
We use closedby="any" to close the dialog when the user clicks outside.
We add polyfill so closedby="any" also works in older Safari.
React
Unable to parse html
const CloseWithClickOutside = () => ( <Dialog.TriggerContext> <Dialog.Trigger>Open Dialog</Dialog.Trigger> <Dialog closedby='any'> <Heading>Click outside to close</Heading> </Dialog> </Dialog.TriggerContext> ); render(<CloseWithClickOutside />)
HTML
The main class name is ds-dialog, which is placed on the <dialog> element.
Blocks inside the dialog are given class names like ds-dialog__block.
In HTML, you have to connect the <dialog> element to a trigger yourself through command="show-modal" or command="--show-non-modal" and commandfor="DIALOG-ID".
CSS variables and data attributes
All CSS variables used by ds-dialog__block are set to ds-dialog.
| Name | Value |
|---|---|
| --dsc-dialog-backdrop-background | rgba(0,0,0,.5) |
| --dsc-dialog-background | var(--ds-color-neutral-surface-default) |
| --dsc-dialog-icon-spacing | var(--ds-size-3) |
| --dsc-dialog-icon-url | url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='1em' height='1em' fill='none' viewBox='0 0 24 24'%3E%3Cpath fill='currentColor' d='M6.53 5.47a.75.75 0 0 0-1.06 1.06L10.94 12l-5.47 5.47a.75.75 0 1 0 1.06 1.06L12 13.06l5.47 5.47a.75.75 0 1 0 1.06-1.06L13.06 12l5.47-5.47a.75.75 0 0 0-1.06-1.06L12 10.94z'/%3E%3C/svg%3E") |
| --dsc-dialog-color | var(--ds-color-neutral-text-default) |
| --dsc-dialog-divider-border-width | var(--ds-border-width-default) |
| --dsc-dialog-divider-border-style | solid |
| --dsc-dialog-divider-border-color | var(--ds-color-neutral-border-subtle) |
| --dsc-dialog-border-width | var(--ds-border-width-default) |
| --dsc-dialog-border-style | solid |
| --dsc-dialog-border-color | var(--ds-color-neutral-border-subtle) |
| --dsc-dialog-max-height | 80vh |
| --dsc-dialog-max-width | 40rem |
| --dsc-dialog-spacing | var(--ds-size-6) |
| --dsc-dialog-placement-inline-max-width | 40rem |
| --dsc-dialog-placement-block-max-width | 100% |
| --dsc-dialog-transition-duration | 300ms |
| Name | Value |
|---|---|
| data-placement | bottom, top, left, right |
| data-command | close |