Skip to main content Red Hat Design System logo Contribute on Github v1.4.5

Dialog

Overview Style Guidelines Code Demos Accessibility

Installation

Usage 

<rh-dialog trigger="standard-trigger">
  <h2 slot="header">Leave page</h2>
  <p>If you leave the page, any unsaved information will be lost.</p>
  <rh-button slot="footer">Leave</rh-button>
  <rh-button slot="footer" variant="tertiary">Cancel</rh-button>
</rh-dialog>
<rh-button id="standard-trigger">Open modal dialog</rh-button>

rh-dialog

Slots 3
Slot Name Description

The default slot can contain any type of content. When the header is not present this unnamed slot appear at the top of the dialog window (to the left of the close button). Otherwise it will appear beneath the header.
header

The header is an optional slot that appears at the top of the dialog window. It should be a header tag (h2-h6).
footer

Optional footer content. Good place to put action buttons.
Attributes 5
DOM Property Description Type Default
variant

The variant controls the width of the dialog. There are three options: small, medium and large. The default is large.

 
'small' | 'medium' | 'large' | undefined
 
unknown
position

position="top" aligns the dialog with the top of the page

 
'top' | undefined
 
unknown
open 
boolean
 
false
trigger

Optional ID of the trigger element

 
string | undefined
 
unknown
type 
'video' | undefined
 
unknown
Methods 5
Method Name Description
setTrigger(element: HTMLElement)
toggle()

Manually toggles the dialog.

dialog.toggle();
show()

Manually opens the dialog.

dialog.show();
showModal()
close(returnValue: string)

Manually closes the dialog.

dialog.close();
Events 3
Event Name Description
open

Fires when a user clicks on the trigger or manually opens a dialog.
close

Fires when either a user clicks on either the close button or the overlay or manually closes a dialog.
cancel
CSS Shadow Parts 7
Part Name Description
overlay

The dialog overlay which lies under the dialog and above the page body
dialog

The dialog element
content

The container for the dialog content
header

The container for the optional dialog header
description

The container for the optional dialog description in the header
close-button

The dialog's close button
footer

Actions footer container
CSS Custom Properties 2
CSS Property Description Default
--rh-dialog-video-aspect-ratio —
--rh-dialog-close-button-color

Sets the dialog close button color.

 var(--rh-color-icon-secondary-on-dark, #ffffff)
Design Tokens 0

None
© 2021-2024 Red Hat, Inc. Deploys by Netlify