@instructure/ui-tooltip 8.8.1-snapshot.8 → 8.9.0

package/lib/Tooltip/props.js

@@ -0,0 +1,128 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.allowedProps = exports.propTypes = void 0;
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _PositionPropTypes = require("@instructure/ui-position/lib/PositionPropTypes.js");
+
+var _element = require("@instructure/ui-prop-types/lib/element.js");
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+const propTypes = {
+  /**
+   * @param {Object} renderProps
+   * @param {Boolean} renderProps.focused - Is the Tooltip trigger focused?
+   * @param {Function} renderProps.getTriggerProps - Props to be spread onto the trigger element
+   */
+  children: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
+
+  /**
+   * The content to render in the tooltip
+   */
+  renderTip: _propTypes.default.oneOfType([_propTypes.default.node, _propTypes.default.func]).isRequired,
+
+  /**
+   * Whether or not the tooltip content is shown, when controlled
+   */
+  isShowingContent: _propTypes.default.bool,
+
+  /**
+   * Whether or not to show the content by default, when uncontrolled
+   */
+  defaultIsShowingContent: _propTypes.default.bool,
+
+  /**
+   * the element type to render as (assumes a single child if 'as' is undefined)
+   */
+  as: _propTypes.default.elementType,
+  // eslint-disable-line react/require-default-props
+
+  /**
+   * The action that causes the Content to display (`click`, `hover`, `focus`)
+   */
+  on: _propTypes.default.oneOfType([_propTypes.default.oneOf(['click', 'hover', 'focus']), _propTypes.default.arrayOf(_propTypes.default.oneOf(['click', 'hover', 'focus']))]),
+
+  /**
+   * The color of the tooltip content
+   */
+  color: _propTypes.default.oneOf(['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: _PositionPropTypes.PositionPropTypes.placement,
+
+  /**
+   * An element or a function returning an element to use as the mount node
+   * for the `<Tooltip />` (defaults to `document.body`)
+   */
+  mountNode: _PositionPropTypes.PositionPropTypes.mountNode,
+
+  /**
+   * The parent in which to constrain the tooltip.
+   * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+   * or a function returning an element
+   */
+  constrain: _PositionPropTypes.PositionPropTypes.constrain,
+
+  /**
+   * The horizontal offset for the positioned content
+   */
+  offsetX: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+
+  /**
+   * The vertical offset for the positioned content
+   */
+  offsetY: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
+
+  /**
+   * Target element for positioning the Tooltip (if it differs from children/trigger)
+   */
+  positionTarget: _propTypes.default.oneOfType([_element.element, _propTypes.default.func]),
+
+  /**
+   * Callback fired when content is shown. When controlled, this callback is
+   * fired when the tooltip expects to be shown
+   */
+  onShowContent: _propTypes.default.func,
+
+  /**
+   * Callback fired when content is hidden. When controlled, this callback is
+   * fired when the tooltip expects to be hidden
+   */
+  onHideContent: _propTypes.default.func
+};
+exports.propTypes = propTypes;
+const allowedProps = ['children', 'renderTip', 'isShowingContent', 'defaultIsShowingContent', 'as', 'on', 'color', 'placement', 'mountNode', 'constrain', 'offsetX', 'offsetY', 'positionTarget', 'onShowContent', 'onHideContent'];
+exports.allowedProps = allowedProps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-tooltip",
-  "version": "8.8.1-snapshot.8+7b83164f4",
+  "version": "8.9.0",
   "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.8.1-snapshot.8+7b83164f4",
-    "@instructure/shared-types": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-popover": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-position": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-prop-types": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-react-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-testable": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/uid": "8.8.1-snapshot.8+7b83164f4",
+    "@instructure/emotion": "8.9.0",
+    "@instructure/shared-types": "8.9.0",
+    "@instructure/ui-popover": "8.9.0",
+    "@instructure/ui-position": "8.9.0",
+    "@instructure/ui-prop-types": "8.9.0",
+    "@instructure/ui-react-utils": "8.9.0",
+    "@instructure/ui-testable": "8.9.0",
+    "@instructure/uid": "8.9.0",
     "prop-types": "^15"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-color-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-locator": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-queries": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-test-utils": "8.8.1-snapshot.8+7b83164f4",
-    "@instructure/ui-themes": "8.8.1-snapshot.8+7b83164f4"
+    "@instructure/ui-babel-preset": "8.9.0",
+    "@instructure/ui-color-utils": "8.9.0",
+    "@instructure/ui-test-locator": "8.9.0",
+    "@instructure/ui-test-queries": "8.9.0",
+    "@instructure/ui-test-utils": "8.9.0",
+    "@instructure/ui-themes": "8.9.0"
   },
   "peerDependencies": {
     "react": ">=16.8 <=17"
@@ -49,6 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "sideEffects": false,
-  "gitHead": "7b83164f4c5872f3a217e010563f59bf584ae4fc"
+  "sideEffects": false
 }

package/src/Tooltip/index.tsx

@@ -24,7 +24,6 @@
 
 /** @jsx jsx */
 import { Component } from 'react'
-import PropTypes from 'prop-types'
 
 import {
   getElementType,
@@ -33,16 +32,15 @@ import {
   passthroughProps,
   callRenderProp
 } from '@instructure/ui-react-utils'
-import { PositionPropTypes } from '@instructure/ui-position'
 import { uid } from '@instructure/uid'
 import { testable } from '@instructure/ui-testable'
 import { Popover } from '@instructure/ui-popover'
-import { element } from '@instructure/ui-prop-types'
 import { withStyle, jsx } from '@instructure/emotion'
 
 import generateStyle from './styles'
 import generateComponentTheme from './theme'
-import { TooltipProps } from './types'
+import type { TooltipProps } from './props'
+import { allowedProps, propTypes } from './props'
 
 /**
 ---
@@ -54,97 +52,17 @@ category: components
 class Tooltip extends Component<TooltipProps> {
   static readonly componentId = 'Tooltip'
 
-  static propTypes = {
-    // eslint-disable-next-line react/require-default-props
-    makeStyles: PropTypes.func,
-    // eslint-disable-next-line react/require-default-props
-    styles: PropTypes.object,
-    /**
-     * @param {Object} renderProps
-     * @param {Boolean} renderProps.focused - Is the Tooltip trigger focused?
-     * @param {Function} renderProps.getTriggerProps - Props to be spread onto the trigger element
-     */
-    children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
-    /**
-     * The content to render in the tooltip
-     */
-    renderTip: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
-    /**
-     * Whether or not the tooltip content is shown, when controlled
-     */
-    isShowingContent: PropTypes.bool,
-    /**
-     * Whether or not to show the content by default, when uncontrolled
-     */
-    defaultIsShowingContent: PropTypes.bool,
-    /**
-     * the element type to render as (assumes a single child if 'as' is undefined)
-     */
-    as: PropTypes.elementType, // eslint-disable-line react/require-default-props
-    /**
-     * The action that causes the Content to display (`click`, `hover`, `focus`)
-     */
-    on: PropTypes.oneOfType([
-      PropTypes.oneOf(['click', 'hover', 'focus']),
-      PropTypes.arrayOf(PropTypes.oneOf(['click', 'hover', 'focus']))
-    ]),
-    /**
-     * The color of the tooltip content
-     */
-    color: PropTypes.oneOf(['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: PositionPropTypes.placement,
-    /**
-     * An element or a function returning an element to use as the mount node
-     * for the `<Tooltip />` (defaults to `document.body`)
-     */
-    mountNode: PositionPropTypes.mountNode,
-    /**
-     * The parent in which to constrain the tooltip.
-     * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
-     * or a function returning an element
-     */
-    constrain: PositionPropTypes.constrain,
-    /**
-     * The horizontal offset for the positioned content
-     */
-    offsetX: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-    /**
-     * The vertical offset for the positioned content
-     */
-    offsetY: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-    /**
-     * Target element for positioning the Tooltip (if it differs from children/trigger)
-     */
-    positionTarget: PropTypes.oneOfType([element, PropTypes.func]),
-    /**
-     * Callback fired when content is shown. When controlled, this callback is
-     * fired when the tooltip expects to be shown
-     */
-    onShowContent: PropTypes.func,
-    /**
-     * Callback fired when content is hidden. When controlled, this callback is
-     * fired when the tooltip expects to be hidden
-     */
-    onHideContent: PropTypes.func
-  } as const
+  static allowedProps = allowedProps
+  static propTypes = propTypes
 
   static defaultProps = {
-    isShowingContent: undefined,
     defaultIsShowingContent: false,
-    on: undefined,
     color: 'primary',
     placement: 'top',
     mountNode: null,
     constrain: 'window',
     offsetX: 0,
     offsetY: 0,
-    positionTarget: undefined,
     // @ts-expect-error ts-migrate(6133) FIXME: 'event' is declared but its value is never read.
     onShowContent: (event) => {},
     // @ts-expect-error ts-migrate(6133) FIXME: 'event' is declared but its value is never read.
@@ -155,14 +73,12 @@ class Tooltip extends Component<TooltipProps> {
   state = { hasFocus: false }
 
   componentDidMount() {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
   // @ts-expect-error ts-migrate(6133) FIXME: 'prevProps' is declared but its value is never rea... Remove this comment to see the full error message
   componentDidUpdate(prevProps, prevState, snapshot) {
-    // @ts-expect-error ts-migrate(2722) FIXME: Cannot invoke an object which is possibly 'undefin... Remove this comment to see the full error message
-    this.props.makeStyles()
+    this.props.makeStyles?.()
   }
 
   // @ts-expect-error ts-migrate(6133) FIXME: 'event' is declared but its value is never read.
@@ -191,6 +107,7 @@ class Tooltip extends Component<TooltipProps> {
         </Trigger>
       )
     } else if (typeof children === 'function') {
+      // @ts-expect-error FIXME: React children types are badly calculated
       return children({
         focused: hasFocus,
         // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'props' implicitly has an 'any' type.
@@ -247,7 +164,7 @@ class Tooltip extends Component<TooltipProps> {
         onFocus={this.handleFocus}
         onBlur={this.handleBlur}
       >
-        <span id={this._id} css={styles.tooltip} role="tooltip">
+        <span id={this._id} css={styles?.tooltip} role="tooltip">
           {callRenderProp(renderTip)}
         </span>
       </Popover>

package/src/Tooltip/props.ts

@@ -0,0 +1,156 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import PropTypes from 'prop-types'
+import { PositionPropTypes } from '@instructure/ui-position'
+import { element } from '@instructure/ui-prop-types'
+
+import type { PropValidators, AsElementType } from '@instructure/shared-types'
+import type {
+  PlacementPropValues,
+  PositionConstraint,
+  PositionMountNode
+} from '@instructure/ui-position'
+import React from 'react'
+import type { WithStyleProps } from '@instructure/emotion'
+
+type TooltipOwnProps = {
+  renderTip: React.ReactNode | ((...args: any[]) => any)
+  children: React.ReactNode | ((...args: any[]) => React.ReactNode)
+  isShowingContent?: boolean
+  defaultIsShowingContent?: boolean
+  as?: AsElementType
+  on?: ('click' | 'hover' | 'focus') | ('click' | 'hover' | 'focus')[]
+  color?: 'primary' | 'primary-inverse'
+  placement?: PlacementPropValues
+  mountNode?: PositionMountNode
+  constrain?: PositionConstraint
+  positionTarget?: PositionMountNode
+  offsetX?: string | number
+  offsetY?: string | number
+  onShowContent?: (...args: any[]) => any
+  onHideContent?: (...args: any[]) => any
+}
+
+type PropKeys = keyof TooltipOwnProps
+
+type AllowedPropKeys = Readonly<Array<PropKeys>>
+
+type TooltipProps = TooltipOwnProps & WithStyleProps
+
+const propTypes: PropValidators<PropKeys> = {
+  /**
+   * @param {Object} renderProps
+   * @param {Boolean} renderProps.focused - Is the Tooltip trigger focused?
+   * @param {Function} renderProps.getTriggerProps - Props to be spread onto the trigger element
+   */
+  children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
+  /**
+   * The content to render in the tooltip
+   */
+  renderTip: PropTypes.oneOfType([PropTypes.node, PropTypes.func]).isRequired,
+  /**
+   * Whether or not the tooltip content is shown, when controlled
+   */
+  isShowingContent: PropTypes.bool,
+  /**
+   * Whether or not to show the content by default, when uncontrolled
+   */
+  defaultIsShowingContent: PropTypes.bool,
+  /**
+   * the element type to render as (assumes a single child if 'as' is undefined)
+   */
+  as: PropTypes.elementType, // eslint-disable-line react/require-default-props
+  /**
+   * The action that causes the Content to display (`click`, `hover`, `focus`)
+   */
+  on: PropTypes.oneOfType([
+    PropTypes.oneOf(['click', 'hover', 'focus']),
+    PropTypes.arrayOf(PropTypes.oneOf(['click', 'hover', 'focus']))
+  ]),
+  /**
+   * The color of the tooltip content
+   */
+  color: PropTypes.oneOf(['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: PositionPropTypes.placement,
+  /**
+   * An element or a function returning an element to use as the mount node
+   * for the `<Tooltip />` (defaults to `document.body`)
+   */
+  mountNode: PositionPropTypes.mountNode,
+  /**
+   * The parent in which to constrain the tooltip.
+   * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+   * or a function returning an element
+   */
+  constrain: PositionPropTypes.constrain,
+  /**
+   * The horizontal offset for the positioned content
+   */
+  offsetX: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  /**
+   * The vertical offset for the positioned content
+   */
+  offsetY: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  /**
+   * Target element for positioning the Tooltip (if it differs from children/trigger)
+   */
+  positionTarget: PropTypes.oneOfType([element, PropTypes.func]),
+  /**
+   * Callback fired when content is shown. When controlled, this callback is
+   * fired when the tooltip expects to be shown
+   */
+  onShowContent: PropTypes.func,
+  /**
+   * Callback fired when content is hidden. When controlled, this callback is
+   * fired when the tooltip expects to be hidden
+   */
+  onHideContent: PropTypes.func
+}
+
+const allowedProps: AllowedPropKeys = [
+  'children',
+  'renderTip',
+  'isShowingContent',
+  'defaultIsShowingContent',
+  'as',
+  'on',
+  'color',
+  'placement',
+  'mountNode',
+  'constrain',
+  'offsetX',
+  'offsetY',
+  'positionTarget',
+  'onShowContent',
+  'onHideContent'
+]
+
+export type { TooltipProps }
+export { propTypes, allowedProps }