@splunk/react-ui 5.0.0 → 5.2.0

package/types/src/TransitionOpen/docs/examples/ExpandHeight.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Expand height
+ */
 declare function ExpandHeight(): React.JSX.Element;
 export default ExpandHeight;

package/types/src/TransitionOpen/docs/examples/ExpandWidth.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Expand width
+ */
 declare function ExpandWidth(): React.JSX.Element;
 export default ExpandWidth;

package/types/src/TransitionOpen/docs/examples/None.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name None
+ * @description Transition Open content appears with no animation.
+ */
 declare function None(): React.JSX.Element;
 export default None;

package/types/src/TransitionOpen/docs/examples/SlideFromBottom.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Slide from bottom
+ * @description Transition Open content sliding in from the bottom.
+ */
 declare function SlideFromBottom(): React.JSX.Element;
 export default SlideFromBottom;

package/types/src/TransitionOpen/docs/examples/SlideFromLeft.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Slide from left
+ * @description Transition Open content sliding in from the left.
+ */
 declare function SlideFromLeft(): React.JSX.Element;
 export default SlideFromLeft;

package/types/src/TransitionOpen/docs/examples/SlideFromRight.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Slide from right
+ * @description Transition Open content sliding in from the right.
+ */
 declare function SlideFromRight(): React.JSX.Element;
 export default SlideFromRight;

package/types/src/TransitionOpen/docs/examples/SlideFromTop.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Slide from top
+ * @description Transition Open content sliding in from the top.
+ */
 declare function SlideFromTop(): React.JSX.Element;
 export default SlideFromTop;

package/types/src/Tree/Item.d.ts

