Skip to content

组件使用文档索引

简述

文件名 ↔ 组件 ↔ 演示路径总览 mmsUnix 全量文档;维护新组件时请同步侧栏与 pathMap(详见下方约定)。

说明

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

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

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

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

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

文档与演示约定

提示

  • 演示路径:均为分包根 pages_demo 下的页面,跳转使用 /pages_demo/...
  • 双向绑定:表单类组件优先使用 v-model / v-model:xxx;文档中「Events」列出的 update:* 与之一一对应。
  • 默认值与枚举:以源码 props.default 及注释为准;文档中「type / size / position」等尽量列出全部合法取值;透传原生能力的字符串(如 inputtype)以 uni-app 官方文档为准。表格与实现不一致时以源码为准。
  • 文档站 H5 预览:右下角固定手机造型预览框(机身宽度约 360px、总高度上限约 620px,以主题组件为准);路由由 themeConfig.mmsUnixH5PreviewpathMap 等配置。单页 frontmatter:previewPathpreviewUrlpreview: false
  • 单页「演示地址」:每篇组件文档含 ## 演示地址,表格列出分包路径与可点击的线上 hash 链接(与预览 iframe 同源)。批量维护:npm run docs:m-unix-demo-address

按文档文件索引

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

扩展组件、整页模版、瀑布流 等已单列侧栏与文档:与同目录下 waterfall.mdaction-sheet.mdwing-blank.mdforum-feed.mdchat-room.md 等一一对应。新增组件时请同步侧栏、pathMap、本表一行与 ## 演示地址

与线上 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。
content.md无独立分包页,预览指向 pages_demo/extensions/extensions 扩展总览。
white-space.md与「布局辅助」同页:pages_demo/ext/layout-helpers/layout-helpers
picture-cropper.md演示路径为 pages_demo/ext/cropper/cropper
dropdown-list.md演示路径为 pages_demo/ext/dropdown/dropdown
update.md演示路径为 pages_demo/ext/app-update/app-update
forum-feed.mdchat-room.md分包 pages_demo/templates/...

扩展演示索引

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

Released under the MIT License.