@zebra-fed/zeta-web
    Preparing search index...

    Class ZetaInPageBanner

    In page banners display an important, succinct message, and may provide actions for users to address. Banners should be displayed at the top of the screen, below a top app bar. Only one banner should be shown at a time.

    This component represents a banner that can be displayed within a page. It can have a title, body content, and various status options.

    • The main content of the banner.

    action - The action buttons.

    header - The header section containing the title.

    body - The body section containing the main content.

    footer - The footer section containing action buttons.

    close - Fired when the close icon is clicked.

    --banner-border-color - The border color of the banner.

    --banner-background-color - The background color of the banner.

    --banner-foreground-color - The foreground color of the banner.

    --banner-icon-color - The icon color of the banner.

    https://www.figma.com/file/JesXQFLaPJLc1BdBM4sisI/🦓-ZDS---Components?node-id=21156-27071

    https://design.zebra.com/web/storybook/?path=/docs/components-in-page-banner--docs

    Hierarchy

    • ContourableInterface<this> & LitElement<this>
      • ZetaInPageBanner
    Index

    Other

    constructor canClose icon? rounded showIcon status title styles close

    rendering

    render

    Other

    • Returns ZetaInPageBanner

    canClose: boolean = true

    Whether the banner can be closed by the user.

    icon?: ZetaIconName

    Custom icon to replace default.

    Default icons are:

    • positive: check_circle
    • negative: error
    • warning: warning
    • info: info
    • default: info
    rounded: boolean
    showIcon: boolean = true

    Whether the icon should be displayed.

    status: "positive" | "negative" | "info" | "warning" | "default" = "default"

    Status of the component.

    title: string = ""

    Title of the banner, displayed at the top.

    styles: CSSResultGroup[] = ...

    rendering

    • Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

      Returns TemplateResult<1>

    Settings

    Member Visibility

    On This Page

    Other
    rendering