sp-banner

Deprecation Warning
@spectrum-web-components/banner is deprecated and will be removed in the SWC 1.0 release.

NPM

0.44.0

Storybook

View Storybook

Try it on

webcomponents.dev
Examples API Changelog

Attributes and Properties #

Property Attribute Type Default Description corner corner boolean false Determines if banner sets position at upper right corner or not. type type 'info' | 'warning' | 'error' 'info' Determines the style, can be "info", "warning", or "error". Default is "info"

Slots #

Name Description content Secondary message of the banner. Used to provide a description. header Primary message of the banner.

0.44.0 (2024-07-15) #

Note: Version bump only for package @spectrum-web-components/banner

0.43.0 (2024-06-11) #

Note: Version bump only for package @spectrum-web-components/banner

0.42.5 (2024-05-24) #

Note: Version bump only for package @spectrum-web-components/banner

0.42.4 (2024-05-14) #

Note: Version bump only for package @spectrum-web-components/banner

0.42.3 (2024-05-01) #

Note: Version bump only for package @spectrum-web-components/banner

0.42.2 (2024-04-03) #

Note: Version bump only for package @spectrum-web-components/banner

0.42.1 (2024-04-02) #

Note: Version bump only for package @spectrum-web-components/banner

0.42.0 (2024-03-19) #

