@instructure/ui-tooltip 8.14.0 → 8.14.1-snapshot.17

package/types/Tooltip/index.d.ts

@@ -1,17 +1,19 @@
 /** @jsx jsx */
 import { Component } from 'react';
+import type { PopoverProps } from '@instructure/ui-popover';
 import { jsx } from '@instructure/emotion';
-import type { TooltipProps, TooltipRenderChildren } from './props';
+import type { TooltipProps, TooltipState } from './props';
 /**
 ---
 category: components
 ---
+@tsProps
 **/
-declare class Tooltip extends Component<TooltipProps> {
+declare class Tooltip extends Component<TooltipProps, TooltipState> {
     static readonly componentId = "Tooltip";
     static allowedProps: readonly (keyof {
-        renderTip: import("react").ReactNode | ((...args: any[]) => any);
-        children: import("react").ReactNode | TooltipRenderChildren;
+        children: import("react").ReactNode | import("./props").TooltipRenderChildren;
+        renderTip: import("react").ReactNode | (() => import("react").ReactNode);
         isShowingContent?: boolean | undefined;
         defaultIsShowingContent?: boolean | undefined;
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
@@ -20,15 +22,17 @@ declare class Tooltip extends Component<TooltipProps> {
         placement?: import("@instructure/ui-position").PlacementPropValues | undefined;
         mountNode?: import("@instructure/ui-position").PositionMountNode | undefined;
         constrain?: import("@instructure/ui-position").PositionConstraint | undefined;
-        positionTarget?: import("@instructure/ui-position").PositionMountNode | undefined;
         offsetX?: string | number | undefined;
         offsetY?: string | number | undefined;
-        onShowContent?: ((...args: any[]) => any) | undefined;
-        onHideContent?: ((...args: any[]) => any) | undefined;
+        positionTarget?: import("@instructure/ui-position").PositionMountNode | undefined;
+        onShowContent?: ((event: import("react").UIEvent<Element, UIEvent> | import("react").FocusEvent<Element, Element>) => void) | undefined;
+        onHideContent?: ((event: import("react").UIEvent<Element, UIEvent> | import("react").FocusEvent<Element, Element>, args: {
+            documentClick: boolean;
+        }) => void) | undefined;
     })[];
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
-        renderTip: import("react").ReactNode | ((...args: any[]) => any);
-        children: import("react").ReactNode | TooltipRenderChildren;
+        children: import("react").ReactNode | import("./props").TooltipRenderChildren;
+        renderTip: import("react").ReactNode | (() => import("react").ReactNode);
         isShowingContent?: boolean | undefined;
         defaultIsShowingContent?: boolean | undefined;
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
@@ -37,36 +41,31 @@ declare class Tooltip extends Component<TooltipProps> {
         placement?: import("@instructure/ui-position").PlacementPropValues | undefined;
         mountNode?: import("@instructure/ui-position").PositionMountNode | undefined;
         constrain?: import("@instructure/ui-position").PositionConstraint | undefined;
-        positionTarget?: import("@instructure/ui-position").PositionMountNode | undefined;
         offsetX?: string | number | undefined;
         offsetY?: string | number | undefined;
-        onShowContent?: ((...args: any[]) => any) | undefined;
-        onHideContent?: ((...args: any[]) => any) | undefined;
+        positionTarget?: import("@instructure/ui-position").PositionMountNode | undefined;
+        onShowContent?: ((event: import("react").UIEvent<Element, UIEvent> | import("react").FocusEvent<Element, Element>) => void) | undefined;
+        onHideContent?: ((event: import("react").UIEvent<Element, UIEvent> | import("react").FocusEvent<Element, Element>, args: {
+            documentClick: boolean;
+        }) => void) | undefined;
     }>;
     static defaultProps: {
         readonly defaultIsShowingContent: false;
         readonly color: "primary";
         readonly placement: "top";
-        readonly mountNode: null;
         readonly constrain: "window";
         readonly offsetX: 0;
         readonly offsetY: 0;
-        readonly onShowContent: (event: any) => void;
-        readonly onHideContent: (event: any, { documentClick }: {
-            documentClick: any;
-        }) => void;
-    };
-    _id: string;
-    state: {
-        hasFocus: boolean;
     };
+    private readonly _id;
     ref: Element | null;
     handleRef: (el: Element | null) => void;
+    constructor(props: TooltipProps);
     componentDidMount(): void;
-    componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
-    handleFocus: (event: any) => void;
-    handleBlur: (event: any) => void;
-    renderTrigger(): import("react").ReactNode;
+    componentDidUpdate(): void;
+    handleFocus: PopoverProps['onFocus'];
+    handleBlur: PopoverProps['onBlur'];
+    renderTrigger(): any;
     render(): jsx.JSX.Element;
 }
 export default Tooltip;

package/types/Tooltip/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Tooltip/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAYjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAKrD,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAGlE;;;;GAIG;AACH,cAEM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;;;;;;MAYT;IAEV,GAAG,SAAiB;IACpB,KAAK;;MAAsB;IAE3B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAKjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAKjD,WAAW,uBAEV;IAGD,UAAU,uBAET;IAED,aAAa;IA6Bb,MAAM;CAiDP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Tooltip/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAYjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAKrD,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAGzD;;;;;GAKG;AACH,cAEM,OAAQ,SAAQ,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;MAOT;IAEV,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAE5B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;gBAEW,KAAK,EAAE,YAAY;IAQ/B,iBAAiB;IAIjB,kBAAkB;IAIlB,WAAW,EAAE,YAAY,CAAC,SAAS,CAAC,CAEnC;IAED,UAAU,EAAE,YAAY,CAAC,QAAQ,CAAC,CAEjC;IAED,aAAa;IA6Bb,MAAM;CAiDP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/types/Tooltip/props.d.ts

@@ -1,37 +1,100 @@
 import React from 'react';
-import type { PropValidators, AsElementType, TooltipTheme } from '@instructure/shared-types';
+import type { PropValidators, AsElementType, TooltipTheme, OtherHTMLAttributes } from '@instructure/shared-types';
 import type { PlacementPropValues, PositionConstraint, PositionMountNode } from '@instructure/ui-position';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
+import type { PopoverOwnProps } from '@instructure/ui-popover';
 declare type TooltipRenderChildrenArgs = {
     focused: boolean;
-    getTriggerProps: <P extends Record<string, any>>(props: P) => {
+    getTriggerProps: <TriggerProps extends Record<string, any>>(props: TriggerProps) => {
         'aria-describedby': string;
-    } & P;
+    } & TriggerProps;
 };
 declare type TooltipRenderChildren = (args: TooltipRenderChildrenArgs) => React.ReactNode;
 declare type TooltipOwnProps = {
-    renderTip: React.ReactNode | ((...args: any[]) => any);
+    /**
+     * A ReactNode or a function that returns a ReactNode with the following params:
+     *
+     * @param {Boolean} focused - Is the Tooltip trigger focused?
+     * @param {Function} getTriggerProps - Props to be spread onto the trigger element
+     */
     children: React.ReactNode | TooltipRenderChildren;
+    /**
+     * The content to render in the tooltip
+     */
+    renderTip: React.ReactNode | (() => React.ReactNode);
+    /**
+     * Whether or not the tooltip content is shown, when controlled
+     */
     isShowingContent?: boolean;
+    /**
+     * Whether or not to show the content by default, when uncontrolled
+     */
     defaultIsShowingContent?: boolean;
+    /**
+     * the element type to render as (assumes a single child if 'as' is undefined)
+     */
     as?: AsElementType;
+    /**
+     * The action that causes the Content to display (`click`, `hover`, `focus`)
+     */
     on?: ('click' | 'hover' | 'focus') | ('click' | 'hover' | 'focus')[];
+    /**
+     * The color of the tooltip content
+     */
     color?: 'primary' | 'primary-inverse';
+    /**
+     * Specifies where the Tooltip will be placed in relation to the target element.
+     * Ex. placement="bottom" will render the Tooltip below the triggering element
+     * (Note: if there is not room, it will position opposite. Ex. "top" will
+     * automatically switch to "bottom")
+     */
     placement?: PlacementPropValues;
+    /**
+     * An element or a function returning an element to use as the mount node
+     * for the `<Tooltip />` (defaults to `document.body`)
+     */
     mountNode?: PositionMountNode;
+    /**
+     * The parent in which to constrain the tooltip.
+     * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+     * or a function returning an element
+     */
     constrain?: PositionConstraint;
-    positionTarget?: PositionMountNode;
+    /**
+     * The horizontal offset for the positioned content
+     */
     offsetX?: string | number;
+    /**
+     * The vertical offset for the positioned content
+     */
     offsetY?: string | number;
-    onShowContent?: (...args: any[]) => any;
-    onHideContent?: (...args: any[]) => any;
+    /**
+     * Target element for positioning the Tooltip (if it differs from children/trigger)
+     */
+    positionTarget?: PositionMountNode;
+    /**
+     * Callback fired when content is shown. When controlled, this callback is
+     * fired when the tooltip expects to be shown
+     */
+    onShowContent?: (event: React.UIEvent | React.FocusEvent) => void;
+    /**
+     * Callback fired when content is hidden. When controlled, this callback is
+     * fired when the tooltip expects to be hidden
+     */
+    onHideContent?: (event: React.UIEvent | React.FocusEvent, args: {
+        documentClick: boolean;
+    }) => void;
 };
 declare type PropKeys = keyof TooltipOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type TooltipProps = TooltipOwnProps & WithStyleProps<TooltipTheme, TooltipStyle>;
+declare type PropsPassableToPopover = Omit<PopoverOwnProps, 'isShowingContent' | 'defaultIsShowingContent' | 'on' | 'shouldRenderOffscreen' | 'shouldReturnFocus' | 'placement' | 'color' | 'mountNode' | 'constrain' | 'shadow' | 'offsetX' | 'offsetY' | 'positionTarget' | 'renderTrigger' | 'onShowContent' | 'onHideContent' | 'onFocus' | 'onBlur' | 'elementRef'>;
+declare type TooltipProps = PropsPassableToPopover & TooltipOwnProps & WithStyleProps<TooltipTheme, TooltipStyle> & OtherHTMLAttributes<TooltipOwnProps>;
 declare type TooltipStyle = ComponentStyle<'tooltip'>;
+declare type TooltipState = {
+    hasFocus: boolean;
+};
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { TooltipProps, TooltipStyle, TooltipRenderChildren, TooltipRenderChildrenArgs };
+export type { TooltipProps, TooltipState, TooltipStyle, TooltipRenderChildren, TooltipRenderChildrenArgs };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Tooltip/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,YAAY,EACb,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,yBAAyB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7C,KAAK,EAAE,CAAC,KACL;QAAE,kBAAkB,EAAE,MAAM,CAAA;KAAE,GAAG,CAAC,CAAA;CACxC,CAAA;AAED,aAAK,qBAAqB,GAAG,CAC3B,IAAI,EAAE,yBAAyB,KAC5B,KAAK,CAAC,SAAS,CAAA;AAEpB,aAAK,eAAe,GAAG;IACrB,SAAS,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACtD,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,qBAAqB,CAAA;IACjD,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,EAAE,CAAA;IACpE,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAA;IACrC,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAC/B,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAC9B,cAAc,CAAC,EAAE,iBAAiB,CAAA;IAClC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACvC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;CACxC,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAIhD,aAAK,YAAY,GAAG,eAAe,GAAG,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;AAEhF,aAAK,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,CAAA;AAE7C,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA0EvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAgBnB,CAAA;AAED,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,qBAAqB,EACrB,yBAAyB,EAC1B,CAAA;AACD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Tooltip/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,YAAY,EACZ,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAE9D,aAAK,yBAAyB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,CAAC,YAAY,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACxD,KAAK,EAAE,YAAY,KAChB;QAAE,kBAAkB,EAAE,MAAM,CAAA;KAAE,GAAG,YAAY,CAAA;CACnD,CAAA;AAED,aAAK,qBAAqB,GAAG,CAC3B,IAAI,EAAE,yBAAyB,KAC5B,KAAK,CAAC,SAAS,CAAA;AAEpB,aAAK,eAAe,GAAG;IACrB;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,qBAAqB,CAAA;IAEjD;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAEpD;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;IAEjC;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,EAAE,CAAA;IAEpE;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAA;IAErC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,iBAAiB,CAAA;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,UAAU,KAAK,IAAI,CAAA;IAEjE;;;OAGG;IACH,aAAa,CAAC,EAAE,CACd,KAAK,EAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,UAAU,EACvC,IAAI,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,KAC7B,IAAI,CAAA;CACV,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAGhD,aAAK,sBAAsB,GAAG,IAAI,CAChC,eAAe,EACb,kBAAkB,GAClB,yBAAyB,GACzB,IAAI,GACJ,uBAAuB,GACvB,mBAAmB,GACnB,WAAW,GACX,OAAO,GACP,WAAW,GACX,WAAW,GACX,QAAQ,GACR,SAAS,GACT,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,eAAe,GACf,SAAS,GACT,QAAQ,GACR,YAAY,CACf,CAAA;AAED,aAAK,YAAY,GAAG,sBAAsB,GACxC,eAAe,GACf,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,GAE1C,mBAAmB,CAAC,eAAe,CAAC,CAAA;AAEtC,aAAK,YAAY,GAAG,cAAc,CAAC,SAAS,CAAC,CAAA;AAE7C,aAAK,YAAY,GAAG;IAClB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAmBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAgBnB,CAAA;AAED,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,qBAAqB,EACrB,yBAAyB,EAC1B,CAAA;AACD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}