igx-banner

November 19, 2025 ยท View on GitHub

igx-banner supports banner component that is shown at the full width of the screen above the app content but below a Navigation Bar if available. A walkthrough of how to get started can be found here

Usage

<igx-banner #banner>
    This is default template's message!
</igx-banner>

API Summary

Inputs

Inputs available on the IgxBanner:

NameTypeDescription
animationSettings{ openAnimation: AnimationRefMetadata, closeAnimation: AnimationRefMetadata }Sets the open / close animations for the banner.

Outputs

A list of the events emitted by the IgxBanner:

NameDescriptionCancelable
openingFires before the banner is openedtrue
openedFires after the banner is openedfalse
closingFire before the banner is closedtrue
closedFires after the banner is closedfalse

Getters

Getters available on the IgxBanner:

NameTypeGetterSetterDescription
collapsedbooleanYesNoGets whether igx-banner is collapsed.

Methods

Here is a list of all public methods exposed by IgxBanner:

SignatureDescription
open()Opens the banner
close()Closes the banner
toggle()Toggles the banner