Skip to content

unidocs-zh
unidocs-zh

DCloud / unidocs-zh

通知 3597
Star 108
Fork 921
unidocs-zh
unidocs-zh
提交 35be7f7d 编写于 作者: D DCloud_LXH
浏览文件
操作

feat: autodoc vueJson

上级 947ef99a
隐藏空白更改
内联 并排
Showing with 55 addition and 95 deletion
docs/.vuepress/markdown/inject-json-to-md.js
浏览文件 @ 35be7f7d
...@@ -4,6 +4,7 @@ let utsApiJson = {}; ...@@ -4,6 +4,7 @@ let utsApiJson = {};
let utsComJson = {}; let utsComJson = {};
let utsUnicloudApiJson = {}; let utsUnicloudApiJson = {};
let customTypeJson = {}; let customTypeJson = {};
let vueJson = {};
try { try {
cssJson = require('../utils/cssJson.json'); cssJson = require('../utils/cssJson.json');
} catch (error) {} } catch (error) {}
...@@ -22,6 +23,9 @@ try { ...@@ -22,6 +23,9 @@ try {
try { try {
customTypeJson = require('../utils/customTypeJson.json'); customTypeJson = require('../utils/customTypeJson.json');
} catch (error) {} } catch (error) {}
try {
vueJson = require('../utils/vueJson.json');
} catch (error) {}
function getRegExp(key) { function getRegExp(key) {
...@@ -77,6 +81,14 @@ const getJSON = text => { ...@@ -77,6 +81,14 @@ const getJSON = text => {
}; };
} }
match = text.match(getRegExp('VUEJSON'));
if (match) {
return {
match,
json: vueJson,
};
}
return { return {
match: null, match: null,
json: {}, json: {},
......
docs/.vuepress/utils/vueJson.json 0 → 100644
浏览文件 @ 35be7f7d
{"application":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| app.component() | 5.0 | √ | √ | 10.0 | √ | x |\n| app.directive() | 5.0 | √ | x | 10.0 | √ | x |\n| app.use() | 5.0 | √ | x | 10.0 | √ | x |\n| app.mixin() | 5.0 | √ | x | 10.0 | √ | x |\n| app.provide() | 5.0 | √ | x | 10.0 | √ | x |\n| app.config | 5.0 | √ | √ | 10.0 | √ | x |\n| app.config.errorHandler | 5.0 | √ | x | 10.0 | √ | x |\n| app.config.warnHandler | 5.0 | √ | x | 10.0 | √ | x |\n| app.config.performance | 5.0 | √ | x | 10.0 | √ | x |\n| app.config.globalProperties | 5.0 | √ | x | 10.0 | √ | x |\n| app.config.optionMergeStrategies | 5.0 | √ | x | 10.0 | √ | x |"},"general":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| nextTick() | 5.0 | x | √ | 10.0 | x | x |\n| defineComponent() | 5.0 | x | x | 10.0 | x | x |\n| defineAsyncComponent() | 5.0 | x | x | 10.0 | x | x |"},"options_state":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| data | 5.0 | √ | √ | 10.0 | √ | x |\n| props | 5.0 | √ | √ | 10.0 | √ | x |\n| computed | 5.0 | √ | √ | 10.0 | √ | x |\n| methods | 5.0 | √ | √ | 10.0 | √ | x |\n| watch | 5.0 | √ | √ | 10.0 | √ | x |\n| emits | 5.0 | √ | √ | 10.0 | √ | x |"},"options_rendering":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| template | 5.0 | x | x | 10.0 | x | x |\n| render | 5.0 | x | x | 10.0 | x | x |"},"options_lifecycle":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| beforeCreate | 5.0 | √ | √ | 10.0 | √ | x |\n| created | 5.0 | √ | √ | 10.0 | √ | x |\n| beforeMount | 5.0 | √ | √ | 10.0 | √ | x |\n| mounted | 5.0 | √ | √ | 10.0 | √ | x |\n| beforeUpdate | 5.0 | √ | √ | 10.0 | √ | x |\n| updated | 5.0 | √ | √ | 10.0 | √ | x |\n| beforeUnmount | 5.0 | √ | √ | 10.0 | √ | x |\n| unmounted | 5.0 | √ | √ | 10.0 | √ | x |\n| errorCaptured | 5.0 | √ | x | 10.0 | √ | x |\n| renderTracked | 5.0 | √ | x | 10.0 | √ | x |\n| renderTriggered | 5.0 | √ | x | 10.0 | √ | x |\n| activated | 5.0 | √ | x | 10.0 | √ | x |\n| deactivated | 5.0 | √ | x | 10.0 | √ | x |"},"options_composition":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| provide | 5.0 | √ | x | 10.0 | √ | x |\n| inject | 5.0 | √ | x | 10.0 | √ | x |\n| mixins | 5.0 | √ | x | 10.0 | √ | x |\n| extends | 5.0 | √ | x | 10.0 | √ | x |"},"options_misc":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| name | 5.0 | √ | √ | 10.0 | √ | x |\n| inheritAttrs | 5.0 | √ | √ | 10.0 | √ | x |\n| components | 5.0 | √ | √ | 10.0 | √ | x |\n| directives | 5.0 | √ | x | 10.0 | √ | x |"},"component_instance":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| $data | 5.0 | √ | √ | 10.0 | √ | x |\n| $props | 5.0 | √ | √ | 10.0 | √ | x |\n| $el | 5.0 | x | √ | 10.0 | x | x |\n| $options | 5.0 | √ | √ | 10.0 | √ | x |\n| $parent | 5.0 | √ | √ | 10.0 | √ | x |\n| $root | 5.0 | √ | √ | 10.0 | √ | x |\n| $slots | 5.0 | x | √ | 10.0 | √ | x |\n| $refs | 5.0 | √ | √ | 10.0 | √ | x |\n| $attrs | 5.0 | √ | √ | 10.0 | √ | x |\n| $watch() | 5.0 | √ | √ | 10.0 | √ | x |\n| $emit | 5.0 | √ | √ | 10.0 | √ | x |\n| $forceUpdate | 5.0 | √ | x | 10.0 | √ | x |\n| $nextTick | 5.0 | √ | √ | 10.0 | √ | x |"},"render_function":{"compatibility":"| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| h() | 5.0 | x | x | 10.0 | x | x |\n| resolveComponent() | 5.0 | x | √ | 10.0 | x | x |\n| resolveDirective() | 5.0 | x | x | 10.0 | x | x |\n| withDirectives() | 5.0 | x | √ | 10.0 | x | x |"}}
\ No newline at end of file
docs/uni-app-x/vue/api.md
浏览文件 @ 35be7f7d
...@@ -2,98 +2,45 @@ ...@@ -2,98 +2,45 @@
本文暂时只包括兼容性表格，功能详情另见 [Vue API](https://uniapp.dcloud.net.cn/tutorial/vue3-api.html)。 本文暂时只包括兼容性表格，功能详情另见 [Vue API](https://uniapp.dcloud.net.cn/tutorial/vue3-api.html)。
## 全局 API 兼容性 ## 全局 API兼容性
| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x | ### 应用实例
| :- | :- | :- | :- | :- | :- | :- |
| h | 5.0 | x | x | 10.0 | x | x |
| defineComponent | 5.0 | x | x | 10.0 | x | x | <!-- VUEJSON.application.compatibility -->
| defineAsyncComponent | 5.0 | x | x | 10.0 | x | x | ### 通用
| resolveComponent | 5.0 | x | √ | 10.0 | x | x |
| resolveDynamicComponent | 5.0 | x | x | 10.0 | x | x |
| resolveDirective | 5.0 | x | x | 10.0 | x | x | <!-- VUEJSON.general.compatibility -->
| withDirectives | 5.0 | x | √ | 10.0 | x | x | ## 选项式 API兼容性
| createRenderer | 5.0 | x | x | 10.0 | x | x |
| nextTick | 5.0 | x | √ | 10.0 | x | x | ### 状态选项
| provide | 5.0 | √ | x | 10.0 | √ | x |
| inject | 5.0 | √ | x | 10.0 | √ | x |
| watch | 5.0 | √ | x | 10.0 | √ | x | <!-- VUEJSON.options_state.compatibility -->
| watchEffect | 5.0 | √ | x | 10.0 | √ | x | ### 渲染选项
| getCurrentInstance | 5.0 | √ | x | 10.0 | √ | x |
## App 类型兼容性
<!-- VUEJSON.options_rendering.compatibility -->
| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x | ### 生命周期选项
| :- | :- | :- | :- | :- | :- | :- |
| config | 5.0 | √ | √ | 10.0 | √ | x |
| use | 5.0 | √ | x | 10.0 | √ | x | <!-- VUEJSON.options_lifecycle.compatibility -->
| mixin | 5.0 | √ | x | 10.0 | √ | x | ### 组合选项
| component | 5.0 | √ | √ | 10.0 | √ | x |
| directive | 5.0 | √ | x | 10.0 | √ | x |
| provide | 5.0 | √ | x | 10.0 | √ | x | <!-- VUEJSON.options_composition.compatibility -->
## AppConfig 类型兼容性 ### 其他杂项
| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
| :- | :- | :- | :- | :- | :- | :- | <!-- VUEJSON.options_misc.compatibility -->
| performance | 5.0 | √ | x | 10.0 | √ | x | ### 组件实例
| optionMergeStrategies | 5.0 | √ | x | 10.0 | √ | x |
| globalProperties | 5.0 | √ | x | 10.0 | √ | x |
| errorHandler | 5.0 | √ | x | 10.0 | √ | x | <!-- VUEJSON.component_instance.compatibility -->
| warnHandler | 5.0 | √ | x | 10.0 | √ | x | ## 进阶 API兼容性
| isCustomElement | 5.0 | √ | x | 10.0 | √ | x |
## LegacyOptions 类型兼容性 ### 渲染函数
| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
| :- | :- | :- | :- | :- | :- | :- | <!-- VUEJSON.render_function.compatibility -->
| data | 5.0 | √ | √ | 10.0 | √ | x | \ No newline at end of file
| computed | 5.0 | √ | √ | 10.0 | √ | x |
| methods | 5.0 | √ | √ | 10.0 | √ | x |
| watch | 5.0 | √ | √ | 10.0 | √ | x |
| provide | 5.0 | √ | x | 10.0 | √ | x |
| inject | 5.0 | √ | x | 10.0 | √ | x |
| mixins | 5.0 | √ | x | 10.0 | √ | x |
| extends | 5.0 | √ | x | 10.0 | √ | x |
| beforeCreate | 5.0 | √ | √ | 10.0 | √ | x |
| created | 5.0 | √ | √ | 10.0 | √ | x |
| beforeMount | 5.0 | √ | √ | 10.0 | √ | x |
| mounted | 5.0 | √ | √ | 10.0 | √ | x |
| beforeUpdate | 5.0 | √ | √ | 10.0 | √ | x |
| updated | 5.0 | √ | √ | 10.0 | √ | x |
| activated | 5.0 | √ | x | 10.0 | √ | x |
| deactivated | 5.0 | √ | x | 10.0 | √ | x |
| beforeDestroy | 5.0 | √ | x | 10.0 | √ | x |
| beforeUnmount | 5.0 | √ | √ | 10.0 | √ | x |
| destroyed | 5.0 | √ | x | 10.0 | √ | x |
| unmounted | 5.0 | √ | √ | 10.0 | √ | x |
| renderTracked | 5.0 | √ | x | 10.0 | √ | x |
| renderTriggered | 5.0 | √ | x | 10.0 | √ | x |
| errorCaptured | 5.0 | √ | x | 10.0 | √ | x |
| delimiters | 5.0 | x | x | 10.0 | x | x |
## ComponentOptionsBase 类型兼容性
| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
| :- | :- | :- | :- | :- | :- | :- |
| setup | 5.0 | √ | x | 10.0 | √ | x |
| name | 5.0 | √ | √ | 10.0 | √ | x |
| template | 5.0 | x | x | 10.0 | x | x |
| render | 5.0 | x | x | 10.0 | x | x |
| components | 5.0 | √ | √ | 10.0 | √ | x |
| directives | 5.0 | √ | x | 10.0 | √ | x |
| inheritAttrs | 5.0 | √ | √ | 10.0 | √ | x |
| emits | 5.0 | √ | √ | 10.0 | √ | x |
## ComponentPublicInstance （组件实例）兼容性
| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |
| :- | :- | :- | :- | :- | :- | :- |
| $data | 5.0 | √ | √ | 10.0 | √ | x |
| $props | 5.0 | √ | √ | 10.0 | √ | x |
| $attrs | 5.0 | √ | √ | 10.0 | √ | x |
| $refs | 5.0 | √ | √ | 10.0 | √ | x |
| $slots | 5.0 | x | √ | 10.0 | √ | x |
| $root | 5.0 | √ | √ | 10.0 | √ | x |
| $parent | 5.0 | √ | √ | 10.0 | √ | x |
| $emit | 5.0 | √ | √ | 10.0 | √ | x |
| $el | 5.0 | x | √ | 10.0 | x | x |
| $options | 5.0 | √ | √ | 10.0 | √ | x |
| $forceUpdate | 5.0 | √ | x | 10.0 | √ | x |
| $nextTick | 5.0 | √ | √ | 10.0 | √ | x |
| $watch | 5.0 | √ | √ | 10.0 | √ | x |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或