@splunk/react-ui 5.1.0 → 5.3.0

package/types/src/TextArea/docs/examples/Inline.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Inline
+ * @description Passing inline will create an inline element and the input will be its default size.
+ */
 declare const Inline: () => React.JSX.Element;
 export default Inline;

package/types/src/TextArea/docs/examples/Uncontrolled.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Uncontrolled
+ * @description Alternatively, Text Area can be uncontrolled and optionally provided a defaultValue. The onChange callback still fires. The value prop cannot be set or updated externally.
+ */
 declare function Uncontrolled(): React.JSX.Element;
 export default Uncontrolled;

package/types/src/Tooltip/Tooltip.d.ts

@@ -94,6 +94,15 @@ interface TooltipPropsBase {
      * The onRequestClose and onRequestOpen callbacks are usually used.
      */
     open?: boolean;
+    /**
+     * Allows the `Tooltip` to point to and align with a different part of the anchor.
+     *
+     * This prop is forwarded to Popover. See `Popover`'s `pointTo` prop for more information.
+     */
+    pointTo?: {
+        x: number;
+        y: number;
+    };
     /** @private Generally passed by parent component rather than added directly. */
     prepend?: boolean;
     /**
@@ -122,7 +131,7 @@ type TooltipProps = ComponentProps<TooltipPropsBase, 'span'>;
  * The Tooltip component wraps arbitrary content to be displayed when the target element is hovered
  * or focused.
  */
-declare function Tooltip({ appearance, append, children, closeDelay, closeWhen, content, contentRelationship, defaultPlacement, elementRef, inline, onRequestClose, onRequestOpen, open: openProp, openDelay, renderAnchor, prepend, ...otherProps }: TooltipProps): React.JSX.Element;
+declare function Tooltip({ appearance, append, children, closeDelay, closeWhen, content, contentRelationship, defaultPlacement, elementRef, inline, onRequestClose, onRequestOpen, open: openProp, openDelay, renderAnchor, pointTo, prepend, ...otherProps }: TooltipProps): React.JSX.Element;
 declare namespace Tooltip {
     var propTypes: {
         /** @private */
@@ -142,6 +151,10 @@ declare namespace Tooltip {
         onRequestOpen: PropTypes.Requireable<(...args: any[]) => any>;
         open: PropTypes.Requireable<boolean>;
         openDelay: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+        pointTo: PropTypes.Requireable<PropTypes.InferProps<{
+            x: PropTypes.Requireable<number>;
+            y: PropTypes.Requireable<number>;
+        }>>;
         /** @private */
         prepend: PropTypes.Requireable<boolean>;
         renderAnchor: PropTypes.Requireable<(...args: any[]) => any>;

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

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Basic
+ * @description Add additional description to a form control.
+ */
 declare function Basic(): React.JSX.Element;
 export default Basic;

package/types/src/Tooltip/docs/examples/ContentRelationship.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Content relationship
+ * @description Set contentRelationship="label" for icon-only buttons.
+ */
 declare function ContentRelationship(): React.JSX.Element;
 export default ContentRelationship;

package/types/src/Tooltip/docs/examples/Controlled.d.ts

@@ -1,5 +1,9 @@
 import React, { Component } from 'react';
 import { TooltipRequestCloseHandler, TooltipRequestOpenHandler } from '@splunk/react-ui/Tooltip';
+/**
+ * @name Controlled
+ * @description Tooltips can also be controlled for more complex use cases.
+ */
 declare class Controlled extends Component<object, {
     open: boolean;
     reason: string;

package/types/src/Tooltip/docs/examples/CustomDelay.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Custom delay
+ * @description Open and close delays can be configured separately. Default delay values differ across themes.
+ */
 declare function CustomDelay(): React.JSX.Element;
 export default CustomDelay;

package/types/src/Tooltip/docs/examples/CustomProps.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Custom props
+ * @description Use the renderAnchor prop to customize rendering of the anchor element. Make sure that anchor element get assigned the onBlur, onFocus, onClick listeners, the describedBy or labelledBy string props and the elementRef.
+ */
 declare function CustomProps(): React.JSX.Element;
 export default CustomProps;

package/types/src/Tooltip/docs/examples/Toggletip.d.ts

@@ -1,3 +1,7 @@
 import React from 'react';
+/**
+ * @name Toggletip
+ * @description Tooltip defaults to showing an info button as an anchor to explain the surrounding context. For accessibility, please consider other ways of conveying this information before you decide to use the toggletip.
+ */
 declare function Toggletip(): React.JSX.Element;
 export default Toggletip;

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

@@ -8,7 +8,9 @@ interface TreeItemPropsBase {
     children?: React.ReactNode;
     /** Content to show on the `Tree.Item`. */
     content?: React.ReactNode;
-    /** Custom indent to show before `Tree.Item` content. */
+    /**
+     * @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.
@@ -23,7 +25,6 @@ interface TreeItemPropsBase {
     endAdornment?: React.ReactNode;
     /** Expansion state of the `Tree.Item`. */
     expanded?: boolean;
-    labelledBy?: string;
     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. */
@@ -42,7 +43,7 @@ type TreeItemToggleExpansionHandler = (event: React.KeyboardEvent<HTMLLIElement>
 type TreeItemToggleSelectionHandler = (event: React.KeyboardEvent<HTMLLIElement> | React.MouseEvent<HTMLSpanElement>, data?: {
     treeItemId?: string;
 }) => void;
-declare function Item({ id, children, content, customIndent, elementRef, endAdornment, expanded, labelledBy, onFocus, onKeyDown, onToggleExpansion, onToggleSelection, ...otherProps }: TreeItemProps): React.JSX.Element;
+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>;
@@ -52,7 +53,6 @@ declare namespace Item {
         elementRef: PropTypes.Requireable<object>;
         endAdornment: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         expanded: PropTypes.Requireable<boolean>;
-        labelledBy: PropTypes.Requireable<string>;
         onFocus: PropTypes.Requireable<(...args: any[]) => any>;
         onKeyDown: PropTypes.Requireable<(...args: any[]) => any>;
         onToggleSelection: PropTypes.Requireable<(...args: any[]) => any>;

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/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/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/NonInteractiveCheckbox.js

@@ -1,101 +0,0 @@
-/******/ (() => {
-    // webpackBootstrap
-    /******/ "use strict";
-    /******/ // The require scope
-    /******/    var e = {};
-    /******/
-    /************************************************************************/
-    /******/ /* webpack/runtime/compat get default export */
-    /******/    (() => {
-        /******/ // getDefaultExport function for compatibility with non-harmony modules
-        /******/ e.n = r => {
-            /******/ var t = r && r.__esModule ? 
-            /******/ () => r["default"]
-            /******/ : () => r
-            /******/;
-            e.d(t, {
-                a: t
-            });
-            /******/            return t;
-            /******/        };
-        /******/    })();
-    /******/
-    /******/ /* webpack/runtime/define property getters */
-    /******/    (() => {
-        /******/ // define getter functions for harmony exports
-        /******/ e.d = (r, t) => {
-            /******/ for (var o in t) {
-                /******/ if (e.o(t, o) && !e.o(r, o)) {
-                    /******/ Object.defineProperty(r, o, {
-                        enumerable: true,
-                        get: t[o]
-                    });
-                    /******/                }
-                /******/            }
-            /******/        };
-        /******/    })();
-    /******/
-    /******/ /* webpack/runtime/hasOwnProperty shorthand */
-    /******/    (() => {
-        /******/ e.o = (e, r) => Object.prototype.hasOwnProperty.call(e, r)
-        /******/;
-    })();
-    /******/
-    /******/ /* webpack/runtime/make namespace object */
-    /******/    (() => {
-        /******/ // define __esModule on exports
-        /******/ e.r = e => {
-            /******/ if (typeof Symbol !== "undefined" && Symbol.toStringTag) {
-                /******/ Object.defineProperty(e, Symbol.toStringTag, {
-                    value: "Module"
-                });
-                /******/            }
-            /******/            Object.defineProperty(e, "__esModule", {
-                value: true
-            });
-            /******/        };
-        /******/    })();
-    /******/
-    /************************************************************************/    var r = {};
-    // ESM COMPAT FLAG
-        e.r(r);
-    // EXPORTS
-        e.d(r, {
-        default: () => /* reexport */ i
-    });
-    // CONCATENATED MODULE: external "react"
-    const t = require("react");
-    var o =  e.n(t);
-    // CONCATENATED MODULE: external "prop-types"
-    const a = require("prop-types");
-    var n =  e.n(a);
-    // CONCATENATED MODULE: external "@splunk/react-ui/Switch"
-    const l = require("@splunk/react-ui/Switch");
-    var c =  e.n(l);
-    // CONCATENATED MODULE: ./src/NonInteractiveCheckbox/NonInteractiveCheckbox.tsx
-    var s = {
-        disabled: n().bool,
-        selected: n().oneOfType([ n().bool, n().oneOf([ "some" ]) ])
-    };
-    /**
- * NonInteractiveCheckbox is a private component that replaced our internal usage of Switch's interactive={false}
- * for components like Menu.Item, Table.Toggle, etc. (SUI-6757)
- *
- */    var d = function e(r) {
-        var t = r.className, a = r.disabled, n = r.selected;
-        
-        return o().createElement(c(), {
-            appearance: "checkbox",
-            className: t,
-            "data-test": "non-interactive-checkbox",
-            disabled: a,
-            role: "presentation",
-            selected: n,
-            tabIndex: -1
-        });
-    };
-    d.propTypes = s;
-    /* harmony default export */    const i = d;
-    // CONCATENATED MODULE: ./src/NonInteractiveCheckbox/index.ts
-    module.exports = r;
-    /******/})();

package/types/src/CollapsiblePanel/icons/ExpandPanel.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-type ExpandPanelIconProps = {
-    className?: string;
-};
-declare const ExpandPanelIcon: {
-    ({ className }: ExpandPanelIconProps): React.JSX.Element;
-    propTypes: {
-        className: PropTypes.Requireable<string>;
-    };
-};
-export default ExpandPanelIcon;

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/NonInteractiveCheckbox/NonInteractiveCheckbox.d.ts

@@ -1,22 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { ComponentProps } from '../utils/types';
-interface NonInteractiveCheckboxPropsBase {
-    disabled?: boolean;
-    selected?: boolean | 'some';
-}
-type NonInteractiveCheckboxProps = ComponentProps<NonInteractiveCheckboxPropsBase, 'div'>;
-/**
- * NonInteractiveCheckbox is a private component that replaced our internal usage of Switch's interactive={false}
- * for components like Menu.Item, Table.Toggle, etc. (SUI-6757)
- *
- */
-declare const NonInteractiveCheckbox: {
-    ({ className, disabled, selected }: NonInteractiveCheckboxProps): React.JSX.Element;
-    propTypes: {
-        disabled: PropTypes.Requireable<boolean>;
-        selected: PropTypes.Requireable<NonNullable<string | boolean | null | undefined>>;
-    };
-};
-export default NonInteractiveCheckbox;
-export { NonInteractiveCheckboxPropsBase };

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

@@ -1 +0,0 @@
-export { default } from './NonInteractiveCheckbox';

package/types/src/Switch/docs/examples/Error.d.ts

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

package/types/src/Text/IconOutlinedHide.d.ts

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

package/types/src/Text/IconOutlinedView.d.ts

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