阅读(4035) (0)

Vant4 ActionBar 动作栏

2022-12-08 14:24:45 更新

介绍

用于为页面相关操作提供便捷交互。

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

import { createApp } from 'vue';
import { ActionBar, ActionBarIcon, ActionBarButton } from 'vant';

const app = createApp();
app.use(ActionBar);
app.use(ActionBarIcon);
app.use(ActionBarButton);

代码演示

基础用法

<van-action-bar>
  <van-action-bar-icon icon="chat-o" text="客服" @click="onClickIcon" />
  <van-action-bar-icon icon="cart-o" text="购物车" @click="onClickIcon" />
  <van-action-bar-icon icon="shop-o" text="店铺" @click="onClickIcon" />
  <van-action-bar-button type="danger" text="立即购买" @click="onClickButton" />
</van-action-bar>
import { showToast } from 'vant';

export default {
  setup() {
    const onClickIcon = () => showToast('点击图标');
    const onClickButton = () => showToast('点击按钮');
    return {
      onClickIcon,
      onClickButton,
    };
  },
};

徽标提示

在 ActionBarIcon 组件上设置 ​dot​ 属性后,会在图标右上角展示一个小红点;设置 ​badge​ 属性后,会在图标右上角展示相应的徽标。

<van-action-bar>
  <van-action-bar-icon icon="chat-o" text="客服" dot />
  <van-action-bar-icon icon="cart-o" text="购物车" badge="5" />
  <van-action-bar-icon icon="shop-o" text="店铺" badge="12" />
  <van-action-bar-button type="warning" text="加入购物车" />
  <van-action-bar-button type="danger" text="立即购买" />
</van-action-bar>

自定义图标颜色

通过 ActionBarIcon 的 ​color​ 属性可以自定义图标的颜色。

<van-action-bar>
  <van-action-bar-icon icon="chat-o" text="客服" color="#ee0a24" />
  <van-action-bar-icon icon="cart-o" text="购物车" />
  <van-action-bar-icon icon="star" text="已收藏" color="#ff5000" />
  <van-action-bar-button type="warning" text="加入购物车" />
  <van-action-bar-button type="danger" text="立即购买" />
</van-action-bar>

自定义按钮颜色

通过 ActionBarButton 的 ​color​ 属性可以自定义按钮的颜色,支持传入 ​linear-gradient​ 渐变色。

<van-action-bar>
  <van-action-bar-icon icon="chat-o" text="客服" />
  <van-action-bar-icon icon="shop-o" text="店铺" />
  <van-action-bar-button color="#be99ff" type="warning" text="加入购物车" />
  <van-action-bar-button color="#7232dd" type="danger" text="立即购买" />
</van-action-bar>

API

ActionBar Props

参数 说明 类型 默认值
safe-area-inset-bottom 是否开启底部安全区适配 boolean true
placeholder v3.5.1 是否在标签位置生成一个等高的占位元素 boolean false

ActionBarIcon Props

参数 说明 类型 默认值
text 按钮文字 string -
icon 图标 string -
color 图标颜色 string #323233
icon-class 图标额外类名 string | Array | object -
icon-prefix v3.0.17 图标类名前缀,等同于 Icon 组件的 class-prefix 属性 string van-icon
dot 是否显示图标右上角小红点 boolean false
badge 图标右上角徽标的内容 number | string -
badge-props v3.2.8 自定义徽标的属性,传入的对象会被透传给 Badge 组件的 props BadgeProps -
url 点击后跳转的链接地址 string -
to 点击后跳转的目标路由对象,等同于 vue-router 的 to 属性 string | object -
replace 是否在跳转时替换当前页面历史 boolean false

ActionBarButton Props

参数 说明 类型 默认值
text 按钮文字 string -
type 按钮类型,可选值为 primary info warning danger string default
color 按钮颜色,支持传入 linear-gradient 渐变色 string -
icon 左侧图标名称或图片链接,等同于 Icon 组件的 name 属性 string -
disabled 是否禁用按钮 boolean false
loading 是否显示为加载状态 boolean false
url 点击后跳转的链接地址 string -
to 点击后跳转的目标路由对象,等同于 vue-router 的 to 属性 string | object -
replace 是否在跳转时替换当前页面历史 boolean false

ActionBarIcon Slots

名称 说明
default 文本内容
icon 自定义图标

ActionBarButton Slots

名称 说明
default 按钮显示内容

类型定义

组件导出以下类型定义:

import type {
  ActionBarProps,
  ActionBarIconProps,
  ActionBarButtonProps,
} from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称 默认值 描述
--van-action-bar-background var(--van-background-2) -
--van-action-bar-height 50px -
--van-action-bar-icon-width 48px -
--van-action-bar-icon-height 100% -
--van-action-bar-icon-color var(--van-text-color) -
--van-action-bar-icon-size 18px -
--van-action-bar-icon-font-size var(--van-font-size-xs) -
--van-action-bar-icon-active-color var(--van-active-color) -
--van-action-bar-icon-text-color var(--van-text-color) -
--van-action-bar-icon-background var(--van-background-2) -
--van-action-bar-button-height 40px -
--van-action-bar-button-warning-color var(--van-gradient-orange) -
--van-action-bar-button-danger-color var(--van-gradient-red) -