forked from opentiny/tiny-vue
feat(readme): add readme files to main packages (#1826)
This commit is contained in:
ajaxzheng
GitHub
parent
89fd59a965
commit
4a7c5d993e
|
|
@ -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
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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
|
||||
```
|
||||
|
|
@ -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]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
# @opentiny/vue-theme-mobile
|
||||
|
||||
为 `TinyVue` 组件（mobile模板）提供主题样式的包
|
||||
|
||||
## 提供动态切换主题能力（theme-tool）
|
||||
|
||||
具体可以参考：主题切换文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme]
|
||||
|
|
@ -1 +1,7 @@
|
|||
# @opentiny/vue-theme-saas
|
||||
# @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]
|
||||
|
|
|
|||
|
|
@ -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]
|
||||
|
|
@ -1 +1,7 @@
|
|||
# @opentiny/vue-theme
|
||||
# @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]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
# @opentiny/vue-theme
|
||||
|
||||
为 `TinyVue` 组件（pc模板）提供主题样式的包
|
||||
|
||||
## 提供动态切换主题能力（theme-tool）
|
||||
|
||||
具体可以参考：主题切换文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/theme]
|
||||
|
|
@ -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.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# @opentiny/vue-common
|
||||
|
||||
`TinyVue` 组件库跨 `vue2` 和 `vue3` 的适配兼容层，并且提供了主题规范适配、浏览器窗口大小断点检测等功能
|
||||
|
|
@ -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]
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# @opentiny/vue-directive
|
||||
|
||||
`TinyVue` 组件库提供的 `vue` 指令集合，汇集一些好用的 `vue` 指令。
|
||||
|
||||
使用方式可以参考：自定义指令文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/directives-auto-tip]
|
||||
|
|
@ -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]
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# @opentiny/vue-icon-saas
|
||||
|
||||
提供 `svg` 格式的 vue 图标组件（saas风格）
|
||||
|
||||
使用方式可以参考：icon使用文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/icon]
|
||||
|
|
@ -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]
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# @opentiny/vue-icon
|
||||
|
||||
提供 `svg` 格式的 vue 图标组件
|
||||
|
||||
使用方式可以参考：icon使用文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/icon]
|
||||
|
|
@ -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]
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# @opentiny/vue-locale
|
||||
|
||||
为 `TinyVue` 组件库提供国际化语言词条并提供国际化切换功能。
|
||||
|
||||
## 提供国际化能力
|
||||
|
||||
具体可以参考：国际化配置文档[https://opentiny.design/tiny-vue/zh-CN/smb-theme/docs/i18n]
|
||||
|
|
@ -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
|
||||
<head>
|
||||
<!-- 引入 vue 和 @opentiny/vue -->
|
||||
<script type="importmap">
|
||||
{
|
||||
"imports": {
|
||||
"vue": "https://registry.npmmirror.com/vue/3.4.27/files/dist/vue.runtime.esm-browser.js",
|
||||
"echarts": "https://registry.npmmirror.com/echarts/5.4.1/files/dist/echarts.esm.js",
|
||||
"@opentiny/vue": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-pc.mjs",
|
||||
"@opentiny/vue-icon": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-icon.mjs",
|
||||
"@opentiny/vue-locale": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-locale.mjs",
|
||||
"@opentiny/vue-common": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-common.mjs"
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<!-- 引入 @opentiny/vue 样式 -->
|
||||
<link rel="stylesheet" href="https://registry.npmmirror.com/@opentiny/vue-theme/3.17/files/index.css" />
|
||||
</head>
|
||||
```
|
||||
|
|
@ -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
|
||||
<head>
|
||||
<!-- 引入 vue 和 @opentiny/vue -->
|
||||
<script type="importmap">
|
||||
{
|
||||
"imports": {
|
||||
"vue": "https://registry.npmmirror.com/vue/3.4.27/files/dist/vue.runtime.esm-browser.js",
|
||||
"echarts": "https://registry.npmmirror.com/echarts/5.4.1/files/dist/echarts.esm.js",
|
||||
"@opentiny/vue": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-pc.mjs",
|
||||
"@opentiny/vue-icon": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-icon.mjs",
|
||||
"@opentiny/vue-locale": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-locale.mjs",
|
||||
"@opentiny/vue-common": "https://registry.npmmirror.com/@opentiny/vue-runtime/3.17/files/dist3/tiny-vue-common.mjs"
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<!-- 引入 @opentiny/vue 样式 -->
|
||||
<link rel="stylesheet" href="https://registry.npmmirror.com/@opentiny/vue-theme/3.17/files/index.css" />
|
||||
</head>
|
||||
```
|
||||
|
|
@ -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.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# @opentiny/vue-saas-common
|
||||
|
||||
`TinyVue` 组件库跨 `vue2` 和 `vue3` 的适配兼容层，并且提供了 `saas` 主题规范适配、浏览器窗口大小断点检测等功能。
|
||||
Loading…
Reference in New Issue