@fluentui/react-tooltip 9.0.0-nightly.46b9ea7036.0 → 9.0.0-rc.1

package/dist/react-tooltip.d.ts

@@ -1,9 +1,9 @@
 import type { ComponentProps } from '@fluentui/react-utilities';
 import type { ComponentState } from '@fluentui/react-utilities';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
-import type { IntrinsicShorthandProps } from '@fluentui/react-utilities';
+import type { FluentTriggerComponent } from '@fluentui/react-utilities';
 import type { PositioningShorthand } from '@fluentui/react-positioning';
 import * as React_2 from 'react';
+import type { Slot } from '@fluentui/react-utilities';
 
 /**
  * Data for the Tooltip's onVisibleChange event.
@@ -15,32 +15,27 @@ export declare type OnVisibleChangeData = {
 /**
  * Render the final JSX of Tooltip
  */
-export declare const renderTooltip: (state: TooltipState) => JSX.Element;
+export declare const renderTooltip_unstable: (state: TooltipState) => JSX.Element;
 
 /**
  * A tooltip provides light weight contextual information on top of its target element.
  */
-export declare const Tooltip: ForwardRefComponent<TooltipProps>;
+export declare const Tooltip: React_2.FC<TooltipProps> & FluentTriggerComponent;
+
+export declare const tooltipClassName = "fui-Tooltip";
 
 /**
  * Properties and state for Tooltip
  */
-export declare type TooltipCommons = {
-    /**
-     * A tooltip can appear with the default appearance or inverted.
-     * When not specified, the default appearance is used.
-     */
-    appearance?: 'inverted';
-    /**
-     * The content displayed inside the tooltip.
-     */
-    content: React_2.ReactNode;
+declare type TooltipCommons = {
     /**
-     * Color variant with inverted colors
+     * The tooltip's visual appearance.
+     * * `normal` - Uses the theme's background and text colors.
+     * * `inverted` - Higher contrast variant that uses the theme's inverted colors.
      *
-     * @defaultvalue false
+     * @defaultvalue normal
      */
-    inverted?: boolean;
+    appearance?: 'normal' | 'inverted';
     /**
      * Render an arrow pointing to the target element
      *
@@ -67,15 +62,15 @@ export declare type TooltipCommons = {
      */
     onVisibleChange?: (event: React_2.PointerEvent<HTMLElement> | React_2.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
     /**
-     * Specifies which aria attribute to set on the trigger element.
-     * * `label` - Set aria-label to the tooltip's content. Requires content to be a string; if not, uses `labelledby`.
-     * * `labelledby` - Set aria-labelledby to the tooltip's id. The id is generated if not provided.
-     * * `describedby` - Set aria-describedby to the tooltip's id. The id is generated if not provided.
-     * * null - Do not set any aria attributes on the trigger element.
+     * (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
      *
-     * @defaultvalue label
+     * * `label` - The tooltip sets the trigger's aria-label or aria-labelledby attribute. This is useful for buttons
+     *    displaying only an icon, for example.
+     * * `description` - The tooltip sets the trigger's aria-description or aria-describedby attribute.
+     * * `inaccessible` - No aria attributes are set on the trigger. This makes the tooltip's content inaccessible to
+     *   screen readers, and should only be used if the tooltip's text is available by some other means.
      */
-    triggerAriaAttribute: 'label' | 'labelledby' | 'describedby' | null;
+    relationship: 'label' | 'description' | 'inaccessible';
     /**
      * Delay before the tooltip is shown, in milliseconds.
      *
@@ -93,36 +88,26 @@ export declare type TooltipCommons = {
 /**
  * Properties for Tooltip
  */
-export declare type TooltipProps = ComponentProps<TooltipSlots> & Partial<Omit<TooltipCommons, 'content'>> & Pick<TooltipCommons, 'content'>;
+export declare type TooltipProps = ComponentProps<TooltipSlots> & Partial<Omit<TooltipCommons, 'relationship'>> & Pick<TooltipCommons, 'relationship'> & {
+    children?: (React_2.ReactElement & {
+        ref?: React_2.Ref<unknown>;
+    }) | ((props: TooltipTriggerProps) => React_2.ReactElement | null) | null;
+};
 
 /**
  * Slot properties for Tooltip
  */
 export declare type TooltipSlots = {
-    root: Omit<IntrinsicShorthandProps<'div'>, 'children'> & {
-        /**
-         * The child is the element that triggers the Tooltip. It will have additional properties added,
-         * including events and aria properties.
-         * Alternatively, children can be a render function that takes the props and adds
-         * them to the appropriate elements.
-         */
-        children?: (React_2.ReactElement<React_2.HTMLAttributes<HTMLElement>> & {
-            ref?: React_2.Ref<unknown>;
-        }) | ((props: TooltipTriggerProps) => React_2.ReactNode) | null;
-    };
+    content: NonNullable<Slot<'div'>>;
 };
 
 /**
  * State used in rendering Tooltip
  */
 export declare type TooltipState = ComponentState<TooltipSlots> & TooltipCommons & {
+    children?: React_2.ReactElement | null;
     /**
      * Whether the tooltip should be rendered to the DOM.
-     *
-     * Normally the tooltip will only be rendered when visible. However, if
-     * triggerAriaAttribute is labelledby or describedby, the tooltip will
-     * always be rendered even when hidden so that those aria attributes
-     * to always refer to a valid DOM element.
      */
     shouldRenderTooltip?: boolean;
     /**
@@ -145,18 +130,16 @@ export declare type TooltipTriggerProps = {
 /**
  * Create the state required to render Tooltip.
  *
- * The returned state can be modified with hooks such as useTooltipStyles,
- * before being passed to renderTooltip.
+ * The returned state can be modified with hooks such as useTooltipStyles_unstable,
+ * before being passed to renderTooltip_unstable.
  *
  * @param props - props from this instance of Tooltip
- * @param ref - reference to root HTMLElement of Tooltip
- * @param defaultProps - (optional) default prop values provided by the implementing type
  */
-export declare const useTooltip: (props: TooltipProps, ref: React_2.Ref<HTMLDivElement>) => TooltipState;
+export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;
 
 /**
  * Apply styling to the Tooltip slots based on the state
  */
-export declare const useTooltipStyles: (state: TooltipState) => TooltipState;
+export declare const useTooltipStyles_unstable: (state: TooltipState) => TooltipState;
 
 export { }

package/lib/components/Tooltip/Tooltip.d.ts

@@ -1,6 +1,7 @@
+import * as React from 'react';
 import type { TooltipProps } from './Tooltip.types';
-import type { ForwardRefComponent } from '@fluentui/react-utilities';
+import type { FluentTriggerComponent } from '@fluentui/react-utilities';
 /**
  * A tooltip provides light weight contextual information on top of its target element.
  */
-export declare const Tooltip: ForwardRefComponent<TooltipProps>;
+export declare const Tooltip: React.FC<TooltipProps> & FluentTriggerComponent;

package/lib/components/Tooltip/Tooltip.js

@@ -1,15 +1,15 @@
-import * as React from 'react';
-import { useTooltip } from './useTooltip';
-import { renderTooltip } from './renderTooltip';
-import { useTooltipStyles } from './useTooltipStyles';
+import { useTooltip_unstable } from './useTooltip';
+import { renderTooltip_unstable } from './renderTooltip';
+import { useTooltipStyles_unstable } from './useTooltipStyles';
 /**
  * A tooltip provides light weight contextual information on top of its target element.
  */
 
-export var Tooltip = /*#__PURE__*/React.forwardRef(function (props, ref) {
-  var state = useTooltip(props, ref);
-  useTooltipStyles(state);
-  return renderTooltip(state);
-});
+export const Tooltip = props => {
+  const state = useTooltip_unstable(props);
+  useTooltipStyles_unstable(state);
+  return renderTooltip_unstable(state);
+};
 Tooltip.displayName = 'Tooltip';
+Tooltip.isFluentTriggerComponent = true;
 //# sourceMappingURL=Tooltip.js.map

package/lib/components/Tooltip/Tooltip.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/components/Tooltip/Tooltip.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,UAAT,QAA2B,cAA3B;AACA,SAAS,aAAT,QAA8B,iBAA9B;AACA,SAAS,gBAAT,QAAiC,oBAAjC;AAIA;;AAEG;;AACH,OAAO,IAAM,OAAO,gBAAsC,KAAK,CAAC,UAAN,CAAiB,UAAC,KAAD,EAAQ,GAAR,EAAW;AACpF,MAAM,KAAK,GAAG,UAAU,CAAC,KAAD,EAAQ,GAAR,CAAxB;AAEA,EAAA,gBAAgB,CAAC,KAAD,CAAhB;AACA,SAAO,aAAa,CAAC,KAAD,CAApB;AACD,CALyD,CAAnD;AAOP,OAAO,CAAC,WAAR,GAAsB,SAAtB","sourceRoot":""}
+{"version":3,"sources":["../../../src/components/Tooltip/Tooltip.tsx"],"names":[],"mappings":"AACA,SAAS,mBAAT,QAAoC,cAApC;AACA,SAAS,sBAAT,QAAuC,iBAAvC;AACA,SAAS,yBAAT,QAA0C,oBAA1C;AAIA;;AAEG;;AACH,OAAO,MAAM,OAAO,GAAoD,KAAK,IAAG;AAC9E,QAAM,KAAK,GAAG,mBAAmB,CAAC,KAAD,CAAjC;AAEA,EAAA,yBAAyB,CAAC,KAAD,CAAzB;AACA,SAAO,sBAAsB,CAAC,KAAD,CAA7B;AACD,CALM;AAOP,OAAO,CAAC,WAAR,GAAsB,SAAtB;AACA,OAAO,CAAC,wBAAR,GAAmC,IAAnC","sourceRoot":""}

package/lib/components/Tooltip/Tooltip.types.d.ts

@@ -1,41 +1,24 @@
 import * as React from 'react';
 import type { PositioningShorthand } from '@fluentui/react-positioning';
-import type { ComponentProps, ComponentState, IntrinsicShorthandProps } from '@fluentui/react-utilities';
+import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
 /**
  * Slot properties for Tooltip
  */
 export declare type TooltipSlots = {
-    root: Omit<IntrinsicShorthandProps<'div'>, 'children'> & {
-        /**
-         * The child is the element that triggers the Tooltip. It will have additional properties added,
-         * including events and aria properties.
-         * Alternatively, children can be a render function that takes the props and adds
-         * them to the appropriate elements.
-         */
-        children?: (React.ReactElement<React.HTMLAttributes<HTMLElement>> & {
-            ref?: React.Ref<unknown>;
-        }) | ((props: TooltipTriggerProps) => React.ReactNode) | null;
-    };
+    content: NonNullable<Slot<'div'>>;
 };
 /**
  * Properties and state for Tooltip
  */
-export declare type TooltipCommons = {
+declare type TooltipCommons = {
     /**
-     * A tooltip can appear with the default appearance or inverted.
-     * When not specified, the default appearance is used.
-     */
-    appearance?: 'inverted';
-    /**
-     * The content displayed inside the tooltip.
-     */
-    content: React.ReactNode;
-    /**
-     * Color variant with inverted colors
+     * The tooltip's visual appearance.
+     * * `normal` - Uses the theme's background and text colors.
+     * * `inverted` - Higher contrast variant that uses the theme's inverted colors.
      *
-     * @defaultvalue false
+     * @defaultvalue normal
      */
-    inverted?: boolean;
+    appearance?: 'normal' | 'inverted';
     /**
      * Render an arrow pointing to the target element
      *
@@ -62,15 +45,15 @@ export declare type TooltipCommons = {
      */
     onVisibleChange?: (event: React.PointerEvent<HTMLElement> | React.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
     /**
-     * Specifies which aria attribute to set on the trigger element.
-     * * `label` - Set aria-label to the tooltip's content. Requires content to be a string; if not, uses `labelledby`.
-     * * `labelledby` - Set aria-labelledby to the tooltip's id. The id is generated if not provided.
-     * * `describedby` - Set aria-describedby to the tooltip's id. The id is generated if not provided.
-     * * null - Do not set any aria attributes on the trigger element.
+     * (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
      *
-     * @defaultvalue label
+     * * `label` - The tooltip sets the trigger's aria-label or aria-labelledby attribute. This is useful for buttons
+     *    displaying only an icon, for example.
+     * * `description` - The tooltip sets the trigger's aria-description or aria-describedby attribute.
+     * * `inaccessible` - No aria attributes are set on the trigger. This makes the tooltip's content inaccessible to
+     *   screen readers, and should only be used if the tooltip's text is available by some other means.
      */
-    triggerAriaAttribute: 'label' | 'labelledby' | 'describedby' | null;
+    relationship: 'label' | 'description' | 'inaccessible';
     /**
      * Delay before the tooltip is shown, in milliseconds.
      *
@@ -99,18 +82,18 @@ export declare type OnVisibleChangeData = {
 /**
  * Properties for Tooltip
  */
-export declare type TooltipProps = ComponentProps<TooltipSlots> & Partial<Omit<TooltipCommons, 'content'>> & Pick<TooltipCommons, 'content'>;
+export declare type TooltipProps = ComponentProps<TooltipSlots> & Partial<Omit<TooltipCommons, 'relationship'>> & Pick<TooltipCommons, 'relationship'> & {
+    children?: (React.ReactElement & {
+        ref?: React.Ref<unknown>;
+    }) | ((props: TooltipTriggerProps) => React.ReactElement | null) | null;
+};
 /**
  * State used in rendering Tooltip
  */
 export declare type TooltipState = ComponentState<TooltipSlots> & TooltipCommons & {
+    children?: React.ReactElement | null;
     /**
      * Whether the tooltip should be rendered to the DOM.
-     *
-     * Normally the tooltip will only be rendered when visible. However, if
-     * triggerAriaAttribute is labelledby or describedby, the tooltip will
-     * always be rendered even when hidden so that those aria attributes
-     * to always refer to a valid DOM element.
      */
     shouldRenderTooltip?: boolean;
     /**
@@ -122,3 +105,4 @@ export declare type TooltipState = ComponentState<TooltipSlots> & TooltipCommons
      */
     arrowClassName?: string;
 };
+export {};

package/lib/components/Tooltip/index.d.ts

@@ -2,4 +2,4 @@ export * from './Tooltip';
 export * from './Tooltip.types';
 export * from './renderTooltip';
 export * from './useTooltip';
-export { useTooltipStyles } from './useTooltipStyles';
+export * from './useTooltipStyles';

package/lib/components/Tooltip/index.js

@@ -2,5 +2,5 @@ export * from './Tooltip';
 export * from './Tooltip.types';
 export * from './renderTooltip';
 export * from './useTooltip';
-export { useTooltipStyles } from './useTooltipStyles';
+export * from './useTooltipStyles';
 //# sourceMappingURL=index.js.map

package/lib/components/Tooltip/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/Tooltip/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/Tooltip/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC"}

package/lib/components/Tooltip/private/constants.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The height of the tooltip's arrow in pixels.
+ */
+export declare const arrowHeight = 6;
+/**
+ * The default value of the tooltip's border radius (borderRadiusMedium).
+ *
+ * Unfortunately, Popper requires it to be specified as a variable instead of using CSS.
+ * While we could use getComputedStyle, that adds a performance penalty for something that
+ * will likely never change.
+ */
+export declare const tooltipBorderRadius = 4;

package/lib/components/Tooltip/private/constants.js

@@ -0,0 +1,14 @@
+/**
+ * The height of the tooltip's arrow in pixels.
+ */
+export const arrowHeight = 6;
+/**
+ * The default value of the tooltip's border radius (borderRadiusMedium).
+ *
+ * Unfortunately, Popper requires it to be specified as a variable instead of using CSS.
+ * While we could use getComputedStyle, that adds a performance penalty for something that
+ * will likely never change.
+ */
+
+export const tooltipBorderRadius = 4;
+//# sourceMappingURL=constants.js.map

package/lib/components/Tooltip/private/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/components/Tooltip/private/constants.ts"],"names":[],"mappings":"AAAA;;AAEG;AACH,OAAO,MAAM,WAAW,GAAG,CAApB;AAEP;;;;;;AAMG;;AACH,OAAO,MAAM,mBAAmB,GAAG,CAA5B","sourceRoot":""}

package/lib/components/Tooltip/renderTooltip.d.ts

@@ -2,4 +2,4 @@ import type { TooltipState } from './Tooltip.types';
 /**
  * Render the final JSX of Tooltip
  */
-export declare const renderTooltip: (state: TooltipState) => JSX.Element;
+export declare const renderTooltip_unstable: (state: TooltipState) => JSX.Element;

package/lib/components/Tooltip/renderTooltip.js

@@ -1,4 +1,3 @@
-import { __assign } from "tslib";
 import * as React from 'react';
 import { Portal } from '@fluentui/react-portal';
 import { getSlots } from '@fluentui/react-utilities';
@@ -6,14 +5,15 @@ import { getSlots } from '@fluentui/react-utilities';
  * Render the final JSX of Tooltip
  */
 
-export var renderTooltip = function (state) {
-  var _a = getSlots(state, ['root']),
-      slots = _a.slots,
-      slotProps = _a.slotProps;
-
-  return /*#__PURE__*/React.createElement(React.Fragment, null, state.root.children, state.shouldRenderTooltip && /*#__PURE__*/React.createElement(Portal, null, /*#__PURE__*/React.createElement(slots.root, __assign({}, slotProps.root), state.withArrow && /*#__PURE__*/React.createElement("div", {
+export const renderTooltip_unstable = state => {
+  const {
+    slots,
+    slotProps
+  } = getSlots(state);
+  return /*#__PURE__*/React.createElement(React.Fragment, null, state.children, state.shouldRenderTooltip && /*#__PURE__*/React.createElement(Portal, null, /*#__PURE__*/React.createElement(slots.content, { ...slotProps.content
+  }, state.withArrow && /*#__PURE__*/React.createElement("div", {
     ref: state.arrowRef,
     className: state.arrowClassName
-  }), state.content)));
+  }), state.content.children)));
 };
 //# sourceMappingURL=renderTooltip.js.map

package/lib/components/Tooltip/renderTooltip.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/components/Tooltip/renderTooltip.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,MAAT,QAAuB,wBAAvB;AACA,SAAS,QAAT,QAAyB,2BAAzB;AAGA;;AAEG;;AACH,OAAO,IAAM,aAAa,GAAG,UAAC,KAAD,EAAoB;AACzC,MAAA,EAAA,GAAuB,QAAQ,CAAe,KAAf,EAAsB,CAAC,MAAD,CAAtB,CAA/B;AAAA,MAAE,KAAK,GAAA,EAAA,CAAA,KAAP;AAAA,MAAS,SAAS,GAAA,EAAA,CAAA,SAAlB;;AAEN,sBACE,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EACG,KAAK,CAAC,IAAN,CAAW,QADd,EAEG,KAAK,CAAC,mBAAN,iBACC,KAAA,CAAA,aAAA,CAAC,MAAD,EAAO,IAAP,eACE,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,IAAP,EAAW,QAAA,CAAA,EAAA,EAAK,SAAS,CAAC,IAAf,CAAX,EACG,KAAK,CAAC,SAAN,iBAAmB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA;AAAK,IAAA,GAAG,EAAE,KAAK,CAAC,QAAhB;AAA0B,IAAA,SAAS,EAAE,KAAK,CAAC;AAA3C,GAAA,CADtB,EAEG,KAAK,CAAC,OAFT,CADF,CAHJ,CADF;AAaD,CAhBM","sourceRoot":""}
+{"version":3,"sources":["../../../src/components/Tooltip/renderTooltip.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,MAAT,QAAuB,wBAAvB;AACA,SAAS,QAAT,QAAyB,2BAAzB;AAGA;;AAEG;;AACH,OAAO,MAAM,sBAAsB,GAAI,KAAD,IAAwB;AAC5D,QAAM;AAAE,IAAA,KAAF;AAAS,IAAA;AAAT,MAAuB,QAAQ,CAAe,KAAf,CAArC;AAEA,sBACE,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EACG,KAAK,CAAC,QADT,EAEG,KAAK,CAAC,mBAAN,iBACC,KAAA,CAAA,aAAA,CAAC,MAAD,EAAO,IAAP,eACE,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,OAAP,EAAc,EAAA,GAAK,SAAS,CAAC;AAAf,GAAd,EACG,KAAK,CAAC,SAAN,iBAAmB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA;AAAK,IAAA,GAAG,EAAE,KAAK,CAAC,QAAhB;AAA0B,IAAA,SAAS,EAAE,KAAK,CAAC;AAA3C,GAAA,CADtB,EAEG,KAAK,CAAC,OAAN,CAAc,QAFjB,CADF,CAHJ,CADF;AAaD,CAhBM","sourceRoot":""}

package/lib/components/Tooltip/useTooltip.d.ts

@@ -1,13 +1,10 @@
-import * as React from 'react';
 import type { TooltipProps, TooltipState } from './Tooltip.types';
 /**
  * Create the state required to render Tooltip.
  *
- * The returned state can be modified with hooks such as useTooltipStyles,
- * before being passed to renderTooltip.
+ * The returned state can be modified with hooks such as useTooltipStyles_unstable,
+ * before being passed to renderTooltip_unstable.
  *
  * @param props - props from this instance of Tooltip
- * @param ref - reference to root HTMLElement of Tooltip
- * @param defaultProps - (optional) default prop values provided by the implementing type
  */
-export declare const useTooltip: (props: TooltipProps, ref: React.Ref<HTMLDivElement>) => TooltipState;
+export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;