@instructure/ui-tree-browser 8.14.1-snapshot.46 → 8.14.1-snapshot.63

package/types/TreeBrowser/props.d.ts

@@ -1,34 +1,131 @@
-/// <reference types="react" />
 import type { PropValidators, TreeBrowserTheme } from '@instructure/shared-types';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
+import React, { ReactElement } from 'react';
+import type { TreeBrowserButtonProps } from './TreeButton/props';
 declare type TreeBrowserOwnProps = {
-    collections: any;
-    items: any;
+    /**
+     * a normalized hash of collections, keyed by id, that contains an
+     * :id, :name, :items (an array of item ids), :collections (an array of
+     * collection ids), optional :descriptor text, optional :containerRef function,
+     * an optional :renderBeforeItems TreeNode, and an optional :renderAfterItems TreeNode.
+     * Each collection must have a unique id.
+     */
+    collections: Record<number | string, Collection>;
+    /**
+     * a hash of items, keyed by id, that contain an :id, :name,
+     * optional :descriptor text, and optional :thumbnail url
+     */
+    items: Record<number, CollectionItem>;
+    /**
+     * specifies the id of the root level collection, if present.
+     * if no root is specified, all collections will be rendered
+     * at the top level
+     **/
     rootId?: string | number;
-    expanded?: any;
+    /**
+     * an array of expanded collection ids, must be accompanied by an 'onCollectionToggle' prop
+     */
+    expanded?: (string | number | undefined)[];
+    /**
+     * an array of collection ids to expand by default
+     */
     defaultExpanded?: (string | number)[];
+    /**
+     * There are 2 types of tree selection:  single and multi.
+     * This is set up to allow for "multi" in the future without having to deprecate the old API.
+     */
     selectionType?: 'none' | 'single';
-    size?: 'small' | 'medium' | 'large';
-    variant?: 'folderTree' | 'indent';
-    collectionIcon?: React.ReactNode | ((...args: any[]) => any);
-    collectionIconExpanded?: React.ReactNode | ((...args: any[]) => any);
-    itemIcon?: React.ReactNode | ((...args: any[]) => any);
-    getItemProps?: (...args: any[]) => any;
-    getCollectionProps?: (...args: any[]) => any;
+    onCollectionToggle?: (collection: CollectionData) => void;
+    onItemClick?: (data: CollectionData) => void;
+    /**
+     * Whether or not to show the root collection specified in rootId prop or
+     * to begin with its immediate subcollections and items instead
+     */
     showRootCollection?: boolean;
-    onCollectionClick?: (...args: any[]) => any;
-    onCollectionToggle?: (...args: any[]) => any;
-    onItemClick?: (...args: any[]) => any;
+    /**
+     * An optional label to assist visually impaired users
+     */
     treeLabel?: string;
-    renderContent?: (...args: any[]) => any;
+    /**
+     * An optional compare function to specify order of the collections and the items
+     */
     sortOrder?: (obj1: any, obj2: any) => number;
+} & TreeBrowserBaseProps;
+declare type TreeBrowserBaseProps = {
+    /**
+     * A function called with each item's props as an argument. The return value of this function is a
+     * props object which will be passed to the item when it is rendered. This is useful for situations where
+     * you need to render the item differently depending on it's props. For example, if you would like to
+     * display a different icon for items with a certain name.
+     */
+    getItemProps?: (props: Record<string, any>) => Record<string, any>;
+    /**
+     * A function called with each collection's props as an argument. The return value of this function is a
+     * props object which will be passed to the collection when it is rendered. This is useful for situations where
+     * you need to render the collection differently depending on it's props. For example, if you would like to
+     * display a different icon for collections with a certain name.
+     */
+    getCollectionProps?: (props: Record<string, any>) => TreeBrowserButtonProps;
+    onCollectionClick?: (e: React.MouseEvent, data: CollectionData) => void;
+} & TreeBrowserCommonProps;
+declare type TreeBrowserCommonProps = {
+    size?: 'small' | 'medium' | 'large';
+    variant?: 'folderTree' | 'indent';
+    collectionIcon?: React.ReactNode | ((props: unknown) => React.ReactNode);
+    collectionIconExpanded?: React.ReactNode | ((props: unknown) => React.ReactNode);
+    itemIcon?: React.ReactNode | ((props: unknown) => React.ReactNode);
+    renderContent?: (props: TreeBrowserButtonProps) => JSX.Element;
 };
 declare type PropKeys = keyof TreeBrowserOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
 declare type TreeBrowserProps = TreeBrowserOwnProps & WithStyleProps<TreeBrowserTheme, TreeBrowserStyle>;
 declare type TreeBrowserStyle = ComponentStyle<'treeBrowser'>;
