Skip to content

Commit aa72878

Browse files
JackLianJackLian
committed
Merge branch 'release/1.1.0'
2 parents f4868b8 + 19b997c commit aa72878

757 files changed

Lines changed: 19618 additions & 10002 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.eslintrc.js‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,17 @@ module.exports = {
4040
"@typescript-eslint/no-useless-constructor": 0,
4141
'@typescript-eslint/dot-notation': 0, // for lint performance
4242
'@typescript-eslint/restrict-plus-operands': 0, // for lint performance
43+
'no-unexpected-multiline': 1,
44+
'no-multiple-empty-lines': ['error', { "max": 1 }],
45+
'lines-around-comment': ['error', {
46+
"beforeBlockComment": true,
47+
"afterBlockComment": false,
48+
"afterLineComment": false,
49+
"allowBlockStart": true,
50+
}],
51+
"@typescript-eslint/member-ordering": [
52+
"error",
53+
{ "default": ["signature", "field", "constructor", "method"] }
54+
],
4355
}
44-
};
56+
};

‎babel.config.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module.exports = {
2+
plugins: [
3+
['@babel/plugin-proposal-decorators', { legacy: true }],
4+
[require.resolve('@babel/plugin-proposal-class-properties'), { loose: true }],
5+
],
6+
};

‎docs/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ $ yarn build
2727
1. npm run build
2828
2. npm publish # 记得改下版本号，比如 1.0.1
2929

30-
# 发布完后执行 tnpm sync
31-
3. tnpm sync
30+
# 发布完后执行 tnpm syncOss 同步到 uipaas CDN
31+
3. tnpm syncOss
3232

3333
4. 更新 diamond 版本 1.0.1
3434
5. lowcode-engine.cn 站点生效
@@ -37,10 +37,9 @@ $ yarn build
3737

3838
## 功能
3939
- [x] 支持本地离线搜搜
40-
- [x] 版本化文档管理
40+
- [x] 版本化文档管理
4141
- [x] 离线静态部署
4242
- [x] 主题（fork 宜搭开发者中心）
4343

4444
## 使用文档
4545
https://docusaurus.io/zh-CN/docs/docs-introduction
46-

