Skip to content

Commit

Permalink
chore(dep): change element-plus to semi-ui-vue
Browse files Browse the repository at this point in the history
  • Loading branch information
497363983 committed Oct 1, 2024
1 parent 1112925 commit fa13446
Show file tree
Hide file tree
Showing 8 changed files with 11,660 additions and 5,732 deletions.
17,370 changes: 11,649 additions & 5,721 deletions package-lock.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"@commitlint/cli": "^19.0.0",
"@commitlint/config-conventional": "^19.0.0",
"@eslint/js": "^9.8.0",
"@kousum/semi-ui-vue": "^0.21.0",
"@lark-base-open/js-sdk": "https://lf3-static.bytednsdoc.com/obj/eden-cn/jjjpceh7nulojvhj/@lark-base-open-js-sdk-0.4.1-beta.5.tgz",
"@types/fs-extra": "^11.0.2",
"@types/js-yaml": "^4.0.7",
Expand All @@ -69,7 +70,6 @@
"@vitest/ui": "^2.0.0",
"@vue/test-utils": "^2.4.1",
"@vueuse/core": "^11.0.0",
"element-plus": "^2.3.14",
"eslint": "^9.0.0",
"eslint-plugin-markdown": "^5.0.0",
"eslint-plugin-vue": "^9.17.0",
Expand Down
2 changes: 1 addition & 1 deletion src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ features:
details: Documentation of functions also come with interactive demos
- icon:
title: Light
details: No built-in third-party libraries, but depends on element-plus, js-sdk and vue
details: No built-in third-party libraries, but depends on semi-ui-vue, js-sdk and vue
- icon: 🦾
title: TypeScript
details: Written in TypeScript
Expand Down
2 changes: 1 addition & 1 deletion src/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ features:
details: 功能文档附带交互式演示
- icon:
title: 轻量
details: 无内置第三方库, 但依赖于 element-plus, js-sdk 和 vue
details: 无内置第三方库, 但依赖于 semi-ui-vue, js-sdk 和 vue
- icon: 🦾
title: TypeScript
details: 使用 TypeScript 编写
Expand Down
6 changes: 3 additions & 3 deletions src/introduction/1_What-is-useBitable.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ isFn: false
This library is still in early development.
:::

