@splunk/react-ui 5.1.0 → 5.2.0

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/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;