Feedback · Banner

Banner

The Banner component is usually used to identify the status or notification of the full page. It is usually resident and requires the user to close it initiatively.

Demos

How to import

<script setup lang="ts">
    import { Banner } from '@fibrous/semi-ui-vue';
</script>

Basic Usage

Code
<script setup lang="ts">
    import { ref } from 'vue';
    import { Banner, Button, Layout } from '@fibrous/semi-ui-vue';

    const visible = ref(false);
    const toggle = () => {
        visible.value = !visible.value;
    };

    const commonStyle = {
        height: '64px',
        lineHeight: '64px',
        background: 'var(--semi-color-fill-0)',
    };
</script>

<template>
    <Layout class="components-layout-demo banner-basic">
        <Layout.Header :style="commonStyle">Header</Layout.Header>
        <Banner v-if="visible" @close="toggle">
            <template #description>Semi D2C 现已支持 Figma DevMode, 安装插件,随时查阅图层对应的前端代码</template>
        </Banner>
        <Layout.Content style="height: 300px; line-height: 300px">Content</Layout.Content>
        <Layout.Footer :style="commonStyle">Footer</Layout.Footer>
    </Layout>
    <Button style="display: block; width: 120px; margin: 0 auto" @click="toggle">
        {{ visible ? 'Hide Banner' : 'Show Banner' }}
    </Button>
</template>

Types

The type prop supports one of: default(default),danger,warning, success.




Code
<script setup lang="ts">
    import { Banner } from '@fibrous/semi-ui-vue';
</script>

<template>
    <Banner type="info">
        <template #description>Semi D2C 现已支持 Figma DevMode, 安装插件,随时查阅图层对应的前端代码</template>
    </Banner>
    <br />
    <Banner type="warning">
        <template #description>当前使用 Figma UI Kit 为旧版,可能无法支持完整的 Design to code 能力</template>
    </Banner>
    <br />
    <Banner type="danger">
        <template #description>当前使用 API 已过期,请尽快升级</template>
    </Banner>
    <br />
    <Banner type="success">
        <template #description>Semi DSM, Make Semi Design to Any Design</template>
    </Banner>
</template>

Use in Container

You could set :fullMode="false" to use style for non-fullscreen mode. Also, use bordered for bordered style. Empty #icon and #closeIcon slots hide the icon and the close button.




Code
<script setup lang="ts">
    import { Banner, Typography } from '@fibrous/semi-ui-vue';

    const types = ['info', 'warning', 'danger', 'success'] as const;
</script>

<template>
    <div class="components-banner-demo" style="width: 640px">
        <template v-for="(type, index) in types" :key="type">
            <br v-if="index > 0" />
            <Banner bordered :fullMode="false" :type="type">
                <template #icon />
                <template #closeIcon />
                <template #title>
                    <div style="font-weight: 600; font-size: 14px; line-height: 20px">不知道 AppKey?</div>
                </template>
                <template #description>
                    <div>
                        你可先联系对应的研发同学,确认是否已在
                        <Typography.Text :link="{ href: 'https://semi.design/' }">应用云平台</Typography.Text>
                        申请了应用,并填写对应的信息。
                    </div>
                </template>
            </Banner>
        </template>
    </div>
</template>
.components-banner-demo {
    .semi-banner-info.semi-banner-bordered {
        border: 1px solid var(--semi-color-primary-disabled);
    }
    .semi-banner-warning.semi-banner-bordered {
        border: 1px solid var(--semi-color-warning-light-active);
    }
    .semi-banner-danger.semi-banner-bordered {
        border: 1px solid var(--semi-color-danger-light-active);
    }
    .semi-banner-success.semi-banner-bordered {
        border: 1px solid var(--semi-color-success-light-active);
    }
}

Customized Content

Use the default slot to create customized content.


Code
<script setup lang="ts">
    import { Banner } from '@fibrous/semi-ui-vue';
</script>

<template>
    <div style="width: 500px; padding: 20px; border: 1px solid var(--semi-color-border)">
        <Banner bordered :fullMode="false" title="Title" type="warning">
            <template #description> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat </template>
            <div class="semi-modal-footer">
                <button class="semi-button semi-button-tertiary semi-button-light" type="button">No, thanks.</button>
                <button class="semi-button semi-button-warning" type="button">Sounds great!</button>
            </div>
        </Banner>
        <br />
    </div>
