Skip to content

组件使用文档索引

说明

本文档集(docs/mms-unix/*.md)描述 mmsUnix 自研组件的用法、属性、事件与演示入口,与 pages_demo 分包中的示例一一对应。不涉及任何外部商业组件库名称。

单篇组件文档结构(推荐)

与常见组件库文档一致,每篇建议按顺序包含:

  1. 标题# mms-xxx 中文名
  2. 简述:组件定位与能力摘要(一两段即可)
  3. 注意事项::: warning 容器(VitePress 显示为「注意」),写平台差异、命名、易错点
  4. 平台差异说明:四列表格 App(vue) / App(nvue) / H5 / 小程序,以 表示支持;若某端不支持请在「注意」中说明
  5. 基本使用:首个完整示例(原「使用 / 演示」等节统一为「基本使用」)
  6. 其后可接 Props / Events / 插槽 / 示例 等原有章节

批量插入头结构可使用仓库脚本 npm run docs:mms-unix-template(已含 ## 简述 的文件不会重复处理)。

文档与演示约定

提示

  • 演示路径:均为分包根 pages_demo 下的页面,跳转使用 /pages_demo/...
  • 双向绑定:表单类组件优先使用 v-model / v-model:xxx;文档中「Events」列出的 update:* 与之一一对应。
  • 默认值:以 uni_modules/mms-unix/components/mms-* 源码中 props.default 为准;文档表格与实现不一致时以源码为准。
  • 文档站 H5 预览:右下角固定手机造型预览框(机身总高约 500px,无标题栏);路由由 themeConfig.mmsUnixH5PreviewpathMap 等配置。单页 frontmatter:previewPathpreviewUrlpreview: false

按文档文件索引

文档组件演示页(示例)
button.mdmms-buttonpages_demo/button/button
cell.mdmms-cellpages_demo/cell/cell
input.mdmms-input、mms-formpages_demo/form/input、form/form
textarea.mdmms-textareapages_demo/textarea/textarea
radio-group.mdmms-radio-grouppages_demo/radio/radio
radio.mdmms-radiopages_demo/radio/radio
checkbox-group.mdmms-checkbox-grouppages_demo/checkbox/checkbox
checkbox.mdmms-checkboxpages_demo/checkbox/checkbox
switch.mdmms-switchpages_demo/switch/switch
tag.mdmms-tagpages_demo/tag/tag
toast.mdmms-toastpages_demo/toast/toast
loading.mdmms-loadingpages_demo/loading/loading
empty.mdmms-emptypages_demo/empty/empty
grid.mdmms-gridpages_demo/grid/grid
card.mdmms-cardpages_demo/card/card
qrcode.mdmms-qrcodepages_demo/qrcode/qrcode
clipboard.mdmms-clipboardpages_demo/ext/clipboard/clipboard
notice-bar.mdmms-notice-barpages_demo/ext/notice-bar/notice-bar
picker.mdmms-pickerpages_demo/ext/picker/picker
bubble-popup.mdmms-bubble-popuppages_demo/ext/bubble-popup/bubble-popup
rate.mdmms-ratepages_demo/ext/rate/rate
number-box.mdmms-number-boxpages_demo/ext/number-box/number-box

其余组件见仓库内同目录 .md 文件;新增组件时请同步增加一篇说明与本表一行。

与线上 H5(unix.mmsadmin.cn)路由

文档站 iframe 的 pathMaphttps://unix.mmsadmin.cn 当前分包为准,与上表不一致处如下(已在 .vitepress/config.mts 中校正):

文档说明
countdown-verify.md线上页面路径为 pages_demo/smsCountdown/smsCountdown(驼峰目录),非 countdown-verify
row / col / gap / div / tree / loadmore / screenshot线上无同名分包页,预览指向 pages_demo/extensions/extensions
overlay / bottom-popup无独立页,预览指向 pages_demo/popup/popup
datetime-picker无独立页,预览指向 pages_demo/ext/picker/picker(能力最接近)。
sticky-bottom预览指向 pages_demo/ext/sticky/sticky
wx-login预览指向 pages_demo/login/login
utils.mdrequest.md无 H5 演示页,文档站 preview: false 关闭 iframe。

扩展演示索引

扩展类演示登记于 pages.jsonpages_demo 分包,入口页:pages_demo/extensions/extensions

Released under the MIT License.