Skip to content

Commit 3592356

Browse files
1ncounter1ncounter
committed
build: upgrade docs deps
1 parent fedbbca commit 3592356

30 files changed

+816
-744
lines changed

‎docs/README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,20 @@
22

33
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
44

5-
### 安装
6-
7-
```
8-
$ yarn
9-
```
10-
115
### 本地开发
126

137
```
14-
$ yarn start
8+
$ pnpm start
159
```
1610

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
1911
### 构建
2012

2113
```
22-
$ yarn build
14+
$ pnpm build
2315
```
2416

2517
### 部署
18+
2619
```bash
2720
1. npm run build
2821
2. npm publish # 记得改下版本号，比如 1.0.1
@@ -34,12 +27,13 @@ $ yarn build
3427
5. lowcode-engine.cn 站点生效
3528
```
3629

37-
3830
## 功能
31+
3932
- [x] 支持本地离线搜索
4033
- [x] 版本化文档管理
4134
- [x] 离线静态部署
4235
- [x] 主题（fork 宜搭开发者中心）
4336

4437
## 使用文档
38+
4539
https://docusaurus.io/zh-CN/docs/docs-introduction

‎docs/config/navbar.js renamed to ‎docs/config/navbar.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
/**
2-
* 此配置的修改，如未生效，可以重新启动下即可
3-
*/
4-
module.exports = {
1+
import type * as Preset from '@docusaurus/preset-classic';
2+
3+
const navbar: Preset.ThemeConfig['navbar'] = {
54
title: '',
65
logo: {
76
alt: 'LowCode-Engine',
@@ -63,7 +62,6 @@ module.exports = {
6362
// position: 'right',
6463
// dropdownActiveClassDisabled: true,
6564
// },
66-
// {
6765
{
6866
href: 'https://github.com/alibaba/lowcode-engine',
6967
position: 'right',
@@ -82,3 +80,5 @@ module.exports = {
8280
},
8381
],
8482
};
83+
84+
export default navbar;

‎docs/config/sidebars.js renamed to ‎docs/config/sidebars.ts

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
1-
/*
2-
* Copyright (c) Facebook, Inc. and its affiliates.
3-
*
4-
* This source code is licensed under the MIT license found in the
5-
* LICENSE file in the root directory of this source tree.
6-
*/
7-
const getDocsFromDir = require('../scripts/getDocsFromDir');
1+
import getDocsFromDir from '../scripts/getDocsFromDir';
82

9-
module.exports = {
10-
// 手动配置的导航
11-
// guide: [
12-
// 'guide/quickStart/intro',
13-
// 'guide/quickStart/start',
14-
// {
15-
// type: 'category',
16-
// label: 'FAQ',
17-
// collapsed: false,
18-
// items: getDocsFromDir('guide/quickStart/faq'),
19-
// },
20-
// ],
3+
const sidebars = {
214
/**
225
* 根据当前目录自动生成导航配置
236
*/
@@ -39,7 +22,9 @@ module.exports = {
3922
type: 'category',
4023
label: '扩展编辑器',
4124
collapsed: false,
42-
items: getDocsFromDir('guide/expand/editor', [{ dir: 'guide/expand/editor/parts', label: 'Parts·造物' }]),
25+
items: getDocsFromDir('guide/expand/editor', [
26+
{ dir: 'guide/expand/editor/parts', label: 'Parts·造物' },
27+
]),
4328
},
4429
{
4530
type: 'category',
@@ -109,3 +94,5 @@ module.exports = {
10994
},
11095
],
11196
};
97+
98+
export default sidebars;

‎docs/config/sidebarsCommunity.js renamed to ‎docs/config/sidebarsCommunity.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module.exports = {
1+
export default {
22
community: [
33
{
44
type: 'autogenerated',

‎docs/docs/api/commonUI.md

Lines changed: 55 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ sidebar_position: 10
66
> **@since** v1.3.0
77
88
## 简介
9+
910
CommonUI API 是一个专为低代码引擎设计的组件 UI 库，使用它开发的插件，可以保证在不同项目和主题切换中能够保持一致性和兼容性。
1011

1112
## 组件列表
@@ -14,51 +15,50 @@ CommonUI API 是一个专为低代码引擎设计的组件 UI 库，使用它开
1415

1516
提示组件
1617

17-
| 参数 | 说明 | 类型 | 默认值 |
18-
|-----------|--------------|---------------------------------------|--------|
19-
| className | className | string (optional) | |
20-
| children | tip 的内容 | IPublicTypeI18nData \| ReactNode | |
21-
| direction | tip 的方向 | 'top' \| 'bottom' \| 'left' \| 'right' | |
22-
18+
| 参数 | 说明 | 类型 | 默认值 |
19+
| --------- | ---------- | -------------------------------------- | ------ |
20+
| className | className | string (optional) | |
21+
| children | tip 的内容 | IPublicTypeI18nData \| ReactNode | |
22+
| direction | tip 的方向 | 'top' \| 'bottom' \| 'left' \| 'right' | |
2323

2424
### HelpTip
2525

2626
带 help icon 的提示组件
2727

28-
| 参数 | 说明 | 类型 | 默认值 |
29-
|-----------|--------|-----------------------------------|--------|
30-
| help | 描述 | IPublicTypeHelpTipConfig | |
31-
| direction | 方向 | IPublicTypeTipConfig['direction'] | 'top' |
32-
| size | 方向 | IconProps['size'] | 'small'|
28+
| 参数 | 说明 | 类型 | 默认值 |
29+
| --------- | ---- | --------------------------------- | ------- |
30+
| help | 描述 | IPublicTypeHelpTipConfig | |
31+
| direction | 方向 | IPublicTypeTipConfig['direction'] | 'top' |
32+
| size | 方向 | IconProps['size'] | 'small' |
3333

3434
### Title
3535

3636
标题组件
3737

38-
| 参数 | 说明 | 类型 | 默认值 |
39-
|-----------|------------|-----------------------------|--------|
40-
| title | 标题内容 | IPublicTypeTitleContent | |
41-
| className | className | string (optional) | |
42-
| onClick | 点击事件 | () => void (optional) | |
38+
| 参数 | 说明 | 类型 | 默认值 |
39+
| --------- | --------- | ----------------------- | ------ |
40+
| title | 标题内容 | IPublicTypeTitleContent | |
41+
| className | className | string (optional) | |
42+
| onClick | 点击事件 | () => void (optional) | |
4343

4444
### ContextMenu
4545

46-
| 参数 | 说明 | 类型 | 默认值 |
47-
|--------|----------------------------------------------------|------------------------------------|--------|
48-
| menus | 定义上下文菜单的动作数组 | IPublicTypeContextMenuAction[] | |
49-
| children | 组件的子元素 | React.ReactElement[] | |
46+
| 参数 | 说明 | 类型 | 默认值 |
47+
| -------- | ------------------------ | ------------------------------ | ------ |
48+
| menus | 定义上下文菜单的动作数组 | IPublicTypeContextMenuAction[] | |
49+
| children | 组件的子元素 | React.ReactElement[] | |
5050

5151
**IPublicTypeContextMenuAction Interface**
5252

53-
| 参数 | 说明 | 类型 | 默认值 |
54-
|------------|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|----------------------------------------|
55-
| name | 动作的唯一标识符<br/>Unique identifier for the action | string | |
56-
| title | 显示的标题，可以是字符串或国际化数据<br/>Display title, can be a string or internationalized data | string \| IPublicTypeI18nData (optional) | |
57-
| type | 菜单项类型<br/>Menu item type | IPublicEnumContextMenuType (optional) | IPublicEnumContextMenuType.MENU_ITEM |
58-
| action | 点击时执行的动作，可选<br/>Action to execute on click, optional | (nodes: IPublicModelNode[]) => void (optional) | |
59-
| items | 子菜单项或生成子节点的函数，可选，仅支持两级<br/>Sub-menu items or function to generate child node, optional | Omit<IPublicTypeContextMenuAction, 'items'>[] \| ((nodes: IPublicModelNode[]) => Omit<IPublicTypeContextMenuAction, 'items'>[]) (optional) | |
60-
| condition | 显示条件函数<br/>Function to determine display condition | (nodes: IPublicModelNode[]) => boolean (optional) | |
61-
| disabled | 禁用条件函数，可选<br/>Function to determine disabled condition, optional | (nodes: IPublicModelNode[]) => boolean (optional) | |
53+
| 参数 | 说明 | 类型 | 默认值 |
54+
| --------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------ | --- |
55+
| name | 动作的唯一标识符<br/>Unique identifier for the action | string | |
56+
| title | 显示的标题，可以是字符串或国际化数据 <br/> Display title, can be a string or internationalized data | string \| IPublicTypeI18nData (optional) | |
57+
| type | 菜单项类型 <br/> Menu item type | IPublicEnumContextMenuType (optional) | IPublicEnumContextMenuType.MENU_ITEM |
58+
| action | 点击时执行的动作，可选<br/>Action to execute on click, optional | (nodes: IPublicModelNode[]) => void (optional) | |
59+
| items | 子菜单项或生成子节点的函数，可选，仅支持两级 <br/> Sub-menu items or function to generate child node, optional | `Omit<IPublicTypeContextMenuAction, 'items'>[] | ((nodes: IPublicModelNode[]) => Omit<IPublicTypeContextMenuAction, 'items'>[]) (optional)` | |
60+
| condition | 显示条件函数 <br/> Function to determine display condition | (nodes: IPublicModelNode[]) => boolean (optional) | |
61+
| disabled | 禁用条件函数，可选<br/>Function to determine disabled condition, optional | (nodes: IPublicModelNode[]) => boolean (optional) | |
6262

6363
**ContextMenu 示例**
6464

@@ -127,84 +127,109 @@ export default App;
127127
详细文档： [Balloon Documentation](https://fusion.design/pc/component/balloon)
128128

129129
### Breadcrumb
130+
130131
详细文档： [Breadcrumb Documentation](https://fusion.design/pc/component/breadcrumb)
131132

132133
### Button
134+
133135
详细文档： [Button Documentation](https://fusion.design/pc/component/button)
134136

135137
### Card
138+
136139
详细文档：[Card Documentation](https://fusion.design/pc/component/card)
137140

138141
### Checkbox
142+
139143
详细文档：[Checkbox Documentation](https://fusion.design/pc/component/checkbox)
140144

141145
### DatePicker
146+
142147
详细文档：[DatePicker Documentation](https://fusion.design/pc/component/datepicker)
143148

144149
### Dialog
150+
145151
详细文档：[Dialog Documentation](https://fusion.design/pc/component/dialog)
146152

147153
### Dropdown
154+
148155
详细文档：[Dropdown Documentation](https://fusion.design/pc/component/dropdown)
149156

150157
### Form
158+
151159
详细文档：[Form Documentation](https://fusion.design/pc/component/form)
152160

153161
### Icon
162+
154163
详细文档：[Icon Documentation](https://fusion.design/pc/component/icon)
155164

156165
引擎默认主题支持的 icon 列表：https://fusion.design/64063/component/icon?themeid=20133
157166

158-
159167
### Input
168+
160169
详细文档：[Input Documentation](https://fusion.design/pc/component/input)
161170

162171
### Loading
172+
163173
详细文档：[Loading Documentation](https://fusion.design/pc/component/loading)
164174

165175
### Message
176+
166177
详细文档：[Message Documentation](https://fusion.design/pc/component/message)
167178

168179
### Overlay
180+
169181
详细文档：[Overlay Documentation](https://fusion.design/pc/component/overlay)
170182

171183
### Pagination
184+
172185
详细文档：[Pagination Documentation](https://fusion.design/pc/component/pagination)
173186

174187
### Radio
188+
175189
详细文档：[Radio Documentation](https://fusion.design/pc/component/radio)
176190

177191
### Search
192+
178193
详细文档：[Search Documentation](https://fusion.design/pc/component/search)
179194

180195
### Select
196+
181197
详细文档：[Select Documentation](https://fusion.design/pc/component/select)
182198

183199
### SplitButton
200+
184201
详细文档：[SplitButton Documentation](https://fusion.design/pc/component/splitbutton)
185202

186203
### Step
204+
187205
详细文档：[Step Documentation](https://fusion.design/pc/component/step)
188206

189207
### Switch
208+
190209
详细文档：[Switch Documentation](https://fusion.design/pc/component/switch)
191210

192211
### Tab
212+
193213
详细文档：[Tab Documentation](https://fusion.design/pc/component/tab)
194214

195215
### Table
216+
196217
详细文档：[Table Documentation](https://fusion.design/pc/component/table)
197218

198219
### Tree
220+
199221
详细文档：[Tree Documentation](https://fusion.design/pc/component/tree)
200222

201223
### TreeSelect
224+
202225
详细文档：[TreeSelect Documentation](https://fusion.design/pc/component/treeselect)
203226

204227
### Upload
228+
205229
详细文档：[Upload Documentation](https://fusion.design/pc/component/upload)
206230

207231
### Divider
232+
208233
详细文档：[Divider Documentation](https://fusion.design/pc/component/divider)
209234

210235
## 说明

‎docs/docs/guide/appendix/setterDetails/mixed.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: MixedSetter
33
---
4+
45
## 简介
6+
57
可以让属性同时支持多个 setter
68

79
## 展示
@@ -10,6 +12,6 @@ title: MixedSetter
1012

1113
## 配置
1214

13-
| **属性名** | **类型** | **说明** |
14-
| --- | --- | --- |
15-
| setters | Array<String\> | SetterName |
15+
| **属性名** | **类型** | **说明** |
16+
| ---------- | --------------- | ---------- |
17+
| setters | `Array<String>` | SetterName |

‎docs/docs/guide/appendix/setterDetails/radioGroup.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
---
22
title: RadioGroupSetter
33
---
4+
45
## 简介
6+
57
用于直观的展示选择并选择。
8+
69
## 展示
710

811
<img src="https://img.alicdn.com/imgextra/i2/O1CN01rId9td25yYv0my5Hd_!!6000000007595-2-tps-564-98.png" width="300"/>
912

1013
## setter 配置
11-
| 属性名 | 说明 |
12-
| --- | --- |
13-
| defaultValue | 默认值 |
14-
| options | 传入的数据源，**参数格式**: [{img: 'url', value: 'text', label/title: 'text'}, ...] \| [ 'text', 'text', ...] |
14+
15+
| 属性名 | 说明 |
16+
| ------------ | ------------------------------------------------------------------------------------ | ----------------------- |
17+
| defaultValue | 默认值 |
18+
| options | 传入的数据源，**参数格式**: `[{img: 'url', value: 'text', label/title: 'text'}, ...] | [ 'text', 'text', ...]` |
1519

1620
## 返回类型
21+
1722
String | Number | Boolean
1823
会返回 options 中的 value 值

‎docs/docs/guide/appendix/setterDetails/select.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
---
22
title: SelectSetter
33
---
4+
45
## 简介
6+
57
用来选择组件。在限定的可选性内进行选择，核心能力是选择
8+
69
## 展示
710

811
<img src="https://img.alicdn.com/imgextra/i4/O1CN013arqCy1f1JfwdTGQo_!!6000000003946-2-tps-574-602.png" width="300"/>
912

1013
## setter 配置
11-
| 属性名 | 说明 |
12-
| --- | --- |
13-
| mode | 选择器模式 可选值: 'single', 'multiple', 'tag' |
14-
| defaultValue | 默认值 |
15-
| options | 传入的数据源，**参数格式**: [ {label/title: '文字', value: 'text'}, ...] |
14+
15+
| 属性名 | 说明 |
16+
| ------------ | -------------------------------------------------------------------------- |
17+
| mode | 选择器模式 可选值: 'single', 'multiple', 'tag' |
18+
| defaultValue | 默认值 |
19+
| options | 传入的数据源，**参数格式**: `[ {label/title: '文字', value: 'text'}, ...]` |
1620

1721
## 返回类型
1822

0 commit comments

Comments
 (0)