From 5f245cabd7fa4317aeb32516a7f2d37b05fc0aee Mon Sep 17 00:00:00 2001 From: "kongjing@dian.so" Date: Mon, 23 May 2022 16:06:45 +0800 Subject: [PATCH] fix: merge main format md --- .github/ISSUE_TEMPLATE/---------.md | 3 - .github/ISSUE_TEMPLATE/bug--.md | 9 +- .prettierignore | 1 + README.md | 31 ++- packages/vantui-demo/README.md | 21 +- packages/vantui-doc/docs/comments.md | 22 +- packages/vantui-doc/docs/custom-style.md | 2 +- packages/vantui-doc/docs/home.md | 29 +- packages/vantui-doc/docs/quickstart.md | 90 +++--- packages/vantui-doc/docs/theme.md | 15 +- packages/vantui-doc/docs/use-in-react.md | 4 +- packages/vantui-doc/scripts/ts-to-md.js | 59 ++-- .../vantui-doc/scripts/utils/ts-parser.js | 7 +- .../vantui-doc/src/action-sheet/README.md | 231 +++++++++------- packages/vantui-doc/src/button/README.md | 261 ++++++------------ packages/vantui-doc/src/card/README.md | 68 +++-- packages/vantui-doc/src/cell/README.md | 70 ++--- packages/vantui-doc/src/circle/README.md | 32 +-- packages/vantui-doc/src/col/README.md | 24 +- packages/vantui-doc/src/collapse/README.md | 62 ++--- packages/vantui-doc/src/count-down/README.md | 60 ++-- .../vantui-doc/src/datetime-picker/README.md | 71 ++--- packages/vantui-doc/src/divider/README.md | 30 +- .../vantui-doc/src/dropdown-menu/README.md | 83 +++--- packages/vantui-doc/src/empty/README.md | 22 +- packages/vantui-doc/src/field/README.md | 134 ++++----- packages/vantui-doc/src/form/README.md | 75 ++--- .../vantui-doc/src/goods-action/README.md | 10 +- packages/vantui-doc/src/grid/README.md | 58 ++-- packages/vantui-doc/src/image/README.md | 32 +-- packages/vantui-doc/src/index-bar/README.md | 20 +- packages/vantui-doc/src/index/README.md | 2 +- packages/vantui-doc/src/loading/README.md | 18 +- packages/vantui-doc/src/nav-bar/README.md | 36 +-- packages/vantui-doc/src/notice-bar/README.md | 42 +-- packages/vantui-doc/src/notify/README.md | 34 +-- .../vantui-doc/src/number-keyboard/README.md | 30 +- packages/vantui-doc/src/overlay/README.md | 16 +- packages/vantui-doc/src/pagination/README.md | 34 +-- packages/vantui-doc/src/picker/README.md | 57 ++-- packages/vantui-doc/src/progress/README.md | 26 +- packages/vantui-doc/src/radio/README.md | 50 ++-- packages/vantui-doc/src/rate/README.md | 38 +-- packages/vantui-doc/src/search/README.md | 70 ++--- packages/vantui-doc/src/share-sheet/README.md | 74 ++--- packages/vantui-doc/src/sidebar/README.md | 40 +-- packages/vantui-doc/src/slider/README.md | 42 +-- packages/vantui-doc/src/steps/README.md | 26 +- packages/vantui-doc/src/sticky/README.md | 22 +- packages/vantui-doc/src/submit-bar/README.md | 40 +-- packages/vantui-doc/src/swipe-cell/README.md | 48 ++-- packages/vantui-doc/src/switch/README.md | 26 +- packages/vantui-doc/src/tab/README.md | 80 +++--- packages/vantui-doc/src/tabbar/README.md | 56 ++-- packages/vantui-doc/src/tag/README.md | 28 +- packages/vantui-doc/src/transition/README.md | 8 +- packages/vantui-doc/src/tree-select/README.md | 28 +- packages/vantui-doc/src/uploader/README.md | 68 ++--- packages/vantui/README.md | 21 +- 59 files changed, 1319 insertions(+), 1377 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---------.md b/.github/ISSUE_TEMPLATE/---------.md index be64f8327..3b615ad84 100644 --- a/.github/ISSUE_TEMPLATE/---------.md +++ b/.github/ISSUE_TEMPLATE/---------.md @@ -1,13 +1,10 @@ --- name: 产品功能需求及建议 about: 提供新功能的建议 - --- **您提出的功能是否和您遇到的问题有关，请描述该问题** - **您是否有建议的实现方案** - **其它帮助我们理解您需求的描述、截图** diff --git a/.github/ISSUE_TEMPLATE/bug--.md b/.github/ISSUE_TEMPLATE/bug--.md index 371b934f7..e61d77f3c 100644 --- a/.github/ISSUE_TEMPLATE/bug--.md +++ b/.github/ISSUE_TEMPLATE/bug--.md @@ -1,25 +1,18 @@ --- name: Bug反馈 about: 为了更快速的定位您的问题，请提供详细的BUG描述。 - --- -**BUG描述** - +**BUG 描述** **复现步骤** - **期望结果** - **实际结果** - **截图** - **环境** - **附加信息** diff --git a/.prettierignore b/.prettierignore index 59db9678b..b97661b2c 100644 --- a/.prettierignore +++ b/.prettierignore @@ -23,6 +23,7 @@ packages/vantui/es packages/vantui-doc/lib packages/vantui-doc/es packages/vantui-doc/dist +packages/vantui-doc/site packages/vantui/src/style/components/iconfont.less packages/vantui-demo/weapp packages/vantui-demo/alipay diff --git a/README.md b/README.md index 757ec9150..85dab831f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ ### 相关链接 + - [Vant Weapp](https://github.com/youzan/vant-weapp)：由有赞团队打造的轻量、可靠的微信小程序 UI 组件库 - [Taro](https://github.com/NervJS/taro)：由京东团队打造的开放式跨端跨框架解决方案，支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用 @@ -24,7 +25,7 @@ - 使用 TypeScript 编写，提供完整的类型定义 -- 支持 Taro(H5、微信小程序、支付宝小程序、抖音小程序...)(注：React Native不支持) +- 支持 Taro(H5、微信小程序、支付宝小程序、抖音小程序...)(注：React Native 不支持) - 支持 React(webpack 兼容配置我们后续会统一起来，方便大家使用) @@ -38,17 +39,16 @@ ### 为什么你可以放心用 -- 整个组件库是依赖开源项目Vant Weapp的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持React，很大程度避免了重新造轮子带来的各种问题，同时保留了Vant Weapp多年积累的经验。 - +- 整个组件库是依赖开源项目 Vant Weapp 的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持 React，很大程度避免了重新造轮子带来的各种问题，同时保留了 Vant Weapp 多年积累的经验。 -> 如果觉得不错，麻烦给个Star哦 +> 如果觉得不错，麻烦给个 Star 哦 -> 收到了一些反馈，这里说明一下吧。关于demo的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了50多个组件要维护，还有Taro Demo和React Demo和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！ +> 收到了一些反馈，这里说明一下吧。关于 demo 的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了 50 多个组件要维护，还有 Taro Demo 和 React Demo 和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！ ### 学习链接 -* [github文档](https://antmjs.github.io/vantui/#/home) -* [gitee文档](https://antm-js.gitee.io/vantui/#/home) +- [github 文档](https://antmjs.github.io/vantui/#/home) +- [gitee 文档](https://antm-js.gitee.io/vantui/#/home) ### 预览 @@ -57,7 +57,7 @@ ### 贡献代码 -使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对vant-weapp的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了2022-03-27的版本，我们也会持续同步 +使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对 vant-weapp 的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了 2022-03-27 的版本，我们也会持续同步 ### 开源协议 @@ -65,20 +65,21 @@ ### 参与共建 -首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。 +首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM 团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。 ### 特别声明 -* 该组件库并不是一个新的轮子，我们只是得益于有赞团队在vant-weapp的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以Taro/React的方式进行开发接入。 -* 我们是vant-weapp的锦上添花版本，在此还是需要感谢Taro团队以及有赞团队为社区所作出的贡献。 +- 该组件库并不是一个新的轮子，我们只是得益于有赞团队在 vant-weapp 的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以 Taro/React 的方式进行开发接入。 + +- 我们是 vant-weapp 的锦上添花版本，在此还是需要感谢 Taro 团队以及有赞团队为社区所作出的贡献。 -* Logo暂时还未获得使用许可，如有侵权，请及时联系我们。 +- Logo 暂时还未获得使用许可，如有侵权，请及时联系我们。 ### 以下是 @antmjs/vantui 的核心贡献者们 -[![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) -:---:|:---:|:---:|:---: -[hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/) +| [![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) | +| :-------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | +| [hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/) | ### 贡献者们 diff --git a/packages/vantui-demo/README.md b/packages/vantui-demo/README.md index 8d7b59049..041f6286e 100644 --- a/packages/vantui-demo/README.md +++ b/packages/vantui-demo/README.md @@ -1,4 +1,4 @@ -## Taro快速开发模版 +## Taro 快速开发模版 ### 选型 @@ -6,8 +6,8 @@ Taro + React + Less ### 特性 -- 非UI全局缓存能力 -- UI全局缓存能力 +- 非 UI 全局缓存能力 +- UI 全局缓存能力 ### 规范 @@ -20,7 +20,6 @@ Commitlint + Husky + lint-staged + Prettier + Eslint + Stylelint + TSC Prettier - Code formatter + Eslint + stylelint - ### 工程使用 git clone git@github.com:AntmJS/temptaro.git @@ -47,23 +46,23 @@ project.weapp.json - projectname description project.tt.json - projectname description -package.json - name description appId(环境对应API_ENV) Taro版本 +package.json - name description appId(环境对应 API_ENV) Taro 版本 config/index.js - projectName date h5.webpackChain.publicPath src/app.config.ts - window.navigationBarTitleText -src/utils/request/innerRequest/index.ts - statusCode为200的判断依据返回是否和约定一致，其他均为失败 +src/utils/request/innerRequest/index.ts - statusCode 为 200 的判断依据返回是否和约定一致，其他均为失败 -src/components/container.tsx - MiniBar的homeUrl +src/components/container.tsx - MiniBar 的 homeUrl ### 注意事项 - 路径引用可以使用 '@/xxx' -- 主题可以放在src/style/index.less下面 +- 主题可以放在 src/style/index.less 下面 - API_ENV: stable real pre dev -### 执行顺序 useDidShow 优先于useEffect执行 +### 执行顺序 useDidShow 优先于 useEffect 执行 - app show - app launch @@ -97,7 +96,7 @@ src/components/container.tsx - MiniBar的homeUrl - hack Taro API - Boundary Error -- request loading error 结合React +- request loading error 结合 React - theme - action ts -- 分页快速模版 \ No newline at end of file +- 分页快速模版 diff --git a/packages/vantui-doc/docs/comments.md b/packages/vantui-doc/docs/comments.md index ebb0bd0ea..650e2918a 100644 --- a/packages/vantui-doc/docs/comments.md +++ b/packages/vantui-doc/docs/comments.md @@ -1,16 +1,20 @@ -## ts同步到文档说明 +## ts 同步到文档说明 + +### vantui-doc 下执行同步命令 + +将 vantui/types 中 d.ts 的类型描述转换为文档中的 API props -### vantui-doc下执行同步命令 -将vantui/types中d.ts的类型描述转换为文档中的API props ```bash yarn docs-ts ``` -### ts中注释 -- 只转换export的属性 -- 导出类型的注释描述只支持@title和@description -- 属性类型的注释描述只支持@default和@description -- 转换后文档的组件API说明 展示的顺序和ts的export的顺序一致，所以d.ts中组件参数的export尽量放在最开始 +### ts 中注释 + +- 只转换 export 的属性 +- 导出类型的注释描述只支持@title 和@description +- 属性类型的注释描述只支持@default 和@description +- 转换后文档的组件 API 说明 展示的顺序和 ts 的 export 的顺序一致，所以 d.ts 中组件参数的 export 尽量放在最开始 + ```ts /** * @title 组件实例 @@ -23,4 +27,4 @@ export type xxProps = { */ xxvalue?: string } -``` \ No newline at end of file +``` diff --git a/packages/vantui-doc/docs/custom-style.md b/packages/vantui-doc/docs/custom-style.md index c9f18f8b7..d00e6cca7 100644 --- a/packages/vantui-doc/docs/custom-style.md +++ b/packages/vantui-doc/docs/custom-style.md @@ -2,7 +2,7 @@ ### 样式类覆盖 -得益于Taro3的实现，我们无需再关注小程序的样式隔离问题，所以我们可以常规使用样式覆盖 +得益于 Taro3 的实现，我们无需再关注小程序的样式隔离问题，所以我们可以常规使用样式覆盖 ```jsx diff --git a/packages/vantui-doc/docs/home.md b/packages/vantui-doc/docs/home.md index 1d74a0aa9..3b98ff54d 100644 --- a/packages/vantui-doc/docs/home.md +++ b/packages/vantui-doc/docs/home.md @@ -7,6 +7,7 @@ ### 相关链接 + - [Vant Weapp](https://github.com/youzan/vant-weapp)：由有赞团队打造的轻量、可靠的微信小程序 UI 组件库 - [Taro](https://github.com/NervJS/taro)：由京东团队打造的开放式跨端跨框架解决方案，支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用 @@ -38,17 +39,16 @@ ### 为什么你可以放心用 -整个组件库是依赖开源项目Vant Weapp的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持React，很大程度避免了重新造轮子带来的各种问题，同时保留了Vant Weapp多年积累的经验。 - +整个组件库是依赖开源项目 Vant Weapp 的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持 React，很大程度避免了重新造轮子带来的各种问题，同时保留了 Vant Weapp 多年积累的经验。 -> 如果觉得不错，麻烦给个Star哦 +> 如果觉得不错，麻烦给个 Star 哦 -> 收到了一些反馈，这里说明一下吧。关于demo的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了50多个组件要维护，还有Taro Demo和React Demo和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！ +> 收到了一些反馈，这里说明一下吧。关于 demo 的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了 50 多个组件要维护，还有 Taro Demo 和 React Demo 和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！ ### 学习链接 -* [github文档](https://antmjs.github.io/vantui/#/home) -* [gitee文档](https://antm-js.gitee.io/vantui/#/home) +- [github 文档](https://antmjs.github.io/vantui/#/home) +- [gitee 文档](https://antm-js.gitee.io/vantui/#/home) ### 预览 @@ -57,7 +57,7 @@ ### 贡献代码 -使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对vant-weapp的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了2022-03-27的版本，我们也会持续同步 +使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对 vant-weapp 的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了 2022-03-27 的版本，我们也会持续同步 ### 开源协议 @@ -65,20 +65,21 @@ ### 参与共建 -首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。 +首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM 团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。 ### 特别声明 -* 该组件库并不是一个新的轮子，我们只是得益于有赞团队在vant-weapp的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以Taro/React的方式进行开发接入。 -* 我们是vant-weapp的锦上添花版本，在此还是需要感谢Taro团队以及有赞团队为社区所作出的贡献。 +- 该组件库并不是一个新的轮子，我们只是得益于有赞团队在 vant-weapp 的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以 Taro/React 的方式进行开发接入。 + +- 我们是 vant-weapp 的锦上添花版本，在此还是需要感谢 Taro 团队以及有赞团队为社区所作出的贡献。 -* Logo暂时还未获得使用许可，如有侵权，请及时联系我们。 +- Logo 暂时还未获得使用许可，如有侵权，请及时联系我们。 ### 以下是 @antmjs/vantui 的核心贡献者们 -[![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) -:---:|:---:|:---:|:---: -[hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/) +| [![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) | +| :-------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | +| [hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/) | ### 贡献者们 diff --git a/packages/vantui-doc/docs/quickstart.md b/packages/vantui-doc/docs/quickstart.md index 16e6a57ab..032259a63 100644 --- a/packages/vantui-doc/docs/quickstart.md +++ b/packages/vantui-doc/docs/quickstart.md @@ -2,35 +2,37 @@ ### 背景知识 -使用 @antmjs/vantui 前，请确保你已经学习过[Taro框架React版](https://taro.zone/) 或者 [React](https://reactjs.org/)。 +使用 @antmjs/vantui 前，请确保你已经学习过[Taro 框架 React 版](https://taro.zone/) 或者 [React](https://reactjs.org/)。 ### 差异点 + - 组件属性均用驼峰代替 -- slot改为通过属性传递ReactNode 即 slot="footer" 改为 render为前缀F大写传ReactNode renderFooter={} -- 组件文档案例部分可能会存在一些小问题（时间紧大家见谅）如果有问题可以提issue给我们，你们可以先看实际demo。文档TS信息是和我们的组件同步的 +- slot 改为通过属性传递 ReactNode 即 slot="footer" 改为 render 为前缀 F 大写传 ReactNode renderFooter={} +- 组件文档案例部分可能会存在一些小问题（时间紧大家见谅）如果有问题可以提 issue 给我们，你们可以先看实际 demo。文档 TS 信息是和我们的组件同步的 ### 支持程度 -- Taro需要使用3.0+的版本 -- 小程序参考Taro的最低支持程度 + +- Taro 需要使用 3.0+的版本 +- 小程序参考 Taro 的最低支持程度 ### 如何修复/开发新的组件库 -- Fork代码：[VantUI](https://github.com/AntmJS/vantui) +- Fork 代码：[VantUI](https://github.com/AntmJS/vantui) - 进入根目录：执行 yarn && yarn bootstrap - 进入组件库目录：cd packages/vantui && yarn watch -- 进入Taro版工程vantui-demo： cd packages/vantui-demo && yarn watch:weapp +- 进入 Taro 版工程 vantui-demo： cd packages/vantui-demo && yarn watch:weapp -### 使用模版快速开发Taro应用 +### 使用模版快速开发 Taro 应用 -- Pull代码：[纯净版React In Taro模版工程](https://github.com/AntmJS/pure-project-vantui) +- Pull 代码：[纯净版 React In Taro 模版工程](https://github.com/AntmJS/pure-project-vantui) - 进入根目录：执行 yarn && yarn watch:weapp -### 使用模版快速开发React应用 +### 使用模版快速开发 React 应用 -- Pull代码：[纯净版React模版工程](https://github.com/AntmJS/create-react-app-vantui) +- Pull 代码：[纯净版 React 模版工程](https://github.com/AntmJS/create-react-app-vantui) - 进入根目录：执行 yarn && TARO_ENV=h5 yarn start ## 开始使用 @@ -75,12 +77,13 @@ h5: { #### 需要注意开发者工具的项目设置： -* 需要设置关闭 ES6 转 ES5 功能，开启可能报错 -* 需要设置关闭上传代码时样式自动补全，开启可能报错 -* 需要设置关闭代码压缩上传，开启可能报错 +- 需要设置关闭 ES6 转 ES5 功能，开启可能报错 +- 需要设置关闭上传代码时样式自动补全，开启可能报错 +- 需要设置关闭代码压缩上传，开启可能报错 #### 编译问题 -该组件在编译阶段默认已经使用了babel/runtime进行语法转换以及polyfill。目前使用taro的默认babel配置在支付宝和钉钉等环境会报错，解决方案可以参考[temptaro](https://github.com/AntmJS/temptaro)的配置。 + +该组件在编译阶段默认已经使用了 babel/runtime 进行语法转换以及 polyfill。目前使用 taro 的默认 babel 配置在支付宝和钉钉等环境会报错，解决方案可以参考[temptaro](https://github.com/AntmJS/temptaro)的配置。 ## 引入组件 @@ -131,11 +134,11 @@ npm i babel-plugin-import -D ```js // 原始代码 -import { Button } from '@antmjs/vantui'; +import { Button } from '@antmjs/vantui' // 编译后代码 -import Button from '@antmjs/vantui/es/button'; -import '@antmjs/vantui/es/button/style'; +import Button from '@antmjs/vantui/es/button' +import '@antmjs/vantui/es/button/style' ``` ### 方式二. 在 Vite 项目中按需引入组件 @@ -149,7 +152,7 @@ npm i vite-plugin-style-import -D ```js // vite.config.js -import styleImport from 'vite-plugin-style-import'; +import styleImport from 'vite-plugin-style-import' export default { plugins: [ @@ -163,7 +166,7 @@ export default { ], }), ], -}; +} ``` ### 方式三. 手动按需引入组件 @@ -172,9 +175,9 @@ export default { ```js // 引入组件 -import Button from '@antmjs/vantui/es/button'; +import Button from '@antmjs/vantui/es/button' // 引入组件对应的样式，若组件没有样式文件，则无须引入 -import '@antmjs/vantui/es/button/style'; +import '@antmjs/vantui/es/button/style' ``` ### 方式四. 导入所有组件 @@ -183,14 +186,13 @@ Vant 支持一次性导入所有组件，引入所有组件会增加代码包体 ```js // 不需要更改主题，引用它 -import '@antmjs/vantui/lib/index.css'; +import '@antmjs/vantui/lib/index.css' // 需要通过less变量/var()更改主题，引用它 import '@antmjs/vantui/lib/index.less' ``` > Tips: 配置按需引入后，将不允许直接导入所有组件。 - ### 注意 ```js @@ -208,11 +210,11 @@ new MiniCssExtractPlugin({ }) ``` -> 线上打包的时候会提示conflicating order between ... 此类警告，可以通过ignoreOrder:true关闭 +> 线上打包的时候会提示 conflicating order between ... 此类警告，可以通过 ignoreOrder:true 关闭 ### 单位尺寸转化问题 -VantUI默认的尺寸规则 [作用参考](https://taro-docs.jd.com/taro/docs/size) [修改参考](https://taro-docs.jd.com/taro/docs/config) +VantUI 默认的尺寸规则 [作用参考](https://taro-docs.jd.com/taro/docs/size) [修改参考](https://taro-docs.jd.com/taro/docs/config) ```json { @@ -225,7 +227,7 @@ VantUI默认的尺寸规则 [作用参考](https://taro-docs.jd.com/taro/docs/si } ``` -如何在js中转换单位 +如何在 js 中转换单位 ```js import { pxTransform } from '@antmjs/vantui' @@ -233,22 +235,24 @@ import { pxTransform } from '@antmjs/vantui' pxTransform(10) ``` -### 兼容Vant Weapp 以及 兼容项目配置的尺寸设置为非750导致组件库的样式偏大偏小问题 +### 兼容 Vant Weapp 以及 兼容项目配置的尺寸设置为非 750 导致组件库的样式偏大偏小问题 -Vant Weapp要求pxTransform的selectorBlackList要设置成 [/van-/]以免组件被转换成rpx之后缩小一倍。而vantui组件默认适配的rpx，所以尺寸都是按照750的设计稿比例转换过的，但是类名和Vant Weapp是一致的，所以设置selectorBlackList: [/van-/] 也会影响到vantui使其组件视觉上看去放大了一倍。针对这个问题，以下配置可以解决这个问题。同时也能兼容项目配置的尺寸设置为非750导致组件库的样式偏大偏小问题 +Vant Weapp 要求 pxTransform 的 selectorBlackList 要设置成 [/van-/]以免组件被转换成 rpx 之后缩小一倍。而 vantui 组件默认适配的 rpx，所以尺寸都是按照 750 的设计稿比例转换过的，但是类名和 Vant Weapp 是一致的，所以设置 selectorBlackList: [/van-/] 也会影响到 vantui 使其组件视觉上看去放大了一倍。针对这个问题，以下配置可以解决这个问题。同时也能兼容项目配置的尺寸设置为非 750 导致组件库的样式偏大偏小问题 ```js // 这个不用安装，taro已经装过了，直接require就好了 -const pxtransform = require("postcss-pxtransform") +const pxtransform = require('postcss-pxtransform') const config = { mini: { - webpackChain (chain) { + webpackChain(chain) { const lessRule = chain.module.rules.get('less') const lessRuleCfg = { test: /@antmjs[\\/]vantui(.+?)\.less$/, - oneOf: [{ - use: [] - }] + oneOf: [ + { + use: [], + }, + ], } lessRule.toConfig().oneOf[0].use.map((use) => { if (/postcss-loader/.test(use.loader)) { @@ -257,9 +261,9 @@ const config = { options: { sourceMap: use.options.sourceMap, postcssOptions: { - plugins: [] - } - } + plugins: [], + }, + }, } use.options.postcssOptions.plugins.map((xitem) => { if (xitem.postcssPlugin === 'postcss-pxtransform') { @@ -270,25 +274,23 @@ const config = { deviceRatio: { 640: 2.34 / 2, 750: 1, - 828: 1.81 / 2 + 828: 1.81 / 2, }, selectorBlackList: [], - }) + }), ) } else { newUse.options.postcssOptions.plugins.push(xitem) } - }) lessRuleCfg.oneOf[0].use.push({ ...newUse }) } else { lessRuleCfg.oneOf[0].use.push({ ...use }) } - }) chain.module.rule('vantuiLess').merge(lessRuleCfg) - lessRule.exclude.clear().add(/@antmjs[\\/]vantui/) - } - } + lessRule.exclude.clear().add(/@antmjs[\\/]vantui/) + }, + }, } ``` diff --git a/packages/vantui-doc/docs/theme.md b/packages/vantui-doc/docs/theme.md index 5023fea9b..308bab0a4 100644 --- a/packages/vantui-doc/docs/theme.md +++ b/packages/vantui-doc/docs/theme.md @@ -2,7 +2,7 @@ ### 背景知识 -Taro3的架构摒弃了小程序自定义组件带来的复杂性，所以 @antmjs/vantui 使用与之配套的 [CSS 变量](https://developer.mozilla.org/zh-CN/docs/Web/CSS/Using_CSS_custom_properties) 来实现定制主题。链接中的内容可以帮助你对这两个概念有基本的认识，避免许多不必要的困扰。 +Taro3 的架构摒弃了小程序自定义组件带来的复杂性，所以 @antmjs/vantui 使用与之配套的 [CSS 变量](https://developer.mozilla.org/zh-CN/docs/Web/CSS/Using_CSS_custom_properties) 来实现定制主题。链接中的内容可以帮助你对这两个概念有基本的认识，避免许多不必要的困扰。 CSS 变量 的兼容性要求可以在 [这里](https://caniuse.com/#feat=css-variables) 查看。对于不支持 CSS 变量 的设备，定制主题将不会生效，不过不必担心，默认样式仍会生效。 @@ -43,22 +43,22 @@ module.exports = { '@antmjs/vantui', ], ], -}; +} ``` #### 手动引入样式 ```js // 引入全部样式 -import '@antmjs/vantui/lib/index.less'; +import '@antmjs/vantui/lib/index.less' // 引入单个组件样式 -import '@antmjs/vantui/lib/button/style/less'; +import '@antmjs/vantui/lib/button/style/less' ``` ### 步骤二 修改样式变量 -#### 通过覆盖less主题方式修改 +#### 通过覆盖 less 主题方式修改 使用 Less 提供的 [modifyVars](http://lesscss.org/usage/#using-less-in-the-browser-modify-variables) 即可对变量进行修改，下面是参考的 webpack 配置。 @@ -88,10 +88,11 @@ module.exports = { ], }, ], -}; +} ``` -#### 通过css变量形式修改 +#### 通过 css 变量形式修改 + ##### 定制单个组件的主题样式 > 在 less 中为组件设置 CSS 变量 diff --git a/packages/vantui-doc/docs/use-in-react.md b/packages/vantui-doc/docs/use-in-react.md index bd27351a8..5a4100db2 100644 --- a/packages/vantui-doc/docs/use-in-react.md +++ b/packages/vantui-doc/docs/use-in-react.md @@ -1,6 +1,6 @@ -# 如何在React中使用（单纯的React应用，非Taro应用） +# 如何在 React 中使用（单纯的 React 应用，非 Taro 应用） -### 在React应用中使用需要在如下文件中添加代码 +### 在 React 应用中使用需要在如下文件中添加代码 ```bash yarn add @tarojs/taro @tarojs/components @antmjs/vantui diff --git a/packages/vantui-doc/scripts/ts-to-md.js b/packages/vantui-doc/scripts/ts-to-md.js index 85bbfb92c..0fde47186 100644 --- a/packages/vantui-doc/scripts/ts-to-md.js +++ b/packages/vantui-doc/scripts/ts-to-md.js @@ -10,35 +10,34 @@ const GITHUB_TYPESHS = `https://github.com/AntmJS/vantui/tree/main/packages/vant const READMES_PATH = `${path.resolve(process.cwd(), './src/**/README.md')}` const spinner = ora(`文档 API 同步开始`) -glob(READMES_PATH, - function (err, path_) { - path_.map((item) => { - const componentName = item.split('/').reverse()[1] - let content = fs.readFileSync(item, 'utf-8') - spinner.start(`${componentName}文档 API 同步中...`) +glob(READMES_PATH, function (err, path_) { + path_.map((item) => { + const componentName = item.split('/').reverse()[1] + let content = fs.readFileSync(item, 'utf-8') + spinner.start(`${componentName}文档 API 同步中...`) - if (content) { - content = removeOldTable(content) - } + if (content) { + content = removeOldTable(content) + } - if ( - fs.existsSync(`../vantui/types/${componentName}.d.ts`) && - componentName !== 'index' && componentName!== 'power-scroll-view' - ) { - let tsInfo = fs.readFileSync( - `../vantui/types/${componentName}.d.ts`, - 'utf-8', - ) - const res = parser(tsInfo) + if ( + fs.existsSync(`../vantui/types/${componentName}.d.ts`) && + componentName !== 'index' && + componentName !== 'power-scroll-view' + ) { + let tsInfo = fs.readFileSync( + `../vantui/types/${componentName}.d.ts`, + 'utf-8', + ) + const res = parser(tsInfo) - fs.writeFileSync(item, content + createMd(res, componentName)) - spinner.stop(`${componentName}文档 API 同步完成`) - } - }) + fs.writeFileSync(item, content + createMd(res, componentName)) + spinner.stop(`${componentName}文档 API 同步完成`) + } + }) - spinner.succeed(`文档 API 同步完成`) - }, -) + spinner.succeed(`文档 API 同步完成`) +}) function createMd(obj, compName) { let mdRes = `` @@ -46,9 +45,10 @@ function createMd(obj, compName) { const item = obj[Dkey] if (!Object.keys(item).length) continue mdRes += - `### ${item['title__'] && typeof item['title__'] === 'string' - ? item['title__'] - : Dkey + `### ${ + item['title__'] && typeof item['title__'] === 'string' + ? item['title__'] + : Dkey }` + ` [[详情]](${GITHUB_TYPESHS}/${compName}.d.ts) ` @@ -123,7 +123,8 @@ function removeOldTable(md) { // 处理第一版ts的展示 if (shouldRmoveIndex === undefined) { ast.children.forEach((as, index) => { - if (as.type === 'Header' && + if ( + as.type === 'Header' && as.raw === '### TS信息' && shouldRmoveIndex === undefined ) { diff --git a/packages/vantui-doc/scripts/utils/ts-parser.js b/packages/vantui-doc/scripts/utils/ts-parser.js index bdd40710d..e3ecd45a2 100644 --- a/packages/vantui-doc/scripts/utils/ts-parser.js +++ b/packages/vantui-doc/scripts/utils/ts-parser.js @@ -69,7 +69,8 @@ function parseTokens(TOKENS) { count-- if (count === 0) { status = STATUS.EXPORT_1 - if (attrName && exportName) res[exportName][attrName]['value'] = formatTsValue(value) + if (attrName && exportName) + res[exportName][attrName]['value'] = formatTsValue(value) value = '' attrNamePrev = '' attrName = '' @@ -191,7 +192,8 @@ attr:${tsValue} semi: false, printWidth: 48, }, - ).replace('type temp = {\n', '') + ) + .replace('type temp = {\n', '') .replace('attr: ', '') .replace( `} @@ -201,4 +203,3 @@ attr:${tsValue} return res } - diff --git a/packages/vantui-doc/src/action-sheet/README.md b/packages/vantui-doc/src/action-sheet/README.md index adfc7c19e..d54c0ce42 100644 --- a/packages/vantui-doc/src/action-sheet/README.md +++ b/packages/vantui-doc/src/action-sheet/README.md @@ -9,7 +9,7 @@ 在 Taro 文件中引入组件 ```js -import { ActionSheet } from "@antmjs/vantui"; +import { ActionSheet } from '@antmjs/vantui' ``` ## 代码演示 @@ -21,15 +21,19 @@ import { ActionSheet } from "@antmjs/vantui"; ```jsx function Demo() { const [show, setShow] = react.useState(false) - const [actions, setActions] = react.useState([{ - name: '选项1' - }, { - name: '选项' - }, { - name: '选项', - subname: '描述信息', - openType: 'share' - }]) + const [actions, setActions] = react.useState([ + { + name: '选项1', + }, + { + name: '选项', + }, + { + name: '选项', + subname: '描述信息', + openType: 'share', + }, + ]) return ( <> @@ -39,10 +43,12 @@ function Demo() { onClose={() => setShow(false)} onSelect={(e) => console.info(e.detail)} /> - + ) -} +} ``` ### 选项状态 @@ -52,15 +58,19 @@ function Demo() { ```jsx function Demo() { const [show, setShow] = react.useState(false) - const [actions, setActions] = react.useState([{ - name: '着色选项', - color: '#ee0a24' - }, { - loading: true - }, { - name: '禁用选项', - disabled: true - }]) + const [actions, setActions] = react.useState([ + { + name: '着色选项', + color: '#ee0a24', + }, + { + loading: true, + }, + { + name: '禁用选项', + disabled: true, + }, + ]) return ( <> @@ -69,11 +79,12 @@ function Demo() { actions={actions} onClose={() => setShow(false)} /> - + ) -} - +} ``` ### 展示取消按钮 @@ -83,15 +94,19 @@ function Demo() { ```jsx function Demo() { const [show, setShow] = react.useState(false) - const [actions, setActions] = react.useState([{ - name: '选项' - }, { - name: '选项' - }, { - name: '选项', - subname: '描述信息', - openType: 'share' - }]) + const [actions, setActions] = react.useState([ + { + name: '选项', + }, + { + name: '选项', + }, + { + name: '选项', + subname: '描述信息', + openType: 'share', + }, + ]) return ( <> @@ -101,11 +116,12 @@ function Demo() { cancelText="取消" onClose={() => setShow(false)} /> - + ) -} - +} ``` ### 展示描述信息 @@ -115,15 +131,19 @@ function Demo() { ```jsx function Demo() { const [show, setShow] = react.useState(false) - const [actions, setActions] = react.useState([{ - name: '选项' - }, { - name: '选项' - }, { - name: '选项', - subname: '描述信息', - openType: 'share' - }]) + const [actions, setActions] = react.useState([ + { + name: '选项', + }, + { + name: '选项', + }, + { + name: '选项', + subname: '描述信息', + openType: 'share', + }, + ]) return ( <> @@ -133,10 +153,12 @@ function Demo() { description="这是一段描述信息" onClose={() => setShow(false)} /> - + ) -} +} ``` ### 展示标题栏 @@ -146,32 +168,31 @@ function Demo() { ```jsx function Demo() { const [show, setShow] = react.useState(false) - const [actions, setActions] = react.useState([{ - name: '选项' - }, { - name: '选项' - }, { - name: '选项', - subname: '描述信息', - openType: 'share' - }]) + const [actions, setActions] = react.useState([ + { + name: '选项', + }, + { + name: '选项', + }, + { + name: '选项', + subname: '描述信息', + openType: 'share', + }, + ]) return ( <> - setShow(false)} - > - - 内容 - + setShow(false)}> + 内容 - + ) } - ``` ### 微信开放能力 @@ -181,11 +202,13 @@ function Demo() { ```jsx function Demo() { const [show, setShow] = react.useState(false) - const [actions, setActions] = react.useState([{ - name: '获取用户信息', - color: '#07c160', - openType: 'getUserInfo' - }]) + const [actions, setActions] = react.useState([ + { + name: '获取用户信息', + color: '#07c160', + openType: 'getUserInfo', + }, + ]) return ( <> @@ -193,41 +216,43 @@ function Demo() { show={show} actions={actions} onClose={() => setShow(false)} - onGetuserinfo={e => console.info(e.detail)} + onGetuserinfo={(e) => console.info(e.detail)} /> - + ) } ``` -### ActionSheetItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| name | - | _  string
_ | -| subname | - | _  string
_ | -| color | - | _  string
_ | -| loading | - | _  boolean
_ | -| disabled | - | _  boolean
_ | - -### ActionSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| actions | - | _  ActionSheetItem[]
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| show | - | _  boolean
_ | - | `false` | -| cancelText | - | _  string
_ | - | `false` | -| description | - | _  string
_ | - | `false` | -| overlay | - | _  boolean
_ | - | `false` | -| closeOnClickOverlay | - | _  boolean
_ | - | `false` | -| closeOnClickAction | - | _  boolean
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| round | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onSelect | - | _  (
    event: ITouchEvent & {
      detail: ActionSheetItem
    }
  ) => void