Bug Fixes #

  • theme: deprecate lightest and darkest color stops (#4179) (0c01a66)

0.41.2 (2024-03-05) #

Note: Version bump only for package @spectrum-web-components/banner

0.41.1 (2024-02-22) #

Note: Version bump only for package @spectrum-web-components/banner

0.41.0 (2024-02-13) #

Note: Version bump only for package @spectrum-web-components/banner

0.40.5 (2024-02-05) #

Note: Version bump only for package @spectrum-web-components/banner

0.40.4 (2024-01-29) #

Note: Version bump only for package @spectrum-web-components/banner

0.40.3 (2024-01-11) #

Note: Version bump only for package @spectrum-web-components/banner

0.40.2 (2023-12-18) #

Note: Version bump only for package @spectrum-web-components/banner

0.40.1 (2023-12-05) #

Note: Version bump only for package @spectrum-web-components/banner

0.40.0 (2023-11-16) #

Note: Version bump only for package @spectrum-web-components/banner

0.39.4 (2023-11-02) #

Note: Version bump only for package @spectrum-web-components/banner

0.39.3 (2023-10-18) #

Note: Version bump only for package @spectrum-web-components/banner

0.39.2 (2023-10-13) #

Note: Version bump only for package @spectrum-web-components/banner

0.39.1 (2023-10-06) #

Note: Version bump only for package @spectrum-web-components/banner

0.39.0 (2023-09-25) #

Note: Version bump only for package @spectrum-web-components/banner

0.38.0 (2023-09-05) #

Note: Version bump only for package @spectrum-web-components/banner

0.37.0 (2023-08-18) #

Note: Version bump only for package @spectrum-web-components/banner

0.36.0 (2023-08-18) #

Note: Version bump only for package @spectrum-web-components/banner

0.35.0 (2023-07-31) #

Note: Version bump only for package @spectrum-web-components/banner

0.34.0 (2023-07-11) #

Note: Version bump only for package @spectrum-web-components/banner

0.33.2 (2023-06-14) #

Note: Version bump only for package @spectrum-web-components/banner

0.33.0 (2023-06-08) #

Note: Version bump only for package @spectrum-web-components/banner

0.32.0 (2023-06-01) #

Note: Version bump only for package @spectrum-web-components/banner

0.31.0 (2023-05-17) #

Note: Version bump only for package @spectrum-web-components/banner

0.30.0 (2023-05-03) #

Bug Fixes #

  • correct @element jsDoc listing across library (c97a632)
  • include "type" in package.json, generate custom-elements.json (1a8d716)
  • include default export in the "exports" fields (f32407d)
  • include the "types" entry in package.json files (b432f59)
  • stop merging selectors in a way that alters the cascade (369388f)
  • update side effect listings (8160d3a)
  • update to latest spectrum-css packages (a5ca19f)

Features #

  • include all Dev Mode files in side effects (f70817c)
  • leverage "exports" field in package.json (321abd7)
  • leverage latest Spectrum button API (9faeade)
  • shared pkg versions, devmode define warning, registry-conflicts docs (6e49565)
  • update lit-* dependencies, wip (377f3c8)
  • update to Spectrum CSS v3.0.0 (e8b3d8f)
  • use @adobe/spectrum-css@2.15.1 (3918888)
  • use latest exports specification (a7ecf4b)

Performance Improvements #

  • use "sideEffects" listing in package.json (7271614)
  • use imported TypeScript helpers instead of inlining them (cc2bd0a)

Reverts #

  • Revert "chore: release new versions" (a6d655d)

0.9.6 (2023-04-05) #

Note: Version bump only for package @spectrum-web-components/banner

0.9.5 (2023-03-22) #

Note: Version bump only for package @spectrum-web-components/banner

0.9.4 (2023-01-23) #

Note: Version bump only for package @spectrum-web-components/banner

0.9.3 (2023-01-09) #

Note: Version bump only for package @spectrum-web-components/banner

0.9.2 (2022-11-21) #

Note: Version bump only for package @spectrum-web-components/banner

0.9.1 (2022-11-14) #

Note: Version bump only for package @spectrum-web-components/banner

0.9.0 (2022-08-09) #

Features #

  • include all Dev Mode files in side effects (f70817c)

0.8.6 (2022-08-04) #

Note: Version bump only for package @spectrum-web-components/banner

0.8.5 (2022-06-29) #

Note: Version bump only for package @spectrum-web-components/banner

0.8.4 (2022-06-07) #

Note: Version bump only for package @spectrum-web-components/banner

0.8.3 (2022-05-12) #

Note: Version bump only for package @spectrum-web-components/banner

0.8.2 (2022-04-21) #

Note: Version bump only for package @spectrum-web-components/banner

0.8.1 (2022-03-08) #

Note: Version bump only for package @spectrum-web-components/banner

0.8.0 (2022-03-04) #

Features #

  • leverage latest Spectrum button API (9faeade)

0.7.2 (2022-02-22) #

Note: Version bump only for package @spectrum-web-components/banner

0.7.1 (2021-12-13) #

Note: Version bump only for package @spectrum-web-components/banner

0.7.0 (2021-11-08) #

Features #

  • update lit-* dependencies, wip (377f3c8)

0.6.8 (2021-11-08) #

Note: Version bump only for package @spectrum-web-components/banner

0.6.7 (2021-09-20) #

Note: Version bump only for package @spectrum-web-components/banner

0.6.6 (2021-08-24) #

Bug Fixes #

  • correct @element jsDoc listing across library (c97a632)

0.6.5 (2021-07-22) #

Note: Version bump only for package @spectrum-web-components/banner

0.6.4 (2021-06-16) #

Note: Version bump only for package @spectrum-web-components/banner

0.6.3 (2021-04-09) #

Note: Version bump only for package @spectrum-web-components/banner

0.6.2 (2021-03-22) #

Note: Version bump only for package @spectrum-web-components/banner

0.6.1 (2021-03-05) #

Note: Version bump only for package @spectrum-web-components/banner

0.6.0 (2021-03-04) #

Features #

  • use latest exports specification (a7ecf4b)

0.5.2 (2021-02-11) #

Bug Fixes #

  • update to latest spectrum-css packages (a5ca19f)

0.5.1 (2021-01-21) #

Bug Fixes #

  • include the "types" entry in package.json files (b432f59)
  • stop merging selectors in a way that alters the cascade (369388f)

0.5.0 (2021-01-13) #

Bug Fixes #

  • include the "types" entry in package.json files (b432f59)
  • stop merging selectors in a way that alters the cascade (369388f)

0.4.3 (2020-10-12) #

Note: Version bump only for package @spectrum-web-components/banner

0.4.2 (2020-10-12) #

Bug Fixes #

  • include default export in the "exports" fields (f32407d)

0.4.1 (2020-09-25) #

Bug Fixes #

  • update side effect listings (8160d3a)

0.4.0 (2020-08-31) #

Features #

  • update to Spectrum CSS v3.0.0 (e8b3d8f)

0.3.1 (2020-08-19) #

Note: Version bump only for package @spectrum-web-components/banner

0.3.0 (2020-07-17) #

Features #

  • leverage "exports" field in package.json (321abd7)

0.2.6 (2020-06-08) #

Note: Version bump only for package @spectrum-web-components/banner

0.2.5 (2020-04-16) #

Performance Improvements #

  • use "sideEffects" listing in package.json (7271614)

0.2.4 (2020-04-07) #

Note: Version bump only for package @spectrum-web-components/banner

0.2.3 (2020-03-11) #

Note: Version bump only for package @spectrum-web-components/banner

0.2.2 (2020-01-06) #

Note: Version bump only for package @spectrum-web-components/banner

0.2.1 (2019-11-27) #

Bug Fixes #

  • include "type" in package.json, generate custom-elements.json (1a8d716)

0.2.0 (2019-11-19) #

Features #

  • use @adobe/spectrum-css@2.15.1 (3918888)

0.1.4 (2019-10-14) #

Performance Improvements #

  • use imported TypeScript helpers instead of inlining them (cc2bd0a)

0.1.3 (2019-10-03) #

Note: Version bump only for package @spectrum-web-components/banner

Description #

An <sp-banner> is an additional label an existing component may have. Banners cannot be interacted with. Banners in Spectrum have three variations for different uses as well as the ability to place it overlaid in the top-right corner of a container.

Usage #

See it on NPM! How big is this package in your project? Try it on webcomponents.dev

yarn add @spectrum-web-components/banner

Import the side effectful registration of <sp-banner> via:

import '@spectrum-web-components/banner/sp-banner.js';

When looking to leverage the Banner base class as a type and/or for extension purposes, do so via:

import { Banner } from '@spectrum-web-components/banner';

Example #

<sp-banner>
    <div slot="header">Header text</div>
    <div slot="content">Content of the banner</div>
</sp-banner>

Variants #

Info banners #

Banners intended for providing information. This is the default banner variant.

<sp-banner type="info">
    <div slot="header">This is an info banner</div>
    <div slot="content">Description here</div>
</sp-banner>

Error banners #

Banners intended to indicate an error as occurred, with a brief description of the issue. More severe than a warning banner.

<sp-banner type="error">
    <div slot="header">This is an error banner</div>
    <div slot="content">Something bad happened</div>
</sp-banner>

Corner placement #

In addition to the variant, banners can be placed in the top-right corner of its container by giving them a corner prop. Note that the position of the containing element needs to be either relative or absolute

<div
    style="width: 300px; max-width: 75%; height: 100px; background-color: #ba598b; position: relative;"
>
    <sp-banner corner>
        <div slot="header">This banner is in a corner</div>
        <div slot="content">Neat!</div>
    </sp-banner>
</div>

Accessibility #

A Banner does not have a default semantic role communicated to assistive technology, but it does accept id, role and other aria- props that can be added to to improve accessibility depending on context.