Skip to content

Cell 单元格

介绍

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

引入

通过以下方式来引入组件。

js
import { createApp } from 'vue';
import { Cell, CellGroup } from '@szhn/dh-design-mobile';

const app = createApp();
app.use(Cell);
app.use(CellGroup);

代码演示

基础用法

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

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

卡片风格

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

html
<van-cell-group inset>
  <van-cell title="单元格" value="内容" />
  <van-cell title="单元格" value="内容" label="描述信息" />
</van-cell-group>

单元格大小

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

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

展示图标

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

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

展示箭头

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

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

页面导航

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

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

分组标题

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

html
<van-cell-group title="分组1">
  <van-cell title="单元格" value="内容" />
</van-cell-group>
<van-cell-group title="分组2">
  <van-cell title="单元格" value="内容" />
</van-cell-group>

使用插槽

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

html
<van-cell value="内容" is-link>
  <!-- 使用 title 插槽来自定义标题 -->
  <template #title>
    <span class="custom-title">单元格</span>
    <van-tag type="primary">标签</van-tag>
  </template>
</van-cell>

<van-cell title="单元格" icon="shop-o">
  <!-- 使用 right-icon 插槽来自定义右侧图标 -->
  <template #right-icon>
    <van-icon name="search" class="search-icon" />
  </template>
</van-cell>

<style>
  .custom-title {
    margin-right: 4px;
    vertical-align: middle;
  }

  .search-icon {
    font-size: 16px;
    line-height: inherit;
  }
</style>

垂直居中

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

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

API

CellGroup Props

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

Cell Props

参数说明类型默认值
title左侧标题number | string-
value右侧内容number | string-
label标题下方的描述信息number | string-
size单元格大小,可选值为 large normalstring-
icon左侧图标名称或图片链接,等同于 Icon 组件的 name 属性string-
icon-prefix图标类名前缀,等同于 Icon 组件的 class-prefix 属性stringvan-icon
tag根节点对应的 HTML 标签名stringdiv
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自定义右侧内容
label自定义标题下方的描述信息
icon自定义左侧图标
right-icon自定义右侧图标
extra自定义单元格最右侧的额外内容

类型定义

组件导出以下类型定义:

ts
import type {
  CellSize,
  CellProps,
  CellGroupProps,
  CellArrowDirection,
} from '@szhn/dh-design-mobile';

主题定制

样式变量

组件提供了下列 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-backgroundvar(--van-background-2)单元格的背景色
--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-value-font-sizeinherit右侧内容的字体大小
--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-large-value-font-sizeinherit大尺寸单元格右侧内容的字体大小
--van-cell-group-backgroundvar(--van-background-2)单元格组的背景色
--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-radiusvar(--van-radius-lg)嵌入式单元格组的圆角大小
--van-cell-group-inset-title-paddingvar(--van-padding-md) var(--van-padding-md) var(--van-padding-xs) var(--van-padding-xl)嵌入式单元格组标题的内边距