_ | - | `false` | -| onCancel | - | _  () => void
_ | - | `false` | -| onClose | - | _  () => void
_ | - | `false` | -| onClickOverlay | - | _  () => void
_ | - | `false` | +### ActionSheetItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) + +| 参数 | 说明 | 类型 | +| -------- | ---- | -------------------------- | +| name | - | _  string
_ | +| subname | - | _  string
_ | +| color | - | _  string
_ | +| loading | - | _  boolean
_ | +| disabled | - | _  boolean
_ | + +### ActionSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/action-sheet.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| actions | - | _  ActionSheetItem[]
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| show | - | _  boolean
_ | - | `false` | +| cancelText | - | _  string
_ | - | `false` | +| description | - | _  string
_ | - | `false` | +| overlay | - | _  boolean
_ | - | `false` | +| closeOnClickOverlay | - | _  boolean
_ | - | `false` | +| closeOnClickAction | - | _  boolean
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| round | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onSelect | - | _  (
    event: ITouchEvent & {
      detail: ActionSheetItem
    }
  ) => void
_ | - | `false` | +| onCancel | - | _  () => void
_ | - | `false` | +| onClose | - | _  () => void
_ | - | `false` | +| onClickOverlay | - | _  () => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/button/README.md b/packages/vantui-doc/src/button/README.md index 42dd6870e..10f90f46b 100644 --- a/packages/vantui-doc/src/button/README.md +++ b/packages/vantui-doc/src/button/README.md @@ -9,7 +9,12 @@ 在 Taro 文件中引入组件 ```js -import { Button, MiniLoginButton, MiniPhoneButton, MiniUserButton } from "@antmjs/vantui"; +import { + Button, + MiniLoginButton, + MiniPhoneButton, + MiniUserButton, +} from '@antmjs/vantui' ``` ## 代码演示 @@ -22,24 +27,14 @@ import { Button, MiniLoginButton, MiniPhoneButton, MiniUserButton } from "@antmj function Demo() { return ( - - - - - + + + + + ) -} +} ``` ### 朴素按钮 @@ -50,22 +45,15 @@ function Demo() { function Demo() { return ( - - ) } - ``` ### 细边框 @@ -75,25 +63,16 @@ function Demo() { ```jsx function Demo() { return ( - - - - + + + + ) } - ``` ### 禁用状态 @@ -103,23 +82,16 @@ function Demo() { ```jsx function Demo() { return ( - - - - + + + + ) } - ``` ### 加载状态 @@ -127,25 +99,13 @@ function Demo() { ```jsx function Demo() { return ( - - - - + + + + ) } - ``` ### 图标按钮 @@ -180,14 +133,8 @@ function Demo() { function Demo() { return ( - - - - - + + + + + + ) } - ``` ### 块级元素 @@ -247,17 +180,13 @@ function Demo() { ```jsx function Demo() { return ( - - - + + + ) } - ``` ### 自定义颜色 @@ -267,41 +196,35 @@ function Demo() { ```jsx function Demo() { return ( - - - - - + + + + + ) } - ``` -### ButtonProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/button.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| icon | - | _  string
_ | - | `false` | -| classPrefix | - | _  string
_ | - | `false` | -| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | -| size | - | _  "small" ¦ "normal" ¦ "large" ¦ "mini"
_ | - | `false` | -| block | - | _  boolean
_ | - | `false` | -| round | - | _  boolean
_ | - | `false` | -| square | - | _  boolean
_ | - | `false` | -| loading | - | _  boolean
_ | - | `false` | -| hairline | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| loadingText | - | _  string
_ | - | `false` | -| loadingSize | - | _  string
_ | - | `false` | -| loadingType | - | _  "spinner" ¦ "circular"
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### ButtonProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/button.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| icon | - | _  string
_ | - | `false` | +| classPrefix | - | _  string
_ | - | `false` | +| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | +| size | - | _  "small" ¦ "normal" ¦ "large" ¦ "mini"
_ | - | `false` | +| block | - | _  boolean
_ | - | `false` | +| round | - | _  boolean
_ | - | `false` | +| square | - | _  boolean
_ | - | `false` | +| loading | - | _  boolean
_ | - | `false` | +| hairline | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| loadingText | - | _  string
_ | - | `false` | +| loadingSize | - | _  string
_ | - | `false` | +| loadingType | - | _  "spinner" ¦ "circular"
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/card/README.md b/packages/vantui-doc/src/card/README.md index dba37637f..9957a40b3 100644 --- a/packages/vantui-doc/src/card/README.md +++ b/packages/vantui-doc/src/card/README.md @@ -9,7 +9,7 @@ 在 Taro 文件中引入组件 ```js -import { Card } from "@antmjs/vantui"; +import { Card } from '@antmjs/vantui' ``` ## 代码演示 @@ -28,7 +28,6 @@ function Demo() { /> ) } - ``` ### 高级用法 @@ -45,46 +44,41 @@ function Demo() { desc="描述信息" title="商品标题" thumb="https://img.yzcdn.cn/upload_files/2017/07/02/af5b9f44deaeb68000d7e4a711160c53.jpg" - renderFooter={( + renderFooter={ - - + + - )} + } /> ) } - ``` -### CardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/card.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| tag | - | _  string
_ | - | `false` | -| num | - | _  string
_ | - | `false` | -| desc | - | _  string
_ | - | `false` | -| thumb | - | _  string
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| price | - | _  string
_ | - | `true` | -| centered | - | _  boolean
_ | - | `false` | -| lazyLoad | - | _  boolean
_ | - | `false` | -| thumbLink | - | _  string
_ | - | `false` | -| originPrice | - | _  string
_ | - | `false` | -| thumbMode | - | _  keyof ImageProps.mode
_ | - | `false` | -| currency | - | _  string
_ | - | `false` | -| renderFooter | - | _  ReactNode
_ | - | `false` | -| renderBottom | - | _  ReactNode
_ | - | `false` | -| renderNum | - | _  ReactNode
_ | - | `false` | -| renderOriginPrice | - | _  ReactNode
_ | - | `false` | -| renderPrice | - | _  ReactNode
_ | - | `false` | -| renderPriceTop | - | _  ReactNode
_ | - | `false` | -| renderTags | - | _  ReactNode
_ | - | `false` | -| renderDesc | - | _  ReactNode
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderTag | - | _  ReactNode
_ | - | `false` | -| renderThumb | - | _  ReactNode
_ | - | `false` | +### CardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/card.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ---- | --------------------------------------------- | ------ | ------- | +| tag | - | _  string
_ | - | `false` | +| num | - | _  string
_ | - | `false` | +| desc | - | _  string
_ | - | `false` | +| thumb | - | _  string
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| price | - | _  string
_ | - | `true` | +| centered | - | _  boolean
_ | - | `false` | +| lazyLoad | - | _  boolean
_ | - | `false` | +| thumbLink | - | _  string
_ | - | `false` | +| originPrice | - | _  string
_ | - | `false` | +| thumbMode | - | _  keyof ImageProps.mode
_ | - | `false` | +| currency | - | _  string
_ | - | `false` | +| renderFooter | - | _  ReactNode
_ | - | `false` | +| renderBottom | - | _  ReactNode
_ | - | `false` | +| renderNum | - | _  ReactNode
_ | - | `false` | +| renderOriginPrice | - | _  ReactNode
_ | - | `false` | +| renderPrice | - | _  ReactNode
_ | - | `false` | +| renderPriceTop | - | _  ReactNode
_ | - | `false` | +| renderTags | - | _  ReactNode
_ | - | `false` | +| renderDesc | - | _  ReactNode
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderTag | - | _  ReactNode
_ | - | `false` | +| renderThumb | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/cell/README.md b/packages/vantui-doc/src/cell/README.md index a75144b73..c91fac182 100644 --- a/packages/vantui-doc/src/cell/README.md +++ b/packages/vantui-doc/src/cell/README.md @@ -173,39 +173,39 @@ function Demo() { ) } ``` -### CellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| url | 点击后跳转的链接地址 | _  string
_ | - | `false` | -| linkType | 点击后跳转的链接地址 | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | navigateTo | `false` | -| title | 左侧标题 | _  string ¦ number
_ | - | `false` | -| value | 右侧内容 | _  string ¦ number
_ | - | `false` | -| icon | 标题下方的描述信息 | _  string
_ | - | `false` | -| size | 单元格大小，可选值为 large | _  "large"
_ | - | `false` | -| label | 标题下方的描述信息 | _  string
_ | - | `false` | -| center | 是否使内容垂直居中 | _  boolean
_ | - | `false` | -| isLink | 是否展示右侧箭头并开启点击反馈 | _  boolean
_ | - | `false` | -| required | 是否显示表单必填星号 | _  boolean
_ | false | `false` | -| clickable | 是否开启点击反馈 | _  boolean
_ | false | `false` | -| titleWidth | 标题宽度，须包含单位 | _  string
_ | - | `false` | -| style | - | _  string
_ | - | `false` | -| arrowDirection | 箭头方向 | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | -| border | 是否显示下边框 | _  boolean
_ | - | `false` | -| titleStyle | 标题样式 | _  string
_ | - | `false` | -| renderTitle | 自定义渲染标题 | _  ReactNode
_ | - | `false` | -| renderIcon | 自定义渲染左侧icon | _  ReactNode
_ | - | `false` | -| renderLabel | 自定义label显示内容 | _  ReactNode
_ | - | `false` | -| renderRightIcon | 自定义icon显示内容 | _  ReactNode
_ | - | `false` | -| renderExtra | 自定义右边内容后跟随的内容 | _  ReactNode
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | - -### CellGroup Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| title | 标题 | _  string
_ | - | `false` | -| border | 是否显示外边框 | _  boolean
_ | true | `false` | -| inset | 是否展示为圆角卡片风格 | _  boolean
_ | false | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### CellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ------------------------------ | --------------------------------------------------------------------------------------------- | ---------- | ------- | +| url | 点击后跳转的链接地址 | _  string
_ | - | `false` | +| linkType | 点击后跳转的链接地址 | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | navigateTo | `false` | +| title | 左侧标题 | _  string ¦ number
_ | - | `false` | +| value | 右侧内容 | _  string ¦ number
_ | - | `false` | +| icon | 标题下方的描述信息 | _  string
_ | - | `false` | +| size | 单元格大小，可选值为 large | _  "large"
_ | - | `false` | +| label | 标题下方的描述信息 | _  string
_ | - | `false` | +| center | 是否使内容垂直居中 | _  boolean
_ | - | `false` | +| isLink | 是否展示右侧箭头并开启点击反馈 | _  boolean
_ | - | `false` | +| required | 是否显示表单必填星号 | _  boolean
_ | false | `false` | +| clickable | 是否开启点击反馈 | _  boolean
_ | false | `false` | +| titleWidth | 标题宽度，须包含单位 | _  string
_ | - | `false` | +| style | - | _  string
_ | - | `false` | +| arrowDirection | 箭头方向 | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | +| border | 是否显示下边框 | _  boolean
_ | - | `false` | +| titleStyle | 标题样式 | _  string
_ | - | `false` | +| renderTitle | 自定义渲染标题 | _  ReactNode
_ | - | `false` | +| renderIcon | 自定义渲染左侧 icon | _  ReactNode
_ | - | `false` | +| renderLabel | 自定义 label 显示内容 | _  ReactNode
_ | - | `false` | +| renderRightIcon | 自定义 icon 显示内容 | _  ReactNode
_ | - | `false` | +| renderExtra | 自定义右边内容后跟随的内容 | _  ReactNode
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | + +### CellGroup Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/cell.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ---------------------- | ---------------------------- | ------ | ------- | +| title | 标题 | _  string
_ | - | `false` | +| border | 是否显示外边框 | _  boolean
_ | true | `false` | +| inset | 是否展示为圆角卡片风格 | _  boolean
_ | false | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/circle/README.md b/packages/vantui-doc/src/circle/README.md index 53a085c8f..95ee8eaff 100644 --- a/packages/vantui-doc/src/circle/README.md +++ b/packages/vantui-doc/src/circle/README.md @@ -78,20 +78,20 @@ function Demo() { ) } ``` -### CircleProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/circle.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| text | - | _  string
_ | - | `false` | -| lineCap | - | _  string
_ | - | `false` | -| value | - | _  number
_ | - | `false` | -| speed | - | _  number
_ | - | `false` | -| size | - | _  number
_ | - | `false` | -| fill | - | _  string
_ | - | `false` | -| layerColor | - | _  string
_ | - | `false` | -| color | - | _  string ¦ Record
_ | - | `false` | -| type | - | _  string
_ | - | `false` | -| strokeWidth | - | _  number
_ | - | `false` | -| clockwise | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### CircleProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/circle.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ------------------------------------------------------------------------ | ------ | ------- | +| text | - | _  string
_ | - | `false` | +| lineCap | - | _  string
_ | - | `false` | +| value | - | _  number
_ | - | `false` | +| speed | - | _  number
_ | - | `false` | +| size | - | _  number
_ | - | `false` | +| fill | - | _  string
_ | - | `false` | +| layerColor | - | _  string
_ | - | `false` | +| color | - | _  string ¦ Record
_ | - | `false` | +| type | - | _  string
_ | - | `false` | +| strokeWidth | - | _  number
_ | - | `false` | +| clockwise | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/col/README.md b/packages/vantui-doc/src/col/README.md index 9ed2fe485..01b79ca9f 100644 --- a/packages/vantui-doc/src/col/README.md +++ b/packages/vantui-doc/src/col/README.md @@ -74,19 +74,19 @@ function Demo() { ) } ``` -### ColProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| span | 列元素宽度 | _  number ¦ string
_ | - | `true` | -| offset | 列元素偏移距离 | _  number ¦ string
_ | - | `false` | -| gutter | 列元素之间的间距（单位为 px）, 从Row上获取 | _  number ¦ string
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `true` | +### ColProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) -### Row Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | -------------------------------------------- | --------------------------------------------------- | ------ | ------- | +| span | 列元素宽度 | _  number ¦ string
_ | - | `true` | +| offset | 列元素偏移距离 | _  number ¦ string
_ | - | `false` | +| gutter | 列元素之间的间距（单位为 px）, 从 Row 上获取 | _  number ¦ string
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `true` | -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| gutter | 列元素之间的间距（单位为 px） | _  number ¦ string
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `true` | +### Row Props [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/col.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ----------------------------- | --------------------------------------------------- | ------ | ------- | +| gutter | 列元素之间的间距（单位为 px） | _  number ¦ string
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `true` | diff --git a/packages/vantui-doc/src/collapse/README.md b/packages/vantui-doc/src/collapse/README.md index 1fe73c314..2fbaf631c 100644 --- a/packages/vantui-doc/src/collapse/README.md +++ b/packages/vantui-doc/src/collapse/README.md @@ -123,35 +123,35 @@ function Demo() { ) } ``` -### CollapseProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  Array ¦ string
_ | - | `false` | -| accordion | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| children | - | _  Array
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onOpen | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | - -### CollapseItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | - | _  string ¦ number
_ | - | `false` | -| title | - | _  string ¦ number
_ | - | `false` | -| value | - | _  string ¦ number
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| clickable | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| isLink | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| renderValue | - | _  ReactNode
_ | - | `false` | -| size | - | _  "large"
_ | - | `false` | +### CollapseProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ------------------------------------------------------------------------------------ | ------ | ------- | +| value | - | _  Array ¦ string
_ | - | `false` | +| accordion | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| children | - | _  Array
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onOpen | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | + +### CollapseItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/collapse.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | --------------------------------------------------- | ------ | ------- | +| name | - | _  string ¦ number
_ | - | `false` | +| title | - | _  string ¦ number
_ | - | `false` | +| value | - | _  string ¦ number
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| clickable | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| isLink | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| renderValue | - | _  ReactNode
_ | - | `false` | +| size | - | _  "large"
_ | - | `false` | diff --git a/packages/vantui-doc/src/count-down/README.md b/packages/vantui-doc/src/count-down/README.md index 55265f9f0..4f7607e01 100644 --- a/packages/vantui-doc/src/count-down/README.md +++ b/packages/vantui-doc/src/count-down/README.md @@ -116,34 +116,34 @@ function Demo() { ) } ``` -### ICountDownRef [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| start | - | _  () => void
_ | -| pause | - | _  () => void
_ | -| reset | - | _  () => void
_ | - -### ITimeData [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| days | - | _  number
_ | -| hours | - | _  number
_ | -| minutes | - | _  number
_ | -| seconds | - | _  number
_ | -| milliseconds | - | _  number
_ | - -### CountDownProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| millisecond | - | _  boolean
_ | - | `false` | -| time | - | _  number
_ | - | `false` | -| format | - | _  string
_ | - | `false` | -| autoStart | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (timeData: {
    detail: ITimeData
  }) => void
_ | - | `false` | -| onFinish | - | _  () => void
_ | - | `false` | -| ref | - | _  React.MutableRefObject<
    ICountDownRef ¦ undefined
  >
_ | - | `false` | +### ICountDownRef [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) + +| 参数 | 说明 | 类型 | +| ----- | ---- | --------------------------------------- | +| start | - | _  () => void
_ | +| pause | - | _  () => void
_ | +| reset | - | _  () => void
_ | + +### ITimeData [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) + +| 参数 | 说明 | 类型 | +| ------------ | ---- | ------------------------- | +| days | - | _  number
_ | +| hours | - | _  number
_ | +| minutes | - | _  number
_ | +| seconds | - | _  number
_ | +| milliseconds | - | _  number
_ | + +### CountDownProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/count-down.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| millisecond | - | _  boolean
_ | - | `false` | +| time | - | _  number
_ | - | `false` | +| format | - | _  string
_ | - | `false` | +| autoStart | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (timeData: {
    detail: ITimeData
  }) => void
_ | - | `false` | +| onFinish | - | _  () => void
_ | - | `false` | +| ref | - | _  React.MutableRefObject<
    ICountDownRef ¦ undefined
  >
_ | - | `false` | diff --git a/packages/vantui-doc/src/datetime-picker/README.md b/packages/vantui-doc/src/datetime-picker/README.md index 3c92e0f6a..5ffb6ff4f 100644 --- a/packages/vantui-doc/src/datetime-picker/README.md +++ b/packages/vantui-doc/src/datetime-picker/README.md @@ -198,45 +198,46 @@ function Demo() { ) } ``` -### DatetimePickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | 选项的值 | _  string ¦ number
_ | null | `false` | -| filter | 对选项数组进行过滤，实现自定义时间间隔 | _  (
    type: string,
    values: (string ¦ number)[]
  ) => (number ¦ string)[]
