fix(overlay-menu): missing nested items property (#982)

* fix(overlay-menu): missing nested items property Co-authored-by: wattachai <117723407+wattachai-lseg@users.noreply.github.com> --------- Co-authored-by: Theeraphat-Sorasetsakul <86758473+Theeraphat-Sorasetsakul@users.noreply.github.com>
Refinitiv · Oct 9, 2023 · bac94cb · bac94cb
1 parent e06ba68
commit bac94cb
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 2 deletions.
diff --git a/documents/src/pages/utils/data-management.md b/documents/src/pages/utils/data-management.md
@@ -20,8 +20,10 @@ interface CollectionItem {
   /**
    * Child items collection.
    * Used for nested data structures.
+   * Override this property in sub interfaces with their own type to ensure nested type checking.
+   * For example, `MyCollectionItem extends CollectionItem { items?: MyCollectionItem[]; }`
    */
-  items?: this[];
+  items?: CollectionItem[];
 }
 ```
 
@@ -74,6 +76,11 @@ interface DataItem extends CollectionItem {
    * item from being interacted with.
    */
   disabled?: boolean;
+
+  /**
+   * Used for nested DataItem.
+   */
+  items?: DataItem[];
 }
 ```
 

diff --git a/packages/elements/src/item/helpers/types.ts b/packages/elements/src/item/helpers/types.ts
@@ -7,6 +7,10 @@ interface CommonItem extends DataItem {
    * Type of item. Value can be `text`, `header`, `divider`
    */
   type?: ItemType;
+  /**
+   * Used for nested ItemData.
+   */
+  items?: ItemData[];
 }
 
 interface CommonLabelItem extends CommonItem {

diff --git a/packages/elements/src/tree/helpers/types.ts b/packages/elements/src/tree/helpers/types.ts
@@ -18,6 +18,11 @@ export interface TreeDataItem extends DataItem {
    * If `true`, child items will be visible
    */
   expanded?: boolean;
+
+  /**
+   * Used for nested TreeDataItem.
+   */
+  items?: TreeDataItem[];
 }
 
 /**

diff --git a/packages/utils/src/collection/collection-item.ts b/packages/utils/src/collection/collection-item.ts
@@ -12,6 +12,8 @@ export interface CollectionItem {
   /**
    * Child items collection.
    * Used for nested data structures.
+   * Override this property in sub interfaces with their own type to ensure nested type checking.
+   * For example, `MyCollectionItem extends CollectionItem { items?: MyCollectionItem[]; }`
    */
-  items?: this[];
+  items?: CollectionItem[];
 }
diff --git a/packages/utils/src/collection/data-item.ts b/packages/utils/src/collection/data-item.ts
@@ -48,4 +48,9 @@ export interface DataItem extends CollectionItem {
    * item from being interacted with.
    */
   disabled?: boolean;
+
+  /**
+   * Used for nested DataItem.
+   */
+  items?: DataItem[];
 }