The igc-banner component displays important and concise message(s) for a user to address, that is specific to a page or feature.
- Slots
-
default— Renders the text content of the banner message. -
prefix— Renders additional content at the start of the message block. -
actions— Renders any action elements.
- CSS Parts
base— The base wrapper of the banner component.spacer— The inner wrapper that sets the space around the banner.message— The part that holds the text and the illustration.illustration— The part that holds the banner icon/illustration.content— The part that holds the banner text content.actions— The part that holds the banner action buttons.
Properties
Section titled "Properties"Determines whether the banner is being shown/hidden.
open: booleanMethods
Section titled "Methods"Hides the banner if not already hidden. Returns true when the animation has completed.
hide(): Promise<boolean>Returns Promise<boolean>
Shows the banner if not already shown. Returns true when the animation has completed.
show(): Promise<boolean>Returns Promise<boolean>
toggle
Section titled "toggle"Toggles between shown/hidden state. Returns true when the animation has completed.
toggle(): Promise<boolean>Returns Promise<boolean>
Events
Section titled "Events"onClosed
Section titled "onClosed"Emitted after the banner is closed
onClosed(args: CustomEvent<void>): voidParameters
- args:
CustomEvent<void>
Returns void
onClosing
Section titled "onClosing"Emitted before closing the banner
onClosing(args: CustomEvent<void>): voidParameters
- args:
CustomEvent<void>