_ | - | `false` | -| type | 时间类型，不建议动态修改 | _  attr:
    ¦ "datetime"
    ¦ "date"
    ¦ "year-month"
    ¦ "time"
_ | datetime | `false` | -| showToolbar | 是否显示顶部栏 | _  boolean
_ | true | `false` | -| formatter | 选项格式化函数 | _  (
    type: string,
    value: string ¦ number
  ) => number ¦ string
_ | - | `false` | -| minDate | 可选的最小时间，精确到分钟 | _  number ¦ string
_ | 十年前 | `false` | -| maxDate | 可选的最大时间，精确到分钟 | _  number ¦ string
_ | 十年后 | `false` | -| minHour | 可选的最小小时，针对type=time | _  number ¦ string
_ | 0 | `false` | -| maxHour | 可选的最大小时，针对type=time | _  number ¦ string
_ | 23 | `false` | -| minMinute | 可选的最小分钟，针对type=time | _  number ¦ string
_ | 0 | `false` | -| maxMinute | 可选的最大分钟，针对type=time | _  number ¦ string
_ | 59 | `false` | -| onInput | 当值变化时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | -| onChange | 当值变化时触发的事件 | _  (
    e: DatetimePickerEventsByInstance
  ) => void
_ | - | `false` | -| onConfirm | 点击完成按钮时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | -| onCancel | 点击取消按钮时触发的事件 | _  () => void
_ | - | `false` | - -### onInput、onConfirm的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) -继承了@taro/components的ITouchEvent + +### DatetimePickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | +| value | 选项的值 | _  string ¦ number
_ | null | `false` | +| filter | 对选项数组进行过滤，实现自定义时间间隔 | _  (
    type: string,
    values: (string ¦ number)[]
  ) => (number ¦ string)[]