@@ -0,0 +1,63 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { ComponentProps } from '../utils/types';
+interface TreeItemPropsBase {
+    /** A unique `id` for this item and used by `Tree` to keep track of the focused item. */
+    id: string;
+    /** Should contain `Tree.Item`s, can also include other elements to display in between tree items. */
+    children?: React.ReactNode;
+    /** Content to show on the `Tree.Item`. */
+    content?: React.ReactNode;
+    /**
+     * @private Custom indent to show before `Tree.Item` content.
+     */
+    customIndent?: React.ReactNode;
+    /**
+     * A React ref which is set to the DOM element when the component mounts and null when it unmounts.
+     */
+    elementRef?: React.Ref<HTMLLIElement>;
+    /**
+     * @private Used only by JSONTree - artifact from before Tree was public.
+     * Conventional `endAdornment` in all other cases would instead be just done by including the desired element in `content`.
+     * Left in for JSONTree because the need to support the endAdornment conditionally going to the end of the unordered list of children in the expanded view.
+     * This is required in JSONTree to handle closing bracket/braces but does not have a known use case for other Tree uses.
+     */
+    endAdornment?: React.ReactNode;
+    /** Expansion state of the `Tree.Item`. */
+    expanded?: boolean;
+    onFocus?: React.FocusEventHandler<HTMLLIElement>;
+    onKeyDown?: React.KeyboardEventHandler<HTMLLIElement>;
+    /** Called on expansion state change of the `Tree.Item` and should be used to maintain `expanded`. For proper keyboard accessibility this is required when a `Tree.Item` has children. */
+    onToggleExpansion?: TreeItemToggleExpansionHandler;
+    /** Called on selection state change of the `Tree.Item` and can be used to maintain optional external `Tree.Item` selection state. */
+    onToggleSelection?: TreeItemToggleSelectionHandler;
+}
+type TreeItemProps = ComponentProps<TreeItemPropsBase, 'li'>;
+type TreeItemClickHandler = (event: React.MouseEvent<HTMLSpanElement>, id: string) => void;
+type TreeItemKeyDownHandler = (event: React.KeyboardEvent<HTMLLIElement>, id: string, isExpanded: boolean | undefined, childrenCleaned: React.ReactElement[] | undefined | null, handleToggleExpansion: TreeItemToggleExpansionHandler) => void;
+/** @public */
+type TreeItemToggleExpansionHandler = (event: React.KeyboardEvent<HTMLLIElement> | React.MouseEvent<HTMLSpanElement>, data?: {
+    treeItemId?: string;
+}) => void;
+/** @public */
+type TreeItemToggleSelectionHandler = (event: React.KeyboardEvent<HTMLLIElement> | React.MouseEvent<HTMLSpanElement>, data?: {
+    treeItemId?: string;
+}) => void;
+declare function Item({ id, children, content, customIndent, elementRef, endAdornment, expanded, onFocus, onKeyDown, onToggleExpansion, onToggleSelection, ...otherProps }: TreeItemProps): React.JSX.Element;
+declare namespace Item {
+    var propTypes: {
+        id: PropTypes.Requireable<string>;
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        content: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        customIndent: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        elementRef: PropTypes.Requireable<object>;
+        endAdornment: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        expanded: PropTypes.Requireable<boolean>;
+        onFocus: PropTypes.Requireable<(...args: any[]) => any>;
+        onKeyDown: PropTypes.Requireable<(...args: any[]) => any>;
+        onToggleSelection: PropTypes.Requireable<(...args: any[]) => any>;
+        onToggleExpansion: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+}
+export default Item;
+export { TreeItemClickHandler, TreeItemKeyDownHandler, TreeItemPropsBase, TreeItemToggleExpansionHandler, TreeItemToggleSelectionHandler, };

package/types/src/Tree/Tree.d.ts

@@ -1,24 +1,31 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import Item from './Item';
 import { ComponentProps } from '../utils/types';
-import TreeItem from './TreeItem';
 type RemoveNodeHandler = (id: string) => void;
 type SetNodeHandler = (id: string, path?: string) => void;
 interface TreePropsBase {
-    /** Should contain TreeItems, can also include other elements to display in between tree items. */
+    /** Should contain `Tree.Item`s, can also include other elements to display in between tree items. */
     children?: React.ReactNode;
     /** Removes default indent from list styles if set to false. */
     defaultIndent?: boolean;
+    /**
+     * A React ref which is set to the DOM element when the component mounts and null when it unmounts.
+     */
+    elementRef?: React.Ref<HTMLUListElement>;
 }
 type TreeProps = ComponentProps<TreePropsBase, 'ul'>;
-declare function Tree({ children, defaultIndent, ...otherProps }: TreeProps): React.JSX.Element;
+/**
+ * Used to present a hierarchical list.
+ */
+declare function Tree({ children, defaultIndent, elementRef, ...otherProps }: TreeProps): React.JSX.Element;
 declare namespace Tree {
     var propTypes: {
         children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         defaultIndent: PropTypes.Requireable<boolean>;
+        elementRef: PropTypes.Requireable<object>;
     };
-    var TreeItem: typeof import("./TreeItem").default;
+    var Item: typeof import("./Item").default;
 }
 export default Tree;
-export { TreeItem };
-export { RemoveNodeHandler, SetNodeHandler };
+export { RemoveNodeHandler, SetNodeHandler, Item };

package/types/src/Tree/TreeContext.d.ts

@@ -1,5 +1,5 @@
+import { TreeItemClickHandler, TreeItemKeyDownHandler } from './Item';
 import { RemoveNodeHandler, SetNodeHandler } from './Tree';
-import { TreeItemClickHandler, TreeItemKeyDownHandler } from './TreeItem';
 export interface TreeContext {
     defaultIndent?: boolean;
     onItemKeyDown?: TreeItemKeyDownHandler;

package/types/src/Tree/docs/examples/Basic.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+/**
+ * @name Basic
+ */
+export default function Basic(): React.JSX.Element;

package/types/src/Tree/docs/examples/ClickableExpansion.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export default function ClickableExpansion(): React.JSX.Element;

package/types/src/Tree/docs/examples/ClickableExpansionWithSelection.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export default function ClickableExpansionWithSelection(): React.JSX.Element;

package/types/src/Tree/index.d.ts

@@ -1,3 +1,3 @@
 export { default } from './Tree';
 export * from './Tree';
-export * from './TreeItem';
+export * from './Item';

package/types/src/Typography/docs/examples/Basic.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Basic
+ * @description Style text with a variant, font settings props, or both. Typography will default to the body variant if no other TypographyParams props are passed (an as prop is always required).
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/WaitSpinner/docs/examples/Basic.d.ts

@@ -1,3 +1,6 @@
 import React from 'react';
+/**
+ * @name Basic
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/useControlled/useControlled.d.ts

@@ -1,4 +1,6 @@
 import { MutableRefObject } from 'react';
+declare function isPrimitive(value: unknown): boolean;
+declare function isAllowedType(value: unknown): boolean;
 interface DefaultValueProps {
     componentProps: {
         [key: string]: any;
@@ -19,4 +21,4 @@ interface DefaultValueProps {
  */
 declare function useControlled({ componentProps, componentName, defaultValuePropName, valuePropName, }: DefaultValueProps): MutableRefObject<boolean>['current'];
 export default useControlled;
-export { DefaultValueProps };
+export { DefaultValueProps, isPrimitive, isAllowedType };

package/useControlled.js

@@ -19,9 +19,9 @@
     /******/ // The require function
     /******/    function t(o) {
         /******/ // Check if module is in cache
-        /******/ var a = r[o];
-        /******/        if (a !== undefined) {
-            /******/ return a.exports;
+        /******/ var n = r[o];
+        /******/        if (n !== undefined) {
+            /******/ return n.exports;
             /******/        }
         /******/ // Create a new module (and put it into the cache)
         /******/        var u = r[o] = {
@@ -96,14 +96,30 @@
         t.r(o);
         // EXPORTS
                 t.d(o, {
-            default: () => /* reexport */ n
+            default: () => /* reexport */ l,
+            isAllowedType: () => /* reexport */ f,
+            isPrimitive: () => /* reexport */ a
         });
         // EXTERNAL MODULE: external "react"
                 var e = t(9497);
+        // CONCATENATED MODULE: external "lodash/isEqual"
+        const r = require("lodash/isEqual");
         // EXTERNAL MODULE: external "lodash/has"
-                var r = t(5919);
-        var a =  t.n(r);
+                var n = t(5919);
+        var u =  t.n(n);
         // CONCATENATED MODULE: ./src/useControlled/useControlled.tsx
+        function a(e) {
+            return e === null || e === undefined || typeof e === "boolean" || typeof e === "string" || typeof e === "number";
+        }
+        function f(e) {
+            if (a(e)) {
+                return true;
+            }
+            if (Array.isArray(e)) {
+                return e.every(a);
+            }
+            return false;
+        }
         /**
  * This is a private component not intended for use outside @splunk/react-ui
  *
@@ -113,21 +129,21 @@
  * are not happening.
  *
  * Return the controlled state of the component.
- */
-        function u(r) {
-            var t = r.componentProps, o = r.componentName, u = o === void 0 ? "this component" : o, n = r.defaultValuePropName, f = n === void 0 ? "defaultValue" : n, i = r.valuePropName, l = i === void 0 ? "value" : i;
-            var s = (0, e.useRef)(a()(t, l));
+ */        function i(r) {
+            var t = r.componentProps, o = r.componentName, n = o === void 0 ? "this component" : o, a = r.defaultValuePropName, f = a === void 0 ? "defaultValue" : a, i = r.valuePropName, l = i === void 0 ? "value" : i;
+            var s = (0, e.useRef)(u()(t, l));
             var d = (0, e.useRef)(t[f]);
             (0, e.useEffect)((function() {
                 if (false) {}
-            }), [ u, t, f, l ]);
+            }), [ n, t, f, l ]);
             (0, e.useEffect)((function() {
                 if (false) {}
                 if (false) {}
-            }), [ u, t, f, l ]);
+                if (false) {}
+            }), [ n, t, f, l ]);
             return s.current;
         }
