Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrDialog

Represents a Dialog component.

Slot

  • Renders content inside the default slot of the dialog.

Slot

title - Renders content in the title slot of the dialog header.

Slot

message - Renders the message content of the dialog.

Slot

footer - Renders content in the dialog footer.

Csspart

base - The base wrapper of the dialog.

Csspart

title - The title container of the dialog.

Csspart

footer - The footer container of the dialog.

Csspart

overlay - The backdrop overlay of the dialog.

Callable

  • IgrDialog(): ReactNode

    Returns ReactNode

Events

Methods

Properties

Events

onClosed

onClosed: (args: CustomEvent<void>) => void

Emitted after closing the dialog.

Type declaration

onClosing

onClosing: (args: CustomEvent<void>) => void

Emitter just before the dialog is closed. Cancelable.

Type declaration

Methods

hide

  • hide(): Promise<boolean>

    Closes the dialog.

    Returns Promise<boolean>

show

  • show(): Promise<boolean>

    Opens the dialog.

    Returns Promise<boolean>

toggle

  • toggle(): Promise<boolean>

    Toggles the open state of the dialog.

    Returns Promise<boolean>

Properties

closeOnOutsideClick

closeOnOutsideClick: boolean

Whether the dialog should be closed when clicking outside of it.

hideDefaultAction

hideDefaultAction: boolean

Whether to hide the default action button for the dialog.

When there is projected content in the footer slot this property has no effect.

keepOpenOnEscape

keepOpenOnEscape: boolean

Whether the dialog should be kept open when pressing the 'Escape' button.

open

open: boolean

Whether the dialog is opened.

returnValue

returnValue: string

Sets the return value for the dialog.

title

title: string

Sets the title of the dialog.