_ | - | `false` | +| type | 时间类型，不建议动态修改 | _  attr:
    ¦ "datetime"
    ¦ "date"
    ¦ "year-month"
    ¦ "time"
_ | datetime | `false` | +| showToolbar | 是否显示顶部栏 | _  boolean
_ | true | `false` | +| formatter | 选项格式化函数 | _  (
    type: string,
    value: string ¦ number
  ) => number ¦ string
_ | - | `false` | +| minDate | 可选的最小时间，精确到分钟 | _  number ¦ string
_ | 十年前 | `false` | +| maxDate | 可选的最大时间，精确到分钟 | _  number ¦ string
_ | 十年后 | `false` | +| minHour | 可选的最小小时，针对 type=time | _  number ¦ string
_ | 0 | `false` | +| maxHour | 可选的最大小时，针对 type=time | _  number ¦ string
_ | 23 | `false` | +| minMinute | 可选的最小分钟，针对 type=time | _  number ¦ string
_ | 0 | `false` | +| maxMinute | 可选的最大分钟，针对 type=time | _  number ¦ string
_ | 59 | `false` | +| onInput | 当值变化时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | +| onChange | 当值变化时触发的事件 | _  (
    e: DatetimePickerEventsByInstance
  ) => void
_ | - | `false` | +| onConfirm | 点击完成按钮时触发的事件 | _  (e: DatetimePickerEventsByValue) => void
_ | - | `false` | +| onCancel | 点击取消按钮时触发的事件 | _  () => void
_ | - | `false` | + +### onInput、onConfirm 的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) + +继承了@taro/components 的 ITouchEvent | 参数 | 说明 | 类型 | | --- | --- | --- | | detail | 选项的值 | _  {
    value?: string ¦ number
  }
_ | -### onChange的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) - -| 方法 | 说明 | 类型 | -| --- | --- | --- | -| detail | 包含每项的值columns、当前时间innerValue、手动设置列数据setColumns、更新某列值updateColumnValue | _  {
    datetimePicker: {
      columns: (string ¦ number)[]
      setColumns: (
        columns: (string ¦ number)[]
      ) => void
      innerValue: Date
      updateColumnValue: (
        value: string
      ) => Promise
    }
  }
_ | +### onChange 的回掉参数 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) -### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) +| 方法 | 说明 | 类型 | +| ------ | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| detail | 包含每项的值 columns、当前时间 innerValue、手动设置列数据 setColumns、更新某列值 updateColumnValue | _  {
    datetimePicker: {
      columns: (string ¦ number)[]
      setColumns: (
        columns: (string ¦ number)[]
      ) => void
      innerValue: Date
      updateColumnValue: (
        value: string
      ) => Promise
    }
  }
_ | -| 方法 | 说明 | 类型 | -| --- | --- | --- | -| columns | - | _  (string ¦ number)[]
_ | -| setColumns | - | _  (columns: (string ¦ number)[]) => void
_ | -| innerValue | - | _  Date
_ | -| updateColumnValue | - | _  (value: string) => Promise
_ | -| pickerInstance | - | _  IPickerInstance
_ | +### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/datetime-picker.d.ts) +| 方法 | 说明 | 类型 | +| ----------------- | ---- | ----------------------------------------------------------------------------------------- | +| columns | - | _  (string ¦ number)[]
_ | +| setColumns | - | _  (columns: (string ¦ number)[]) => void
_ | +| innerValue | - | _  Date
_ | +| updateColumnValue | - | _  (value: string) => Promise
_ | +| pickerInstance | - | _  IPickerInstance
_ | diff --git a/packages/vantui-doc/src/divider/README.md b/packages/vantui-doc/src/divider/README.md index 996d3c636..6eed9ca39 100644 --- a/packages/vantui-doc/src/divider/README.md +++ b/packages/vantui-doc/src/divider/README.md @@ -9,7 +9,7 @@ 在 Taro 文件中引入组件 ```js -import { Divider } from "@antmjs/vantui"; +import { Divider } from '@antmjs/vantui' ``` > Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart)。 @@ -26,7 +26,6 @@ function Demo() { ) } - ``` ### 使用 hairline @@ -39,7 +38,6 @@ function Demo() { ) } - ``` ### 虚线 @@ -52,7 +50,6 @@ function Demo() { ) } - ``` ### 文本位置 @@ -67,7 +64,6 @@ function Demo() { ) } - ``` ### 自定义属性 @@ -88,7 +84,6 @@ function Demo() { ) } - ``` ### 自定义样式 @@ -106,17 +101,16 @@ function Demo() { ) } - ``` -### DividerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/divider.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| dashed | - | _  boolean
_ | - | `false` | -| hairline | - | _  boolean
_ | - | `false` | -| contentPosition | - | _  "left" ¦ "center" ¦ "right"
_ | - | `false` | -| fontSize | - | _  string
_ | - | `false` | -| borderColor | - | _  string
_ | - | `false` | -| textColor | - | _  string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### DividerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/divider.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | -------------------------------------------------------------------------------- | ------ | ------- | +| dashed | - | _  boolean
_ | - | `false` | +| hairline | - | _  boolean
_ | - | `false` | +| contentPosition | - | _  "left" ¦ "center" ¦ "right"
_ | - | `false` | +| fontSize | - | _  string
_ | - | `false` | +| borderColor | - | _  string
_ | - | `false` | +| textColor | - | _  string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/dropdown-menu/README.md b/packages/vantui-doc/src/dropdown-menu/README.md index ebd303ce9..13eddf188 100644 --- a/packages/vantui-doc/src/dropdown-menu/README.md +++ b/packages/vantui-doc/src/dropdown-menu/README.md @@ -201,47 +201,48 @@ function Demo() { ) } ``` -### DropdownMenuProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| activeColor | 选中选项后颜色 | _  string
_ | - | `false` | -| overlay | 是否展示蒙层 | _  boolean
_ | - | `false` | -| zIndex | 弹出层zIndex | _  number
_ | - | `false` | -| duration | 弹出层执行时间 | _  number
_ | - | `false` | -| direction | 弹出层执行方向 | _  "down" ¦ "up"
_ | - | `false` | -| closeOnClickOverlay | 点击蒙层是否关闭弹出层 | _  boolean
_ | - | `false` | -| closeOnClickOutside | 是否在点击外部 menu 后关闭菜单 | _  boolean
_ | - | `false` | -| children | 子元素,须为DropdownMenuItem | _  React.ReactNode
_ | - | `true` | - -### DropdownItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | 对应菜单选项的值 | _  string ¦ number
_ | - | `false` | -| title | 未选择时候的按钮标题 | _  string
_ | - | `false` | -| disabled | 是否禁用 | _  boolean
_ | - | `false` | -| titleClass | 标题元素的class | _  string
_ | - | `false` | -| options | 所有选项 | _  Array
_ | - | `true` | -| popupStyle | 弹出层的样式 | _  React.CSSProperties
_ | - | `false` | -| onOpen | 展开下拉项触发 | _  () => void
_ | - | `false` | -| onOpened | 展开下拉项完成时触发 | _  () => void
_ | - | `false` | -| onClose | 关闭下拉项触发 | _  () => void
_ | - | `false` | -| onClosed | 展开下拉项完成触发 | _  () => void
_ | - | `false` | -| onChange | 点击选项触发 | _  (value?: number ¦ string) => void
_ | - | `false` | -| children | 传入的子元素 | _  React.ReactNode ¦ React.ReactNode[]
_ | - | `false` | - -### 菜单下拉选项DropdownMenuOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| text | 展示的label | _  string
_ | -| value | 对应的数值 | _  number ¦ string
_ | -| icon | 前缀图标 | _  string
_ | -### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) -通过ref获取到的方法如下 +### DropdownMenuProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ------------------------------ | ------------------------------------------------- | ------ | ------- | +| activeColor | 选中选项后颜色 | _  string
_ | - | `false` | +| overlay | 是否展示蒙层 | _  boolean
_ | - | `false` | +| zIndex | 弹出层 zIndex | _  number
_ | - | `false` | +| duration | 弹出层执行时间 | _  number
_ | - | `false` | +| direction | 弹出层执行方向 | _  "down" ¦ "up"
_ | - | `false` | +| closeOnClickOverlay | 点击蒙层是否关闭弹出层 | _  boolean
_ | - | `false` | +| closeOnClickOutside | 是否在点击外部 menu 后关闭菜单 | _  boolean
_ | - | `false` | +| children | 子元素,须为 DropdownMenuItem | _  React.ReactNode
_ | - | `true` | + +### DropdownItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | -------------------- | ------------------------------------------------------------------------------------ | ------ | ------- | +| value | 对应菜单选项的值 | _  string ¦ number
_ | - | `false` | +| title | 未选择时候的按钮标题 | _  string
_ | - | `false` | +| disabled | 是否禁用 | _  boolean
_ | - | `false` | +| titleClass | 标题元素的 class | _  string
_ | - | `false` | +| options | 所有选项 | _  Array
_ | - | `true` | +| popupStyle | 弹出层的样式 | _  React.CSSProperties
_ | - | `false` | +| onOpen | 展开下拉项触发 | _  () => void
_ | - | `false` | +| onOpened | 展开下拉项完成时触发 | _  () => void
_ | - | `false` | +| onClose | 关闭下拉项触发 | _  () => void
_ | - | `false` | +| onClosed | 展开下拉项完成触发 | _  () => void
_ | - | `false` | +| onChange | 点击选项触发 | _  (value?: number ¦ string) => void
_ | - | `false` | +| children | 传入的子元素 | _  React.ReactNode ¦ React.ReactNode[]
_ | - | `false` | + +### 菜单下拉选项 DropdownMenuOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +| 参数 | 说明 | 类型 | +| ----- | ------------ | --------------------------------------------------- | +| text | 展示的 label | _  string
_ | +| value | 对应的数值 | _  number ¦ string
_ | +| icon | 前缀图标 | _  string
_ | + +### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/dropdown-menu.d.ts) + +通过 ref 获取到的方法如下 | 方法 | 说明 | 类型 | | --- | --- | --- | -| toggle | 控制展开/收起菜单栏，传入参数show是否展开，options.immediate是否不需要动画 | _  (
    show?: boolean,
    options?: { immediate: boolean }
  ) => void
_ | - +| toggle | 控制展开/收起菜单栏，传入参数 show 是否展开，options.immediate 是否不需要动画 | _  (
    show?: boolean,
    options?: { immediate: boolean }
  ) => void
_ | diff --git a/packages/vantui-doc/src/empty/README.md b/packages/vantui-doc/src/empty/README.md index 67a5c209f..d566ecd7a 100644 --- a/packages/vantui-doc/src/empty/README.md +++ b/packages/vantui-doc/src/empty/README.md @@ -9,7 +9,7 @@ 在 Taro 文件中引入组件 ```js -import { Empty } from "@antmjs/vantui"; +import { Empty } from '@antmjs/vantui' ``` ## 代码演示 @@ -24,7 +24,6 @@ function Demo() { ) } - ``` ### 图片类型 @@ -44,7 +43,6 @@ function Demo() { ) } - ``` ### 自定义图片 @@ -63,7 +61,6 @@ function Demo() { ) } - ``` ### 底部内容 @@ -82,15 +79,14 @@ function Demo() { ) } - ``` -### EmptyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/empty.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| description | - | _  string
_ | - | `false` | -| image | - | _  attr:
    ¦ "error"
    ¦ "search"
    ¦ "default"
    ¦ "network"
    ¦ string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderImage | - | _  ReactNode
_ | - | `false` | -| renderDescription | - | _  ReactNode
_ | - | `false` | +### EmptyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/empty.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| description | - | _  string
_ | - | `false` | +| image | - | _  attr:
    ¦ "error"
    ¦ "search"
    ¦ "default"
    ¦ "network"
    ¦ string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderImage | - | _  ReactNode
