@planningcenter/tapestry-react 4.14.0 → 4.14.1

package/dist/TokenInput/DefaultToken.d.ts

@@ -1,13 +1,21 @@
 import React, { ComponentProps, ReactNode } from 'react';
 import Badge from '../Badge';
 interface Props {
+    /** Props to pass to the Badge component. */
     keyboardControls?: ComponentProps<typeof Badge>;
+    /** Callback when "X" Icon is clicked */
     removeToken: (notUsed: false) => void;
+    /** Not used. */
     selectFirstToken?: () => void;
+    /** Not used. */
     selectLastToken?: () => void;
+    /** Not used. */
     selectNextToken?: () => void;
+    /** Not used. */
     selectPreviousToken?: () => void;
+    /** The token to render. */
     token?: ReactNode;
+    /** Not used */
     tokenIndex?: number;
 }
 type InheritedProps = Omit<ComponentProps<typeof Badge>, keyof Props>;

package/dist/TokenInput/DefaultToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DefaultToken.d.ts","sourceRoot":"","sources":["../../src/TokenInput/DefaultToken.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,cAAc,EAAqB,SAAS,EAAE,MAAM,OAAO,CAAA;AAE3E,OAAO,KAAK,MAAM,UAAU,CAAA;AAG5B,UAAU,KAAK;IAEb,gBAAgB,CAAC,EAAE,cAAc,CAAC,OAAO,KAAK,CAAC,CAAA;IAG/C,WAAW,EAAE,CAAC,OAAO,EAAE,KAAK,KAAK,IAAI,CAAA;IAGrC,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAA;IAG7B,eAAe,CAAC,EAAE,MAAM,IAAI,CAAA;IAG5B,eAAe,CAAC,EAAE,MAAM,IAAI,CAAA;IAG5B,mBAAmB,CAAC,EAAE,MAAM,IAAI,CAAA;IAGhC,KAAK,CAAC,EAAE,SAAS,CAAA;IAGjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AACD,KAAK,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC,CAAA;AACrE,KAAK,iBAAiB,GAAG,KAAK,GAAG,cAAc,CAAA;AAE/C,iBAAS,YAAY,CAAC,EACpB,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,KAAK,EACL,UAAU,EACV,GAAG,SAAS,EACb,EAAE,iBAAiB,qBAkBnB;AAED,eAAe,YAAY,CAAA"}
+{"version":3,"file":"DefaultToken.d.ts","sourceRoot":"","sources":["../../src/TokenInput/DefaultToken.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,cAAc,EAAqB,SAAS,EAAE,MAAM,OAAO,CAAA;AAE3E,OAAO,KAAK,MAAM,UAAU,CAAA;AAG5B,UAAU,KAAK;IACb,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,cAAc,CAAC,OAAO,KAAK,CAAC,CAAA;IAE/C,wCAAwC;IACxC,WAAW,EAAE,CAAC,OAAO,EAAE,KAAK,KAAK,IAAI,CAAA;IAErC,gBAAgB;IAChB,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAA;IAE7B,gBAAgB;IAChB,eAAe,CAAC,EAAE,MAAM,IAAI,CAAA;IAE5B,gBAAgB;IAChB,eAAe,CAAC,EAAE,MAAM,IAAI,CAAA;IAE5B,gBAAgB;IAChB,mBAAmB,CAAC,EAAE,MAAM,IAAI,CAAA;IAEhC,2BAA2B;IAC3B,KAAK,CAAC,EAAE,SAAS,CAAA;IAEjB,eAAe;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AACD,KAAK,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC,CAAA;AACrE,KAAK,iBAAiB,GAAG,KAAK,GAAG,cAAc,CAAA;AAE/C,iBAAS,YAAY,CAAC,EACpB,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,KAAK,EACL,UAAU,EACV,GAAG,SAAS,EACb,EAAE,iBAAiB,qBAkBnB;AAED,eAAe,YAAY,CAAA"}

package/dist/TokenInput/TokenInput.d.ts

@@ -2,12 +2,19 @@ import React, { Component } from 'react';
 import { defaultRenderInput, defaultRenderToken } from './default-renders';
 import DefaultToken from './DefaultToken';
 export interface TokenInputProps<T = unknown> {
+    /**
+     * Callback when a token has been added or removed.
+     */
     onChange: (event: {
         added: boolean;
         token: T;
         tokenIndex: number;
         tokens: T[];
     }) => void;
+    /**
+     * Control how the internal input is rendered, `inputProps` must be passed
+     * through to the rendered input.
+     */
     renderInput?: (inputProps: object, options: {
         addToken: (token: T) => void;
         clearInputValue: () => void;
@@ -15,6 +22,11 @@ export interface TokenInputProps<T = unknown> {
         selectFirstToken: () => void;
         selectLastToken: () => void;
     }) => React.ReactElement;
+    /**
+     * Control how a token is rendered. As long as this function returns a string,
+     * it will use a default badge, otherwise pass any custom component and
+     * functionality you need.
+     */
     renderToken?: (token: T, options: {
         keyboardControls: {
             onKeyDown: (e: React.KeyboardEvent) => void;
@@ -28,6 +40,9 @@ export interface TokenInputProps<T = unknown> {
         tokenIndex: number;
     }) => React.ReactElement;
     size?: string;
+    /**
+     * Controlled set of tokens.
+     */
     tokens: Array<T>;
 }
 type Props<T = unknown> = TokenInputProps<T>;

package/dist/TokenInput/TokenInput.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TokenInput.d.ts","sourceRoot":"","sources":["../../src/TokenInput/TokenInput.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAgB,SAAS,EAAE,MAAM,OAAO,CAAA;AAKtD,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAEzC,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO;IAI1C,QAAQ,EAAE,CAAC,KAAK,EAAE;QAChB,KAAK,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,CAAC,CAAA;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,MAAM,EAAE,CAAC,EAAE,CAAA;KACZ,KAAK,IAAI,CAAA;IAKV,WAAW,CAAC,EAAE,CACZ,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE;QACP,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAA;QAC5B,eAAe,EAAE,MAAM,IAAI,CAAA;QAC3B,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;QACpD,gBAAgB,EAAE,MAAM,IAAI,CAAA;QAC5B,eAAe,EAAE,MAAM,IAAI,CAAA;KAC5B,KACE,KAAK,CAAC,YAAY,CAAA;IAMvB,WAAW,CAAC,EAAE,CACZ,KAAK,EAAE,CAAC,EACR,OAAO,EAAE;QACP,gBAAgB,EAAE;YAChB,SAAS,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAA;YAC3C,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QACD,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;QACpD,gBAAgB,EAAE,MAAM,IAAI,CAAA;QAC5B,eAAe,EAAE,MAAM,IAAI,CAAA;QAC3B,eAAe,EAAE,MAAM,IAAI,CAAA;QAC3B,mBAAmB,EAAE,MAAM,IAAI,CAAA;QAC/B,UAAU,EAAE,MAAM,CAAA;KACnB,KACE,KAAK,CAAC,YAAY,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IAKb,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;CACjB;AAED,KAAK,KAAK,CAAC,CAAC,GAAG,OAAO,IAAI,eAAe,CAAC,CAAC,CAAC,CAAA;AAE5C,cAAM,UAAU,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,KAAK,sBAAe;IAE3B,MAAM,CAAC,YAAY;;;;;MAKlB;IAED,QAAQ,EAAE,gBAAgB,CAAA;IAE1B,KAAK;;MAEJ;IAED,kBAAkB,CAAC,SAAS,KAAA;IAM5B,eAAe,aAEd;IAED,QAAQ,uBAkBP;IAED,WAAW,wCAiCV;IAED,kBAAkB,mBAWjB;IAED,iBAAiB,mBAEhB;IAED,IAAI,aAEH;IAED,KAAK,uBAEJ;IAED,eAAe,aAEd;IAED,cAAc,aAEb;IAED,MAAM;CAwFP;;AAED,wBAEC"}
+{"version":3,"file":"TokenInput.d.ts","sourceRoot":"","sources":["../../src/TokenInput/TokenInput.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAgB,SAAS,EAAE,MAAM,OAAO,CAAA;AAKtD,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAEzC,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO;IAC1C;;OAEG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE;QAChB,KAAK,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,CAAC,CAAA;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,MAAM,EAAE,CAAC,EAAE,CAAA;KACZ,KAAK,IAAI,CAAA;IACV;;;OAGG;IACH,WAAW,CAAC,EAAE,CACZ,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE;QACP,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAA;QAC5B,eAAe,EAAE,MAAM,IAAI,CAAA;QAC3B,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;QACpD,gBAAgB,EAAE,MAAM,IAAI,CAAA;QAC5B,eAAe,EAAE,MAAM,IAAI,CAAA;KAC5B,KACE,KAAK,CAAC,YAAY,CAAA;IACvB;;;;OAIG;IACH,WAAW,CAAC,EAAE,CACZ,KAAK,EAAE,CAAC,EACR,OAAO,EAAE;QACP,gBAAgB,EAAE;YAChB,SAAS,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAA;YAC3C,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QACD,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;QACpD,gBAAgB,EAAE,MAAM,IAAI,CAAA;QAC5B,eAAe,EAAE,MAAM,IAAI,CAAA;QAC3B,eAAe,EAAE,MAAM,IAAI,CAAA;QAC3B,mBAAmB,EAAE,MAAM,IAAI,CAAA;QAC/B,UAAU,EAAE,MAAM,CAAA;KACnB,KACE,KAAK,CAAC,YAAY,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;CACjB;AAED,KAAK,KAAK,CAAC,CAAC,GAAG,OAAO,IAAI,eAAe,CAAC,CAAC,CAAC,CAAA;AAE5C,cAAM,UAAU,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,KAAK,sBAAe;IAE3B,MAAM,CAAC,YAAY;;;;;MAKlB;IAED,QAAQ,EAAE,gBAAgB,CAAA;IAE1B,KAAK;;MAEJ;IAED,kBAAkB,CAAC,SAAS,KAAA;IAM5B,eAAe,aAEd;IAED,QAAQ,uBAkBP;IAED,WAAW,wCAiCV;IAED,kBAAkB,mBAWjB;IAED,iBAAiB,mBAEhB;IAED,IAAI,aAEH;IAED,KAAK,uBAEJ;IAED,eAAe,aAEd;IAED,cAAc,aAEb;IAED,MAAM;CAwFP;;AAED,wBAEC"}

package/dist/Toolbar/Toolbar.d.ts

@@ -2,12 +2,34 @@ import React, { Component, ComponentProps, ReactElement, ReactNode } from 'react
 import StackView from '../StackView';
 import ToolbarAction from './Action';
 export type ToolbarProps = ComponentProps<typeof StackView> & {
+    /**
+     * Provide either a single action like a `Button` or `Dropdown` or an array of actions.
+     * Each element will be cloned with the following props: `{ size: 'xs', borderColor: 'primary' }`.
+     */
     actions?: ReactElement | Array<ReactElement>;
+    /**
+     * Adds a counter next to the title of the toolbar.
+     */
     count?: number;
+    /**
+     * Controls the color of the counter.
+     */
     countColor?: string;
+    /**
+     * Render help content inside of a `Collapse` that is triggered by an info button placed next to the title.
+     */
     helpContent?: string | ReactNode;
+    /**
+     * Used to clear a status once it has been set.
+     */
     onStatusClearRequest?: () => null;
+    /**
+     * Renders either a saved or error badge.
+     */
     status?: 'error' | 'success';
+    /**
+     * Renders a heading in the left portion of the toolbar.
+     */
     title: ReactNode;
 };
 declare class Toolbar extends Component<ToolbarProps> {

package/dist/Toolbar/Toolbar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Toolbar.d.ts","sourceRoot":"","sources":["../../src/Toolbar/Toolbar.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAGZ,SAAS,EACT,cAAc,EACd,YAAY,EACZ,SAAS,EACV,MAAM,OAAO,CAAA;AAId,OAAO,SAAS,MAAM,cAAc,CAAA;AAEpC,OAAO,aAAa,MAAM,UAAU,CAAA;AAQpC,MAAM,MAAM,YAAY,GAAG,cAAc,CAAC,OAAO,SAAS,CAAC,GAAG;IAK5D,OAAO,CAAC,EAAE,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAA;IAK5C,KAAK,CAAC,EAAE,MAAM,CAAA;IAKd,UAAU,CAAC,EAAE,MAAM,CAAA;IAKnB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAKhC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAA;IAKjC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAK5B,KAAK,EAAE,SAAS,CAAA;CACjB,CAAA;AAED,cAAM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,MAAM,uBAAgB;IAE7B,cAAc,SAAsC;IAEpD,MAAM,CAAC,YAAY;;MAA2B;IAE9C,MAAM;CA+EP;AASD,eAAe,OAAO,CAAA"}
+{"version":3,"file":"Toolbar.d.ts","sourceRoot":"","sources":["../../src/Toolbar/Toolbar.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAGZ,SAAS,EACT,cAAc,EACd,YAAY,EACZ,SAAS,EACV,MAAM,OAAO,CAAA;AAId,OAAO,SAAS,MAAM,cAAc,CAAA;AAEpC,OAAO,aAAa,MAAM,UAAU,CAAA;AAQpC,MAAM,MAAM,YAAY,GAAG,cAAc,CAAC,OAAO,SAAS,CAAC,GAAG;IAC5D;;;OAGG;IACH,OAAO,CAAC,EAAE,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAA;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEhC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAA;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAE5B;;OAEG;IACH,KAAK,EAAE,SAAS,CAAA;CACjB,CAAA;AAED,cAAM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,MAAM,uBAAgB;IAE7B,cAAc,SAAsC;IAEpD,MAAM,CAAC,YAAY;;MAA2B;IAE9C,MAAM;CA+EP;AASD,eAAe,OAAO,CAAA"}

package/dist/Tooltip/Tooltip.d.ts

@@ -3,19 +3,78 @@ import React from 'react';
 import { As, StyleProps } from '../types';
 export type TooltipProps = StyleProps & {
     as?: As;
+    /**
+     * Passes props to [Popover](/popover)'s `anchorElement`.
+     */
     childProps?: object;
+    /**
+     * The child becomes the trigger for the tooltip, unless it is overridden with `popoverProps={{relativeTo: ref}}`.
+     */
     children?: any;
+    /**
+     * The amount of time in milliseconds before the tooltip closes.
+     */
     closeDelay?: number;
+    /**
+     * Controls whether the Popover is rendered as open or closed.
+     */
     defaultOpen?: boolean;
+    /**
+     * Attempts to keep popover in view clipping edges if too large.
+     */
     keepInView?: boolean;
+    /**
+     * The amount of time in milliseconds before the tooltip opens.
+     */
     openDelay?: number;
+    /**
+     * `'top-start'
+      | 'top'
+      | 'top-end'
+      | 'right-start'
+      | 'right'
+      | 'right-end'
+      | 'bottom-start'
+      | 'bottom'
+      | 'bottom-end'
+      | 'left-start'
+      | 'left'
+      | 'left-end'`
+  
+     * Where to place the popover.
+    */
     placement?: Placement;
+    /**
+     * Accepts any valid [Popover](/popover) props.
+     */
     popoverProps?: object;
+    /**
+     * Determines if the tooltip should use innerRef instead of ref. Default is `true`.
+     * This is useful when the anchor element is not a Tapestry React component.
+     */
     refAsInnerRef?: boolean;
+    /**
+     * Where to render the composed popover into. Accepts an HTML element or selector.
+     * Uses the closest fixed parent or `document.body` by default. This will only
+     * be computed once on initial render.
+     */
     renderTo?: HTMLElement | string;
+    /**
+     * The title of the tooltip. Accepts a string or a React element.
+     */
     title?: any;
+    /**
+     * Reveals the tooltip when the cloned child receives focus.
+     */
     triggerOnFocus?: boolean;
+    /**
+     * Reveals the tooltip when the cloned child is hovered.
+     */
     triggerOnHover?: boolean;
+    /**
+     * Set a specific z-index for Tooltip. (defaults to `10000`)
+     * This option can be helpful in adjusting elements that overlap visually.
+     */
     zIndex?: number;
 };
 declare const _default: React.ForwardRefExoticComponent<Pick<React.CSSProperties, "borderWidth" | "borderTopWidth" | "borderRightWidth" | "borderBottomWidth" | "borderLeftWidth" | "contain" | "left" | "right" | "bottom" | "top" | "content" | "flex" | "position" | "clip" | "clear" | "border" | "padding" | "resize" | "filter" | "overflow" | "overflowX" | "overflowY" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "aspectRatio" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "borderBottom" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderCollapse" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderLeft" | "borderLeftStyle" | "borderRadius" | "borderRight" | "borderRightStyle" | "borderSpacing" | "borderStyle" | "borderTop" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "clipPath" | "clipRule" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "counterIncrement" | "counterReset" | "cursor" | "direction" | "display" | "fillOpacity" | "fillRule" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontSize" | "fontStretch" | "fontStyle" | "fontVariant" | "fontVariantCaps" | "fontVariantLigatures" | "fontVariantNumeric" | "fontWeight" | "gap" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "hyphens" | "imageRendering" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "letterSpacing" | "lightingColor" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBottom" | "marginLeft" | "marginRight" | "marginTop" | "mask" | "maskType" | "maxHeight" | "maxWidth" | "minHeight" | "minWidth" | "mixBlendMode" | "motion" | "objectFit" | "objectPosition" | "opacity" | "order" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflowWrap" | "paddingBottom" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "perspective" | "perspectiveOrigin" | "placeItems" | "placeSelf" | "pointerEvents" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textDecoration" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "touchAction" | "transform" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "verticalAlign" | "visibility" | "userSelect" | "WebkitOverflowScrolling" | "writingMode" | "whiteSpace" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "zIndex"> & Partial<Record<"color" | "fill" | "stroke" | "outlineColor" | "backgroundColor" | "borderColor" | "borderBottomColor" | "borderLeftColor" | "borderRightColor" | "borderTopColor", import("../types").ColorProp>> & {
@@ -54,19 +113,78 @@ declare const _default: React.ForwardRefExoticComponent<Pick<React.CSSProperties
     hover?: StyleProps;
 } & {
     as?: As;
+    /**
+     * Passes props to [Popover](/popover)'s `anchorElement`.
+     */
     childProps?: object;
+    /**
+     * The child becomes the trigger for the tooltip, unless it is overridden with `popoverProps={{relativeTo: ref}}`.
+     */
     children?: any;
+    /**
+     * The amount of time in milliseconds before the tooltip closes.
+     */
     closeDelay?: number;
+    /**
+     * Controls whether the Popover is rendered as open or closed.
+     */
     defaultOpen?: boolean;
+    /**
+     * Attempts to keep popover in view clipping edges if too large.
+     */
     keepInView?: boolean;
+    /**
+     * The amount of time in milliseconds before the tooltip opens.
+     */
     openDelay?: number;
+    /**
+     * `'top-start'
+      | 'top'
+      | 'top-end'
+      | 'right-start'
+      | 'right'
+      | 'right-end'
+      | 'bottom-start'
+      | 'bottom'
+      | 'bottom-end'
+      | 'left-start'
+      | 'left'
+      | 'left-end'`
+  
+     * Where to place the popover.
+    */
     placement?: Placement;
+    /**
+     * Accepts any valid [Popover](/popover) props.
+     */
     popoverProps?: object;
+    /**
+     * Determines if the tooltip should use innerRef instead of ref. Default is `true`.
+     * This is useful when the anchor element is not a Tapestry React component.
+     */
     refAsInnerRef?: boolean;
+    /**
+     * Where to render the composed popover into. Accepts an HTML element or selector.
+     * Uses the closest fixed parent or `document.body` by default. This will only
+     * be computed once on initial render.
+     */
     renderTo?: string | HTMLElement;
+    /**
+     * The title of the tooltip. Accepts a string or a React element.
+     */
     title?: any;
+    /**
+     * Reveals the tooltip when the cloned child receives focus.
+     */
     triggerOnFocus?: boolean;
+    /**
+     * Reveals the tooltip when the cloned child is hovered.
+     */
     triggerOnHover?: boolean;
+    /**
+     * Set a specific z-index for Tooltip. (defaults to `10000`)
+     * This option can be helpful in adjusting elements that overlap visually.
+     */
     zIndex?: number;
 } & React.RefAttributes<unknown>>;
 export default _default;

package/dist/Tooltip/Tooltip.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Tooltip.d.ts","sourceRoot":"","sources":["../../src/Tooltip/Tooltip.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,KAQN,MAAM,OAAO,CAAA;AAId,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAGzC,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG;IACtC,EAAE,CAAC,EAAE,EAAE,CAAA;IAKP,UAAU,CAAC,EAAE,MAAM,CAAA;IAInB,QAAQ,CAAC,EAAE,GAAG,CAAA;IAKd,UAAU,CAAC,EAAE,MAAM,CAAA;IAKnB,WAAW,CAAC,EAAE,OAAO,CAAA;IAKrB,UAAU,CAAC,EAAE,OAAO,CAAA;IAKpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAkBlB,SAAS,CAAC,EAAE,SAAS,CAAA;IAKrB,YAAY,CAAC,EAAE,MAAM,CAAA;IAMrB,aAAa,CAAC,EAAE,OAAO,CAAA;IAOvB,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM,CAAA;IAK/B,KAAK,CAAC,EAAE,GAAG,CAAA;IAKX,cAAc,CAAC,EAAE,OAAO,CAAA;IAKxB,cAAc,CAAC,EAAE,OAAO,CAAA;IAMxB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqLD,wBAAkC"}
+{"version":3,"file":"Tooltip.d.ts","sourceRoot":"","sources":["../../src/Tooltip/Tooltip.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,KAQN,MAAM,OAAO,CAAA;AAId,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAGzC,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG;IACtC,EAAE,CAAC,EAAE,EAAE,CAAA;IAEP;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAA;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;;;;;;;;;;;;MAeE;IACF,SAAS,CAAC,EAAE,SAAS,CAAA;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM,CAAA;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAA;IAEX;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IArFC;;OAEG;;IAEH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;;;;MAeE;;IAGF;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;;AAuLL,wBAAkC"}

package/dist/Wizard/Wizard.d.ts

@@ -4,21 +4,58 @@ import { StackViewProps } from '../StackView';
 import Step from './Step';
 import { StepProps } from './StepProps';
 export type WizardProps = StackViewProps & {
+    /**
+     * Always display cancel button.
+     */
     alwaysCancellable?: boolean;
+    /**
+     * Pass props to the back button.
+     */
     backButtonProps?: ButtonProps;
+    /**
+     * Pass props to all Button components in the footer.
+     */
     buttonProps?: ButtonProps;
+    /**
+     * Pass props to the cancel button.
+     */
     cancelButtonProps?: ButtonProps;
+    /**
+     * The content of the component.
+     */
     children: React.ReactNode;
+    /**
+     * Pass props to the Button components.
+     */
     footerProps?: ButtonProps;
+    /**
+     * The initial payload state.
+     */
     initialPayload?: Record<string, any>;
+    /**
+     * Pass props to the next button.
+     */
     nextButtonProps?: ButtonProps;
+    /**
+     * Determines what the next button title displays.
+     */
     nextButtonTitle?: (props: {
         activeStepIndex: number;
         steps: StepProps[];
         totalSteps: number;
     }) => string;
+    /**
+     * Creates a cancel button for canceling a process from the first step.
+     */
     onCancel?: () => void;
+    /**
+     * Called when the `Done` button is pressed on the last view. Passes back the `payload` state
+     * as well as an option `complete` callback to revert the button spinner back to normal.
+     */
     onSubmit?: (payload: Record<string, any>, complete: () => void) => void;
+    /**
+     * Provide a custom progress component to render in place of `StepperProgress`.
+     */
     renderProgress?: (props: {
         activeStepIndex: number;
         steps: StepProps[];

package/dist/Wizard/Wizard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Wizard.d.ts","sourceRoot":"","sources":["../../src/Wizard/Wizard.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAsD,MAAM,OAAO,CAAA;AAG1E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAI9C,OAAkB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAIxD,OAAO,IAAI,MAAM,QAAQ,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG;IAIzC,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAK3B,eAAe,CAAC,EAAE,WAAW,CAAA;IAK7B,WAAW,CAAC,EAAE,WAAW,CAAA;IAKzB,iBAAiB,CAAC,EAAE,WAAW,CAAA;IAK/B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAKzB,WAAW,CAAC,EAAE,WAAW,CAAA;IAKzB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAKpC,eAAe,CAAC,EAAE,WAAW,CAAA;IAK7B,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,eAAe,EAAE,MAAM,CAAA;QACvB,KAAK,EAAE,SAAS,EAAE,CAAA;QAClB,UAAU,EAAE,MAAM,CAAA;KACnB,KAAK,MAAM,CAAA;IAKZ,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;IAMrB,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;IAKvE,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,eAAe,EAAE,MAAM,CAAA;QACvB,KAAK,EAAE,SAAS,EAAE,CAAA;QAClB,UAAU,EAAE,MAAM,CAAA;KACnB,KAAK,KAAK,CAAC,SAAS,CAAA;CACtB,CAAA;AAED,QAAA,MAAM,MAAM;YAAW,WAAW;;CAkJjC,CAAA;AAID,eAAe,MAAM,CAAA;AACrB,MAAM,WAAW,MAAO,SAAQ,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC;IACnD,IAAI,EAAE,OAAO,IAAI,CAAA;CAClB"}
+{"version":3,"file":"Wizard.d.ts","sourceRoot":"","sources":["../../src/Wizard/Wizard.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAsD,MAAM,OAAO,CAAA;AAG1E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAI9C,OAAkB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAIxD,OAAO,IAAI,MAAM,QAAQ,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG;IACzC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,CAAA;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAA;IAE/B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,CAAA;IAE7B;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,eAAe,EAAE,MAAM,CAAA;QACvB,KAAK,EAAE,SAAS,EAAE,CAAA;QAClB,UAAU,EAAE,MAAM,CAAA;KACnB,KAAK,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;IAEvE;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QACvB,eAAe,EAAE,MAAM,CAAA;QACvB,KAAK,EAAE,SAAS,EAAE,CAAA;QAClB,UAAU,EAAE,MAAM,CAAA;KACnB,KAAK,KAAK,CAAC,SAAS,CAAA;CACtB,CAAA;AAED,QAAA,MAAM,MAAM;YAAW,WAAW;;CAkJjC,CAAA;AAID,eAAe,MAAM,CAAA;AACrB,MAAM,WAAW,MAAO,SAAQ,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC;IACnD,IAAI,EAAE,OAAO,IAAI,CAAA;CAClB"}

package/dist/WrapView/WrapView.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 import { StackViewProps } from '../StackView';
 import { As } from '../types';
 type Props = {
+    /** The amount of space between children. */
     spacing?: number | string;
 };
 export type WrapViewProps<E extends As = 'div'> = Props & Omit<StackViewProps<E>, keyof Props>;

package/dist/WrapView/WrapView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WrapView.d.ts","sourceRoot":"","sources":["../../src/WrapView/WrapView.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAkB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAExD,OAAO,EAAE,EAAE,EAAc,MAAM,UAAU,CAAA;AAEzC,KAAK,KAAK,GAAG;IAEX,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1B,CAAA;AACD,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,EAAE,GAAG,KAAK,IAAI,KAAK,GACrD,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,CAAA;AAEtC,wBAAgB,QAAQ,CAAC,CAAC,SAAS,EAAE,EAAE,EACrC,QAAQ,EACR,OAAO,EACP,GAAG,gBAAgB,EACpB,EAAE,aAAa,CAAC,CAAC,CAAC,qBAgBlB"}
+{"version":3,"file":"WrapView.d.ts","sourceRoot":"","sources":["../../src/WrapView/WrapView.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAkB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAExD,OAAO,EAAE,EAAE,EAAc,MAAM,UAAU,CAAA;AAEzC,KAAK,KAAK,GAAG;IACX,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1B,CAAA;AACD,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,EAAE,GAAG,KAAK,IAAI,KAAK,GACrD,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,CAAA;AAEtC,wBAAgB,QAAQ,CAAC,CAAC,SAAS,EAAE,EAAE,EACrC,QAAQ,EACR,OAAO,EACP,GAAG,gBAAgB,EACpB,EAAE,aAAa,CAAC,CAAC,CAAC,qBAgBlB"}

package/dist/hooks/use-accessibility-violation.d.ts

@@ -1,5 +1,12 @@
 import * as React from 'react';
-export declare function useAccessibilityViolation(tooltipContent: React.ReactNode, consoleContent: string): {
+/**
+ * Provide an on-screen and optional console accessibilty violation.
+ */
+export declare function useAccessibilityViolation(
+/** Content to be displayed in tooltip when hovering element. */
+tooltipContent: React.ReactNode, 
+/** Content to be displayed in the console with a reference to the element. */
+consoleContent: string): {
     tooltipProps?: undefined;
     wrapperProps?: undefined;
 } | {

package/dist/hooks/use-accessibility-violation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-accessibility-violation.d.ts","sourceRoot":"","sources":["../../src/hooks/use-accessibility-violation.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAS9B,wBAAgB,yBAAyB,CAEvC,cAAc,EAAE,KAAK,CAAC,SAAS,EAG/B,cAAc,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;EA8CvB"}
+{"version":3,"file":"use-accessibility-violation.d.ts","sourceRoot":"","sources":["../../src/hooks/use-accessibility-violation.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAM9B;;GAEG;AACH,wBAAgB,yBAAyB;AACvC,gEAAgE;AAChE,cAAc,EAAE,KAAK,CAAC,SAAS;AAE/B,8EAA8E;AAC9E,cAAc,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;EA8CvB"}

package/dist/hooks/use-document-event.d.ts

@@ -1,2 +1,17 @@
+/**
+ * Provide a callback for any document event type.
+ *
+ * @event {string} type - A valid [DOM event](https://developer.mozilla.org/en-US/docs/Web/Events).
+ * @param {Function} callback - Callback when specified event type occurs.
+ *
+ * @example
+ *
+ * function App() {
+ *   useDocumentEvent('keydown', event => {
+ *     console.log(`${event.key} pressed`)
+ *   })
+ *   return <div>App</div>
+ * }
+ */
 export declare function useDocumentEvent(type: any, callback: any): void;
 //# sourceMappingURL=use-document-event.d.ts.map

package/dist/hooks/use-document-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-document-event.d.ts","sourceRoot":"","sources":["../../src/hooks/use-document-event.ts"],"names":[],"mappings":"AAiBA,wBAAgB,gBAAgB,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,QAgB9C"}
+{"version":3,"file":"use-document-event.d.ts","sourceRoot":"","sources":["../../src/hooks/use-document-event.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,KAAA,EAAE,QAAQ,KAAA,QAgB9C"}

package/dist/hooks/use-focus.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Determines when one or many elements take focus.
+ *
+ * @returns {{ focus: boolean, focusProps: Object }}
+ */
 export declare function useFocus(): {
     focus: boolean;
     focusProps: {

package/dist/hooks/use-focus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-focus.d.ts","sourceRoot":"","sources":["../../src/hooks/use-focus.ts"],"names":[],"mappings":"AAOA,wBAAgB,QAAQ;;;;;;EASvB"}
+{"version":3,"file":"use-focus.d.ts","sourceRoot":"","sources":["../../src/hooks/use-focus.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,QAAQ;;;;;;EASvB"}

package/dist/hooks/use-id.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Generates a unique id based on the provided prefix.
+ * Be aware using the same prefix elsewhere _does not_ generate a unique id.
+ * @param {string} prefix
+ * @returns {string} unique prefixed id
+ */
 export declare function useId(prefix: any): any;
 //# sourceMappingURL=use-id.d.ts.map

package/dist/hooks/use-id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-id.d.ts","sourceRoot":"","sources":["../../src/hooks/use-id.ts"],"names":[],"mappings":"AAYA,wBAAgB,KAAK,CAAC,MAAM,KAAA,OAM3B"}
+{"version":3,"file":"use-id.d.ts","sourceRoot":"","sources":["../../src/hooks/use-id.ts"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,MAAM,KAAA,OAM3B"}

package/dist/hooks/use-measure.d.ts

@@ -1,4 +1,40 @@
 import * as React from 'react';
+/**
+ * Creates a set of hooks to help manage collecting and using measurements
+ * from one or many components.
+ *
+ * @example
+ *
+ * function Singular({ ref, value }) {
+ *   const [useMeasureRef, useMeasureEffect] = useMeasure()
+ *   useMeasureRef(ref)
+ *   useMeasureEffect(([node]) => {
+ *     console.log(node)
+ *   }, [value])
+ *   return <div />
+ * }
+ *
+ * function Parent({ children }) {
+ *   const [useMeasureRef, useMeasureEffect] = useMeasure()
+ *   useMeasureEffect(nodes => {
+ *     console.log(nodes)
+ *   }, [])
+ *   return (
+ *     <div>
+ *       {Children.map(children, child =>
+ *         React.cloneElement(child, { useMeasureRef })
+ *       )}
+ *     </div>
+ *   )
+ * }
+ *
+ * function Child({ useMeasureRef }) {
+ *   const ref = useMeasureRef(ref)
+ *   return <div ref={ref} />
+ * }
+ *
+ * @returns {[(ref?: React.RefObject) => React.RefObject, (onMeasure: Function, dependencies: Array) => void]}
+ */
 export declare function useMeasure(): [
     (ref?: React.RefObject<Node>) => React.RefObject<Node>,
     (onMeasure: (nodes: HTMLElement[]) => void, dependencies?: React.DependencyList) => void

package/dist/hooks/use-measure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-measure.d.ts","sourceRoot":"","sources":["../../src/hooks/use-measure.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AA4D9B,wBAAgB,UAAU,IAAI;IAC5B,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACtD,CACE,SAAS,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,IAAI,EACzC,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,KAChC,IAAI;CACV,CAmEA"}
+{"version":3,"file":"use-measure.d.ts","sourceRoot":"","sources":["../../src/hooks/use-measure.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAwB9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,UAAU,IAAI;IAC5B,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACtD,CACE,SAAS,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,IAAI,EACzC,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,KAChC,IAAI;CACV,CAmEA"}

package/dist/hooks/use-roving-index.d.ts

@@ -1,3 +1,26 @@
+/**
+ * Manages a set of indices that need to wrap or be contained.
+ *
+ * @example
+ *
+ * const {
+ *   activeIndex,
+ *   moveActiveIndex,
+ * } = useRovingIndex({ maxIndex: items.length - 1 })
+ *
+ * @param {{
+ *   maxIndex: number,
+ *   defaultIndex?: number,
+ *   wrap?: boolean
+ * }} [options]
+ * @returns {{
+ *   activeIndex: number,
+ *   moveActiveIndex: (amountToMove: number) => void,
+ *   setActiveIndex: (nextIndex: number) => void,
+ *   moveBackwardDisabled: boolean,
+ *   moveForwardDisabled: boolean,
+ * }}
+ */
 export declare function useRovingIndex({ maxIndex, defaultIndex, wrap }: {
     maxIndex: any;
     defaultIndex?: number;

package/dist/hooks/use-roving-index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-roving-index.d.ts","sourceRoot":"","sources":["../../src/hooks/use-roving-index.ts"],"names":[],"mappings":"AAyBA,wBAAgB,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAgB,EAAE,IAAY,EAAE;;;;CAAA;;;;;;EAiC1E"}
+{"version":3,"file":"use-roving-index.d.ts","sourceRoot":"","sources":["../../src/hooks/use-roving-index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,CAAC,EAAE,QAAQ,EAAE,YAAgB,EAAE,IAAY,EAAE;;;;CAAA;;;;;;EAiC1E"}