github/lowcode-engine
1
0
Fork 0
mirror of https://github.com/alibaba/lowcode-engine.git synced 2025-12-11 18:42:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add skeleton.getAreaItems docs

Browse Source
This commit is contained in:
liujuping 2023-12-18 19:16:42 +08:00 committed by 林熠
parent 594abc4e6c
commit 2bf3aa70a7
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/docs/api/skeleton.md
View File

@ -297,7 +297,24 @@ showArea(areaName: string): void;
hideArea(areaName: string): void; hideArea(areaName: string): void;
``` ```
### getAreaItems
获取某个区域下的所有面板实例
```typescript
/**
* 获取某个区域下的所有面板实例
* @param areaName IPublicTypeWidgetConfigArea
*/
getAreaItems(areaName: IPublicTypeWidgetConfigArea): IPublicModelSkeletonItem[] | undefined;
```
相关类型：[IPublicModelSkeletonItem](https://github.com/alibaba/lowcode-engine/blob/main/packages/shell/src/model/skeleton-item.ts)
### registerConfigTransducer ### registerConfigTransducer
注册一个面板的配置转换器（transducer）。 注册一个面板的配置转换器（transducer）。
```typescript ```typescript

8
packages/types/src/shell/api/skeleton.ts
View File

@ -1,5 +1,5 @@
import { IPublicModelSkeletonItem } from '../model'; import { IPublicModelSkeletonItem } from '../model';
import { IPublicTypeConfigTransducer, IPublicTypeDisposable, IPublicTypeSkeletonConfig } from '../type'; import { IPublicTypeConfigTransducer, IPublicTypeDisposable, IPublicTypeSkeletonConfig, IPublicTypeWidgetConfigArea } from '../type';
export interface IPublicApiSkeleton { export interface IPublicApiSkeleton {
@ -20,6 +20,12 @@ export interface IPublicApiSkeleton {
*/ */
remove(config: IPublicTypeSkeletonConfig): number | undefined; remove(config: IPublicTypeSkeletonConfig): number | undefined;
/**
* 获取某个区域下的所有面板实例
* @param areaName IPublicTypeWidgetConfigArea
*/
getAreaItems(areaName: IPublicTypeWidgetConfigArea): IPublicModelSkeletonItem[] | undefined;
/** /**
* 获取面板实例 * 获取面板实例
* @param name 面板名称 * @param name 面板名称