Skip to main content
cngx-src documentation

CngxBannerTrigger

ComponentPrimaryv0.1.0WCAG AA

projects/ui/feedback/banner/banner-trigger.ts

Import#

import { CngxBannerTrigger } from '@cngx/ui/feedback'

Description#

Declarative banner trigger - renders nothing, shows/dismisses a global banner when [when] changes.

When [when] becomes true, the banner appears. When false, it is dismissed. The banner's lifecycle is tied to the signal - perfect for reactive system state like isOffline() or sessionExpiring().

Requires provideFeedback(withBanners()).

<cngx-banner-trigger
  [when]="isOffline()"
  message="You are offline. Changes will sync when reconnected."
  id="net:offline"
  severity="error" />

<cngx-banner-trigger
  [when]="sessionExpiring()"
  message="Session expires soon."
  id="auth:session"
  severity="warning"
  actionLabel="Extend"
  [actionHandler]="extendSession" />

Metadata#

Host#

Index#

Inputs#

actionLabel#string | undefined
input()

Action button label.

dismissible#boolean
input()

Show dismiss button.

default true
input()Required

Required unique id - dedup key.

message#string
input()Required

Banner message text.

input()

Visual severity.

default 'info'
input()Required

When true, the banner is shown. When false, it is dismissed.

Instance Properties#

actionHandler#unknown
Readonly

Action button handler.

input<(() => void | Promise<void>) | undefined>(undefined)