Skip to content

docs(changelog): update changelog and runtime doc #1749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions examples/sites/demos/pc/webdoc/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# 更新日志

## v2.17.0/v3.17.0

`2024/07/17`

## What's Changed

### Exciting New Features 🎉

- feat(auto-tip): add auto-tip directive by @zzcr
- feat(fluent-editor): add fluent-editor component by @kagol
- feat(base-select): [base-select,select] add base-select by @kagol in https://github.com/opentiny/tiny-vue/pull/1632
- feat(runtime): add all、pc、mobile、mobile-first、simple runtime by @zzcr in https://github.com/opentiny/tiny-vue/pull/1662
- feat(base-select): [select,base-select] add panel slot by @kagol in https://github.com/opentiny/tiny-vue/pull/1663
- feat(components): [drawer] enable open event by @betavs in https://github.com/opentiny/tiny-vue/pull/1527
- feat: update mobile first template by @zzcr in https://github.com/opentiny/tiny-vue/pull/1697
- feat(breadcrumb): [breadcrumb] adapts to xdesign theme by @wuyiping0628 in https://github.com/opentiny/tiny-vue/pull/1693

### Bug Fixes 🐛

- fix(button-group): [button-group] Fixed I18n by @You-Hw-Y in https://github.com/opentiny/tiny-vue/pull/1689
- fix(timeline): [timeline] add vertical description to node description slot by @wuyiping0628 in https://github.com/opentiny/tiny-vue/pull/1685
- fix(dialog-box): update style problem by @James-9696 in https://github.com/opentiny/tiny-vue/pull/1674
- fix(nav-menu): [nav-menu] resolve the issue of current component not being highlighted by @wuyiping0628 in https://github.com/opentiny/tiny-vue/pull/1695
- fix(chart): [chart] Fixed baidu chart example and chart-core bug by @Davont in https://github.com/opentiny/tiny-vue/pull/1691
- fix(theme): update scrollbar width to 8px by @gimmyhehe in https://github.com/opentiny/tiny-vue/pull/1668
- fix(pager): all theme use same svg to show dot by @gimmyhehe in https://github.com/opentiny/tiny-vue/pull/1673

### Other Changes

- docs: optimize component category by @kagol in https://github.com/opentiny/tiny-vue/pull/1626
- docs: add carousel component of demo by @James-9696 in https://github.com/opentiny/tiny-vue/pull/1609
- ci(runtime): add runtime git action by @zzcr in https://github.com/opentiny/tiny-vue/pull/1667
- docs(date-picker): [date-picker] Optimization Cases by @You-Hw-Y in https://github.com/opentiny/tiny-vue/pull/1690
- build(runtime): update runtime playgroud by @zzcr in https://github.com/opentiny/tiny-vue/pull/1669

## New Contributors

- @zhangpaopao0609 made their first contribution in https://github.com/opentiny/tiny-vue/pull/1654

## v2.16.0/v3.16.0

`2024/05/11`
Expand Down
35 changes: 33 additions & 2 deletions examples/sites/demos/pc/webdoc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ export default defineConfig({
<p><code> @opentiny/vue </code> 支持多种模式。如果您的工程非移动端工程,可以在上面配置代码中的<code>process.env</code>中,声明<code>TINY_MODE</code>的值,以使工程在构建时,能将移动端模式的代码摇掉,优化打包产物的体积。比如 <code>'process.env': { ...process.env,TINY_MODE:'pc' }</code>。</p>
</div>

### 通过 CDN 方式引入
### 通过 CDN 方式引入 (v3.16.0及之前的版本可用)

为了更快地体验 TinyVue 的组件,你也可以通过 CDN 方式直接在 HTML 页面中引入 TinyVue, 建议版本号写 2 个有效版本数字即可,具体配置如下:
为了更快地体验 `TinyVue` 的组件,你也可以通过 `CDN` 方式直接在 HTML 页面中引入 `TinyVue`, 建议版本号写 `2` 个有效版本数字即可,具体配置如下:

```html
<head>
Expand All @@ -80,6 +80,37 @@ export default defineConfig({
</head>
```

### 通过 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>
```

接着就可以导入 TinyVue,并通过 app 实例的 use 方法在全局注册 TinyVue 插件,这样就可以在 template 模板中使用 TinyVue 的组件。

```html
Expand Down
2 changes: 1 addition & 1 deletion examples/sites/playground.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + Vue</title>
<title>OpenTinyVue 演练场</title>
<script>
const cdnHost = 'https://registry.npmmirror.com'
window.localStorage.setItem('setting-cdn', cdnHost)
Expand Down
2 changes: 1 addition & 1 deletion examples/sites/playground/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const isMobileFirst = tinyMode === 'mobile-first'
const isSaas = tinyTheme === 'saas'
const isPreview = searchObj.get('openMode') === 'preview' // 是否多端弹窗预览

const versions = ['3.16', '3.15', '3.14', '3.13', '3.12', '3.11', '3.10', '3.9', '3.8']
const versions = ['3.17', '3.16', '3.15', '3.14', '3.13', '3.12', '3.11', '3.10', '3.9', '3.8']
const latestVersion = isPreview ? versions[0] : localStorage.getItem(VERSION) || versions[0]
const cdnHost = localStorage.getItem('setting-cdn')

Expand Down
Loading