1.0.2 • Published 1 month ago

@tanzhenxing/zx-list-item v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
1 month ago

zx-list-item 列表项组件

一个基于 uni-app、Vue3 语法开发的高兼容性列表项组件,适配 H5、小程序、App。可嵌入于 zx-list 组件中,支持丰富的内容、图标、角标、开关、跳转等功能,适合自定义各类列表场景。

✨ 组件特性

  • 支持多端(H5、App、各类小程序)
  • 可插入 zx-list 作为列表项
  • 支持标题、描述、图标、角标、右侧内容、开关、跳转等
  • 事件丰富,便于扩展
  • 不依赖浏览器特有 DOM
  • 使用 Vue3 语法

📦 属性(Props)

属性名类型默认值说明
titleString''标题
noteString''描述
ellipsisNumber/String0标题省略行数(0不省略)
disabledBoolean/Stringfalse是否禁用
clickableBooleanfalse是否开启点击反馈
showArrowBoolean/Stringfalse是否显示右侧箭头
linkBoolean/Stringfalse是否跳转/跳转类型
toString''跳转目标页面
showBadgeBoolean/Stringfalse是否显示数字角标
badgeTextString''角标内容
badgeTypeString'success'角标类型
badgeStyleObject{}角标样式
rightTextString''右侧文字内容
thumbString''左侧缩略图
thumbSizeString'base'缩略图大小(lg/base/sm)
showExtraIconBoolean/Stringfalse是否显示扩展图标
extraIconObject{type:'',color:'#000',size:20,customPrefix:''}扩展图标参数
borderBooleantrue是否显示左侧边框
customStyleObject{padding:'',backgroundColor:'#fff'}自定义样式
showSwitchBoolean/Stringfalse是否显示Switch
switchCheckedBoolean/StringfalseSwitch是否被选中
keepScrollPositionBooleanfalsenvue下cell是否保持滚动位置
directionString'row'排版方向 row/column

🧲 事件(Events)

事件名说明回调参数
click点击项时触发{data}
switchChange切换Switch时e.detail

🧩 插槽(Slots)

  • header:自定义左侧内容
  • body:自定义中间内容
  • footer:自定义右侧内容

🛠️ 平台兼容性

  • H5
  • App(iOS/Android)
  • 微信/支付宝/百度/抖音/QQ/快手等主流小程序

🚀 基础用法

<template>
  <zx-list>
    <zx-list-item title="标题" note="描述" right-text="更多" />
    <zx-list-item title="带图标" thumb="https://cdn.uviewui.com/uview/common/logo.png" />
    <zx-list-item title="可点击" clickable @click="onItemClick" />
  </zx-list>
</template>

<script setup>
import zxList from '@/components/zx-list/zx-list.vue'
import zxListItem from '@/components/zx-list-item/zx-list-item.vue'
function onItemClick(e) {
  // 处理点击
}
</script>

🌈 插槽自定义内容

<zx-list-item>
  <template #header>
    <image src="..." style="width:24px;height:24px;" />
  </template>
  <template #body>
    <view>自定义内容</view>
  </template>
  <template #footer>
    <text>右侧自定义</text>
  </template>
</zx-list-item>

🎯 跳转用法

<zx-list-item title="跳转页面" link="navigateTo" to="/pages/demo/index" clickable />

💡 注意事项

  • 需配合 zx-list 组件使用,便于统一列表风格。
  • 组件已使用 语法,推荐配合 Vue3/uni-app3 项目使用。
  • nvue 平台下部分属性/事件才生效,详见 uni-app 官方文档。

如需更复杂的列表项样式,建议配合自定义插槽或样式扩展。