@instructure/ui-tooltip 8.10.0 → 8.10.1

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.10.1](https://github.com/instructure/instructure-ui/compare/v8.10.0...v8.10.1) (2021-10-01)
+
+**Note:** Version bump only for package @instructure/ui-tooltip
+
 # [8.10.0](https://github.com/instructure/instructure-ui/compare/v8.9.1...v8.10.0) (2021-09-28)
 
 **Note:** Version bump only for package @instructure/ui-tooltip

package/es/Tooltip/index.js

@@ -90,13 +90,12 @@ let Tooltip = (_dec = withStyle(generateStyle, generateComponentTheme), _dec2 =
       const props = omitProps(this.props, Tooltip.allowedProps);
       return jsx(Trigger, Object.assign({}, props, triggerProps), children);
     } else if (typeof children === 'function') {
+      // TODO: try to remove cast when typing Tooltip (React children types are badly calculated)
       return children({
         focused: hasFocus,
-        getTriggerProps: props => {
-          return { ...triggerProps,
-            ...props
-          };
-        }
+        getTriggerProps: props => ({ ...triggerProps,
+          ...props
+        })
       });
     } else {
       return ensureSingleChild(this.props.children, triggerProps);

package/lib/Tooltip/index.js

@@ -91,13 +91,12 @@ let Tooltip = (_dec = (0, _emotion.withStyle)(_styles.default, _theme.default),
       const props = (0, _omitProps.omitProps)(this.props, Tooltip.allowedProps);
       return (0, _emotion.jsx)(Trigger, Object.assign({}, props, triggerProps), children);
     } else if (typeof children === 'function') {
+      // TODO: try to remove cast when typing Tooltip (React children types are badly calculated)
       return children({
         focused: hasFocus,
-        getTriggerProps: props => {
-          return { ...triggerProps,
-            ...props
-          };
-        }
+        getTriggerProps: props => ({ ...triggerProps,
+          ...props
+        })
       });
     } else {
       return (0, _ensureSingleChild.ensureSingleChild)(this.props.children, triggerProps);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-tooltip",
-  "version": "8.10.0",
+  "version": "8.10.1",
   "description": "A component for showing small text-only overlays on hover/focus.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -25,23 +25,23 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.13.10",
-    "@instructure/emotion": "8.10.0",
-    "@instructure/shared-types": "8.10.0",
-    "@instructure/ui-popover": "8.10.0",
-    "@instructure/ui-position": "8.10.0",
-    "@instructure/ui-prop-types": "8.10.0",
-    "@instructure/ui-react-utils": "8.10.0",
-    "@instructure/ui-testable": "8.10.0",
-    "@instructure/uid": "8.10.0",
+    "@instructure/emotion": "8.10.1",
+    "@instructure/shared-types": "8.10.1",
+    "@instructure/ui-popover": "8.10.1",
+    "@instructure/ui-position": "8.10.1",
+    "@instructure/ui-prop-types": "8.10.1",
+    "@instructure/ui-react-utils": "8.10.1",
+    "@instructure/ui-testable": "8.10.1",
+    "@instructure/uid": "8.10.1",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.10.0",
-    "@instructure/ui-color-utils": "8.10.0",
-    "@instructure/ui-test-locator": "8.10.0",
-    "@instructure/ui-test-queries": "8.10.0",
-    "@instructure/ui-test-utils": "8.10.0",
-    "@instructure/ui-themes": "8.10.0"
+    "@instructure/ui-babel-preset": "8.10.1",
+    "@instructure/ui-color-utils": "8.10.1",
+    "@instructure/ui-test-locator": "8.10.1",
+    "@instructure/ui-test-queries": "8.10.1",
+    "@instructure/ui-test-utils": "8.10.1",
+    "@instructure/ui-themes": "8.10.1"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"

package/src/Tooltip/index.tsx

@@ -39,7 +39,8 @@ import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import type { TooltipProps } from './props'
+
+import type { TooltipProps, TooltipRenderChildren } from './props'
 import { allowedProps, propTypes } from './props'
 
 /**
@@ -107,16 +108,13 @@ class Tooltip extends Component<TooltipProps> {
         </Trigger>
       )
     } else if (typeof children === 'function') {
-      // @ts-expect-error FIXME: React children types are badly calculated
-      return children({
+      // TODO: try to remove cast when typing Tooltip (React children types are badly calculated)
+      return (children as TooltipRenderChildren)({
         focused: hasFocus,
-        // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'props' implicitly has an 'any' type.
-        getTriggerProps: (props) => {
-          return {
-            ...triggerProps,
-            ...props
-          }
-        }
+        getTriggerProps: (props) => ({
+          ...triggerProps,
+          ...props
+        })
       })
     } else {
       return ensureSingleChild(this.props.children, triggerProps)

package/src/Tooltip/props.ts

@@ -40,9 +40,20 @@ import type {
 } from '@instructure/ui-position'
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
 
+type TooltipRenderChildrenArgs = {
+  focused: boolean
+  getTriggerProps: <P extends Record<string, any>>(
+    props: P
+  ) => { 'aria-describedby': string } & P
+}
+
+type TooltipRenderChildren = (
+  args: TooltipRenderChildrenArgs
+) => React.ReactNode
+
 type TooltipOwnProps = {
   renderTip: React.ReactNode | ((...args: any[]) => any)
-  children: React.ReactNode | ((...args: any[]) => React.ReactNode)
+  children: React.ReactNode | TooltipRenderChildren
   isShowingContent?: boolean
   defaultIsShowingContent?: boolean
   as?: AsElementType
@@ -160,5 +171,10 @@ const allowedProps: AllowedPropKeys = [
   'onHideContent'
 ]
 
-export type { TooltipProps, TooltipStyle }
+export type {
+  TooltipProps,
+  TooltipStyle,
+  TooltipRenderChildren,
+  TooltipRenderChildrenArgs
+}
 export { propTypes, allowedProps }

package/src/index.ts

@@ -22,4 +22,4 @@
  * SOFTWARE.
  */
 export { Tooltip } from './Tooltip'
-export type { TooltipProps } from './Tooltip/props'
+export type { TooltipProps, TooltipRenderChildrenArgs } from './Tooltip/props'

package/types/Tooltip/index.d.ts

@@ -1,7 +1,7 @@
 /** @jsx jsx */
 import { Component } from 'react';
 import { jsx } from '@instructure/emotion';
-import type { TooltipProps } from './props';
+import type { TooltipProps, TooltipRenderChildren } from './props';
 /**
 ---
 category: components
@@ -11,7 +11,7 @@ declare class Tooltip extends Component<TooltipProps> {
     static readonly componentId = "Tooltip";
     static allowedProps: readonly (keyof {
         renderTip: import("react").ReactNode | ((...args: any[]) => any);
-        children: import("react").ReactNode | ((...args: any[]) => import("react").ReactNode);
+        children: import("react").ReactNode | TooltipRenderChildren;
         isShowingContent?: boolean | undefined;
         defaultIsShowingContent?: boolean | undefined;
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
@@ -28,7 +28,7 @@ declare class Tooltip extends Component<TooltipProps> {
     })[];
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         renderTip: import("react").ReactNode | ((...args: any[]) => any);
-        children: import("react").ReactNode | ((...args: any[]) => import("react").ReactNode);
+        children: import("react").ReactNode | TooltipRenderChildren;
         isShowingContent?: boolean | undefined;
         defaultIsShowingContent?: boolean | undefined;
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
@@ -64,7 +64,7 @@ declare class Tooltip extends Component<TooltipProps> {
     componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
     handleFocus: (event: any) => void;
     handleBlur: (event: any) => void;
-    renderTrigger(): any;
+    renderTrigger(): import("react").ReactNode;
     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;AAIrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAG3C;;;;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,iBAAiB;IAKjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAKjD,WAAW,uBAEV;IAGD,UAAU,uBAET;IAED,aAAa;IAgCb,MAAM;CA+CP;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,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,iBAAiB;IAKjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAKjD,WAAW,uBAEV;IAGD,UAAU,uBAET;IAED,aAAa;IA6Bb,MAAM;CA+CP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/types/Tooltip/props.d.ts

@@ -2,9 +2,16 @@ import React from 'react';
 import type { PropValidators, AsElementType, TooltipTheme } from '@instructure/shared-types';
 import type { PlacementPropValues, PositionConstraint, PositionMountNode } from '@instructure/ui-position';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
+declare type TooltipRenderChildrenArgs = {
+    focused: boolean;
+    getTriggerProps: <P extends Record<string, any>>(props: P) => {
+        'aria-describedby': string;
+    } & P;
+};
+declare type TooltipRenderChildren = (args: TooltipRenderChildrenArgs) => React.ReactNode;
 declare type TooltipOwnProps = {
     renderTip: React.ReactNode | ((...args: any[]) => any);
-    children: React.ReactNode | ((...args: any[]) => React.ReactNode);
+    children: React.ReactNode | TooltipRenderChildren;
     isShowingContent?: boolean;
     defaultIsShowingContent?: boolean;
     as?: AsElementType;
@@ -25,6 +32,6 @@ declare type TooltipProps = TooltipOwnProps & WithStyleProps<TooltipTheme, Toolt
 declare type TooltipStyle = ComponentStyle<'tooltip'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { TooltipProps, TooltipStyle };
+export type { TooltipProps, 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,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,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IACjE,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;AAEhD,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,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AAC1C,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,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;AAEhD,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"}

package/types/index.d.ts

@@ -1,3 +1,3 @@
 export { Tooltip } from './Tooltip';
-export type { TooltipProps } from './Tooltip/props';
+export type { TooltipProps, TooltipRenderChildrenArgs } from './Tooltip/props';
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,YAAY,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAA"}