‎docs/config/navbar.js‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,6 @@ module.exports = {
3333
position: 'left',
3434
label: 'FAQ',
3535
},
36-
{
37-
type: 'doc',
38-
docId: 'participate/index',
39-
position: 'left',
40-
label: '参与贡献',
41-
},
4236
{
4337
type: 'doc',
4438
docId: 'article/index',
@@ -51,16 +45,6 @@ module.exports = {
5145
position: 'left',
5246
label: 'Demo 使用文档',
5347
},
54-
{
55-
position: 'left',
56-
href: 'https://developer.aliyun.com/ebook/7507',
57-
label: '技术白皮书',
58-
},
59-
{
60-
position: 'left',
61-
href: 'https://github.com/alibaba/lowcode-engine/releases',
62-
label: '更新日志',
63-
},
6448
{
6549
to: '/community/issue',
6650
position: 'left',
@@ -80,6 +64,12 @@ module.exports = {
8064
className: 'header-github-link',
8165
'aria-label': 'GitHub repository',
8266
},
67+
{
68+
type: 'doc',
69+
docId: 'participate/index',
70+
position: 'right',
71+
label: '参与贡献',
72+
},
8373
{
8474
type: 'search',
8575
position: 'right',

‎docs/config/sidebars.js‎

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,56 @@ module.exports = {
2222
* 根据当前目录自动生成导航配置
2323
*/
2424
guide: [
25-
{
26-
type: 'autogenerated',
27-
dirName: 'guide', // '.' 即当前的文档文件夹
28-
},
25+
[
26+
{
27+
type: 'category',
28+
label: '入门',
29+
collapsed: false,
30+
items: getDocsFromDir('guide/quickStart'),
31+
},
32+
{
33+
type: 'category',
34+
label: '创建编辑器',
35+
collapsed: false,
36+
items: getDocsFromDir('guide/create'),
37+
},
38+
{
39+
type: 'category',
40+
label: '扩展编辑器',
41+
collapsed: false,
42+
items: getDocsFromDir('guide/expand/editor', [{ dir: 'guide/expand/editor/parts', label: 'Parts·造物' }]),
43+
},
44+
{
45+
type: 'category',
46+
label: '扩展运行时',
47+
collapsed: false,
48+
items: getDocsFromDir('guide/expand/runtime'),
49+
},
50+
{
51+
type: 'category',
52+
label: '设计原理',
53+
collapsed: false,
54+
items: getDocsFromDir('guide/design'),
55+
},
56+
{
57+
type: 'category',
58+
label: '附录',
59+
collapsed: false,
60+
items: [
61+
{
62+
type: 'link',
63+
label: '更新日志',
64+
href: 'https://github.com/alibaba/lowcode-engine/releases',
65+
},
66+
...getDocsFromDir('guide/appendix'),
67+
],
68+
},
69+
{
70+
type: 'link',
71+
label: '技术白皮书',
72+
href: 'https://developer.aliyun.com/ebook/7507',
73+
},
74+
],
2975
],
3076
api: [
3177
{
@@ -57,5 +103,4 @@ module.exports = {
57103
dirName: 'demoUsage',
58104
},
59105
],
60-
// api: getDocsFromDir('api'),
61106
};

‎docs/docs/api/canvas.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: canvas - 画布 API
3+
sidebar_position: 12
4+
---
5+
6+
> **@types** [IPublicApiCanvas](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/api/canvas.ts)<br/>
7+
> **@since** v1.1.0
8+
9+
10+
## 模块简介
11+
12+
通过该模块可以触达对画布拖拽相关的一些能力。
13+
14+
## 变量
15+
16+
### dragon
17+
18+
获取拖拽操作对象的实例
19+
20+
`@type {IPublicModelDragon | null}`
21+
22+
23+
相关类型：[IPublicModelDragon](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/dragon.ts)
24+
25+
### activeTracker
26+
27+
获取活动追踪器实例
28+
29+
`@type {IPublicModelActiveTracker | null}`
30+
31+
相关类型：[IPublicModelActiveTracker](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/active-tracker.ts)
32+
33+
### isInLiveEditing
34+
35+
是否处于 LiveEditing 状态
36+
37+
`@type {boolean}`
38+
39+
### clipboard
40+
全局剪贴板实例
41+
42+
`@type {IPublicModelClipboard}`
43+
44+
相关类型：[IPublicModelClipboard](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/clipboard.ts)
45+
46+
## 方法
47+
48+
### createLocation
49+
创建一个文档插入位置对象，该对象用来描述一个即将插入的节点在文档中的位置
50+
51+
```typescript
52+
/**
53+
* 创建一个文档插入位置对象，该对象用来描述一个即将插入的节点在文档中的位置
54+
* create a drop location for document, drop location describes a location in document
55+
* @since v1.1.0
56+
*/
57+
createLocation(locationData: IPublicTypeLocationData): IPublicModelDropLocation;
58+
```
59+
60+
### createScroller
61+
创建一个滚动控制器 Scroller，赋予一个视图滚动的基本能力，
62+
```typescript
63+
/**
64+
* 创建一个滚动控制器 Scroller，赋予一个视图滚动的基本能力，
65+
* a Scroller is a controller that gives a view (IPublicTypeScrollable) the ability scrolling
66+
* to some cordination by api scrollTo.
67+
*
68+
* when a scroller is inited, will need to pass is a scrollable, which has a scrollTarget.
69+
* and when scrollTo(options: { left?: number; top?: number }) is called, scroller will
70+
* move scrollTarget`s top-left corner to (options.left, options.top) that passed in.
71+
* @since v1.1.0
72+
*/
73+
createScroller(scrollable: IPublicTypeScrollable): IPublicModelScroller;
74+
75+
```
76+
77+
### createScrollTarget
78+
创建一个 ScrollTarget，与 Scroller 一起发挥作用，详见 [createScroller](#createscroller) 中的描述
79+
80+
```typescript
81+
/**
82+
* 创建一个 ScrollTarget，与 Scroller 一起发挥作用，详见 createScroller 中的描述
83+
* this works with Scroller, refer to createScroller`s description
84+
* @since v1.1.0
85+
*/
86+
createScrollTarget(shell: HTMLDivElement): IPublicModelScrollTarget;
87+
```

0 commit comments

Comments
 (0)