Cell 单元格

介绍

单元格为列表中的单个展示项。

引入

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

  1. import { createApp } from 'vue';
  2. import { Cell, CellGroup } from 'vant';
  3. const app = createApp();
  4. app.use(Cell);
  5. app.use(CellGroup);

代码演示

基础用法

Cell 可以单独使用,也可以与 CellGroup 搭配使用,CellGroup 可以为 Cell 提供上下外边框。

  1. <van-cell-group>
  2. <van-cell title="单元格" value="内容" />
  3. <van-cell title="单元格" value="内容" label="描述信息" />
  4. </van-cell-group>

卡片风格

通过 CellGroupinset 属性,可以将单元格转换为圆角卡片风格(从 3.1.0 版本开始支持)。

  1. <van-cell-group inset>
  2. <van-cell title="单元格" value="内容" />
  3. <van-cell title="单元格" value="内容" label="描述信息" />
  4. </van-cell-group>

单元格大小

通过 size 属性可以控制单元格的大小。

  1. <van-cell title="单元格" value="内容" size="large" />
  2. <van-cell title="单元格" value="内容" size="large" label="描述信息" />

展示图标

通过 icon 属性在标题左侧展示图标。

  1. <van-cell title="单元格" icon="location-o" />

只设置 value

只设置 value 时,内容会靠左对齐。

  1. <van-cell value="内容" />

展示箭头

设置 is-link 属性后会在单元格右侧显示箭头,并且可以通过 arrow-direction 属性控制箭头方向。

  1. <van-cell title="单元格" is-link />
  2. <van-cell title="单元格" is-link value="内容" />
  3. <van-cell title="单元格" is-link arrow-direction="down" value="内容" />

页面导航

可以通过 url 属性进行 URL 跳转,或通过 to 属性进行路由跳转。

  1. <van-cell title="URL 跳转" is-link url="https://github.com" />
  2. <van-cell title="路由跳转" is-link to="index" />

分组标题

通过 CellGrouptitle 属性可以指定分组标题。

  1. <van-cell-group title="分组1">
  2. <van-cell title="单元格" value="内容" />
  3. </van-cell-group>
  4. <van-cell-group title="分组2">
  5. <van-cell title="单元格" value="内容" />
  6. </van-cell-group>

使用插槽

如以上用法不能满足你的需求,可以使用插槽来自定义内容。

  1. <van-cell value="内容" is-link>
  2. <!-- 使用 title 插槽来自定义标题 -->
  3. <template #title>
  4. <span class="custom-title">单元格</span>
  5. <van-tag type="danger">标签</van-tag>
  6. </template>
  7. </van-cell>
  8. <van-cell title="单元格" icon="shop-o">
  9. <!-- 使用 right-icon 插槽来自定义右侧图标 -->
  10. <template #right-icon>
  11. <van-icon name="search" class="search-icon" />
  12. </template>
  13. </van-cell>
  14. <style>
  15. .custom-title {
  16. margin-right: 4px;
  17. vertical-align: middle;
  18. }
  19. .search-icon {
  20. font-size: 16px;
  21. line-height: inherit;
  22. }
  23. </style>

垂直居中

通过 center 属性可以让 Cell 的左右内容都垂直居中。

  1. <van-cell center title="单元格" value="内容" label="描述信息" />

API

CellGroup Props

参数说明类型默认值
title分组标题string-
inset v3.1.0是否展示为圆角卡片风格booleanfalse
border是否显示外边框booleantrue

Cell Props

参数说明类型默认值
title左侧标题number | string-
value右侧内容number | string-
label标题下方的描述信息string-
size单元格大小,可选值为 largestring-
icon左侧图标名称或图片链接,等同于 Icon 组件的 name 属性string-
icon-prefix图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringvan-icon
url点击后跳转的链接地址string-
to点击后跳转的目标路由对象,等同于 vue-router 的 to 属性string | object-
border是否显示内边框booleantrue
replace是否在跳转时替换当前页面历史booleanfalse
clickable是否开启点击反馈booleannull
is-link是否展示右侧箭头并开启点击反馈booleanfalse
required是否显示表单必填星号booleanfalse
center是否使内容垂直居中booleanfalse
arrow-direction箭头方向,可选值为 left up downstringright
title-style左侧标题额外样式string | Array | object-
title-class左侧标题额外类名string | Array | object-
value-class右侧内容额外类名string | Array | object-
label-class描述信息额外类名string | Array | object-

Cell Events

事件名说明回调参数
click点击单元格时触发event: MouseEvent

CellGroup Slots

名称说明
default默认插槽
title自定义分组标题

Cell Slots

名称说明
title自定义左侧标题
value v3.1.1自定义右侧内容
label自定义标题下方的描述信息
icon自定义左侧图标
right-icon自定义右侧图标
extra自定义单元格最右侧的额外内容

类型定义

组件导出以下类型定义:

  1. import type {
  2. CellSize,
  3. CellProps,
  4. CellGroupProps,
  5. CellArrowDirection,
  6. } from 'vant';

主题定制

样式变量

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

名称默认值描述
—van-cell-font-sizevar(—van-font-size-md)-
—van-cell-line-height24px-
—van-cell-vertical-padding10px-
—van-cell-horizontal-paddingvar(—van-padding-md)-
—van-cell-text-colorvar(—van-text-color)-
—van-cell-background-colorvar(—van-background-color-light)-
—van-cell-border-colorvar(—van-border-color)-
—van-cell-active-colorvar(—van-active-color)-
—van-cell-required-colorvar(—van-danger-color)-
—van-cell-label-colorvar(—van-text-color-2)-
—van-cell-label-font-sizevar(—van-font-size-sm)-
—van-cell-label-line-heightvar(—van-line-height-sm)-
—van-cell-label-margin-topvar(—van-padding-base)-
—van-cell-value-colorvar(—van-text-color-2)-
—van-cell-icon-size16px-
—van-cell-right-icon-colorvar(—van-gray-6)-
—van-cell-large-vertical-paddingvar(—van-padding-sm)-
—van-cell-large-title-font-sizevar(—van-font-size-lg)-
—van-cell-large-label-font-sizevar(—van-font-size-md)-
—van-cell-group-background-colorvar(—van-background-color-light)-
—van-cell-group-title-colorvar(—van-text-color-2)-
—van-cell-group-title-paddingvar(—van-padding-md) var(—van-padding-md) var(—van-padding-xs)-
—van-cell-group-title-font-sizevar(—van-font-size-md)-
—van-cell-group-title-line-height16px-
—van-cell-group-inset-padding0 var(—van-padding-md)-
—van-cell-group-inset-border-radiusvar(—van-border-radius-lg)-
—van-cell-group-inset-title-paddingvar(—van-padding-md) var(—van-padding-md) var(—van-padding-xs) var(—van-padding-xl)-

Cell 单元格 - 图1