_ | - | `false` | +| renderDescription | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/field/README.md b/packages/vantui-doc/src/field/README.md index bb9013898..d020fa697 100644 --- a/packages/vantui-doc/src/field/README.md +++ b/packages/vantui-doc/src/field/README.md @@ -193,71 +193,71 @@ function Demo() { 这是微信小程序的 input 组件本身的问题，如果需要兼容手写输入法的场景，可以在 `blur` 事件中取到输入的值。 相关的讨论可以查看[微信开放社区](https://developers.weixin.qq.com/community/search?query=input%20%E6%89%8B%E5%86%99%E8%BE%93%E5%85%A5&page=1&block=1&random=1567079239098)。 -### FieldProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/field.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  string ¦ number
_ | - | `false` | -| placeholder | - | _  string
_ | - | `false` | -| placeholderStyle | - | _  string
_ | - | `false` | -| placeholderClass | - | _  string
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| maxlength | - | _  number
_ | - | `false` | -| cursorSpacing | - | _  number
_ | - | `false` | -| autoFocus | - | _  boolean
_ | - | `false` | -| focus | - | _  boolean
_ | - | `false` | -| cursor | - | _  number
_ | - | `false` | -| selectionStart | - | _  number
_ | - | `false` | -| selectionEnd | - | _  number
_ | - | `false` | -| adjustPosition | - | _  boolean
_ | - | `false` | -| holdKeyboard | - | _  boolean
_ | - | `false` | -| type | - | _  attr:
    ¦ "number"
    ¦ "text"
    ¦ "idcard"
    ¦ "digit"
    ¦ "textarea"
    ¦ "password"
_ | - | `false` | -| password | - | _  boolean
_ | - | `false` | -| confirmType | - | _  attr:
    ¦ "send"
    ¦ "search"
    ¦ "next"
    ¦ "go"
    ¦ "done"
_ | - | `false` | -| confirmHold | - | _  boolean
_ | - | `false` | -| autoHeight | - | _  boolean
_ | - | `false` | -| fixed | - | _  boolean
_ | - | `false` | -| showConfirmBar | - | _  boolean
_ | - | `false` | -| disableDefaultPadding | - | _  boolean
_ | - | `false` | -| size | - | _  "large"
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| error | - | _  boolean
_ | - | `false` | -| center | - | _  boolean
_ | - | `false` | -| isLink | - | _  boolean
_ | - | `false` | -| leftIcon | - | _  string
_ | - | `false` | -| rightIcon | - | _  string
_ | - | `false` | -| autosize | - | _  boolean ¦ Normal.IAnyObject
_ | - | `false` | -| required | - | _  boolean
_ | - | `false` | -| iconClass | - | _  string
_ | - | `false` | -| clickable | - | _  boolean
_ | - | `false` | -| inputAlign | - | _  string
_ | - | `false` | -| style | - | _  string
_ | - | `false` | -| errorMessage | - | _  string
_ | - | `false` | -| arrowDirection | - | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | -| showWordLimit | - | _  boolean
_ | - | `false` | -| errorMessageAlign | - | _  string
_ | - | `false` | -| alwaysEmbed | - | _  boolean
_ | - | `false` | -| readonly | - | _  boolean
_ | - | `false` | -| clearable | - | _  boolean
_ | - | `false` | -| clearTrigger | - | _  string
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| titleWidth | - | _  string
_ | - | `false` | -| clearIcon | - | _  string
_ | - | `false` | -| renderLeftIcon | - | _  ReactNode
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderInput | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| renderButton | - | _  ReactNode
_ | - | `false` | -| onInput | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onConfirm | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClickIcon | - | _  () => void
_ | - | `false` | -| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClear | - | _  () => void
_ | - | `false` | -| onClickInput | - | _  () => void
_ | - | `false` | -| onLineChange | - | _  CommonEventFunction
_ | - | `false` | -| onKeyboardHeightChange | - | _  CommonEventFunction
_ | - | `false` | +### FieldProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/field.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| value | - | _  string ¦ number
_ | - | `false` | +| placeholder | - | _  string
_ | - | `false` | +| placeholderStyle | - | _  string
_ | - | `false` | +| placeholderClass | - | _  string
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| maxlength | - | _  number
_ | - | `false` | +| cursorSpacing | - | _  number
_ | - | `false` | +| autoFocus | - | _  boolean
_ | - | `false` | +| focus | - | _  boolean
_ | - | `false` | +| cursor | - | _  number
_ | - | `false` | +| selectionStart | - | _  number
_ | - | `false` | +| selectionEnd | - | _  number
_ | - | `false` | +| adjustPosition | - | _  boolean
_ | - | `false` | +| holdKeyboard | - | _  boolean
_ | - | `false` | +| type | - | _  attr:
    ¦ "number"
    ¦ "text"
    ¦ "idcard"
    ¦ "digit"
    ¦ "textarea"
    ¦ "password"
_ | - | `false` | +| password | - | _  boolean
_ | - | `false` | +| confirmType | - | _  attr:
    ¦ "send"
    ¦ "search"
    ¦ "next"
    ¦ "go"
    ¦ "done"
_ | - | `false` | +| confirmHold | - | _  boolean
_ | - | `false` | +| autoHeight | - | _  boolean
_ | - | `false` | +| fixed | - | _  boolean
_ | - | `false` | +| showConfirmBar | - | _  boolean
_ | - | `false` | +| disableDefaultPadding | - | _  boolean
_ | - | `false` | +| size | - | _  "large"
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| error | - | _  boolean
_ | - | `false` | +| center | - | _  boolean
_ | - | `false` | +| isLink | - | _  boolean
_ | - | `false` | +| leftIcon | - | _  string
_ | - | `false` | +| rightIcon | - | _  string
_ | - | `false` | +| autosize | - | _  boolean ¦ Normal.IAnyObject
_ | - | `false` | +| required | - | _  boolean
_ | - | `false` | +| iconClass | - | _  string
_ | - | `false` | +| clickable | - | _  boolean
_ | - | `false` | +| inputAlign | - | _  string
_ | - | `false` | +| style | - | _  string
_ | - | `false` | +| errorMessage | - | _  string
_ | - | `false` | +| arrowDirection | - | _  "left" ¦ "up" ¦ "down"
_ | - | `false` | +| showWordLimit | - | _  boolean
_ | - | `false` | +| errorMessageAlign | - | _  string
_ | - | `false` | +| alwaysEmbed | - | _  boolean
_ | - | `false` | +| readonly | - | _  boolean
_ | - | `false` | +| clearable | - | _  boolean
_ | - | `false` | +| clearTrigger | - | _  string
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| titleWidth | - | _  string
_ | - | `false` | +| clearIcon | - | _  string
_ | - | `false` | +| renderLeftIcon | - | _  ReactNode
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderInput | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| renderButton | - | _  ReactNode
_ | - | `false` | +| onInput | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onConfirm | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClickIcon | - | _  () => void
_ | - | `false` | +| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClear | - | _  () => void
_ | - | `false` | +| onClickInput | - | _  () => void
_ | - | `false` | +| onLineChange | - | _  CommonEventFunction
_ | - | `false` | +| onKeyboardHeightChange | - | _  CommonEventFunction
_ | - | `false` | diff --git a/packages/vantui-doc/src/form/README.md b/packages/vantui-doc/src/form/README.md index 53973f498..852336241 100644 --- a/packages/vantui-doc/src/form/README.md +++ b/packages/vantui-doc/src/form/README.md @@ -302,41 +302,43 @@ function DatetimePickerBox_(props) { ) } ``` -### FormProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| form | 传入form实例（const formStore1 = useRef()） | _  IFormInstanceAPI
_ | - | `false` | -| initialValues | 初始化表单仓库值 | _  Record
_ | - | `false` | -| children | 第一级必须是FormItem组件 | _  ReactNode
_ | - | `true` | -| className | 类名 | _  string
_ | - | `false` | -| onFinish | 表单提交触发，配合button.formType = submit | _  () => void
_ | - | `false` | -| onFinishFailed | 表单提交失败触发 | _  () => void
_ | - | `false` | - -### FormItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | 对应表单字段名 | _  string
_ | - | `true` | -| children | 第一级操作表单组件 | _  ReactNode
_ | - | `true` | -| label | 表单label | _  ReactNode
_ | - | `true` | -| layout | 垂直 ｜ 水平 | _  "vertical" ¦ "horizontal"
_ | horizontal | `false` | -| required | 是否必填 | _  boolean
_ | false | `false` | -| validateTrigger | 验证表单触发方法名 | _  string
_ | onChange | `false` | -| labelClassName | label的外层className | _  string
_ | - | `false` | -| requiredClassName | required的外层className | _  string
_ | - | `false` | -| controllClassName | 表单组件的外层className | _  string
_ | - | `false` | -| className | formItem最外层className | _  string
_ | - | `false` | -| requiredIcon | 自定义必填标识 | _  ReactNode
_ | - | `false` | -| feedback | 验证后反馈的信息，可设置为校验成功、失败、都展示或隐藏 | _  "success" ¦ "failed" ¦ "all" ¦ "hidden"
_ | failed | `false` | -| renderRight | 自定义渲染右边内容 | _  ReactNode
_ | - | `false` | -| trigger | 表单交互触发方法 | _  string
_ | onChange | `false` | -| valueKey | 表单控制展示的具体值的字段名 | _  string
_ | value | `false` | -| valueFormat | 根据表单交互回掉函数（时间）参数的重新定义 | _  (
    value: any,
    name: string,
    IFormInstance: IFormInstanceAPI
  ) => any
_ | value | `false` | -| rules | 正则校验值，或者自定义校验后call回掉函数返回错误信息 | _  {
    rule:
      ¦ ((
          value: any,
          call: (errMess: string) => void
        ) => void)
      ¦ RegExp
    message?: string
  }
_ | - | `false` | - -### IFormInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) -通过ref获取到的form的实例 + +### FormProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------------- | --------------------------------------------- | ------------------------------------------- | ------ | ------- | +| form | 传入 form 实例（const formStore1 = useRef()） | _  IFormInstanceAPI
_ | - | `false` | +| initialValues | 初始化表单仓库值 | _  Record
_ | - | `false` | +| children | 第一级必须是 FormItem 组件 | _  ReactNode
_ | - | `true` | +| className | 类名 | _  string
_ | - | `false` | +| onFinish | 表单提交触发，配合 button.formType = submit | _  () => void
_ | - | `false` | +| onFinishFailed | 表单提交失败触发 | _  () => void
_ | - | `false` | + +### FormItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | ------- | +| name | 对应表单字段名 | _  string
_ | - | `true` | +| children | 第一级操作表单组件 | _  ReactNode
_ | - | `true` | +| label | 表单 label | _  ReactNode
_ | - | `true` | +| layout | 垂直 ｜ 水平 | _  "vertical" ¦ "horizontal"
_ | horizontal | `false` | +| required | 是否必填 | _  boolean
_ | false | `false` | +| validateTrigger | 验证表单触发方法名 | _  string
_ | onChange | `false` | +| labelClassName | label 的外层 className | _  string
_ | - | `false` | +| requiredClassName | required 的外层 className | _  string
_ | - | `false` | +| controllClassName | 表单组件的外层 className | _  string
_ | - | `false` | +| className | formItem 最外层 className | _  string
_ | - | `false` | +| requiredIcon | 自定义必填标识 | _  ReactNode
_ | - | `false` | +| feedback | 验证后反馈的信息，可设置为校验成功、失败、都展示或隐藏 | _  "success" ¦ "failed" ¦ "all" ¦ "hidden"
_ | failed | `false` | +| renderRight | 自定义渲染右边内容 | _  ReactNode
_ | - | `false` | +| trigger | 表单交互触发方法 | _  string
_ | onChange | `false` | +| valueKey | 表单控制展示的具体值的字段名 | _  string
_ | value | `false` | +| valueFormat | 根据表单交互回掉函数（时间）参数的重新定义 | _  (
    value: any,
    name: string,
    IFormInstance: IFormInstanceAPI
  ) => any
_ | value | `false` | +| rules | 正则校验值，或者自定义校验后 call 回掉函数返回错误信息 | _  {
    rule:
      ¦ ((
          value: any,
          call: (errMess: string) => void
        ) => void)
      ¦ RegExp
    message?: string
  }
_ | - | `false` | + +### IFormInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/form.d.ts) + +通过 ref 获取到的 form 的实例 | 方法 | 说明 | 类型 | | --- | --- | --- | | registerValidateFields | 注册校验规则 | _  (
    name: string,
    control: Record,
    model: Record
  ) => void
_ | @@ -347,5 +349,4 @@ function DatetimePickerBox_(props) { | getFieldsValue | 获取所有表单值 | _  () => void
_ | | getFieldValue | 获取单个表单值 | _  (name: string) => any
_ | | validateFields | 校验表单，并获取错误信息和所有表单值 | _  (
    callback: (
      errorMess: Array,
      values: Record
    ) => void
  ) => void
_ | -| submit | 校验表单，并获取错误信息和所有表单值，触发form.onFinish和onFinishFailed | _  (
    callback?: (
      errs: Array ¦ null,
      values: Record
    ) => void
  ) => void
_ | - +| submit | 校验表单，并获取错误信息和所有表单值，触发 form.onFinish 和 onFinishFailed | _  (
    callback?: (
      errs: Array ¦ null,
      values: Record
    ) => void
  ) => void
_ | diff --git a/packages/vantui-doc/src/goods-action/README.md b/packages/vantui-doc/src/goods-action/README.md index dfbf868fb..e9881ccb1 100644 --- a/packages/vantui-doc/src/goods-action/README.md +++ b/packages/vantui-doc/src/goods-action/README.md @@ -92,10 +92,10 @@ function Demo() { ) } ``` -### GoodsActionProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/goods-action.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `true` | +### GoodsActionProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/goods-action.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ---------------------------- | ------ | ------- | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `true` | diff --git a/packages/vantui-doc/src/grid/README.md b/packages/vantui-doc/src/grid/README.md index 7185ebdc0..1fda573b5 100644 --- a/packages/vantui-doc/src/grid/README.md +++ b/packages/vantui-doc/src/grid/README.md @@ -158,33 +158,33 @@ function Demo() { ) } ``` -### GridProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| square | - | _  boolean
_ | - | `false` | -| gutter | - | _  number ¦ string
_ | - | `false` | -| clickable | - | _  boolean
_ | - | `false` | -| columnNum | - | _  number
_ | - | `false` | -| center | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| direction | - | _  string
_ | - | `false` | -| iconSize | - | _  string ¦ number
_ | - | `false` | -| reverse | - | _  boolean
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | - -### GridItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| icon | - | _  string
_ | - | `false` | -| iconColor | - | _  string
_ | - | `false` | -| iconPrefix | - | _  string
_ | - | `false` | -| dot | - | _  boolean
_ | - | `false` | -| info | - | _  string ¦ number ¦ undefined
_ | - | `false` | -| badge | - | _  string ¦ number ¦ undefined
_ | - | `false` | -| text | - | _  string
_ | - | `false` | -| url | - | _  string
_ | - | `false` | -| linkType | - | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | +### GridProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | --------------------------------------------------- | ------ | ------- | +| square | - | _  boolean
_ | - | `false` | +| gutter | - | _  number ¦ string
_ | - | `false` | +| clickable | - | _  boolean
_ | - | `false` | +| columnNum | - | _  number
_ | - | `false` | +| center | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| direction | - | _  string
_ | - | `false` | +| iconSize | - | _  string ¦ number
_ | - | `false` | +| reverse | - | _  boolean
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | + +### GridItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/grid.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | ---- | --------------------------------------------------------------------------------------------- | ------ | ------- | +| icon | - | _  string
_ | - | `false` | +| iconColor | - | _  string
_ | - | `false` | +| iconPrefix | - | _  string
_ | - | `false` | +| dot | - | _  boolean
_ | - | `false` | +| info | - | _  string ¦ number ¦ undefined
_ | - | `false` | +| badge | - | _  string ¦ number ¦ undefined
_ | - | `false` | +| text | - | _  string
_ | - | `false` | +| url | - | _  string
_ | - | `false` | +| linkType | - | _  "navigateTo" ¦ "reLaunch" ¦ "redirectTo"
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/image/README.md b/packages/vantui-doc/src/image/README.md index 3addda484..e8012b7e7 100644 --- a/packages/vantui-doc/src/image/README.md +++ b/packages/vantui-doc/src/image/README.md @@ -185,20 +185,20 @@ function Demo() { ) } ``` -### ImageProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/image.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| src | 图片链接 | _  string
_ | - | `true` | -| round | 是否圆角 | _  boolean
_ | false | `false` | -| width | 宽度，单位为px | _  number ¦ string
_ | - | `false` | -| height | 高度，单位为px | _  number ¦ string
_ | - | `false` | -| radius | 圆角大小 | _  number ¦ string
_ | 0 | `false` | -| lazyLoad | 是否懒加载 | _  boolean
_ | false | `false` | -| showMenuByLongpress | 是否开启长按图片显示识别小程序码菜单 | _  boolean
_ | false | `false` | -| fit | 图片填充模式 | _  attr:
    ¦ "contain"
    ¦ "cover"
    ¦ "fill"
    ¦ "widthFix"
    ¦ "heightFix"
    ¦ "none"
_ | fill | `false` | -| showError | 是否展示图片加载失败提示 | _  boolean
_ | false | `false` | -| showLoading | 是否使用 loading 状态 | _  boolean
_ | true | `false` | -| renderLoading | 渲染loading展示元素 | _  ReactNode
_ | - | `false` | -| renderError | 渲染错误描述展示元素 | _  ReactNode
_ | - | `false` | +### ImageProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/image.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| src | 图片链接 | _  string
_ | - | `true` | +| round | 是否圆角 | _  boolean
_ | false | `false` | +| width | 宽度，单位为 px | _  number ¦ string
_ | - | `false` | +| height | 高度，单位为 px | _  number ¦ string
_ | - | `false` | +| radius | 圆角大小 | _  number ¦ string
_ | 0 | `false` | +| lazyLoad | 是否懒加载 | _  boolean
_ | false | `false` | +| showMenuByLongpress | 是否开启长按图片显示识别小程序码菜单 | _  boolean
_ | false | `false` | +| fit | 图片填充模式 | _  attr:
    ¦ "contain"
    ¦ "cover"
    ¦ "fill"
    ¦ "widthFix"
    ¦ "heightFix"
    ¦ "none"
_ | fill | `false` | +| showError | 是否展示图片加载失败提示 | _  boolean
_ | false | `false` | +| showLoading | 是否使用 loading 状态 | _  boolean
_ | true | `false` | +| renderLoading | 渲染 loading 展示元素 | _  ReactNode
_ | - | `false` | +| renderError | 渲染错误描述展示元素 | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/index-bar/README.md b/packages/vantui-doc/src/index-bar/README.md index f2e9980b0..a41374b84 100644 --- a/packages/vantui-doc/src/index-bar/README.md +++ b/packages/vantui-doc/src/index-bar/README.md @@ -61,15 +61,15 @@ function Demo() { ``` -### IndexBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/index-bar.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| sticky | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| highlightColor | - | _  string
_ | - | `false` | -| stickyOffsetTop | - | _  number
_ | - | `false` | -| indexList | - | _  string[] ¦ number[]
_ | - | `false` | -| onSelect | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### IndexBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/index-bar.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| sticky | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| highlightColor | - | _  string
_ | - | `false` | +| stickyOffsetTop | - | _  number
_ | - | `false` | +| indexList | - | _  string[] ¦ number[]
_ | - | `false` | +| onSelect | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/index/README.md b/packages/vantui-doc/src/index/README.md index 11c400ef6..2aab49c2c 100644 --- a/packages/vantui-doc/src/index/README.md +++ b/packages/vantui-doc/src/index/README.md @@ -1,3 +1,3 @@ ### 说明 -具体组件使用方式暂时请查看[有赞文档](https://youzan.github.io/vant-weapp/#/home) \ No newline at end of file +具体组件使用方式暂时请查看[有赞文档](https://youzan.github.io/vant-weapp/#/home) diff --git a/packages/vantui-doc/src/loading/README.md b/packages/vantui-doc/src/loading/README.md index 18dc69bcc..62aa0d443 100644 --- a/packages/vantui-doc/src/loading/README.md +++ b/packages/vantui-doc/src/loading/README.md @@ -59,14 +59,14 @@ function Demo() { ) } ``` -### LoadingProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/loading.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| color | - | _  string
_ | - | `false` | -| vertical | - | _  boolean
_ | - | `false` | -| type | - | _  "spinner" ¦ "circular"
_ | - | `false` | -| size | - | _  string ¦ number
_ | - | `false` | -| textSize | - | _  string ¦ number
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | +### LoadingProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/loading.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ---- | ---------------------------------------------------------- | ------ | ------- | +| color | - | _  string
_ | - | `false` | +| vertical | - | _  boolean
_ | - | `false` | +| type | - | _  "spinner" ¦ "circular"
_ | - | `false` | +| size | - | _  string ¦ number
_ | - | `false` | +| textSize | - | _  string ¦ number
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/nav-bar/README.md b/packages/vantui-doc/src/nav-bar/README.md index 9b5570971..e417a9e9b 100644 --- a/packages/vantui-doc/src/nav-bar/README.md +++ b/packages/vantui-doc/src/nav-bar/README.md @@ -50,23 +50,23 @@ function Demo() { ) } ``` -### NavBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/nav-bar.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| title | - | _  string
_ | - | `false` | -| fixed | - | _  boolean
_ | - | `false` | -| placeholder | - | _  boolean
_ | - | `false` | -| leftText | - | _  string
_ | - | `false` | -| rightText | - | _  string
_ | - | `false` | -| style | - | _  string
_ | - | `false` | -| leftArrow | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| safeAreaInsetTop | - | _  boolean
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderLeft | - | _  ReactNode
_ | - | `false` | -| renderRight | - | _  ReactNode
_ | - | `false` | -| onClickLeft | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClickRight | - | _  (e: ITouchEvent) => void
_ | - | `false` | +### NavBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/nav-bar.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ---------------------------------------------------------- | ------ | ------- | +| title | - | _  string
_ | - | `false` | +| fixed | - | _  boolean
_ | - | `false` | +| placeholder | - | _  boolean
_ | - | `false` | +| leftText | - | _  string
_ | - | `false` | +| rightText | - | _  string
_ | - | `false` | +| style | - | _  string
_ | - | `false` | +| leftArrow | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| safeAreaInsetTop | - | _  boolean
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderLeft | - | _  ReactNode
_ | - | `false` | +| renderRight | - | _  ReactNode
_ | - | `false` | +| onClickLeft | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClickRight | - | _  (e: ITouchEvent) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/notice-bar/README.md b/packages/vantui-doc/src/notice-bar/README.md index d08c8eeed..e503928ce 100644 --- a/packages/vantui-doc/src/notice-bar/README.md +++ b/packages/vantui-doc/src/notice-bar/README.md @@ -111,25 +111,25 @@ function Demo() { ) } ``` -### NoticeBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notice-bar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| text | - | _  string
_ | - | `false` | -| mode | - | _  "closeable" ¦ "link"
_ | - | `false` | -| url | - | _  string
_ | - | `false` | -| openType | - | _  any
_ | - | `false` | -| delay | - | _  number
_ | - | `false` | -| speed | - | _  number
_ | - | `false` | -| scrollable | - | _  boolean
_ | - | `false` | -| leftIcon | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| backgroundColor | - | _  string
_ | - | `false` | -| background | - | _  string
_ | - | `false` | -| wrapable | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderLeftIcon | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| onClick | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | +### NoticeBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notice-bar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| text | - | _  string
_ | - | `false` | +| mode | - | _  "closeable" ¦ "link"
_ | - | `false` | +| url | - | _  string
_ | - | `false` | +| openType | - | _  any
_ | - | `false` | +| delay | - | _  number
_ | - | `false` | +| speed | - | _  number
_ | - | `false` | +| scrollable | - | _  boolean
_ | - | `false` | +| leftIcon | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| backgroundColor | - | _  string
_ | - | `false` | +| background | - | _  string
_ | - | `false` | +| wrapable | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderLeftIcon | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| onClick | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onClose | - | _  (event: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/notify/README.md b/packages/vantui-doc/src/notify/README.md index b573a5229..fbd6e634f 100644 --- a/packages/vantui-doc/src/notify/README.md +++ b/packages/vantui-doc/src/notify/README.md @@ -139,21 +139,21 @@ function Demo() { ) } ``` -### NotifyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notify.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| selector | - | _  string
_ | - | `false` | -| message | - | _  string
_ | - | `false` | -| background | - | _  string
_ | - | `false` | -| type | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| duration | - | _  number
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| safeAreaInsetTop | - | _  boolean
_ | - | `false` | -| top | - | _  number
_ | - | `false` | -| id | - | _  string
_ | - | `false` | -| onClick | - | _  (data: any) => void
_ | - | `false` | -| onOpened | - | _  () => void
_ | - | `false` | -| onClose | - | _  () => void
_ | - | `false` | +### NotifyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/notify.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ----------------------------------------------------- | ------ | ------- | +| selector | - | _  string
_ | - | `false` | +| message | - | _  string
_ | - | `false` | +| background | - | _  string
_ | - | `false` | +| type | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| duration | - | _  number
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| safeAreaInsetTop | - | _  boolean
_ | - | `false` | +| top | - | _  number
_ | - | `false` | +| id | - | _  string
_ | - | `false` | +| onClick | - | _  (data: any) => void
_ | - | `false` | +| onOpened | - | _  () => void
_ | - | `false` | +| onClose | - | _  () => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/number-keyboard/README.md b/packages/vantui-doc/src/number-keyboard/README.md index 4d79579e9..65eaf2b1d 100644 --- a/packages/vantui-doc/src/number-keyboard/README.md +++ b/packages/vantui-doc/src/number-keyboard/README.md @@ -105,20 +105,20 @@ function Demo() { ) } ``` -### NumberKeyboardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/number-keyboard.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| visible | 是否展示 | _  boolean
_ | - | `false` | -| title | 键盘标题 | _  string
_ | - | `false` | -| confirmText | 完成按钮文案，null 不展示 | _  string ¦ null
_ | null | `false` | -| customKey | 自定义按钮 | _  "-" ¦ "." ¦ "X"
_ | - | `false` | -| randomOrder | 是否乱序键盘 | _  boolean
_ | false | `false` | -| showCloseButton | 是否展示收起键盘箭头 | _  boolean
_ | true | `false` | -| onInput | 输入内容回调 | _  (v: string) => void
_ | true | `false` | -| onDelete | 删除内容回调 | _  () => void
_ | - | `false` | -| onClose | 点击关闭时触发 | _  () => void
_ | - | `false` | -| onConfirm | 点击确定按钮时触发 | _  () => void
_ | - | `false` | -| afterClose | 键盘完全收起回调 | _  () => void
_ | - | `false` | -| closeOnConfirm | 是否在点击确定按钮时自动关闭 | _  boolean
_ | true | `false` | +### NumberKeyboardProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/number-keyboard.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---------------------------- | -------------------------------------------------------------------- | ------ | ------- | +| visible | 是否展示 | _  boolean
_ | - | `false` | +| title | 键盘标题 | _  string
_ | - | `false` | +| confirmText | 完成按钮文案，null 不展示 | _  string ¦ null
_ | null | `false` | +| customKey | 自定义按钮 | _  "-" ¦ "." ¦ "X"
_ | - | `false` | +| randomOrder | 是否乱序键盘 | _  boolean
_ | false | `false` | +| showCloseButton | 是否展示收起键盘箭头 | _  boolean
_ | true | `false` | +| onInput | 输入内容回调 | _  (v: string) => void
_ | true | `false` | +| onDelete | 删除内容回调 | _  () => void
_ | - | `false` | +| onClose | 点击关闭时触发 | _  () => void
_ | - | `false` | +| onConfirm | 点击确定按钮时触发 | _  () => void
_ | - | `false` | +| afterClose | 键盘完全收起回调 | _  () => void
_ | - | `false` | +| closeOnConfirm | 是否在点击确定按钮时自动关闭 | _  boolean
_ | true | `false` | diff --git a/packages/vantui-doc/src/overlay/README.md b/packages/vantui-doc/src/overlay/README.md index ec46cfc6d..666d5fdf0 100644 --- a/packages/vantui-doc/src/overlay/README.md +++ b/packages/vantui-doc/src/overlay/README.md @@ -51,13 +51,13 @@ function Demo() { ) } ``` -### OverlayProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/overlay.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| show | - | _  boolean
_ | - | `false` | -| lockScroll | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| duration | - | _  attr:
    ¦ string
    ¦ number
    ¦ {
        enter: string ¦ number
        leave: string ¦ number
      }
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### OverlayProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/overlay.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| show | - | _  boolean
_ | - | `false` | +| lockScroll | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| duration | - | _  attr:
    ¦ string
    ¦ number
    ¦ {
        enter: string ¦ number
        leave: string ¦ number
      }
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/pagination/README.md b/packages/vantui-doc/src/pagination/README.md index 170bd93df..c92a87843 100644 --- a/packages/vantui-doc/src/pagination/README.md +++ b/packages/vantui-doc/src/pagination/README.md @@ -109,21 +109,21 @@ function Demo() { ) } ``` -### PaginationProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/pagination.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| defaultValue | 默认页码 | _  number
_ | 1 | `false` | -| modelValue | 当前页码 | _  number
_ | 1 | `true` | -| mode | - | _  "multi" ¦ "simple"
_ | multi | `false` | -| prevText | 自定义上一页按钮内容 | _  React.ReactNode
_ | 上一页 | `false` | -| nextText | 自定义下一页按钮内容 | _  React.ReactNode
_ | 下一页 | `false` | -| pageCount | 总页数 | _  string ¦ number
_ | 传入或者根据数据量计算 | `true` | -| totalItems | 总记录数 | _  string ¦ number
_ | 0 | `false` | -| itemsPerPage | 每页数量 | _  string ¦ number
_ | 10 | `false` | -| showPageSize | 显示页码个数 | _  string ¦ number
_ | 5 | `false` | -| forceEllipses | 是否展示省略号 | _  boolean
_ | false | `false` | -| pageNodeRender | 自定义渲染页码结构, 入参数为number页数、text文本、 active选中状态 | _  (page: {
    number: number
    text: string
    active: boolean
  }) => React.ReactNode
