Vant4 Vant4 Empty 空状态

2024-02-25 开发教程 Vant4 匿名 3

介绍

空状态时的占位提示。

引入

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

import { createApp } from 'vue';
import { Empty } from 'vant';
const app = createApp();
app.use(Empty);

代码演示

基础用法

<van-empty description="描述文字" />

图片类型

Empty 组件内置了多种占位图片类型,可以在不同业务场景下使用。

<!-- 通用错误 -->
<van-empty image="error" description="描述文字" />
<!-- 网络错误 -->
<van-empty image="network" description="描述文字" />
<!-- 搜索提示 -->
<van-empty image="search" description="描述文字" />

自定义大小

通过 ​image-size​ 属性图片的大小。

<!-- 不指定单位,默认为 px -->
<van-empty image-size="100" description="描述文字" />
<!-- 指定单位,支持 rem, vh, vw -->
<van-empty image-size="10rem" description="描述文字" />

将 ​image-size​ 设置为数组格式,可以分别设置宽高。数组第一项对应宽度,数组第二项对应高度。

<van-empty :image-size="[60, 40]" description="描述文字" />

自定义图片

需要自定义图片时,可以在 image 属性中传入任意图片 URL。

<van-empty
image="https://fastly.jsdelivr.net/npm/@vant/assets/custom-empty-image.png"
image-size="80"
description="描述文字"
/>

底部内容

通过默认插槽可以在 Empty 组件的下方插入内容。

<van-empty description="描述文字">
<van-button round type="primary" class="bottom-button">按钮</van-button>
</van-empty>
<style>
.bottom-button {
width: 160px;
height: 40px;
}
</style>

API

Props

参数说明类型默认值
image图片类型,可选值为 errornetworksearch,支持传入图片 URLstring default
image-size图片大小,默认单位为 pxnumber | string | Array -
description图片下方的描述文字string -

Slots

名称说明
default自定义底部内容
image自定义图标
description自定义描述文字

类型定义

组件导出以下类型定义:

import type { EmptyProps } from 'vant';

主题定制

样式变量

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

名称默认值描述
--van-empty-paddingvar(--van-padding-xl) 0 -
--van-empty-image-size160px -
--van-empty-description-margin-topvar(--van-padding-md) -
--van-empty-description-padding0 60px -
--van-empty-description-colorvar(--van-text-color-2) -
--van-empty-description-font-sizevar(--van-font-size-md) -
--van-empty-description-line-heightvar(--van-line-height-md) -
--van-empty-bottom-margin-top24px -