-        /* harmony default export */        const n = u;
+        /* harmony default export */        const l = i;
     }) // CONCATENATED MODULE: ./src/useControlled/index.ts
     ();
     module.exports = o;

package/useResizeObserver.js

@@ -151,7 +151,7 @@
                                     i === null || i === void 0 ? void 0 : i(o);
                                     return o;
                                 }
-                                return l;
+                                return e;
                             }));
                         }
                     }));
@@ -166,7 +166,7 @@
                 }
                 // Return a no-op function to satisfy consistent-return rule
                                 return function() {};
-            }), [ n ]);
+            }), [ i, n ]);
             return l;
         };
         /* harmony default export */        const c = f;

package/types/src/DefinitionList/docs/examples/Customize.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare function Customize(): React.JSX.Element;
-export default Customize;

package/types/src/Tree/TreeItem.d.ts

@@ -1,44 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { ComponentProps } from '../utils/types';
-interface TreeItemPropsBase {
-    /** A unique `id` for this item and used by `Tree` to keep track of the focused item. */
-    id: string;
-    /** Should contain `TreeItems`, can also include other elements to display in between tree items. */
-    children?: React.ReactNode;
-    /** Content to show on the TreeItem. */
-    content?: React.ReactNode;
-    /** Custom indent to show before TreeItem content. */
-    customIndent?: React.ReactNode;
-    endAdornment?: React.ReactNode;
-    labelledBy?: string;
-    onFocus?: React.FocusEventHandler<HTMLLIElement>;
-    onKeyDown?: React.KeyboardEventHandler<HTMLLIElement>;
-    onToggle?: TreeItemToggleHandler;
-    /** Default open state of the node. */
-    open?: boolean;
-    /** Toggle to pass that opens/closes the node on click. */
-    toggle?: React.ReactElement;
-}
-type TreeItemProps = ComponentProps<TreeItemPropsBase, 'li'>;
-type TreeItemClickHandler = (event: React.MouseEvent<HTMLSpanElement>, id: string) => void;
-type TreeItemKeyDownHandler = (event: React.KeyboardEvent<HTMLLIElement>, id: string, showChildren: boolean | undefined, childrenCleaned: React.ReactElement[] | undefined | null, handleToggle: TreeItemToggleHandler) => void;
-type TreeItemToggleHandler = (isOpen: boolean, event?: React.KeyboardEvent<HTMLLIElement> | React.MouseEvent<HTMLSpanElement>) => void;
-declare function TreeItem({ id, children, content, customIndent, endAdornment, labelledBy, onFocus, onKeyDown, onToggle, open, toggle, ...otherProps }: TreeItemProps): React.JSX.Element;
-declare namespace TreeItem {
-    var propTypes: {
-        id: PropTypes.Requireable<string>;
-        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        content: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        customIndent: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        endAdornment: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        labelledBy: PropTypes.Requireable<string>;
-        onFocus: PropTypes.Requireable<(...args: any[]) => any>;
-        onKeyDown: PropTypes.Requireable<(...args: any[]) => any>;
-        onToggle: PropTypes.Requireable<(...args: any[]) => any>;
-        open: PropTypes.Requireable<boolean>;
-        toggle: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-    };
-}
-export default TreeItem;
-export { TreeItemClickHandler, TreeItemKeyDownHandler, TreeItemPropsBase, TreeItemToggleHandler };