uni-app 组件总览
@ruanno-ui/uniapp 是 ruanno-ui 的跨端组件包:与 Web 端 97/97 同名对应,从 uni-app 渲染层重新实现,不依赖 window / document,目标平台覆盖 H5、微信小程序、App(含鸿蒙),并同时提供经典 uni-app(.vue)与 uni-app X(.uvue) 两套实现。
- 接入步骤见 uni-app 快速开始
- 运行中的手机预览见 在线预览(每个组件文档页内也嵌有对应组件的手机预览)
状态说明:
@ruanno-ui/uniapp当前为实验性预览,暂未发布到 npm(下文安装命令在包首发后可用);可先通过文档站手机预览或仓库内apps/uniapp-demo体验。
与 Web 组件的区别
| 维度 | Web 组件(ruanno-ui) | uni-app 组件(@ruanno-ui/uniapp) |
|---|---|---|
| 运行环境 | 浏览器(桌面 + H5) | uni-app H5 / 微信小程序 / App |
| 渲染层 | DOM + CSS 变量 + Pointer Events | <view> / <text> / <canvas> 等跨端标签 |
| 样式 | --rn-* CSS 变量(:root) | --rn-* CSS 变量(page) |
| 布尔绑定 | v-model:checked(Switch/Checkbox) | v-model |
| 图标 | SVG 内联 | base64 <image> |
| 滚动 / 定位 / 存储 | window / document | uni.* API |
| 包名 | ruanno-ui | @ruanno-ui/uniapp |
其余约定(size / variant / disabled / loading / 事件命名)两端完全一致,见 API 约定。
组件目录结构
每个组件目录包含四件套:
packages/uniapp/src/components/<Name>/
├── <Name>.vue # 经典 uni-app 实现
├── <Name>.uvue # uni-app X 实现
├── index.ts # 组件导出(同时导出 XxxUvue 别名)
└── meta.json # Props / Events / Slots / 示例的 AI 可读契约平台适用性
移动端推荐(H5 / 小程序 / App 体验均良好): 基础展示、表单、反馈、导航、移动交互类组件——Button、Cell、Dialog、Form、Picker、TabBar、PullRefresh、SwipeCell、IndexBar、各类验证码等 80+ 组件。
H5 推荐,小程序 / App 慎用(canvas 性能与交互限制): LineChart、BarChart、PieChart、ScatterChart、HeatmapChart、GraphChart。
桌面端为主,移动端不建议: Affix、Anchor、Backtop、Scrollbar、Menu、PageHeader、Table、Transfer、Tree、TreeSelect、Cascader、RichTextEditor、Watermark。小程序 / App 项目建议用 Drawer + TabBar + Cell 等组合替代桌面布局组件。
组件清单
按分类分组,点击进入对应 uni-app 组件文档(含 Props / Events / Slots / 示例代码与手机实时预览):
- Basic 基础组件(Button / Icon / Cell / CellGroup / Tag / Badge / Avatar / Title / Text / Card / Divider / Loading / Empty / Progress)
- Form 表单组件(Input / InputNumber / Textarea / Checkbox / Radio / RadioGroup / Switch / Rate / Slider / Picker / Calendar / DatePicker / TimePicker / TimeSelect / Select / AutoComplete / PinInput / Form / FormItem / Upload / ColorPicker / Search)
- Feedback 反馈组件(Dialog / Toast / Overlay / ActionSheet / Popconfirm / Popover / Tooltip / NoticeBar / Countdown / MessageBox / Notification / Drawer / Dropdown)
- Layout 布局组件(Row / Col / Grid / Stack / Container / Skeleton / Result / Scrollbar)
- Navigation 导航组件(NavBar / TabBar / Tabs / Breadcrumb / Steps / Timeline / Menu / PageHeader / Backtop / Affix / Anchor)
- Data 数据展示(Table / Tree / TreeSelect / Transfer / Cascader / Pagination / Descriptions / Statistic / Image / Link / Carousel / ImagePreview / IndexBar / PullRefresh / SwipeCell / 6 类图表 / 3 类验证码 / RichTextEditor / Watermark / ConfigProvider)
安装与样式(速览)
该包暂未发布 npm(实验性预览),安装命令在首发后可用。
pnpm add @ruanno-ui/uniapp<!-- App.vue -->
<style>
@import "@ruanno-ui/uniapp/styles";
</style><script setup lang="ts">
import { Button, Cell, Badge, Icon } from "@ruanno-ui/uniapp";
</script>
<template>
<view class="page">
<Button variant="primary" size="md">主要按钮</Button>
<Cell title="用户名" value="Ruanno" arrow />
<Badge content="5">
<Icon name="bell" :size="24" />
</Badge>
</view>
</template>完整注册方式、主题切换与平台注意事项见 uni-app 快速开始。
示例工程
仓库中的 apps/uniapp-demo 提供三端入口(文档站的手机预览即其 H5 构建产物):
pnpm --filter @ruanno-ui/uniapp-demo dev:h5 # H5
pnpm --filter @ruanno-ui/uniapp-demo dev:mp-weixin # 微信小程序
pnpm --filter @ruanno-ui/uniapp-demo dev:app # App小程序 / App 端编译需在 HBuilderX 4.85+ 或
@dcloudio/uni-app-cli环境进行;本仓库 CI 目前覆盖 uni 包类型检查(vue-tsc),H5 / 小程序构建暂未纳入(可在本地跑pnpm --filter @ruanno-ui/uniapp-demo build:h5验证)。
迁移进度
97/97 已完成。当前包处于冻结维护状态:不再新增组件与功能,仅跟随 Web 端做必要同步与防腐验证;后续方向与完整清单见仓库 packages/uniapp/ROADMAP.md。