_ | - | `false` | -| onChange | 页码改变的时候触发 | _  (currPage: number) => void
_ | - | `true` | -| updatecurrent | - | _  (currPage: number) => void
_ | - | `false` | +### PaginationProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/pagination.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ------- | +| defaultValue | 默认页码 | _  number
_ | 1 | `false` | +| modelValue | 当前页码 | _  number
_ | 1 | `true` | +| mode | - | _  "multi" ¦ "simple"
_ | multi | `false` | +| prevText | 自定义上一页按钮内容 | _  React.ReactNode
_ | 上一页 | `false` | +| nextText | 自定义下一页按钮内容 | _  React.ReactNode
_ | 下一页 | `false` | +| pageCount | 总页数 | _  string ¦ number
_ | 传入或者根据数据量计算 | `true` | +| totalItems | 总记录数 | _  string ¦ number
_ | 0 | `false` | +| itemsPerPage | 每页数量 | _  string ¦ number
_ | 10 | `false` | +| showPageSize | 显示页码个数 | _  string ¦ number
_ | 5 | `false` | +| forceEllipses | 是否展示省略号 | _  boolean
_ | false | `false` | +| pageNodeRender | 自定义渲染页码结构, 入参数为 number 页数、text 文本、 active 选中状态 | _  (page: {
    number: number
    text: string
    active: boolean
  }) => React.ReactNode
