Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@material/banner
Advanced tools
A banner displays a prominent message and related optional actions.
Contents
A banner displays an important, succinct message, and provides actions for users to address (or dismiss the banner). It requires a user action to be dismissed.
Banners should be displayed at the top of the screen, below a top app bar. They’re persistent and nonmodal, allowing the user to either ignore them or interact with them at any time. Only one banner should be shown at a time.
npm install @material/banner
@use "@material/banner/styles";
import {MDCBanner} from '@material/banner';
const banner = new MDCBanner(document.querySelector('.mdc-banner'));
See Importing the JS component for more information on how to import JavaScript.
<div class="mdc-banner" role="banner">
<div class="mdc-banner__content"
role="alertdialog"
aria-live="assertive">
<div class="mdc-banner__graphic-text-wrapper">
<div class="mdc-banner__text">
There was a problem processing a transaction on your credit card.
</div>
</div>
<div class="mdc-banner__actions">
<button type="button" class="mdc-button mdc-banner__primary-action">
<div class="mdc-button__ripple"></div>
<div class="mdc-button__label">Fix it</div>
</button>
</div>
</div>
</div>
By default, banners are positioned as leading.
They can optionally be displayed centered by adding the mdc-banner--centered
modifier class to the root element:
<div class="mdc-banner mdc-banner--centered">
...
</div>
Alternatively, you can call the position-centered
mixin from Sass:
.my-banner {
@include banner.position-centered;
}
When used below top app bars, banners should remain fixed at the top of the screen. This can be done by adding the mdc-banner__fixed
wrapper element around the content element:
<div class="mdc-banner" role="banner">
<div class="mdc-banner__fixed">
<div class="mdc-banner__content"
role="alertdialog"
aria-live="assertive">
<div class="mdc-banner__graphic-text-wrapper">
<div class="mdc-banner__text">
There was a problem processing a transaction on your credit card.
</div>
</div>
<div class="mdc-banner__actions">
<button type="button" class="mdc-button mdc-banner__primary-action">
<div class="mdc-button__ripple"></div>
<div class="mdc-button__label">Fix it</div>
</button>
</div>
</div>
</div>
</div>
Images can help communicate a banner’s message.
<div class="mdc-banner" role="banner">
<div class="mdc-banner__content"
role="alertdialog"
aria-live="assertive">
<div class="mdc-banner__graphic-text-wrapper">
<div class="mdc-banner__graphic" role="img" alt=""><i class="material-icons mdc-banner__icon">error_outline</i></div>
<div class="mdc-banner__text">
There was a problem processing a transaction on your credit card.
</div>
</div>
<div class="mdc-banner__actions">
<button type="button" class="mdc-button mdc-banner__primary-action">
<div class="mdc-button__ripple"></div>
<div class="mdc-button__label">Fix it</div>
</button>
</div>
</div>
</div>
Banners may have one or two low-emphasis text buttons.
<div class="mdc-banner" role="banner">
<div class="mdc-banner__content"
role="alertdialog"
aria-live="assertive">
<div class="mdc-banner__graphic-text-wrapper">
<div class="mdc-banner__text">
There was a problem processing a transaction on your credit card.
</div>
</div>
<div class="mdc-banner__actions">
<button type="button" class="mdc-button mdc-banner__secondary-action">
<div class="mdc-button__ripple"></div>
<div class="mdc-button__label">Learn more</div>
</button>
<button type="button" class="mdc-button mdc-banner__primary-action">
<div class="mdc-button__ripple"></div>
<div class="mdc-button__label">Fix it</div>
</button>
</div>
</div>
</div>
On mobile view, banners with long text should have their action(s) be positioned below the text instead of alongside it. This can be accomplished by adding the mdc-banner--mobile-stacked
modifier class to the root element:
<div class="mdc-banner mdc-banner--mobile-stacked">
...
</div>
Alternatively, banner can be in stacked layout regardless of mobile-breakpoint, with the layout-stacked
mixin from Sass:
.my-banner {
@include banner-theme.layout-stacked;
}
Access to theme mixins require importing the banner's theme style module.
@use "@material/banner";
Mixin | Description |
---|---|
fill-color($color) | Sets the fill color of the banner. |
text-color($color) | Sets the color of the banners's text. |
divider-color($color) | Sets the color of the banner's divider. |
min-width($min-width, $mobile-breakpoint) | Sets the min-width of the banner content on tablet/desktop devices. On mobile, the width is automatically set to 100%. |
max-width($max-width) | Sets the max-width of the banner content. |
position-centered() | Sets the banner content to centered instead of leading. |
z-index($z-index) | Sets the z-index of the banner. |
MDCBanner
eventsEvent name | event.detail | Description |
---|---|---|
MDCBanner:closing | MDCBannerCloseEventDetail | Indicates when the banner begins its closing animation. |
MDCBanner:closed | MDCBannerCloseEventDetail | Indicates when the banner finishes its closing animation. |
MDCBanner:opening | {} | Indicates when the banner begins its opening animation. |
MDCBanner:opened | {} | Indicates when the banner finishes its opening animation. |
MDCBanner
properties and methodsProperty | Value Type | Description |
---|---|---|
isOpen | boolean (read-only) | Returns whether the banner is open. |
Method Signature | Description |
---|---|
open() => void | Opens the banner. |
close(reason: CloseReason) => void | Closes the banner, with the specified action indicating why it was closed. |
getText() => string | Gets the text of the banner. |
setText(text: string) => void | Sets the text of the banner. |
getPrimaryActionText() => string | Gets the banner's primary action text. |
setPrimaryActionText(actionButtonText: string) => void | Sets the banner's primary action text. |
getSecondaryActionText() => string | null | Gets the banner's secondary action text. Returns null if the banner has no secondary action. |
setSecondaryActionText(actionButtonText: string) => void | Sets the banner's secondary action text. |
layout() => void | Recalculates layout. With height being calculated dynamically recommended to call on window resize events. |
If you are using a JavaScript framework, such as React or Angular, you can create a banner for your framework. Depending on your needs, you can use the Simple Approach: Wrapping MDC Web Vanilla Components, or the Advanced Approach: Using Foundations and Adapters. Please follow the instructions here.
See MDCBannerAdapter and MDCBannerFoundation for up-to-date code documentation of banner foundation APIs.
FAQs
The Material Components Web banner component.
The npm package @material/banner receives a total of 655,325 weekly downloads. As such, @material/banner popularity was classified as popular.
We found that @material/banner demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.