@amboss/design-system 2.3.12 → 2.3.13

package/build/cjs/components/EntityTree/BaseEntityTree.d.ts

@@ -7,13 +7,33 @@ export type TreeNodeWithUIState = TreeNode & {
 };
 type PartialEntityListItemProps = Pick<EntityListItemProps, "hideBorder" | "size" | "renderRight">;
 export type EntityTreeProps = {
+    /**
+     * TreeNode
+     * @param id - **Unique** identifier for the node
+     * @param label - Node label
+     * @param description - Optional node description
+     * @param children - Node children, TreeNode[]
+     */
     data: TreeNode[];
+    /** Current selected node ids. If provided, the EntityTree becomes a selectable variant */
     selectedIds?: NodeID[];
+    /** Callback function to handle selection change
+     * @param ids - Updated selected node ids
+     */
     onSelectionChange?: (ids: NodeID[]) => void;
+    /** Expanded node ids */
     expandedIds?: NodeID[];
+    /** Callback function to handle node expand/collapse
+     * @param ids - Updated expanded node ids
+     */
     onToggle?: (ids: NodeID[]) => void;
+    /** If provided, the filter function is used to filter the tree. */
     filterFn?: (node: TreeNode) => boolean;
+    /** Callback function to handle tree change
+     * @param data - Updated tree data
+     */
     onTreeChange?: (data: TreeNodeWithUIState[]) => void;
+    /** Show items count or not */
     showItemsCount?: boolean;
     "data-e2e-test-id"?: string;
 } & PartialEntityListItemProps;

package/build/cjs/shared/useKeyboard.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"useKeyboard",{enumerable:!0,get:function(){return useKeyboard}});const _react=require("react"),_useDocument=require("./useDocument");function useKeyboard(config,ref,isActive){let document=(0,_useDocument.useDocument)(),handleKeyboard=event=>{if(!isActive||document.activeElement!==ref.current&&!ref.current.contains(document.activeElement))return;let targetConfigKey=Object.keys(config).find(targetKeys=>targetKeys.split(" ").includes(event.code));targetConfigKey&&(event.preventDefault(),!1===config[targetConfigKey](event)&&event.stopPropagation())};(0,_react.useEffect)(()=>(document.addEventListener("keydown",handleKeyboard),()=>{document.removeEventListener("keydown",handleKeyboard)}))}
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"useKeyboard",{enumerable:!0,get:function(){return useKeyboard}});const _react=require("react"),_useDocument=require("./useDocument");function useKeyboard(config,ref,isActive){let document=(0,_useDocument.useDocument)(),handleKeyboard=event=>{if(!isActive||document.activeElement!==ref.current&&!ref.current?.contains(document.activeElement))return;let targetConfigKey=Object.keys(config).find(targetKeys=>targetKeys.split(" ").includes(event.code));targetConfigKey&&(event.preventDefault(),!1===config[targetConfigKey](event)&&event.stopPropagation())};(0,_react.useEffect)(()=>(document.addEventListener("keydown",handleKeyboard),()=>{document.removeEventListener("keydown",handleKeyboard)}))}

package/build/esm/components/EntityTree/BaseEntityTree.d.ts

@@ -7,13 +7,33 @@ export type TreeNodeWithUIState = TreeNode & {
 };
 type PartialEntityListItemProps = Pick<EntityListItemProps, "hideBorder" | "size" | "renderRight">;
 export type EntityTreeProps = {
+    /**
+     * TreeNode
+     * @param id - **Unique** identifier for the node
+     * @param label - Node label
+     * @param description - Optional node description
+     * @param children - Node children, TreeNode[]
+     */
     data: TreeNode[];
+    /** Current selected node ids. If provided, the EntityTree becomes a selectable variant */
     selectedIds?: NodeID[];
+    /** Callback function to handle selection change
+     * @param ids - Updated selected node ids
+     */
     onSelectionChange?: (ids: NodeID[]) => void;
+    /** Expanded node ids */
     expandedIds?: NodeID[];
+    /** Callback function to handle node expand/collapse
+     * @param ids - Updated expanded node ids
+     */
     onToggle?: (ids: NodeID[]) => void;
+    /** If provided, the filter function is used to filter the tree. */
     filterFn?: (node: TreeNode) => boolean;
+    /** Callback function to handle tree change
+     * @param data - Updated tree data
+     */
     onTreeChange?: (data: TreeNodeWithUIState[]) => void;
+    /** Show items count or not */
     showItemsCount?: boolean;
     "data-e2e-test-id"?: string;
 } & PartialEntityListItemProps;

package/build/esm/shared/useKeyboard.js

@@ -1 +1 @@
-import{useEffect}from"react";import{useDocument}from"./useDocument";export function useKeyboard(config,ref,isActive){let document=useDocument(),handleKeyboard=event=>{if(!isActive||document.activeElement!==ref.current&&!ref.current.contains(document.activeElement))return;let targetConfigKey=Object.keys(config).find(targetKeys=>targetKeys.split(" ").includes(event.code));targetConfigKey&&(event.preventDefault(),!1===config[targetConfigKey](event)&&event.stopPropagation())};useEffect(()=>(document.addEventListener("keydown",handleKeyboard),()=>{document.removeEventListener("keydown",handleKeyboard)}))}
+import{useEffect}from"react";import{useDocument}from"./useDocument";export function useKeyboard(config,ref,isActive){let document=useDocument(),handleKeyboard=event=>{if(!isActive||document.activeElement!==ref.current&&!ref.current?.contains(document.activeElement))return;let targetConfigKey=Object.keys(config).find(targetKeys=>targetKeys.split(" ").includes(event.code));targetConfigKey&&(event.preventDefault(),!1===config[targetConfigKey](event)&&event.stopPropagation())};useEffect(()=>(document.addEventListener("keydown",handleKeyboard),()=>{document.removeEventListener("keydown",handleKeyboard)}))}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amboss/design-system",
-  "version": "2.3.12",
+  "version": "2.3.13",
   "description": "the design system for AMBOSS products",
   "author": "AMBOSS",
   "license": "ISC",
@@ -113,6 +113,7 @@
   ],
   "dependencies": {
     "@swc/helpers": "^0.5.3",
+    "@testing-library/react-hooks": "^8.0.1",
     "focus-trap-react": "^10.2.3",
     "imask": "^7.4.0",
     "react-is": "^17.0.1",