docs: add skeleton.getAreaItems docs

alibaba · Dec 18, 2023 · 6e45bc1 · 6e45bc1
1 parent 594abc4
commit 6e45bc1
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/docs/docs/api/skeleton.md b/docs/docs/api/skeleton.md
@@ -297,7 +297,24 @@ showArea(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
+
 注册一个面板的配置转换器（transducer）。
 
 ```typescript

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