Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrBanner

The igc-banner component displays important and concise message(s) for a user to address, that is specific to a page or feature.

Slot

  • Renders the text content of the banner message.

Slot

prefix - Renders additional content at the start of the message block.

Slot

actions - Renders any action elements.

Csspart

base - The base wrapper of the banner component.

Csspart

spacer - The inner wrapper that sets the space around the banner.

Csspart

message - The part that holds the text and the illustration.

Csspart

illustration - The part that holds the banner icon/illustration.

Csspart

content - The part that holds the banner text content.

Csspart

actions - The part that holds the banner action buttons.

Callable

  • IgrBanner(): ReactNode

    Returns ReactNode

Events

Methods

Properties

Events

onClosed

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

Emitted after the banner is closed

Type declaration

onClosing

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

Emitted before closing the banner

Type declaration

Methods

hide

  • hide(): Promise<boolean>

    Hides the banner if not already hidden. Returns true when the animation has completed.

    Returns Promise<boolean>

show

  • show(): Promise<boolean>

    Shows the banner if not already shown. Returns true when the animation has completed.

    Returns Promise<boolean>

toggle

  • toggle(): Promise<boolean>

    Toggles between shown/hidden state. Returns true when the animation has completed.

    Returns Promise<boolean>

Properties

open

open: boolean

Determines whether the banner is being shown/hidden.