</template>

API Reference

Props

PropertyDescriptionTypeDefault
borderedWhether to show a border. Only takes effect in non-full mode.booleansemiDefault("Banner", "bordered", false)
fullModeWhether the banner is in full mode.booleansemiDefault("Banner", "fullMode", true)
titlePlain-text title. The title slot wins when both are given.stringundefined
typeType: info, success, danger or warning.BannerTypesemiDefault("Banner", "type", "info")

Events

EventDescriptionCallback parameters
closeEmitted when the close button is clicked, with its native click event. The banner hides once the listeners return.[event: MouseEvent]

Slots

SlotDescriptionScope parameters
defaultCustom content below the message.any
descriptionDescription content.any
iconReplaces the icon of the type. An empty slot hides the icon.any
closeIconReplaces the icon in the close button. An empty slot removes the button.any
titleTitle content.any

Exposes

NameDescriptionType
None

class, style and native attributes are passed through attrs and land on the root element; the root's role="alert" is fixed and cannot be overridden. title is also a string prop, and the #title slot wins when both are given. Content of 0 in title, description and the default slot is rendered. The closed state lives inside the component and has no v-model; unmount and mount again with v-if to show it again.

Accessibility

ARIA

  • The component has a role of 'alert'.
  • The close button's aria-label comes from the current locale ('Close' in English, '关闭' in Simplified Chinese).

Keyboard and Focus

  • The close button of the Banner can be focused with the Tab key. After the button is focused, hit the Enter key or the Space key to close the banner.

Content Guidelines

  • Full screen Banner
    • Try to keep the content displayed completely on one line
    • Use correct punctuation, commas within sentences and periods between sentences
  • Non-fullscreen Banner
    • title
      • Instructions in condensed language
      • Try to avoid using commas, periods and other punctuation marks in the title, and support the use of question marks at the end when there are and only interrogative sentences
    • text
      • On the premise of complete information transmission, try to compress the text to 1-2 sentences
      • A detailed description or explanation of the title, rather than a repetition of the title
      • Use correct punctuation, commas within sentences and periods between sentences

Design Tokens

These are the component's internal Sass variables and cannot be overridden. To customize styles, override the --semi-* CSS variables (see the Design Token page) or write unlayered CSS rules.
Sass variableValueUsage
$color-banner_info-bg-defaultvar(--semi-color-info-light-default)背景色 - info
$color-banner_info-text-defaultvar(--semi-color-info)文本颜色 - info
$color-banner_info-border-defaultvar(--semi-color-info)描边颜色 - info
$color-banner_warning-bg-defaultvar(--semi-color-warning-light-default)背景色 - 警告
$color-banner_warning-text-defaultvar(--semi-color-warning)文本颜色 - 警告
$color-banner_warning-border-defaultvar(--semi-color-warning)描边颜色 - 警告
$color-banner_success-bg-defaultvar(--semi-color-success-light-default)背景色 - 成功
$color-banner_success-text-defaultvar(--semi-color-success)文本颜色 - 成功
$color-banner_success-border-defaultvar(--semi-color-success)描边颜色 - 成功
$color-banner_danger-bg-defaultvar(--semi-color-danger-light-default)背景色 - 危险
$color-banner_danger-text-defaultvar(--semi-color-danger)文本颜色 - 危险
$color-banner_danger-border-defaultvar(--semi-color-danger)描边颜色 - 危险
$radius-bannervar(--semi-border-radius-small)圆角
$spacing-banner_closeBtn-marginLeft$spacing-base-tight关闭按钮左边距
$spacing-banner_extra-marginTop$spacing-tight关闭按钮顶边距
$spacing-banner_icon-marginRight$spacing-base-tight关闭按钮顶边距
$spacing-banner-paddingX$spacing-base-tight整体水平内边距
$spacing-banner-paddingY$spacing-base-tight整体垂直内边距
$spacing-banner_title_description-marginTop2px标题与描述信息的间距
$height-banner_closeBtn24px关闭按钮高度
$width-banner_closeBtn24px关闭按钮宽度
$width-banner-border1px描边宽度