---
title: Banner
description: >-
  Highlights important information or required actions prominently within the
  interface. Use to communicate statuses, provide feedback, or draw attention to
  critical updates.
api_name: app-home
source_url:
  html: 'https://shopify.dev/docs/api/app-home/polaris-web-components/feedback/banner'
  md: >-
    https://shopify.dev/docs/api/app-home/polaris-web-components/feedback/banner.md
---

# Banner

Highlights important information or required actions prominently within the interface. Use to communicate statuses, provide feedback, or draw attention to critical updates.

## Properties

* dismissible

  boolean

  Default: false

  Determines whether the close button of the banner is present.

  When the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire.

* heading

  string

  Default: ''

  The title of the banner.

* hidden

  boolean

  Default: false

  Determines whether the banner is hidden.

  If this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires.

  If the banner is not `dismissible`, it can still be hidden by setting this property.

* tone

  "info" | "success" | "warning" | "critical" | "auto"

  Default: 'auto'

  Sets the tone of the Banner, based on the intention of the information being conveyed.

  The banner is a live region and the type of status will be dictated by the Tone selected.

  * `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.
  * `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.

## Events

Learn more about [registering events](https://shopify.dev/docs/api/app-home/using-polaris-components#event-handling).

* afterhide

  CallbackEventListener\<typeof tagName> | null

* dismiss

  CallbackEventListener\<typeof tagName> | null

### CallbackEventListener

```ts
(EventListener & {
      (event: CallbackEvent<T>): void;
    }) | null
```

### CallbackEvent

```ts
Event & {
  currentTarget: HTMLElementTagNameMap[T];
}
```

## Slots

* children

  HTMLElement

  The content of the Banner.

* secondary-actions

  HTMLElement

  The secondary actions to display at the bottom of the Banner.

  Only Buttons with the `variant` of "secondary" or "auto" are permitted. A maximum of two `s-button` components are allowed.

## Outside of a section

Banners placed outside of a section will display in their own card and should be located at the top of the page. They're useful for conveying messages that apply to the entire page or areas not visible within the viewport, such as validation errors further down the page.

## In a section

Banners placed inside a section will have styles applied contextually. They're useful for conveying messages relevant to a specific section or piece of content.

## Best practices

* Seeing these banners can be stressful, so use them sparingly to avoid overwhelming users.
* Focus on a single piece of information or required action to avoid overwhelming users.
* Make the message concise and scannable. Users shouldn’t need to spend a lot of time figuring out what they need to know and do.
* Info, Warning and Critical banners should contain a call to action and clear next steps. Users should know what to do after seeing the banner.
* Avoid banners that can't be dismissed unless the user is required to take action.

## Examples

Component examples

### Basic usage