Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcDialogComponent

Represents a Dialog component.

Element

igc-dialog

Fires

igcClosing - Emitter just before the dialog is closed.

Fires

igcClosed - Emitted after closing the dialog.

Slot

  • Renders content inside the default slot.

Slot

title - Renders the title of the dialog header.

Slot

footer - Renders the dialog footer.

Csspart

base - The base wrapper of the dialog.

Csspart

title - The title container.

Csspart

footer - The footer container.

Csspart

overlay - The overlay.

Hierarchy

Hierarchy

  • EventEmitterInterface<IgcDialogEventMap, this> & LitElement<this>
    • IgcDialogComponent

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

closeOnOutsideClick

closeOnOutsideClick: boolean = false

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

Attr

close-on-outside-click

hideDefaultAction

hideDefaultAction: boolean = false

Whether to hide the default action button for the dialog.

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

Attr

hide-default-action

keepOpenOnEscape

keepOpenOnEscape: boolean = false

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

Attr

keep-open-on-escape

open

open: boolean = false

Whether the dialog is opened.

Attr

returnValue

returnValue: string

Sets the return value for the dialog.

title

title: string

Sets the title of the dialog.

Attr

Static styles

styles: CSSResult[] = ...

Static Readonly tagName

tagName: "igc-dialog" = 'igc-dialog'

Accessors

closeOnEscape

  • get closeOnEscape(): boolean

  • Returns boolean

  • set closeOnEscape(value): void

  • Whether the dialog should be closed when pressing the 'ESCAPE' button.

    Deprecated

    since version 4.2.3. Use keepOpenOnEscape instead.

    Attr

    close-on-escape

    Parameters

    • value: boolean

    Returns void

Methods

emitEvent

  • emitEvent<K, D>(type, eventInitDict?): boolean

  • Type parameters

    Type Parameters

    • K extends keyof IgcDialogEventMap
    • D extends void

    Parameters

    • type: K
    • Optional eventInitDict: CustomEventInit<D>

    Returns boolean

hide

show

toggle

Static register