From 4a7c5d993ec4a0ca840d6b2087f46c19ddd70d39 Mon Sep 17 00:00:00 2001 From: ajaxzheng <894103554@qq.com> Date: Mon, 5 Aug 2024 15:22:50 +0800 Subject: [PATCH] feat(readme): add readme files to main packages (#1826) --- packages/renderless/README.md | 15 ++++++++--- packages/renderless/README.zh-CN.md | 16 +++++++++++ packages/theme-mobile/README.md | 5 ++++ packages/theme-mobile/README.zh-CN.md | 7 +++++ packages/theme-saas/README.md | 8 +++++- packages/theme-saas/README.zh-CN.md | 7 +++++ packages/theme/README.md | 8 +++++- packages/theme/README.zh-CN.md | 7 +++++ packages/vue-common/README.md | 3 +++ packages/vue-common/README.zh-CN.md | 3 +++ packages/vue-directive/README.md | 5 ++++ packages/vue-directive/README.zh-CN.md | 5 ++++ packages/vue-icon-saas/README.md | 5 ++++ packages/vue-icon-saas/README.zh-CN.md | 5 ++++ packages/vue-icon/README.md | 5 ++++ packages/vue-icon/README.zh-CN.md | 5 ++++ packages/vue-locale/README.md | 7 +++++ packages/vue-locale/README.zh-CN.md | 7 +++++ packages/vue-runtime/README.md | 34 ++++++++++++++++++++++++ packages/vue-runtime/README.zh-CN.md | 34 ++++++++++++++++++++++++ packages/vue-saas-common/README.md | 3 +++ packages/vue-saas-common/README.zh-CN.md | 3 +++ 22 files changed, 192 insertions(+), 5 deletions(-) create mode 100644 packages/renderless/README.zh-CN.md create mode 100644 packages/theme-mobile/README.zh-CN.md create mode 100644 packages/theme-saas/README.zh-CN.md create mode 100644 packages/theme/README.zh-CN.md create mode 100644 packages/vue-common/README.md create mode 100644 packages/vue-common/README.zh-CN.md create mode 100644 packages/vue-directive/README.md create mode 100644 packages/vue-directive/README.zh-CN.md create mode 100644 packages/vue-icon-saas/README.md create mode 100644 packages/vue-icon-saas/README.zh-CN.md create mode 100644 packages/vue-icon/README.md create mode 100644 packages/vue-icon/README.zh-CN.md create mode 100644 packages/vue-locale/README.md create mode 100644 packages/vue-locale/README.zh-CN.md create mode 100644 packages/vue-runtime/README.md create mode 100644 packages/vue-runtime/README.zh-CN.md create mode 100644 packages/vue-saas-common/README.md create mode 100644 packages/vue-saas-common/README.zh-CN.md diff --git a/packages/renderless/README.md b/packages/renderless/README.md index 4780432f4..089f24118 100644 --- a/packages/renderless/README.md +++ b/packages/renderless/README.md @@ -1,7 +1,16 @@ # @opentiny/vue-renderless -This is for TINY's own internal use only, currently as a dependency for @opentiny/vue. +Provides a rendering-free logic layer for the `TinyVue` component. -It can also be used as a renderless functions for implementing a custom UI component. +## You can customize the global configuration of some components -For all instructions, please check out the home page: [https://open.codehub.huawei.com/innersource/originjs/tiny/opentiny-vue/home](https://open.codehub.huawei.com/innersource/originjs/tiny/opentiny-vue/home) +### Modify the popup window starting level (z-index) + +Add the following code to the entry file `main.js`: + +```js +import PopupManager from '@opentiny/vue-renderless/common/deps/popup-manager' + +// Set the starting level to 3000 +PopupManager.zIndex = 3000 +``` diff --git a/packages/renderless/README.zh-CN.md b/packages/renderless/README.zh-CN.md new file mode 100644 index 000000000..360cb0ebe --- /dev/null +++ b/packages/renderless/README.zh-CN.md @@ -0,0 +1,16 @@ +# @opentiny/vue-renderless + +为 `TinyVue` 组件提供无渲染逻辑层。 + +## 可以定制一些组件的全局配置 + +### 修改弹窗起始层级（z-index） + +在入口文件 `main.js` 中添加如下代码： + +```js +import PopupManager from '@opentiny/vue-renderless/common/deps/popup-manager' + +// 起始层级设置为3000 +PopupManager.zIndex = 3000 +``` diff --git a/packages/theme-mobile/README.md b/packages/theme-mobile/README.md index 1daf6fcb2..6b4d3e99c 100644 --- a/packages/theme-mobile/README.md +++ b/packages/theme-mobile/README.md @@ -1,2 +1,7 @@ # @opentiny/vue-theme-mobile +A package that provides theme styles for `TinyVue` components (mobile templates) + +## Provides dynamic theme switching capabilities (theme-tool) + +For details, please refer to: Theme switching document [https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme] diff --git a/packages/theme-mobile/README.zh-CN.md b/packages/theme-mobile/README.zh-CN.md new file mode 100644 index 000000000..a235bcdce --- /dev/null +++ b/packages/theme-mobile/README.zh-CN.md @@ -0,0 +1,7 @@ +# @opentiny/vue-theme-mobile + +为 `TinyVue` 组件（mobile模板）提供主题样式的包 + +## 提供动态切换主题能力（theme-tool） + +具体可以参考：主题切换文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme] diff --git a/packages/theme-saas/README.md b/packages/theme-saas/README.md index daec54f24..d59e3fc1b 100644 --- a/packages/theme-saas/README.md +++ b/packages/theme-saas/README.md @@ -1 +1,7 @@ -# @opentiny/vue-theme-saas \ No newline at end of file +# @opentiny/vue-theme-saas + +Provides a package of saas theme (using tailwind token) style for `TinyVue` component (pc template) + +## Provides dynamic theme switching capability (theme-tool) + +For details, please refer to: Theme switching document [https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme] diff --git a/packages/theme-saas/README.zh-CN.md b/packages/theme-saas/README.zh-CN.md new file mode 100644 index 000000000..9e1b304fa --- /dev/null +++ b/packages/theme-saas/README.zh-CN.md @@ -0,0 +1,7 @@ +# @opentiny/vue-theme-saas + +为 `TinyVue` 组件（pc模板）提供saas主题（使用tailwind的token）样式的包 + +## 提供动态切换主题能力（theme-tool） + +具体可以参考：主题切换文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme] diff --git a/packages/theme/README.md b/packages/theme/README.md index fbdd86913..d9c3ae204 100644 --- a/packages/theme/README.md +++ b/packages/theme/README.md @@ -1 +1,7 @@ -# @opentiny/vue-theme \ No newline at end of file +# @opentiny/vue-theme + +A package that provides theme styles for `TinyVue` components (pc templates) + +## Provides dynamic theme switching capabilities (theme-tool) + +For details, please refer to: Theme switching document [https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme] diff --git a/packages/theme/README.zh-CN.md b/packages/theme/README.zh-CN.md new file mode 100644 index 000000000..02f7e700d --- /dev/null +++ b/packages/theme/README.zh-CN.md @@ -0,0 +1,7 @@ +# @opentiny/vue-theme + +为 `TinyVue` 组件（pc模板）提供主题样式的包 + +## 提供动态切换主题能力（theme-tool） + +具体可以参考：主题切换文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme] diff --git a/packages/vue-common/README.md b/packages/vue-common/README.md new file mode 100644 index 000000000..d706b86a0 --- /dev/null +++ b/packages/vue-common/README.md @@ -0,0 +1,3 @@ +# @opentiny/vue-common + +The `TinyVue` component library is compatible with `vue2` and `vue3`, and provides features such as theme specification adaptation and browser window size breakpoint detection. diff --git a/packages/vue-common/README.zh-CN.md b/packages/vue-common/README.zh-CN.md new file mode 100644 index 000000000..9f3512117 --- /dev/null +++ b/packages/vue-common/README.zh-CN.md @@ -0,0 +1,3 @@ +# @opentiny/vue-common + +`TinyVue` 组件库跨 `vue2` 和 `vue3` 的适配兼容层，并且提供了主题规范适配、浏览器窗口大小断点检测等功能 diff --git a/packages/vue-directive/README.md b/packages/vue-directive/README.md new file mode 100644 index 000000000..f09747f0f --- /dev/null +++ b/packages/vue-directive/README.md @@ -0,0 +1,5 @@ +# @opentiny/vue-directive + +The `vue` directive collection provided by the `TinyVue` component library collects some useful `vue` directives. + +For usage, please refer to: Custom directive document [https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/directives-auto-tip] diff --git a/packages/vue-directive/README.zh-CN.md b/packages/vue-directive/README.zh-CN.md new file mode 100644 index 000000000..08314f05e --- /dev/null +++ b/packages/vue-directive/README.zh-CN.md @@ -0,0 +1,5 @@ +# @opentiny/vue-directive + +`TinyVue` 组件库提供的 `vue` 指令集合，汇集一些好用的 `vue` 指令。 + +使用方式可以参考：自定义指令文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/directives-auto-tip] diff --git a/packages/vue-icon-saas/README.md b/packages/vue-icon-saas/README.md new file mode 100644 index 000000000..eb900ecc3 --- /dev/null +++ b/packages/vue-icon-saas/README.md @@ -0,0 +1,5 @@ +# @opentiny/vue-icon-saas + +Provide vue icon components in `svg` format (saas style) + +For usage, please refer to: icon usage document [https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/icon] diff --git a/packages/vue-icon-saas/README.zh-CN.md b/packages/vue-icon-saas/README.zh-CN.md new file mode 100644 index 000000000..e96ec22ee --- /dev/null +++ b/packages/vue-icon-saas/README.zh-CN.md @@ -0,0 +1,5 @@ +# @opentiny/vue-icon-saas + +提供 `svg` 格式的 vue 图标组件（saas风格） + +使用方式可以参考：icon使用文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/icon] diff --git a/packages/vue-icon/README.md b/packages/vue-icon/README.md new file mode 100644 index 000000000..b82d17fbf --- /dev/null +++ b/packages/vue-icon/README.md @@ -0,0 +1,5 @@ +# @opentiny/vue-icon + +Provide vue icon components in `svg` format + +For usage, please refer to: icon usage document [https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/icon] diff --git a/packages/vue-icon/README.zh-CN.md b/packages/vue-icon/README.zh-CN.md new file mode 100644 index 000000000..bafef8f9e --- /dev/null +++ b/packages/vue-icon/README.zh-CN.md @@ -0,0 +1,5 @@ +# @opentiny/vue-icon + +提供 `svg` 格式的 vue 图标组件 + +使用方式可以参考：icon使用文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/icon] diff --git a/packages/vue-locale/README.md b/packages/vue-locale/README.md new file mode 100644 index 000000000..19bdeaced --- /dev/null +++ b/packages/vue-locale/README.md @@ -0,0 +1,7 @@ +# @opentiny/vue-locale + +Provide international language entries for the `TinyVue` component library and provide international switching functions. + +## Provide international capabilities + +For details, please refer to: Internationalization configuration document [https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/i18n] diff --git a/packages/vue-locale/README.zh-CN.md b/packages/vue-locale/README.zh-CN.md new file mode 100644 index 000000000..94b0b3513 --- /dev/null +++ b/packages/vue-locale/README.zh-CN.md @@ -0,0 +1,7 @@ +# @opentiny/vue-locale + +为 `TinyVue` 组件库提供国际化语言词条并提供国际化切换功能。 + +## 提供国际化能力 + +具体可以参考：国际化配置文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/i18n] diff --git a/packages/vue-runtime/README.md b/packages/vue-runtime/README.md new file mode 100644 index 000000000..708aa713d --- /dev/null +++ b/packages/vue-runtime/README.md @@ -0,0 +1,34 @@ +# @opentiny/vue-runtime + +Provide the runtime resource address in `es` format for `TinyVue` component library. + +## Import via CDN (available from v3.17.0) + +In order to meet different business needs, `TinyVue` provides multiple forms of `runtime`:# + +| Runtime name | Instructions | +| ------------------------- | ----------------------------------------------------------------- | +| tiny-vue-pc.mjs | A collection of components including all pc templates | +| tiny-vue-mobile.mjs | A collection of components including all mobile templates | +| tiny-vue-mobile-first.mjs | A collection of components including all multi-terminal templates | +| tiny-vue-simple.mjs | A collection of commonly used components | + +```html + + + + + + +``` diff --git a/packages/vue-runtime/README.zh-CN.md b/packages/vue-runtime/README.zh-CN.md new file mode 100644 index 000000000..38079a8f2 --- /dev/null +++ b/packages/vue-runtime/README.zh-CN.md @@ -0,0 +1,34 @@ +# @opentiny/vue-runtime + +为 `TinyVue` 组件库提供 `es` 格式的运行时资源地址。 + +## 通过 CDN 方式引入 (v3.17.0开始提供使用) + +为了应对不同的业务需要，`TinyVue` 提供多种形态的 `runtime`:# + +| Runtime 名称 | 使用说明 | +| ------------------------- | -------------------------- | +| tiny-vue-pc.mjs | 包含所有pc模板的组件集合 | +| tiny-vue-mobile.mjs | 包含所有移动模板的组件集合 | +| tiny-vue-mobile-first.mjs | 包含所有多端模板的组件集合 | +| tiny-vue-simple.mjs | 包含常用组件的集合 | + +```html + + + + + + +``` diff --git a/packages/vue-saas-common/README.md b/packages/vue-saas-common/README.md new file mode 100644 index 000000000..a20380646 --- /dev/null +++ b/packages/vue-saas-common/README.md @@ -0,0 +1,3 @@ +# @opentiny/vue-saas-common + +The `TinyVue` component library is compatible with `vue2` and `vue3`, and provides `saas` theme specification adaptation, browser window size breakpoint detection and other functions. diff --git a/packages/vue-saas-common/README.zh-CN.md b/packages/vue-saas-common/README.zh-CN.md new file mode 100644 index 000000000..ea10ebb81 --- /dev/null +++ b/packages/vue-saas-common/README.zh-CN.md @@ -0,0 +1,3 @@ +# @opentiny/vue-saas-common + +`TinyVue` 组件库跨 `vue2` 和 `vue3` 的适配兼容层，并且提供了 `saas` 主题规范适配、浏览器窗口大小断点检测等功能。