Back to Tuist

Banner

noora/docs/components/banner.md

4.204.02.6 KB
Original Source
<!-- Generated by scripts/generate-web-components.js. Do not edit directly. -->

Banner

Displays a page-level message with an optional dismiss action.

html
<noora-banner status="success" title="Changes saved"></noora-banner>

Attributes

AttributeType or allowed valuesDefaultDescription
statusprimary, error, success, warning, information"primary"Sets the semantic status.
titlestring""Sets the banner title.
descriptionstringNoneSets the optional description.
dismissiblebooleanfalseShows a dismiss control.

Events

EventTypeDescription
noora-dismissCustomEvent<Record<string, never>>Emitted after the banner is dismissed.

Slots

SlotDescription
iconA custom icon used by primary banners.

Styling parts

PartDescription
bannerThe banner container.
titleThe title.
descriptionThe description.

A dismiss action emits a noora-dismiss event and hides the element.

Statuses

Banners support primary, error, success, warning, and information states.

html
<noora-banner status="primary" title="Primary status" description="I am a primary banner"></noora-banner>
<noora-banner status="error" title="Error status" description="I am an error banner"></noora-banner>
<noora-banner status="success" title="Success status" description="I am a success banner"></noora-banner>
<noora-banner status="warning" title="Warning status" description="I am a warning banner"></noora-banner>
<noora-banner status="information" title="Information status" description="I am an information banner"></noora-banner>

Custom icon

Primary banners accept a custom icon through the icon slot.

html
<noora-banner status="primary" title="Primary status" description="I am a primary banner with a custom icon">
  <noora-icon slot="icon" name="alert_circle"></noora-icon>
</noora-banner>

Content variations

Descriptions are optional, banners can be dismissible, and long content wraps.

html
<noora-banner status="primary" title="Title only banner"></noora-banner>
<noora-banner dismissible status="warning" title="Dismissible banner" description="This banner can be dismissed by the user"></noora-banner>
<noora-banner status="information" title="Banner with longer content" description="This is a banner with much longer descriptive text that demonstrates how the component handles multiple lines of content and text wrapping behavior"></noora-banner>