Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@material/banner

Package Overview
Dependencies
Maintainers
15
Versions
1111
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/banner

The Material Components Web banner component.

  • 14.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
15
Created
Source

Banner

A banner displays a prominent message and related optional actions.

Banner example

Contents

  • Using banners
  • Banners
  • API
  • Usage within web frameworks

Using banners

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.

Installing banners

npm install @material/banner

Styles

@use "@material/banner/styles";

JavaScript instantiation

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.

Banners

Banner example

<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>

Variants

Centered

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;
}
Fixed banner

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>
Banner with graphic

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>
Banner with two actions

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>
Mobile stacked

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;
}

API

Sass mixins

Access to theme mixins require importing the banner's theme style module.

@use "@material/banner";
MixinDescription
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 events

Event nameevent.detailDescription
MDCBanner:closingMDCBannerCloseEventDetailIndicates when the banner begins its closing animation.
MDCBanner:closedMDCBannerCloseEventDetailIndicates 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 methods

PropertyValue TypeDescription
isOpenboolean (read-only)Returns whether the banner is open.
Method SignatureDescription
open() => voidOpens the banner.
close(reason: CloseReason) => voidCloses the banner, with the specified action indicating why it was closed.
getText() => stringGets the text of the banner.
setText(text: string) => voidSets the text of the banner.
getPrimaryActionText() => stringGets the banner's primary action text.
setPrimaryActionText(actionButtonText: string) => voidSets the banner's primary action text.
getSecondaryActionText() => string | nullGets the banner's secondary action text. Returns null if the banner has no secondary action.
setSecondaryActionText(actionButtonText: string) => voidSets the banner's secondary action text.
layout() => voidRecalculates layout. With height being calculated dynamically recommended to call on window resize events.

Usage within frameworks

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.

Keywords

FAQs

Package last updated on 28 Apr 2022

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc