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

package/src/index.ts

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

package/types/Tooltip/index.d.ts

@@ -1,8 +1,7 @@
 /** @jsx jsx */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
 import { jsx } from '@instructure/emotion';
-import { TooltipProps } from './types';
+import type { TooltipProps } from './props';
 /**
 ---
 category: components
@@ -10,93 +9,50 @@ category: components
 **/
 declare class Tooltip extends Component<TooltipProps> {
     static readonly componentId = "Tooltip";
-    static propTypes: {
-        makeStyles: PropTypes.Requireable<(...args: any[]) => any>;
-        styles: PropTypes.Requireable<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.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
-        /**
-         * The content to render in the tooltip
-         */
-        renderTip: PropTypes.Validator<string | number | boolean | {} | PropTypes.ReactElementLike | PropTypes.ReactNodeArray>;
-        /**
-         * Whether or not the tooltip content is shown, when controlled
-         */
-        isShowingContent: PropTypes.Requireable<boolean>;
-        /**
-         * Whether or not to show the content by default, when uncontrolled
-         */
-        defaultIsShowingContent: PropTypes.Requireable<boolean>;
-        /**
-         * the element type to render as (assumes a single child if 'as' is undefined)
-         */
-        as: PropTypes.Requireable<PropTypes.ReactComponentLike>;
-        /**
-         * The action that causes the Content to display (`click`, `hover`, `focus`)
-         */
-        on: PropTypes.Requireable<string | (string | null | undefined)[]>;
-        /**
-         * The color of the tooltip content
-         */
-        color: PropTypes.Requireable<string>;
-        /**
-         * 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: PropTypes.Requireable<string>;
-        /**
-         * An element or a function returning an element to use as the mount node
-         * for the `<Tooltip />` (defaults to `document.body`)
-         */
-        mountNode: PropTypes.Requireable<Element | PropTypes.ReactElementLike | ((...args: any[]) => any)>;
-        /**
-         * The parent in which to constrain the tooltip.
-         * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
-         * or a function returning an element
-         */
-        constrain: PropTypes.Requireable<string | Element | PropTypes.ReactElementLike | ((...args: any[]) => any)>;
-        /**
-         * The horizontal offset for the positioned content
-         */
-        offsetX: PropTypes.Requireable<string | number>;
-        /**
-         * The vertical offset for the positioned content
-         */
-        offsetY: PropTypes.Requireable<string | number>;
-        /**
-         * Target element for positioning the Tooltip (if it differs from children/trigger)
-         */
-        positionTarget: PropTypes.Requireable<Element | ((...args: any[]) => any) | PropTypes.ReactElementLike>;
-        /**
-         * Callback fired when content is shown. When controlled, this callback is
-         * fired when the tooltip expects to be shown
-         */
-        onShowContent: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * Callback fired when content is hidden. When controlled, this callback is
-         * fired when the tooltip expects to be hidden
-         */
-        onHideContent: PropTypes.Requireable<(...args: any[]) => any>;
-    };
+    static allowedProps: readonly (keyof {
+        renderTip: import("react").ReactNode | ((...args: any[]) => any);
+        children: import("react").ReactNode | ((...args: any[]) => import("react").ReactNode);
+        isShowingContent?: boolean | undefined;
+        defaultIsShowingContent?: boolean | undefined;
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        on?: "click" | "hover" | "focus" | ("click" | "hover" | "focus")[] | undefined;
+        color?: "primary" | "primary-inverse" | undefined;
+        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;
+    })[];
+    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);
+        isShowingContent?: boolean | undefined;
+        defaultIsShowingContent?: boolean | undefined;
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        on?: "click" | "hover" | "focus" | ("click" | "hover" | "focus")[] | undefined;
+        color?: "primary" | "primary-inverse" | undefined;
+        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;
+    }>;
     static defaultProps: {
-        isShowingContent: undefined;
-        defaultIsShowingContent: boolean;
-        on: undefined;
-        color: string;
-        placement: string;
-        mountNode: null;
-        constrain: string;
-        offsetX: number;
-        offsetY: number;
-        positionTarget: undefined;
-        onShowContent: (event: any) => void;
-        onHideContent: (event: any, { documentClick }: {
+        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;
     };

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;AACjC,OAAO,SAAS,MAAM,YAAY,CAAA;AAclC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAEtC;;;;GAIG;AACH,cAEM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,SAAS;;;QAKd;;;;WAIG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAKH;;WAEG;;QAEH;;;;;WAKG;;QAEH;;;WAGG;;QAEH;;;;WAIG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;;WAGG;;QAEH;;;WAGG;;MAEJ;IAED,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;MAelB;IAED,GAAG,SAAiB;IACpB,KAAK;;MAAsB;IAE3B,iBAAiB;IAMjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAMjD,WAAW,uBAEV;IAGD,UAAU,uBAET;IAED,aAAa;IA+Bb,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;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"}

package/types/Tooltip/{types.d.ts → props.d.ts}

@@ -1,10 +1,10 @@
-/// <reference types="react" />
-import { AsElementType } from '@instructure/shared-types';
+import type { PropValidators, AsElementType } from '@instructure/shared-types';
 import type { PlacementPropValues, PositionConstraint, PositionMountNode } from '@instructure/ui-position';
-export declare type TooltipProps = {
-    makeStyles?: (...args: any[]) => any;
-    styles?: any;
+import React from 'react';
+import type { WithStyleProps } from '@instructure/emotion';
+declare type TooltipOwnProps = {
     renderTip: React.ReactNode | ((...args: any[]) => any);
+    children: React.ReactNode | ((...args: any[]) => React.ReactNode);
     isShowingContent?: boolean;
     defaultIsShowingContent?: boolean;
     as?: AsElementType;
@@ -19,4 +19,11 @@ export declare type TooltipProps = {
     onShowContent?: (...args: any[]) => any;
     onHideContent?: (...args: any[]) => any;
 };
-//# sourceMappingURL=types.d.ts.map
+declare type PropKeys = keyof TooltipOwnProps;
+declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
+declare type TooltipProps = TooltipOwnProps & WithStyleProps;
+declare const propTypes: PropValidators<PropKeys>;
+declare const allowedProps: AllowedPropKeys;
+export type { TooltipProps };
+export { propTypes, allowedProps };
+//# sourceMappingURL=props.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Tooltip/props.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,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,CAAA;AAEpD,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA0EvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAgBnB,CAAA;AAED,YAAY,EAAE,YAAY,EAAE,CAAA;AAC5B,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/types';
+export type { TooltipProps } from './Tooltip/props';
 //# sourceMappingURL=index.d.ts.map

package/LICENSE.md

@@ -1,27 +0,0 @@
----
-title: The MIT License (MIT)
-category: Getting Started
-order: 9
----
-
-# The MIT License (MIT)
-
-Copyright (c) 2015 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.

package/es/Tooltip/types.js

@@ -1 +0,0 @@
-export {};

package/lib/Tooltip/types.js

@@ -1 +0,0 @@
-"use strict";

package/src/Tooltip/types.ts

@@ -1,49 +0,0 @@
-/*
- * 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 { AsElementType } from '@instructure/shared-types'
-import type {
-  PlacementPropValues,
-  PositionConstraint,
-  PositionMountNode
-} from '@instructure/ui-position'
-
-export type TooltipProps = {
-  makeStyles?: (...args: any[]) => any
-  styles?: any
-  renderTip: React.ReactNode | ((...args: any[]) => any)
-  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
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/Tooltip/types.ts"],"names":[],"mappings":";AAwBA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AAEjC,oBAAY,YAAY,GAAG;IACzB,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACpC,MAAM,CAAC,EAAE,GAAG,CAAA;IACZ,SAAS,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACtD,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"}