_ | - | `false` | +| onChange | 页码改变的时候触发 | _  (currPage: number) => void
_ | - | `true` | +| updatecurrent | - | _  (currPage: number) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/picker/README.md b/packages/vantui-doc/src/picker/README.md index 13dcf3a59..8a636a0e0 100644 --- a/packages/vantui-doc/src/picker/README.md +++ b/packages/vantui-doc/src/picker/README.md @@ -153,39 +153,43 @@ function Demo() { return } ``` -### PickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| valueKey | 选项为对象的时候，文字对应的 key | _  string
_ | text | `false` | -| toolbarPosition | 顶部栏位置，可选值为bottom | _  string
_ | top | `false` | -| defaultIndex | 单列选择器的默认选中项索引,多列选择器请参考下方的 Columns 配置 | _  number
_ | 0 | `false` | -| columns | 每一项数据，可为字符或者对象，对象默认展示值是valueKey设置的key | _  any[]
_ | [] | `false` | -| title | 顶部栏标题 | _  string
_ | '' | `false` | -| cancelButtonText | 取消按钮文字 | _  string
_ | 取消 | `false` | -| confirmButtonText | 确认按钮文字 | _  string
_ | 确认 | `false` | -| loading | 加载状态 | _  boolean
_ | false | `false` | -| itemHeight | 选项高度,对应单位PX | _  string ¦ number
_ | 48 | `false` | -| visibleItemCount | 可见的选项个数 | _  number
_ | 6 | `false` | -| onChange | 变化触发方法 | _  (e: PickerChangeEvents) => void
_ | - | `false` | -| onCancel | 取消触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | -| onConfirm | 确认触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | -| showToolbar | 是否显示顶部栏 | _  boolean
_ | false | `false` | - -### 事件 onConfirm 和 onCancel [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) -继承了Taro的ITouchEvent类型 + +### PickerProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------- | ------ | ------- | +| valueKey | 选项为对象的时候，文字对应的 key | _  string
_ | text | `false` | +| toolbarPosition | 顶部栏位置，可选值为 bottom | _  string
_ | top | `false` | +| defaultIndex | 单列选择器的默认选中项索引,多列选择器请参考下方的 Columns 配置 | _  number
_ | 0 | `false` | +| columns | 每一项数据，可为字符或者对象，对象默认展示值是 valueKey 设置的 key | _  any[]
_ | [] | `false` | +| title | 顶部栏标题 | _  string
_ | '' | `false` | +| cancelButtonText | 取消按钮文字 | _  string
_ | 取消 | `false` | +| confirmButtonText | 确认按钮文字 | _  string
_ | 确认 | `false` | +| loading | 加载状态 | _  boolean
_ | false | `false` | +| itemHeight | 选项高度,对应单位 PX | _  string ¦ number
_ | 48 | `false` | +| visibleItemCount | 可见的选项个数 | _  number
_ | 6 | `false` | +| onChange | 变化触发方法 | _  (e: PickerChangeEvents) => void
_ | - | `false` | +| onCancel | 取消触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | +| onConfirm | 确认触发方法 | _  (e: PickerEvents) => void
_ | - | `false` | +| showToolbar | 是否显示顶部栏 | _  boolean
_ | false | `false` | + +### 事件 onConfirm 和 onCancel [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +继承了 Taro 的 ITouchEvent 类型 | 参数 | 说明 | 类型 | | --- | --- | --- | | detail | 返回选项对应的值和选项对应的下标 | _  {
    value: number ¦ number[]
    index: number ¦ number[]
  }
_ | -### 触发事件 onChange [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) -继承了Taro的ITouchEvent类型 +### 触发事件 onChange [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +继承了 Taro 的 ITouchEvent 类型 | 参数 | 说明 | 类型 | | --- | --- | --- | -| detail | 返回选项对应的值、picker实例和多列返回当前第多少列、单列返回选项对应值 | _  {
    value: number ¦ number[]
    picker: IPickerInstance
    index: number
  }
_ | +| detail | 返回选项对应的值、picker 实例和多列返回当前第多少列、单列返回选项对应值 | _  {
    value: number ¦ number[]
    picker: IPickerInstance
    index: number
  }
_ | -### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) -通过ref获取到的方法如下 +### 组件实例 [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/picker.d.ts) + +通过 ref 获取到的方法如下 | 方法 | 说明 | 类型 | | --- | --- | --- | | setColumnValues | 设置每一列的值 | _  (
    index: number,
    options: string[]
  ) => Promise
_ | @@ -197,4 +201,3 @@ function Demo() { | setIndexes | 获取每一列展示的下标 | _  () => void
_ | | getValues | 每一列展示的下标 | _  () => number ¦ string
_ | | confirm | 触发确认的方法 | _  () => void
_ | - diff --git a/packages/vantui-doc/src/progress/README.md b/packages/vantui-doc/src/progress/README.md index 4e0ede8bb..5a707dfe1 100644 --- a/packages/vantui-doc/src/progress/README.md +++ b/packages/vantui-doc/src/progress/README.md @@ -64,17 +64,17 @@ function Demo() { ) } ``` -### ProgressProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/progress.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| inactive | - | _  boolean
_ | - | `false` | -| percentage | - | _  number
_ | - | `true` | -| pivotText | - | _  string
_ | - | `false` | -| pivotColor | - | _  string
_ | - | `false` | -| trackColor | - | _  string
_ | - | `false` | -| showPivot | - | _  boolean
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| textColor | - | _  string
_ | - | `false` | -| strokeWidth | - | _  number ¦ string
_ | - | `false` | +### ProgressProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/progress.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | --------------------------------------------------- | ------ | ------- | +| inactive | - | _  boolean
_ | - | `false` | +| percentage | - | _  number
_ | - | `true` | +| pivotText | - | _  string
_ | - | `false` | +| pivotColor | - | _  string
_ | - | `false` | +| trackColor | - | _  string
_ | - | `false` | +| showPivot | - | _  boolean
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| textColor | - | _  string
_ | - | `false` | +| strokeWidth | - | _  number ¦ string
_ | - | `false` | diff --git a/packages/vantui-doc/src/radio/README.md b/packages/vantui-doc/src/radio/README.md index 6247aa47a..451604834 100644 --- a/packages/vantui-doc/src/radio/README.md +++ b/packages/vantui-doc/src/radio/README.md @@ -221,29 +221,29 @@ function Demo() { ) } ``` -### RadioProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| name | - | _  string
_ | - | `false` | -| value | - | _  any
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| checkedColor | - | _  string
_ | - | `false` | -| labelPosition | - | _  string
_ | - | `false` | -| labelDisabled | - | _  boolean
_ | - | `false` | -| shape | - | _  "round" ¦ "square"
_ | - | `false` | -| iconSize | - | _  number ¦ string
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | - -### RadioGroupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  any
_ | - | `false` | -| direction | - | _  "vertical" ¦ "horizontal"
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | +### RadioProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| name | - | _  string
_ | - | `false` | +| value | - | _  any
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| checkedColor | - | _  string
_ | - | `false` | +| labelPosition | - | _  string
_ | - | `false` | +| labelDisabled | - | _  boolean
_ | - | `false` | +| shape | - | _  "round" ¦ "square"
_ | - | `false` | +| iconSize | - | _  number ¦ string
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | + +### RadioGroupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/radio.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| value | - | _  any
_ | - | `false` | +| direction | - | _  "vertical" ¦ "horizontal"
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/rate/README.md b/packages/vantui-doc/src/rate/README.md index a8c3a5d2a..d454dd424 100644 --- a/packages/vantui-doc/src/rate/README.md +++ b/packages/vantui-doc/src/rate/README.md @@ -106,23 +106,23 @@ function Demo() { return } ``` -### RateProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/rate.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  number
_ | - | `false` | -| defaultValue | - | _  number
_ | - | `false` | -| readonly | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| allowHalf | - | _  boolean
_ | - | `false` | -| size | - | _  string ¦ number
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| voidIcon | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| voidColor | - | _  string
_ | - | `false` | -| disabledColor | - | _  string
_ | - | `false` | -| count | - | _  number
_ | - | `false` | -| gutter | - | _  string ¦ number
_ | - | `false` | -| touchable | - | _  boolean
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent) => any
_ | - | `false` | +### RateProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/rate.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | --------------------------------------------------------- | ------ | ------- | +| value | - | _  number
_ | - | `false` | +| defaultValue | - | _  number
_ | - | `false` | +| readonly | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| allowHalf | - | _  boolean
_ | - | `false` | +| size | - | _  string ¦ number
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| voidIcon | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| voidColor | - | _  string
_ | - | `false` | +| disabledColor | - | _  string
_ | - | `false` | +| count | - | _  number
_ | - | `false` | +| gutter | - | _  string ¦ number
_ | - | `false` | +| touchable | - | _  boolean
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/search/README.md b/packages/vantui-doc/src/search/README.md index 2be1d7f3b..4198152b2 100644 --- a/packages/vantui-doc/src/search/README.md +++ b/packages/vantui-doc/src/search/README.md @@ -108,39 +108,39 @@ function Demo() { ) } ``` -### SearchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/search.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| value | - | _  string ¦ number
_ | - | `false` | -| defaultValue | - | _  string ¦ number
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| focus | - | _  boolean
_ | - | `false` | -| error | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| readonly | - | _  boolean
_ | - | `false` | -| inputAlign | - | _  string
_ | - | `false` | -| showAction | - | _  boolean
_ | - | `false` | -| leftIcon | - | _  string
_ | - | `false` | -| rightIcon | - | _  string
_ | - | `false` | -| placeholder | - | _  string
_ | - | `false` | -| placeholderStyle | - | _  string
_ | - | `false` | -| actionText | - | _  string
_ | - | `false` | -| background | - | _  string
_ | - | `false` | -| maxlength | - | _  number
_ | - | `false` | -| shape | - | _  string
_ | - | `false` | -| clearable | - | _  boolean
_ | - | `false` | -| clearTrigger | - | _  string
_ | - | `false` | -| clearIcon | - | _  string
_ | - | `false` | -| renderLabel | - | _  ReactNode
_ | - | `false` | -| renderLeftIcon | - | _  ReactNode
_ | - | `false` | -| renderRightIcon | - | _  ReactNode
_ | - | `false` | -| renderAction | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onSearch | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | -| onClear | - | _  () => void
_ | - | `false` | -| onCancel | - | _  () => void
_ | - | `false` | -| onClickInput | - | _  () => void
_ | - | `false` | +### SearchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/search.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ---------------------------------------------------------- | ------ | ------- | +| value | - | _  string ¦ number
_ | - | `false` | +| defaultValue | - | _  string ¦ number
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| focus | - | _  boolean
_ | - | `false` | +| error | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| readonly | - | _  boolean
_ | - | `false` | +| inputAlign | - | _  string
_ | - | `false` | +| showAction | - | _  boolean
_ | - | `false` | +| leftIcon | - | _  string
_ | - | `false` | +| rightIcon | - | _  string
_ | - | `false` | +| placeholder | - | _  string
_ | - | `false` | +| placeholderStyle | - | _  string
_ | - | `false` | +| actionText | - | _  string
_ | - | `false` | +| background | - | _  string
_ | - | `false` | +| maxlength | - | _  number
_ | - | `false` | +| shape | - | _  string
_ | - | `false` | +| clearable | - | _  boolean
_ | - | `false` | +| clearTrigger | - | _  string
_ | - | `false` | +| clearIcon | - | _  string
_ | - | `false` | +| renderLabel | - | _  ReactNode
_ | - | `false` | +| renderLeftIcon | - | _  ReactNode
_ | - | `false` | +| renderRightIcon | - | _  ReactNode
_ | - | `false` | +| renderAction | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onSearch | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onFocus | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onBlur | - | _  (e: ITouchEvent) => void
_ | - | `false` | +| onClear | - | _  () => void
_ | - | `false` | +| onCancel | - | _  () => void
_ | - | `false` | +| onClickInput | - | _  () => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/share-sheet/README.md b/packages/vantui-doc/src/share-sheet/README.md index 7c74227f2..6d0f753cf 100644 --- a/packages/vantui-doc/src/share-sheet/README.md +++ b/packages/vantui-doc/src/share-sheet/README.md @@ -187,42 +187,42 @@ function Demo() { | icon | - | _  string
_ | | description | - | _  string
_ | | openType | - | _  string
_ | -### ShareSheetOptionItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| name | - | _  string
_ | -| icon | - | _  string
_ | -| description | - | _  string
_ | -| openType | - | _  string
_ | - -### ShareSheetOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) - -| 参数 | 说明 | 类型 | -| --- | --- | --- | -| showBorder | - | _  boolean
_ | -| options | - | _  ShareSheetOptionItem[]
_ | -| onSelect | - | _  (
    option: ShareSheetOptionItem,
    index: number
  ) => void
_ | - -### ShareSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| show | - | _  boolean
_ | - | `false` | -| overlayStyle | - | _  string
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| overlay | - | _  boolean
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| closeOnClickOverlay | - | _  boolean
_ | - | `false` | -| duration | - | _  number ¦ string
_ | - | `false` | -| onClickOverlay | - | _  () => void
_ | - | `false` | -| onCancel | - | _  () => void
_ | - | `false` | -| onSelect | - | _  (event: {
    detail: ShareSheetOptionItem
  }) => void
_ | - | `false` | -| onClose | - | _  () => void
_ | - | `false` | -| renderTitle | - | _  ReactNode
_ | - | `false` | -| renderDescription | - | _  ReactNode
_ | - | `false` | -| cancelText | - | _  string
_ | - | `false` | -| description | - | _  string
_ | - | `false` | -| options | - | _  attr:
    ¦ ShareSheetOptionItem[]
    ¦ ShareSheetOptionItem[][]
_ | - | `false` | +### ShareSheetOptionItem [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) +| 参数 | 说明 | 类型 | +| ----------- | ---- | ------------------------- | +| name | - | _  string
_ | +| icon | - | _  string
_ | +| description | - | _  string
_ | +| openType | - | _  string
_ | + +### ShareSheetOption [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) + +| 参数 | 说明 | 类型 | +| ---------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| showBorder | - | _  boolean
_ | +| options | - | _  ShareSheetOptionItem[]
_ | +| onSelect | - | _  (
    option: ShareSheetOptionItem,
    index: number
  ) => void
_ | + +### ShareSheetProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/share-sheet.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| show | - | _  boolean
_ | - | `false` | +| overlayStyle | - | _  string
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| overlay | - | _  boolean
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| closeOnClickOverlay | - | _  boolean
_ | - | `false` | +| duration | - | _  number ¦ string
_ | - | `false` | +| onClickOverlay | - | _  () => void
_ | - | `false` | +| onCancel | - | _  () => void
_ | - | `false` | +| onSelect | - | _  (event: {
    detail: ShareSheetOptionItem
  }) => void
_ | - | `false` | +| onClose | - | _  () => void
_ | - | `false` | +| renderTitle | - | _  ReactNode
_ | - | `false` | +| renderDescription | - | _  ReactNode
_ | - | `false` | +| cancelText | - | _  string
_ | - | `false` | +| description | - | _  string
_ | - | `false` | +| options | - | _  attr:
    ¦ ShareSheetOptionItem[]
    ¦ ShareSheetOptionItem[][]
_ | - | `false` | diff --git a/packages/vantui-doc/src/sidebar/README.md b/packages/vantui-doc/src/sidebar/README.md index 1f56df391..09abd5930 100644 --- a/packages/vantui-doc/src/sidebar/README.md +++ b/packages/vantui-doc/src/sidebar/README.md @@ -88,24 +88,24 @@ function Demo() { ) } ``` -### SidebarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| dot | - | _  boolean
_ | - | `false` | -| badge | - | _  string
_ | - | `false` | -| info | - | _  string
_ | - | `false` | -| title | - | _  string
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| onClick | - | _  (a: any) => void
_ | - | `false` | -| onChange | - | _  (a: OnChangeEvent) => void
_ | - | `false` | -| renderTitle | - | _  (a: any) => React.ReactNode
_ | - | `false` | - -### SidebarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| onChange | - | _  (a: OnChangeEvent) => any
_ | - | `false` | -| activeKey | - | _  number
_ | - | `true` | -| children | - | _  React.ReactNode
_ | - | `true` | +### SidebarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| dot | - | _  boolean
_ | - | `false` | +| badge | - | _  string
_ | - | `false` | +| info | - | _  string
_ | - | `false` | +| title | - | _  string
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| onClick | - | _  (a: any) => void
_ | - | `false` | +| onChange | - | _  (a: OnChangeEvent) => void
_ | - | `false` | +| renderTitle | - | _  (a: any) => React.ReactNode
_ | - | `false` | + +### SidebarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sidebar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ----------------------------------------------------------- | ------ | ------- | +| onChange | - | _  (a: OnChangeEvent) => any
_ | - | `false` | +| activeKey | - | _  number
_ | - | `true` | +| children | - | _  React.ReactNode
_ | - | `true` | diff --git a/packages/vantui-doc/src/slider/README.md b/packages/vantui-doc/src/slider/README.md index 7f71b421d..113eb57d4 100644 --- a/packages/vantui-doc/src/slider/README.md +++ b/packages/vantui-doc/src/slider/README.md @@ -106,25 +106,25 @@ function Demo() { ) } ``` -### SliderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/slider.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| range | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| max | - | _  number
_ | - | `false` | -| min | - | _  number
_ | - | `false` | -| step | - | _  number
_ | - | `false` | -| value | - | _  number
_ | - | `false` | -| barHeight | - | _  number ¦ string
_ | - | `false` | -| vertical | - | _  boolean
_ | - | `false` | -| onDrag | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | -| onChange | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | -| onDragStart | - | _  () => void
_ | - | `false` | -| onDragEnd | - | _  () => void
_ | - | `false` | -| renderLeftButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | -| renderRightButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | -| renderButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | +### SliderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/slider.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ----------------- | ---- | ---------------------------------------------------------------------------------- | ------ | ------- | +| range | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| max | - | _  number
_ | - | `false` | +| min | - | _  number
_ | - | `false` | +| step | - | _  number
_ | - | `false` | +| value | - | _  number
_ | - | `false` | +| barHeight | - | _  number ¦ string
_ | - | `false` | +| vertical | - | _  boolean
_ | - | `false` | +| onDrag | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | +| onChange | - | _  (e: ITouchEvent & SliderEvent) => void
_ | - | `false` | +| onDragStart | - | _  () => void
_ | - | `false` | +| onDragEnd | - | _  () => void
_ | - | `false` | +| renderLeftButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | +| renderRightButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | +| renderButton | - | _  (value: number) => React.ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/steps/README.md b/packages/vantui-doc/src/steps/README.md index 7f694b427..a06bb6a12 100644 --- a/packages/vantui-doc/src/steps/README.md +++ b/packages/vantui-doc/src/steps/README.md @@ -130,17 +130,17 @@ function Demo() { ) } ``` -### StepsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/steps.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| icon | - | _  string
_ | - | `false` | -| steps | - | _  {
    index?: number
    desc: string
    text: string
    activeIcon?: string
    inactiveIcon?: string
  }[]
_ | - | `false` | -| active | - | _  number
_ | - | `false` | -| direction | - | _  "horizontal" ¦ "vertical"
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| activeIcon | - | _  string
_ | - | `false` | -| inactiveIcon | - | _  string
_ | - | `false` | -| onClickStep | - | _  (
    event: ITouchEvent & { detail: number }
  ) => void
_ | - | `false` | +### StepsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/steps.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| icon | - | _  string
_ | - | `false` | +| steps | - | _  {
    index?: number
    desc: string
    text: string
    activeIcon?: string
    inactiveIcon?: string
  }[]
_ | - | `false` | +| active | - | _  number
_ | - | `false` | +| direction | - | _  "horizontal" ¦ "vertical"
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| activeIcon | - | _  string
_ | - | `false` | +| inactiveIcon | - | _  string
_ | - | `false` | +| onClickStep | - | _  (
    event: ITouchEvent & { detail: number }
  ) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/sticky/README.md b/packages/vantui-doc/src/sticky/README.md index 635cc6250..1ac2b92f1 100644 --- a/packages/vantui-doc/src/sticky/README.md +++ b/packages/vantui-doc/src/sticky/README.md @@ -45,15 +45,15 @@ function Demo() { ) } ``` -### StickyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sticky.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| zIndex | - | _  number
_ | - | `false` | -| offsetTop | - | _  number
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| container | - | _  () => any
_ | - | `false` | -| scrollTop | - | _  number
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number
      isFixed?: boolean
    }
  }) => any
_ | - | `false` | +### StickyProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/sticky.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| zIndex | - | _  number
_ | - | `false` | +| offsetTop | - | _  number
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| container | - | _  () => any
_ | - | `false` | +| scrollTop | - | _  number
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number
      isFixed?: boolean
    }
  }) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/submit-bar/README.md b/packages/vantui-doc/src/submit-bar/README.md index b99edb26b..de1db9aa2 100644 --- a/packages/vantui-doc/src/submit-bar/README.md +++ b/packages/vantui-doc/src/submit-bar/README.md @@ -87,24 +87,24 @@ function Demo() { ) } ``` -### SubmitBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/submit-bar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| tip | - | _  string
_ | - | `false` | -| tipIcon | - | _  string
_ | - | `false` | -| price | - | _  number
_ | - | `false` | -| label | - | _  string
_ | - | `false` | -| loading | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| buttonText | - | _  string
_ | - | `false` | -| currency | - | _  string
_ | - | `false` | -| buttonType | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | -| decimalLength | - | _  number
_ | - | `false` | -| suffixLabel | - | _  string
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| renderTop | - | _  ReactNode
_ | - | `false` | -| renderTip | - | _  ReactNode
_ | - | `false` | -| onSubmit | - | _  (event: ITouchEvent) => void
_ | - | `false` | +### SubmitBarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/submit-bar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| tip | - | _  string
_ | - | `false` | +| tipIcon | - | _  string
_ | - | `false` | +| price | - | _  number
_ | - | `false` | +| label | - | _  string
_ | - | `false` | +| loading | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| buttonText | - | _  string
_ | - | `false` | +| currency | - | _  string
_ | - | `false` | +| buttonType | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "info"
    ¦ "warning"
    ¦ "danger"
