react-magma-dom 4.6.0 → 4.7.0-next.1

package/dist/components/TreeView/TreeItemContext.d.ts

@@ -6,9 +6,7 @@ interface TreeItemContextInterface {
     setExpanded: React.Dispatch<React.SetStateAction<boolean>>;
     checkedStatus: IndeterminateCheckboxStatus;
     checkboxChangeHandler: (event: React.ChangeEvent<HTMLInputElement>) => void;
-    numberOfTreeItemChildren: number;
     hasOwnTreeItems: boolean;
-    updateCheckedStatusFromChild: (index: number, status: IndeterminateCheckboxStatus) => void;
     parentDepth: number;
 }
 export declare const TreeItemContext: React.Context<TreeItemContextInterface>;

package/dist/components/TreeView/TreeView.stories.d.ts

@@ -20,6 +20,8 @@ export declare const Complex: {
             itemId: string;
             checkedStatus: IndeterminateCheckboxStatus;
         }[];
+        checkParents: boolean;
+        checkChildren: boolean;
         testId: string;
     };
 };

package/dist/components/TreeView/TreeViewContext.d.ts

@@ -1,10 +1,17 @@
 import * as React from 'react';
-import { TreeViewSelectable } from './useTreeView';
+import { TreeViewSelectable } from './types';
 import { IndeterminateCheckboxStatus } from '../IndeterminateCheckbox';
 export interface TreeItemSelectedInterface {
     itemId?: string;
     checkedStatus: IndeterminateCheckboxStatus;
 }
+export interface TreeViewItemInterface {
+    itemId?: string;
+    parentId?: string | null;
+    icon?: React.ReactNode;
+    checkedStatus: IndeterminateCheckboxStatus;
+    hasOwnTreeItems: boolean;
+}
 export interface TreeViewContextInterface {
     children?: React.ReactNode[];
     hasIcons: boolean;
@@ -12,19 +19,15 @@ export interface TreeViewContextInterface {
     initialExpandedItemsNeedUpdate: boolean;
     onExpandedChange?: (event: React.SyntheticEvent) => void;
     onSelectedItemChange?: (selectedItems: Array<TreeItemSelectedInterface>) => void;
-    preselectedItemsNeedUpdate: boolean;
     registerTreeItem: (itemRefArray: React.MutableRefObject<React.MutableRefObject<Element>[]>, itemRef: React.MutableRefObject<Element>) => void;
     selectable: TreeViewSelectable;
     selectedItems: Array<TreeItemSelectedInterface>;
-    selectedItemsChanged: boolean;
-    setHasIcons: React.Dispatch<React.SetStateAction<boolean>>;
     setInitialExpandedItemsNeedUpdate: React.Dispatch<React.SetStateAction<any>>;
-    setPreselectedItemsNeedUpdate: React.Dispatch<React.SetStateAction<any>>;
-    setSelectedItems: React.Dispatch<React.SetStateAction<any>>;
-    setSelectedItemsChanged: React.Dispatch<React.SetStateAction<any>>;
     treeItemRefArray?: React.MutableRefObject<React.MutableRefObject<Element>[]>;
     itemToFocus?: string;
     checkParents: boolean;
     checkChildren: boolean;
+    items: TreeViewItemInterface[];
+    selectItem: (data: Pick<TreeViewItemInterface, 'itemId' | 'checkedStatus'>) => void;
 }
 export declare const TreeViewContext: React.Context<TreeViewContextInterface>;

package/dist/components/TreeView/index.d.ts

@@ -3,3 +3,4 @@ export * from './TreeItem';
 export * from './useTreeItem';
 export * from './useTreeView';
 export * from './utils';
+export * from './types';

package/dist/components/TreeView/types.d.ts

@@ -0,0 +1,5 @@
+export declare enum TreeViewSelectable {
+    single = "single",
+    multi = "multi",
+    off = "off"
+}

package/dist/components/TreeView/useTreeItem.d.ts

@@ -28,14 +28,8 @@ export interface UseTreeItemProps extends React.HTMLAttributes<HTMLLIElement> {
      */
     icon?: React.ReactElement<IconProps>;
     /**
-     * Indeterminate Checkbox status
      * @internal
      */
-    parentCheckedStatus?: IndeterminateCheckboxStatus;
-    /**
-     * @internal
-     */
-    updateParentCheckStatus?: (index: number, status: IndeterminateCheckboxStatus, isInitialRender?: boolean) => void;
     /**
      * @internal
      */
@@ -69,16 +63,12 @@ export declare function useTreeItem(props: UseTreeItemProps, forwardedRef: any):
         hasOwnTreeItems: boolean;
         itemDepth: number;
         itemId: string;
-        numberOfTreeItemChildren: number;
-        parentCheckedStatus: IndeterminateCheckboxStatus;
         parentDepth: number;
         ref: (node: any) => void;
         selectedItems: import("./TreeViewContext").TreeItemSelectedInterface[];
         setExpanded: React.Dispatch<React.SetStateAction<boolean>>;
-        updateCheckedStatusFromChild: (index: number, status: IndeterminateCheckboxStatus, isInitialRender?: boolean) => void;
         treeItemChildren: (string | number | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any>) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal)[];
     };
     handleClick: (event: any, itemId: any) => void;
     handleKeyDown: (event: React.KeyboardEvent) => void;
 };