+declare type CollectionBase = {
+    id: number | string;
+    name: string;
+    descriptor?: string;
+    /**
+     * A function that returns a reference to the underlying HTML container
+     * @param el The DOM HTMLElement
+     */
+    containerRef?: (el: HTMLElement | null) => void;
+    /**
+     * children of type TreeNode
+     */
+    renderBeforeItems?: ReactElement;
+    /**
+     * children of type TreeNode
+     */
+    renderAfterItems?: ReactElement;
+};
+declare type Collection = CollectionBase & {
+    items?: number[];
+    collections?: (number | string)[];
+};
+declare type CollectionItem = {
+    id: number | string;
+    name: string;
+    descriptor?: string;
+    thumbnail?: string;
+    [key: string]: unknown;
+};
+declare type CollectionProps = {
+    collections?: CollectionProps[];
+    items?: CollectionItem[];
+    expanded?: boolean;
+    isCollectionFlattened?: boolean;
+} & CollectionBase;
+declare type CollectionData = {
+    id?: number | string;
+    expanded?: boolean;
+    type: 'child' | 'collection' | 'item';
+};
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { TreeBrowserProps, TreeBrowserStyle };
+declare type TreeBrowserState = {
+    selection: string;
+    expanded?: (string | number | undefined)[];
+};
+export type { TreeBrowserProps, TreeBrowserState, TreeBrowserStyle, CollectionData, Collection, CollectionItem, CollectionProps, TreeBrowserBaseProps, TreeBrowserCommonProps };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

package/types/TreeBrowser/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/TreeBrowser/props.ts"],"names":[],"mappings":";AA4BA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EACjB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,mBAAmB,GAAG;IACzB,WAAW,EAAE,GAAG,CAAA;IAChB,KAAK,EAAE,GAAG,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,eAAe,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IACrC,aAAa,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IACjC,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,OAAO,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAA;IACjC,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAC5D,sBAAsB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACpE,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACtD,YAAY,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACtC,kBAAkB,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC5C,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,iBAAiB,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC3C,kBAAkB,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC5C,WAAW,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACvC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,MAAM,CAAA;CAC7C,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,mBAAmB,CAAA;AAEzC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAIhD,aAAK,gBAAgB,GAAG,mBAAmB,GACzC,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;AAEpD,aAAK,gBAAgB,GAAG,cAAc,CAAC,aAAa,CAAC,CAAA;AAErD,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA0EvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAqBnB,CAAA;AAED,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/TreeBrowser/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EACjB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAEhE,aAAK,mBAAmB,GAAG;IACzB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,UAAU,CAAC,CAAA;IAChD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IACrC;;;;QAII;IACJ,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE,CAAA;IAC1C;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IACrC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IACjC,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAAE,cAAc,KAAK,IAAI,CAAA;IACzD,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAA;IAC5C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,MAAM,CAAA;CAC7C,GAAG,oBAAoB,CAAA;AAGxB,aAAK,oBAAoB,GAAG;IAC1B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClE;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,sBAAsB,CAAA;IAC3E,iBAAiB,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,cAAc,KAAK,IAAI,CAAA;CACxE,GAAG,sBAAsB,CAAA;AAG1B,aAAK,sBAAsB,GAAG;IAC5B,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,OAAO,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAA;IACjC,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IACxE,sBAAsB,CAAC,EACnB,KAAK,CAAC,SAAS,GACf,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IACzC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAClE,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,GAAG,CAAC,OAAO,CAAA;CAC/D,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,mBAAmB,CAAA;AAEzC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAIhD,aAAK,gBAAgB,GAAG,mBAAmB,GACzC,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;AAEpD,aAAK,gBAAgB,GAAG,cAAc,CAAC,aAAa,CAAC,CAAA;AAErD,aAAK,cAAc,GAAG;IACpB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAA;IAC/C;;OAEG;IACH,iBAAiB,CAAC,EAAE,YAAY,CAAA;IAChC;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAA;CAChC,CAAA;AAED,aAAK,UAAU,GAAG,cAAc,GAAG;IACjC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,WAAW,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CAClC,CAAA;AAED,aAAK,cAAc,GAAG;IACpB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB,CAAA;AAED,aAAK,eAAe,GAAG;IACrB,WAAW,CAAC,EAAE,eAAe,EAAE,CAAA;IAC/B,KAAK,CAAC,EAAE,cAAc,EAAE,CAAA;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,GAAG,cAAc,CAAA;AAElB,aAAK,cAAc,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,EAAE,OAAO,GAAG,YAAY,GAAG,MAAM,CAAA;CACtC,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA4BvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAqBnB,CAAA;AAED,aAAK,gBAAgB,GAAG;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE,CAAA;CAC3C,CAAA;AAED,YAAY,EACV,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,sBAAsB,EACvB,CAAA;AACD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}