Skip to content

Commit 2bf3aa7

Browse files
liujupingJackLian
authored andcommitted
docs: add skeleton.getAreaItems docs
1 parent 594abc4 commit 2bf3aa7

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

docs/docs/api/skeleton.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,24 @@ showArea(areaName: string): void;
297297
hideArea(areaName: string): void;
298298
```
299299

300+
### getAreaItems
301+
302+
获取某个区域下的所有面板实例
303+
304+
```typescript
305+
/**
306+
* 获取某个区域下的所有面板实例
307+
* @param areaName IPublicTypeWidgetConfigArea
308+
*/
309+
getAreaItems(areaName: IPublicTypeWidgetConfigArea): IPublicModelSkeletonItem[] | undefined;
310+
```
311+
312+
相关类型:[IPublicModelSkeletonItem](https://github.com/alibaba/lowcode-engine/blob/main/packages/shell/src/model/skeleton-item.ts)
313+
314+
315+
300316
### registerConfigTransducer
317+
301318
注册一个面板的配置转换器(transducer)。
302319

303320
```typescript

packages/types/src/shell/api/skeleton.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { IPublicModelSkeletonItem } from '../model';
2-
import { IPublicTypeConfigTransducer, IPublicTypeDisposable, IPublicTypeSkeletonConfig } from '../type';
2+
import { IPublicTypeConfigTransducer, IPublicTypeDisposable, IPublicTypeSkeletonConfig, IPublicTypeWidgetConfigArea } from '../type';
33

44
export interface IPublicApiSkeleton {
55

@@ -20,6 +20,12 @@ export interface IPublicApiSkeleton {
2020
*/
2121
remove(config: IPublicTypeSkeletonConfig): number | undefined;
2222

23+
/**
24+
* 获取某个区域下的所有面板实例
25+
* @param areaName IPublicTypeWidgetConfigArea
26+
*/
27+
getAreaItems(areaName: IPublicTypeWidgetConfigArea): IPublicModelSkeletonItem[] | undefined;
28+
2329
/**
2430
* 获取面板实例
2531
* @param name 面板名称

0 commit comments

Comments
 (0)