`useBitable` is inspired by [UIBuilder](https://bytedance.feishu.cn/docx/Dt2hdGiHtoP7jrx23N7cPqGBnWg) and [Vueuse](https://vueuse.org/), aiming to wrap [JS SDK](https://lark-base-team.github.io/js-sdk-docs/en/) of Feishu Official based on [Composition API](https://v3.vuejs.org/guide/composition-api-introduction.html) of [Vue](https://v3.vuejs.org/), provide some useful [Composables](https://v3.vuejs.org/guide/composition-api-introduction.html#composables), and provide an [element-plus](https://element-plus.org/en-US/) version of `UIBuilder`, providing a more convenient way for users to build UI and plugin logic.
`useBitable` is inspired by [UIBuilder](https://bytedance.feishu.cn/docx/Dt2hdGiHtoP7jrx23N7cPqGBnWg) and [Vueuse](https://vueuse.org/), aiming to wrap [JS SDK](https://lark-base-team.github.io/js-sdk-docs/en/) of Feishu Official based on [Composition API](https://v3.vuejs.org/guide/composition-api-introduction.html) of [Vue](https://v3.vuejs.org/), provide some useful [Composables](https://v3.vuejs.org/guide/composition-api-introduction.html#composables), and provide an [semi-ui-vue](https://www.kousum.asia/zh-CN/start/introduction/) version of `UIBuilder`, providing a more convenient way for users to build UI and plugin logic.

:::tip
Although this library tries its best to make the development experience friendly to novices, it is undeniable that using this library requires a certain foundation of `Vue` and `TypeScript`. If you are not familiar with `Vue` and `TypeScript`, it is recommended to learn relevant knowledge first.
:::

## Features

- 🚀 **UIBuilder**: Easily build [`element-plus`](https://element-plus.org/en-US/) style UI through code
- 🚀 **UIBuilder**: Easily build [`semi-ui-vue`](https://www.kousum.asia/zh-CN/start/introduction/) style UI through code
- 🔧 **Composables**: Based on [`Composition API`](https://v3.vuejs.org/guide/composition-api-introduction.html) to wrap [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/en/)
- 🔆 **Interactive Demo**: Interactive demo attached to the documentation
-**Lightweight**: No built-in third-party libraries, but depends on [`element-plus`](https://element-plus.org/en-US/), [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/en/) and [`Vue`](https://v3.vuejs.org/)
-**Lightweight**: No built-in third-party libraries, but depends on [`semi-ui-vue`](https://www.kousum.asia/zh-CN/start/introduction/), [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/en/) and [`Vue`](https://v3.vuejs.org/)
- 🦾 **TypeScript**: Written in TypeScript, providing complete type support
- 🌐 **Internationalization**: i18n support
- 📖 **Documentation**: Detailed documentation and examples
Expand Down
6 changes: 3 additions & 3 deletions src/introduction/1_What-is-useBitable.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ isFn: false
该库仍在初期开发中。
:::

`useBitable` 启发于飞书官方的 [`UIBuilder`](https://bytedance.feishu.cn/docx/Dt2hdGiHtoP7jrx23N7cPqGBnWg)[`Vueuse`](https://vueuse.org/), 旨在基于 [`Vue`](https://cn.vuejs.org/)[`Composition API`](https://cn.vuejs.org/guide/introduction.html#composition-api) 对飞书官方的 [`JS SDK`](https://lark-base-team.github.io/js-sdk-docs/zh/) 进行封装,提供一些有用的[组合式函数(Composables)](https://cn.vuejs.org/guide/reusability/composables.html),并提供一个 [`element-plus`](https://element-plus.org/zh-CN/)版本的 `UIBuilder`,为使用者提供一个更为便捷的构建 UI 和插件逻辑的方式。
`useBitable` 启发于飞书官方的 [`UIBuilder`](https://bytedance.feishu.cn/docx/Dt2hdGiHtoP7jrx23N7cPqGBnWg)[`Vueuse`](https://vueuse.org/), 旨在基于 [`Vue`](https://cn.vuejs.org/)[`Composition API`](https://cn.vuejs.org/guide/introduction.html#composition-api) 对飞书官方的 [`JS SDK`](https://lark-base-team.github.io/js-sdk-docs/zh/) 进行封装,提供一些有用的[组合式函数(Composables)](https://cn.vuejs.org/guide/reusability/composables.html),并提供一个 [`semi-ui-vue`](https://www.kousum.asia/zh-CN/start/introduction/)版本的 `UIBuilder`,为使用者提供一个更为便捷的构建 UI 和插件逻辑的方式。

:::tip
尽管本库尽力使开发体验对新手友好,但不可否认的是,使用本库需要一定的 `Vue``TypeScript` 基础,如果你对 `Vue``TypeScript` 不熟悉,建议先学习一下相关知识。
:::

## 特性

- 🚀 **UIBuilder**:通过编码轻松构建 [`element-plus`](https://element-plus.org/zh-CN/) 风格的 UI
- 🚀 **UIBuilder**:通过编码轻松构建 [`semi-ui-vue`](https://www.kousum.asia/zh-CN/start/introduction/) 风格的 UI
- 🔧 **Composables**:基于 [`Composition API`](https://cn.vuejs.org/guide/introduction.html#composition-api) 封装 [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/zh/) 提供了一些有用的工具
- 🔆 **交互式演示**:功能文档附带交互式演示
-**轻量**:无内置第三方库, 但依赖于 [`element-plus`](https://element-plus.org/zh-CN/), [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/zh/)[`Vue`](https://cn.vuejs.org/)
-**轻量**:无内置第三方库, 但依赖于 [`semi-ui-vue`](https://www.kousum.asia/zh-CN/start/introduction/), [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/zh/)[`Vue`](https://cn.vuejs.org/)
- 🦾 **TypeScript**:使用 TypeScript 编写, 提供完整的类型支持
- 🌐 **国际化**:支持i18n
- 📖 **文档**:详细的文档和示例
Expand Down
2 changes: 1 addition & 1 deletion src/introduction/2_Get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ isFn: false

## Installation

> To use the whole `useBitable` package, you need to install [`vue@3`](https://vuejs.org/), [`element-plus`](https://element-plus.org/en-US/) and [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/en/).
> To use the whole `useBitable` package, you need to install [`vue@3`](https://vuejs.org/), [`semi-ui-vue`](https://www.kousum.asia/zh-CN/start/introduction/) and [`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/en/).
:::code-group

Expand Down
2 changes: 1 addition & 1 deletion src/introduction/2_Get-started.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ isFn: false

## 安装

> 要使用完整的 `useBitable`,同时需要安装 [`vue@3`](https://cn.vuejs.org/)[`element-plus`](https://element-plus.org/zh-CN/)[`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/zh/)
> 要使用完整的 `useBitable`,同时需要安装 [`vue@3`](https://cn.vuejs.org/)[`semi-ui-vue`](https://www.kousum.asia/zh-CN/start/introduction/)[`@lark-base-open/js-sdk`](https://lark-base-team.github.io/js-sdk-docs/zh/)
::: tip 关于 `@lark-base-open/js-sdk` 的版本
对于部分项目,它们的 `@lark-base-open/js-sdk` 版本可能是 [`0.2.x`](https://bytedance.feishu.cn/docx/HjCEd1sPzoVnxIxF3LrcKnepnUf),但这并不妨碍它们升级到 `0.3.x`,至少目前官方表明没有破坏性更改,高版本都完全向下兼容,并且 `0.3.x` 有着更完善的类型支持和更丰富的 `API`。升级到 `0.3.x` 不会影响到已有项目的正常运行。因此,本包默认采用 `0.3.x` 开发。
Expand Down

0 comments on commit fa13446

Please sign in to comment.