-export declare type UseTreeItemReturn = ReturnType<typeof useTreeItem>;

package/dist/components/TreeView/useTreeView.d.ts

@@ -1,9 +1,10 @@
 import * as React from 'react';
-import { TreeItemSelectedInterface } from './TreeViewContext';
-export declare enum TreeViewSelectable {
-    single = "single",
-    multi = "multi",
-    off = "off"
+import { TreeItemSelectedInterface, TreeViewItemInterface } from './TreeViewContext';
+import { TreeViewSelectable } from './types';
+export interface TreeViewApi {
+    selectItem({ itemId, checkedStatus }: Pick<TreeViewItemInterface, 'itemId' | 'checkedStatus'>): void;
+    selectAll(): void;
+    clearAll(): void;
 }
 export interface UseTreeViewProps {
     /**
@@ -63,28 +64,32 @@ export interface UseTreeViewProps {
      */
     checkChildren?: boolean;
     children?: React.ReactNode[];
+    /**
+     * The ref object that allows TreeView manipulation.
+     * Actions available:
+     * selectItem({ itemId, checkedStatus }: Pick<TreeViewItemInterface, 'itemId' | 'checkedStatus'>): void - action that allows to change item selection,
+     * selectAll(): void - action that allows to select all items,
+     * clearAll(): void - action that allows to unselect all items.
+     */
+    apiRef?: React.MutableRefObject<TreeViewApi>;
 }
 export declare function useTreeView(props: UseTreeViewProps): {
     contextValue: {
-        hasIcons: boolean;
+        hasIcons: any;
         itemToFocus: any;
         onSelectedItemChange: (selectedItems: TreeItemSelectedInterface[]) => void;
         onExpandedChange: (event: React.SyntheticEvent<Element, Event>) => void;
         selectable: TreeViewSelectable;
-        setHasIcons: React.Dispatch<React.SetStateAction<boolean>>;
-        selectedItems: TreeItemSelectedInterface[];
-        setSelectedItems: React.Dispatch<React.SetStateAction<TreeItemSelectedInterface[]>>;
+        selectedItems: any;
         initialExpandedItems: string[];
         treeItemRefArray: React.MutableRefObject<React.MutableRefObject<Element>[]>;
         registerTreeItem: (refArray: React.MutableRefObject<React.MutableRefObject<Element>[]>, ref: React.MutableRefObject<Element>) => void;
-        preselectedItemsNeedUpdate: boolean;
-        setPreselectedItemsNeedUpdate: React.Dispatch<React.SetStateAction<boolean>>;
         initialExpandedItemsNeedUpdate: boolean;
         setInitialExpandedItemsNeedUpdate: React.Dispatch<React.SetStateAction<boolean>>;
-        selectedItemsChanged: boolean;
-        setSelectedItemsChanged: React.Dispatch<React.SetStateAction<boolean>>;
         checkChildren: boolean;
         checkParents: boolean;
+        items: any;
+        selectItem: ({ itemId, checkedStatus }: Pick<TreeViewItemInterface, 'itemId' | 'checkedStatus'>) => void;
     };
 };
 export declare type UseTreeViewReturn = ReturnType<typeof useTreeView>;

package/dist/components/TreeView/utils.d.ts

@@ -1,5 +1,9 @@
 import { ThemeInterface } from '../../theme/magma';
-import { TreeViewSelectable } from './useTreeView';
+import { UseTreeViewProps } from './useTreeView';
+import { TreeViewSelectable } from './types';
+import React from 'react';
+import { IndeterminateCheckboxStatus } from '../IndeterminateCheckbox';
+import { TreeViewItemInterface } from './TreeViewContext';
 export declare enum TreeNodeType {
     branch = "branch",
     leaf = "leaf"
@@ -19,26 +23,28 @@ export declare enum TreeNodeType {
 export declare function calculateOffset(type: TreeNodeType, depth?: number, labelElem?: boolean, negative?: boolean): string;
 export declare function getTreeItemLabelColor(isInverse: boolean, disabled: boolean, theme: ThemeInterface): string;
 export declare function getTreeItemWrapperCursor(disabled: boolean, selectable: TreeViewSelectable, nodeType: TreeNodeType): "not-allowed" | "pointer" | "default";
-export declare function arrayIncludesId(itemsArray: any, itemId: any): any;
 export declare function getChildrenItemIds(children: any, status?: string): any[];
 export declare function getChildrenItemIdsFlat(children: any): any[];
 export declare function getChildrenItemIdsInTree(children: any): any[];
-export declare function getAllParentIds(childrenArr: any, itemId: any, parentItemIds?: any[]): any;
-export declare function findChildByItemId(children: any, itemId: any): any;
-export declare function getAllChildrenEnabled(children: any): boolean;
-export declare function filterSelectedItems(selectedItems: any, childrenIds: any, itemId: any): any;
-export declare function getMissingChildrenIds(selectedItems: any, childrenIds: any): any;
-export declare function getChildrenCheckedStatus(childrenIds: any, status: any): any;
-export declare function getEnabledTreeItemChildrenLength(treeItemChildren: any): any;
-export declare function getUpdatedSelectedItems(selectedItems: any, itemId: any, checkedStatus: any): any;
-export declare function getUniqueSelectedItemsArray(itemArr0: any, itemArr1: any, itemArr2: any): any[];
-export declare function findCommonItems(initialItemsArr: any, childrenItemsArr: any): any[];
-export declare function areArraysEqual(array1: any, array2: any): boolean;
-export declare function getCheckedStatus(itemId: any, selectedItems: any): any;
-export declare function findFirstBranchNode(children: any): any;
-export declare function getFirstItemInTree(arr: any, children: any): any;
 export declare function filterNullEntries(obj: any): {
     current: any;
 } | {
     current?: undefined;
 };
+export declare const getInitialItems: ({ children, preselectedItems: rawPreselectedItems, checkParents, selectable }: Pick<UseTreeViewProps, 'children' | 'preselectedItems' | 'checkParents' | 'selectable'>) => any;
+export declare const selectSingle: ({ items, itemId, checkedStatus }: {
+    items: TreeViewItemInterface[];
+    itemId: TreeViewItemInterface['itemId'];
+    checkedStatus: TreeViewItemInterface['checkedStatus'];
+}) => {
+    checkedStatus: IndeterminateCheckboxStatus;
+    itemId?: string;
+    parentId?: string;
+    icon?: React.ReactNode;
+    hasOwnTreeItems: boolean;
+}[];
+export declare const selectMulti: ({ items, itemId, checkedStatus, checkChildren, checkParents }: {
+    items: TreeViewItemInterface[];
+    itemId: TreeViewItemInterface['itemId'];
+    checkedStatus: TreeViewItemInterface['checkedStatus'];
+} & Pick<UseTreeViewProps, "checkParents" | "checkChildren">) => any;