_ | - | `false` | +| decimalLength | - | _  number
_ | - | `false` | +| suffixLabel | - | _  string
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| renderTop | - | _  ReactNode
_ | - | `false` | +| renderTip | - | _  ReactNode
_ | - | `false` | +| onSubmit | - | _  (event: ITouchEvent) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/swipe-cell/README.md b/packages/vantui-doc/src/swipe-cell/README.md index a2153787c..f95db296c 100644 --- a/packages/vantui-doc/src/swipe-cell/README.md +++ b/packages/vantui-doc/src/swipe-cell/README.md @@ -90,28 +90,28 @@ function Demo() { ) } ``` -### SwipeCellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| disabled | - | _  boolean
_ | - | `false` | -| leftWidth | - | _  number
_ | - | `false` | -| rightWidth | - | _  number
_ | - | `false` | -| asyncClose | - | _  boolean
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| catchMove | - | _  boolean
_ | - | `false` | -| wrapperStyle | - | _  React.CSSProperties
_ | - | `false` | -| onOpen | - | _  (e: ITouchEvent & SwipeCellOpen) => void
_ | - | `false` | -| onClick | - | _  (
    e: ITouchEvent & SwipeCellClick
  ) => void
_ | - | `false` | -| onClose | - | _  (
    e: ITouchEvent & SwipeCellClose
  ) => void
_ | - | `false` | -| renderLeft | - | _  React.ReactNode
_ | - | `false` | -| renderRight | - | _  React.ReactNode
_ | - | `false` | -| children | - | _  React.ReactNode
_ | - | `false` | - -### ISwiperCellInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) - -| 方法 | 说明 | 类型 | -| --- | --- | --- | -| open | - | _  (position: "left" ¦ "right") => void
_ | -| close | - | _  () => void
_ | +### SwipeCellProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| disabled | - | _  boolean
_ | - | `false` | +| leftWidth | - | _  number
_ | - | `false` | +| rightWidth | - | _  number
_ | - | `false` | +| asyncClose | - | _  boolean
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| catchMove | - | _  boolean
_ | - | `false` | +| wrapperStyle | - | _  React.CSSProperties
_ | - | `false` | +| onOpen | - | _  (e: ITouchEvent & SwipeCellOpen) => void
_ | - | `false` | +| onClick | - | _  (
    e: ITouchEvent & SwipeCellClick
  ) => void
_ | - | `false` | +| onClose | - | _  (
    e: ITouchEvent & SwipeCellClose
  ) => void
_ | - | `false` | +| renderLeft | - | _  React.ReactNode
_ | - | `false` | +| renderRight | - | _  React.ReactNode
_ | - | `false` | +| children | - | _  React.ReactNode
_ | - | `false` | + +### ISwiperCellInstance [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/swipe-cell.d.ts) + +| 方法 | 说明 | 类型 | +| ----- | ---- | --------------------------------------------------------------------------------------- | +| open | - | _  (position: "left" ¦ "right") => void
_ | +| close | - | _  () => void
_ | diff --git a/packages/vantui-doc/src/switch/README.md b/packages/vantui-doc/src/switch/README.md index ba0cac6b9..34aeb06ad 100644 --- a/packages/vantui-doc/src/switch/README.md +++ b/packages/vantui-doc/src/switch/README.md @@ -94,17 +94,17 @@ function Demo() { ) } ``` -### SwitchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/switch.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| checked | - | _  boolean
_ | - | `false` | -| loading | - | _  boolean
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| size | - | _  string
_ | - | `false` | -| activeValue | - | _  any
_ | - | `false` | -| inactiveValue | - | _  any
_ | - | `false` | -| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | +### SwitchProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/switch.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------- | ---- | ------------------------------------------------------------- | ------ | ------- | +| checked | - | _  boolean
_ | - | `false` | +| loading | - | _  boolean
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| size | - | _  string
_ | - | `false` | +| activeValue | - | _  any
_ | - | `false` | +| inactiveValue | - | _  any
_ | - | `false` | +| onChange | - | _  (event: ITouchEvent) => any
_ | - | `false` | diff --git a/packages/vantui-doc/src/tab/README.md b/packages/vantui-doc/src/tab/README.md index c47a7d420..7a4c8385b 100644 --- a/packages/vantui-doc/src/tab/README.md +++ b/packages/vantui-doc/src/tab/README.md @@ -213,44 +213,44 @@ function Demo() { ) } ``` -### TabsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| sticky | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| swipeable | - | _  boolean
_ | - | `false` | -| titleActiveColor | - | _  string
_ | - | `false` | -| titleInactiveColor | - | _  string
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| animated | - | _  boolean
_ | - | `false` | -| lineWidth | - | _  number ¦ string
_ | - | `false` | -| lineHeight | - | _  number ¦ string
_ | - | `false` | -| active | - | _  number ¦ string
_ | - | `false` | -| type | - | _  string
_ | - | `false` | -| ellipsis | - | _  boolean
_ | - | `false` | -| duration | - | _  number
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| swipeThreshold | - | _  number
_ | - | `false` | -| offsetTop | - | _  number
_ | - | `false` | -| lazyRender | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `true` | -| renderNavLeft | - | _  ReactNode
_ | - | `false` | -| renderNavRight | - | _  ReactNode
_ | - | `false` | -| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number ¦ null
      isFixed?: boolean
    }
  }) => void
_ | - | `false` | -| onClick | - | _  (event: eventDetail) => void
_ | - | `false` | -| onChange | - | _  (event: eventDetail) => void
_ | - | `false` | -| onDisabled | - | _  (event: eventDetail) => void
_ | - | `false` | - -### TabProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| dot | - | _  boolean
_ | - | `false` | -| info | - | _  string ¦ number
_ | - | `false` | -| title | - | _  ReactNode
_ | - | `false` | -| disabled | - | _  boolean
_ | - | `false` | -| titleStyle | - | _  string
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | +### TabsProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| sticky | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| swipeable | - | _  boolean
_ | - | `false` | +| titleActiveColor | - | _  string
_ | - | `false` | +| titleInactiveColor | - | _  string
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| animated | - | _  boolean
_ | - | `false` | +| lineWidth | - | _  number ¦ string
_ | - | `false` | +| lineHeight | - | _  number ¦ string
_ | - | `false` | +| active | - | _  number ¦ string
_ | - | `false` | +| type | - | _  string
_ | - | `false` | +| ellipsis | - | _  boolean
_ | - | `false` | +| duration | - | _  number
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| swipeThreshold | - | _  number
_ | - | `false` | +| offsetTop | - | _  number
_ | - | `false` | +| lazyRender | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `true` | +| renderNavLeft | - | _  ReactNode
_ | - | `false` | +| renderNavRight | - | _  ReactNode
_ | - | `false` | +| onScroll | - | _  (data: {
    detail: {
      scrollTop?: number ¦ null
      isFixed?: boolean
    }
  }) => void
_ | - | `false` | +| onClick | - | _  (event: eventDetail) => void
_ | - | `false` | +| onChange | - | _  (event: eventDetail) => void
_ | - | `false` | +| onDisabled | - | _  (event: eventDetail) => void
_ | - | `false` | + +### TabProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tab.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------- | ---- | --------------------------------------------------- | ------ | ------- | +| dot | - | _  boolean
_ | - | `false` | +| info | - | _  string ¦ number
_ | - | `false` | +| title | - | _  ReactNode
_ | - | `false` | +| disabled | - | _  boolean
_ | - | `false` | +| titleStyle | - | _  string
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/tabbar/README.md b/packages/vantui-doc/src/tabbar/README.md index 21bf42d9f..1029195d2 100644 --- a/packages/vantui-doc/src/tabbar/README.md +++ b/packages/vantui-doc/src/tabbar/README.md @@ -136,32 +136,32 @@ function Demo() { ### 结合自定义 tabBar 请参考 [微信官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/customTabbar.html) 与 [代码片段](https://developers.weixin.qq.com/s/vaXgTsmQ7hnm)。 -### TabbarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| active | - | _  string ¦ number
_ | - | `false` | -| activeColor | - | _  string
_ | - | `false` | -| inactiveColor | - | _  string
_ | - | `false` | -| fixed | - | _  boolean
_ | - | `false` | -| placeholder | - | _  boolean
_ | - | `false` | -| border | - | _  boolean
_ | - | `false` | -| zIndex | - | _  number
_ | - | `false` | -| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onChange | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | - -### TabbarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| info | - | _  string
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| icon | - | _  string
_ | - | `false` | -| dot | - | _  boolean
_ | - | `false` | -| iconPrefix | - | _  string
_ | - | `false` | -| renderIconActive | - | _  ReactNode
_ | - | `false` | -| renderIcon | - | _  ReactNode
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onClick | - | _  (name: string ¦ number) => void
_ | - | `false` | +### TabbarProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- | +| active | - | _  string ¦ number
_ | - | `false` | +| activeColor | - | _  string
_ | - | `false` | +| inactiveColor | - | _  string
_ | - | `false` | +| fixed | - | _  boolean
_ | - | `false` | +| placeholder | - | _  boolean
_ | - | `false` | +| border | - | _  boolean
_ | - | `false` | +| zIndex | - | _  number
_ | - | `false` | +| safeAreaInsetBottom | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onChange | - | _  (event: {
    detail: string ¦ number
  }) => void
_ | - | `false` | + +### TabbarItemProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tabbar.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ---------------------------------------------------------------------------------- | ------ | ------- | +| info | - | _  string
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| icon | - | _  string
_ | - | `false` | +| dot | - | _  boolean
_ | - | `false` | +| iconPrefix | - | _  string
_ | - | `false` | +| renderIconActive | - | _  ReactNode
_ | - | `false` | +| renderIcon | - | _  ReactNode
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onClick | - | _  (name: string ¦ number) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/tag/README.md b/packages/vantui-doc/src/tag/README.md index 08d58b495..3626f39af 100644 --- a/packages/vantui-doc/src/tag/README.md +++ b/packages/vantui-doc/src/tag/README.md @@ -182,18 +182,18 @@ function Demo() { ) } ``` -### TagProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tag.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| size | - | _  "large" ¦ "medium"
_ | - | `false` | -| mark | - | _  boolean
_ | - | `false` | -| color | - | _  string
_ | - | `false` | -| plain | - | _  boolean
_ | - | `false` | -| round | - | _  boolean
_ | - | `false` | -| textColor | - | _  string
_ | - | `false` | -| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "success"
    ¦ "danger"
    ¦ "warning"
_ | - | `false` | -| closeable | - | _  boolean
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onClose | - | _  (e: any) => void
_ | - | `false` | +### TagProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tag.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| size | - | _  "large" ¦ "medium"
_ | - | `false` | +| mark | - | _  boolean
_ | - | `false` | +| color | - | _  string
_ | - | `false` | +| plain | - | _  boolean
_ | - | `false` | +| round | - | _  boolean
_ | - | `false` | +| textColor | - | _  string
_ | - | `false` | +| type | - | _  attr:
    ¦ "default"
    ¦ "primary"
    ¦ "success"
    ¦ "danger"
    ¦ "warning"
_ | - | `false` | +| closeable | - | _  boolean
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onClose | - | _  (e: any) => void
_ | - | `false` | diff --git a/packages/vantui-doc/src/transition/README.md b/packages/vantui-doc/src/transition/README.md index e69a4da04..4224b5541 100644 --- a/packages/vantui-doc/src/transition/README.md +++ b/packages/vantui-doc/src/transition/README.md @@ -79,9 +79,9 @@ function Demo() { transform: rotate(-360deg) translate3d(-100%, -100%, 0); } ``` -### TransitionPropsCom [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/transition.d.ts) -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| children | - | _  ReactNode
_ | - | `false` | +### TransitionPropsCom [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/transition.d.ts) +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| -------- | ---- | ---------------------------- | ------ | ------- | +| children | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/tree-select/README.md b/packages/vantui-doc/src/tree-select/README.md index 16b570c1e..68925c40a 100644 --- a/packages/vantui-doc/src/tree-select/README.md +++ b/packages/vantui-doc/src/tree-select/README.md @@ -184,18 +184,18 @@ function Demo() { ) } ``` -### TreeSelectProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tree-select.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| items | - | _  {
    text: number ¦ string
    badge?: number ¦ string
    dot?: boolean
    disabled?: boolean
    children?: {
      text: number ¦ string
      id: number ¦ string
      disabled?: boolean
    }[]
  }[]
_ | - | `false` | -| activeId | - | _  string ¦ number ¦ number[] ¦ string[]
_ | - | `false` | -| mainActiveIndex | - | _  number
_ | - | `false` | -| value | - | _  number
_ | - | `false` | -| height | - | _  number ¦ string
_ | - | `false` | -| max | - | _  number
_ | - | `false` | -| selectedIcon | - | _  string
_ | - | `false` | -| onClickItem | - | _  (
    event: TouchEvent & {
      detail: {
        text: string
        id: string ¦ number
        disabled?: boolean
      }
    }
  ) => void
_ | - | `false` | -| onClickNav | - | _  (event: {
    detail: { index: number }
  }) => void
_ | - | `false` | -| renderContent | - | _  ReactNode
_ | - | `false` | +### TreeSelectProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/tree-select.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| --------------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| items | - | _  {
    text: number ¦ string
    badge?: number ¦ string
    dot?: boolean
    disabled?: boolean
    children?: {
      text: number ¦ string
      id: number ¦ string
      disabled?: boolean
    }[]
  }[]
_ | - | `false` | +| activeId | - | _  string ¦ number ¦ number[] ¦ string[]
_ | - | `false` | +| mainActiveIndex | - | _  number
_ | - | `false` | +| value | - | _  number
_ | - | `false` | +| height | - | _  number ¦ string
_ | - | `false` | +| max | - | _  number
_ | - | `false` | +| selectedIcon | - | _  string
_ | - | `false` | +| onClickItem | - | _  (
    event: TouchEvent & {
      detail: {
        text: string
        id: string ¦ number
        disabled?: boolean
      }
    }
  ) => void
_ | - | `false` | +| onClickNav | - | _  (event: {
    detail: { index: number }
  }) => void
_ | - | `false` | +| renderContent | - | _  ReactNode
_ | - | `false` | diff --git a/packages/vantui-doc/src/uploader/README.md b/packages/vantui-doc/src/uploader/README.md index 83ea50865..b3a6040c0 100644 --- a/packages/vantui-doc/src/uploader/README.md +++ b/packages/vantui-doc/src/uploader/README.md @@ -189,38 +189,38 @@ function Demo() { ) } ``` -### UploaderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/uploader.d.ts) - -| 参数 | 说明 | 类型 | 默认值 | 必填 | -| --- | --- | --- | --- | --- | -| disabled | - | _  boolean
_ | - | `false` | -| multiple | - | _  boolean
_ | - | `false` | -| uploadText | - | _  string
_ | - | `false` | -| useBeforeRead | - | _  boolean
_ | - | `false` | -| afterRead | - | _  any
_ | - | `false` | -| beforeRead | - | _  any
_ | - | `false` | -| previewSize | - | _  string ¦ number
_ | - | `false` | -| name | - | _  string ¦ number
_ | - | `false` | -| accept | - | _  attr:
    ¦ "all"
    ¦ "media"
    ¦ "image"
    ¦ "file"
    ¦ "video"
_ | - | `false` | -| fileList | - | _  Array
_ | - | `false` | -| maxSize | - | _  number
_ | - | `false` | -| maxCount | - | _  number
_ | - | `false` | -| deletable | - | _  boolean
_ | - | `false` | -| showUpload | - | _  boolean
_ | - | `false` | -| previewImage | - | _  boolean
_ | - | `false` | -| previewFullImage | - | _  boolean
_ | - | `false` | -| imageFit | - | _  keyof ImageProps.mode ¦ undefined
_ | - | `false` | -| uploadIcon | - | _  string
_ | - | `false` | -| sizeType | - | _  Array
_ | - | `false` | -| capture | - | _  string ¦ Array
_ | - | `false` | -| compressed | - | _  boolean
_ | - | `false` | -| maxDuration | - | _  number
_ | - | `false` | -| camera | - | _  "back" ¦ "front"
_ | - | `false` | -| children | - | _  ReactNode
_ | - | `false` | -| onError | - | _  (error: any) => any
_ | - | `false` | -| onDelete | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onBeforeRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onAfterRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onOversize | - | _  (event: ITouchEvent) => any
_ | - | `false` | -| onClickPreview | - | _  (data: any) => any
_ | - | `false` | +### UploaderProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/uploader.d.ts) + +| 参数 | 说明 | 类型 | 默认值 | 必填 | +| ---------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------- | +| disabled | - | _  boolean
_ | - | `false` | +| multiple | - | _  boolean
_ | - | `false` | +| uploadText | - | _  string
_ | - | `false` | +| useBeforeRead | - | _  boolean
_ | - | `false` | +| afterRead | - | _  any
_ | - | `false` | +| beforeRead | - | _  any
_ | - | `false` | +| previewSize | - | _  string ¦ number
_ | - | `false` | +| name | - | _  string ¦ number
_ | - | `false` | +| accept | - | _  attr:
    ¦ "all"
    ¦ "media"
    ¦ "image"
    ¦ "file"
    ¦ "video"
_ | - | `false` | +| fileList | - | _  Array
_ | - | `false` | +| maxSize | - | _  number
_ | - | `false` | +| maxCount | - | _  number
_ | - | `false` | +| deletable | - | _  boolean
_ | - | `false` | +| showUpload | - | _  boolean
_ | - | `false` | +| previewImage | - | _  boolean
_ | - | `false` | +| previewFullImage | - | _  boolean
_ | - | `false` | +| imageFit | - | _  keyof ImageProps.mode ¦ undefined
_ | - | `false` | +| uploadIcon | - | _  string
_ | - | `false` | +| sizeType | - | _  Array
_ | - | `false` | +| capture | - | _  string ¦ Array
_ | - | `false` | +| compressed | - | _  boolean
_ | - | `false` | +| maxDuration | - | _  number
_ | - | `false` | +| camera | - | _  "back" ¦ "front"
_ | - | `false` | +| children | - | _  ReactNode
_ | - | `false` | +| onError | - | _  (error: any) => any
_ | - | `false` | +| onDelete | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onBeforeRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onAfterRead | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onOversize | - | _  (event: ITouchEvent) => any
_ | - | `false` | +| onClickPreview | - | _  (data: any) => any
_ | - | `false` | diff --git a/packages/vantui/README.md b/packages/vantui/README.md index 82893e311..fc1baf430 100644 --- a/packages/vantui/README.md +++ b/packages/vantui/README.md @@ -7,23 +7,27 @@ ### 组件文档 + [点击查看](https://antmjs.github.io/vantui/#/home) ### 关联 + - [Vant Weapp](https://github.com/youzan/vant-weapp)：由有赞团队打造的轻量、可靠的微信小程序 UI 组件库 - [Taro](https://github.com/NervJS/taro)：由京东团队打造的开放式跨端跨框架解决方案，支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用 - [React](https://reactjs.org/)：Facebook 内部开源出来的用于构建用户界面的 JavaScript 库 ### 起源 -- 为什么要做这个组件库？我们认为有赞团队的组件库经过了多年的实践积累，以及经过我们的实际体验之后认为确实是一款优秀的组件库，但可惜的是他们只提供了Vue版本和微信小程序版本，而我们的技术架构选用的是Facebook的React库以及京东的Taro库，所以就开始思考如何能把有赞微信小程序的版本迁移到Taro上面来，最终我们实现了[@antmjs/vantui](https://github.com/antmjs/vantui)。 -- 为什么是99%？迁移的步骤其实不难，第一步100%同步样式，第二步通过Taro convert转译之后再重构js部分，但因为有赞微信小程序的版本完全基于微信小程序实现的，所以在改造兼容支付宝小程序、H5的时候还是存在不能100%兼容的情况，具体的个别差异点可以参考[快速上手](https://antmjs.github.io/vantui/#/quickstart)。 -- 为什么能支持React应用？创建初期是为了在Taro上面使用才建立的，但当我们开始在H5端测试的时候发现，既然这个库能在Taro版的H5应用中使用，为什么不能在React中使用呢？于是乎我们开始调研Taro的底层架构随即理清思路，在不重构任何组件的前提下使之能在React中使用 + +- 为什么要做这个组件库？我们认为有赞团队的组件库经过了多年的实践积累，以及经过我们的实际体验之后认为确实是一款优秀的组件库，但可惜的是他们只提供了 Vue 版本和微信小程序版本，而我们的技术架构选用的是 Facebook 的 React 库以及京东的 Taro 库，所以就开始思考如何能把有赞微信小程序的版本迁移到 Taro 上面来，最终我们实现了[@antmjs/vantui](https://github.com/antmjs/vantui)。 +- 为什么是 99%？迁移的步骤其实不难，第一步 100%同步样式，第二步通过 Taro convert 转译之后再重构 js 部分，但因为有赞微信小程序的版本完全基于微信小程序实现的，所以在改造兼容支付宝小程序、H5 的时候还是存在不能 100%兼容的情况，具体的个别差异点可以参考[快速上手](https://antmjs.github.io/vantui/#/quickstart)。 +- 为什么能支持 React 应用？创建初期是为了在 Taro 上面使用才建立的，但当我们开始在 H5 端测试的时候发现，既然这个库能在 Taro 版的 H5 应用中使用，为什么不能在 React 中使用呢？于是乎我们开始调研 Taro 的底层架构随即理清思路，在不重构任何组件的前提下使之能在 React 中使用 ### 预览 正在全力建设中... ### 优势 +
@@ -42,19 +46,18 @@ TS类型安全 React应用中使用
-> 小程序、Taro-React-H5、React-H5多端完全统一 +> 小程序、Taro-React-H5、React-H5 多端完全统一 ### 贡献代码 -使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对vant-weapp的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了2021-12-23的版本，我们也会持续同步 +使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对 vant-weapp 的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了 2021-12-23 的版本，我们也会持续同步 ### 开源协议 本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源 - ### 参与贡献的小伙伴 -[![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) -:---:|:---:|:---:|:---: -[hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/) +| [![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) | +| :-------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | +| [hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/) |