@fluentui/react-tooltip 0.0.0-nightly65dd5f749420211213.1 → 0.0.0-nightly695230dc7220220301.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,34 +15,37 @@ 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 = {
+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.
+     * (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
+     *
+     * * `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.
      */
-    content: React_2.ReactNode;
+    relationship: 'label' | 'description' | 'inaccessible';
     /**
-     * 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
      *
@@ -68,16 +71,6 @@ export declare type TooltipCommons = {
      * Notification when the visibility of the tooltip is changing
      */
     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.
-     *
-     * @defaultvalue label
-     */
-    triggerAriaAttribute: 'label' | 'labelledby' | 'describedby' | null;
     /**
      * Delay before the tooltip is shown, in milliseconds.
      *
@@ -95,36 +88,35 @@ 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'> & {
+    /**
+     * The tooltip can have a single JSX child, or a render function that accepts TooltipTriggerProps.
+     *
+     * If no child is provided, the tooltip's target must be set with the `positioning` prop, and its
+     * visibility must be controlled with the `visible` prop.
+     */
+    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;
-    };
+    /**
+     * The text or JSX content of the tooltip.
+     */
+    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;
     /**
@@ -147,18 +139,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/Tooltip.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tooltip.js","sourceRoot":"","sources":["../src/Tooltip.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"Tooltip.js","sourceRoot":"../src/","sources":["Tooltip.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC","sourcesContent":["export * from './components/Tooltip/index';\n"]}

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 const Tooltip = /*#__PURE__*/React.forwardRef((props, ref) => {
-  const 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,MAAM,OAAO,gBAAsC,KAAK,CAAC,UAAN,CAAiB,CAAC,KAAD,EAAQ,GAAR,KAAe;AACxF,QAAM,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":["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","sourcesContent":["import * as React from 'react';\nimport { useTooltip_unstable } from './useTooltip';\nimport { renderTooltip_unstable } from './renderTooltip';\nimport { useTooltipStyles_unstable } from './useTooltipStyles';\nimport type { TooltipProps } from './Tooltip.types';\nimport type { FluentTriggerComponent } from '@fluentui/react-utilities';\n\n/**\n * A tooltip provides light weight contextual information on top of its target element.\n */\nexport const Tooltip: React.FC<TooltipProps> & FluentTriggerComponent = props => {\n  const state = useTooltip_unstable(props);\n\n  useTooltipStyles_unstable(state);\n  return renderTooltip_unstable(state);\n};\n\nTooltip.displayName = 'Tooltip';\nTooltip.isFluentTriggerComponent = true;\n"],"sourceRoot":"../src/"}

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

@@ -1,41 +1,37 @@
 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;
-    };
+    /**
+     * The text or JSX content of the tooltip.
+     */
+    content: NonNullable<Slot<'div'>>;
 };
 /**
  * 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';
+declare type TooltipCommons = {
     /**
-     * The content displayed inside the tooltip.
+     * (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.
+     *
+     * * `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.
      */
-    content: React.ReactNode;
+    relationship: 'label' | 'description' | 'inaccessible';
     /**
-     * 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
      *
@@ -61,16 +57,6 @@ export declare type TooltipCommons = {
      * Notification when the visibility of the tooltip is changing
      */
     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.
-     *
-     * @defaultvalue label
-     */
-    triggerAriaAttribute: 'label' | 'labelledby' | 'describedby' | null;
     /**
      * Delay before the tooltip is shown, in milliseconds.
      *
@@ -99,18 +85,24 @@ 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'> & {
+    /**
+     * The tooltip can have a single JSX child, or a render function that accepts TooltipTriggerProps.
+     *
+     * If no child is provided, the tooltip's target must be set with the `positioning` prop, and its
+     * visibility must be controlled with the `visible` prop.
+     */
+    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 +114,4 @@ export declare type TooltipState = ComponentState<TooltipSlots> & TooltipCommons
      */
     arrowClassName?: string;
 };
+export {};

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

@@ -1 +1 @@
-{"version":3,"file":"Tooltip.types.js","sourceRoot":"","sources":["../../../src/components/Tooltip/Tooltip.types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"Tooltip.types.js","sourceRoot":"../src/","sources":["components/Tooltip/Tooltip.types.ts"],"names":[],"mappings":"","sourcesContent":["import * as React from 'react';\nimport type { PositioningShorthand } from '@fluentui/react-positioning';\nimport type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\n\n/**\n * Slot properties for Tooltip\n */\nexport type TooltipSlots = {\n  /**\n   * The text or JSX content of the tooltip.\n   */\n  content: NonNullable<Slot<'div'>>;\n};\n\n/**\n * Properties and state for Tooltip\n */\ntype TooltipCommons = {\n  /**\n   * (Required) Specifies whether this tooltip is acting as the description or label of its trigger element.\n   *\n   * * `label` - The tooltip sets the trigger's aria-label or aria-labelledby attribute. This is useful for buttons\n   *    displaying only an icon, for example.\n   * * `description` - The tooltip sets the trigger's aria-description or aria-describedby attribute.\n   * * `inaccessible` - No aria attributes are set on the trigger. This makes the tooltip's content inaccessible to\n   *   screen readers, and should only be used if the tooltip's text is available by some other means.\n   */\n  relationship: 'label' | 'description' | 'inaccessible';\n\n  /**\n   * The tooltip's visual appearance.\n   * * `normal` - Uses the theme's background and text colors.\n   * * `inverted` - Higher contrast variant that uses the theme's inverted colors.\n   *\n   * @defaultvalue normal\n   */\n  appearance?: 'normal' | 'inverted';\n\n  /**\n   * Render an arrow pointing to the target element\n   *\n   * @defaultvalue false\n   */\n  withArrow?: boolean;\n\n  /**\n   * Configure the positioning of the tooltip\n   *\n   * @defaultvalue above\n   */\n  positioning?: PositioningShorthand;\n\n  /**\n   * Control the tooltip's visibility programatically.\n   *\n   * This can be used in conjunction with onVisibleChange to modify the tooltip's show and hide behavior.\n   *\n   * If not provided, the visibility will be controlled by the tooltip itself, based on hover and focus events on the\n   * trigger (child) element.\n   */\n  visible?: boolean;\n\n  /**\n   * Notification when the visibility of the tooltip is changing\n   */\n  onVisibleChange?: (\n    event: React.PointerEvent<HTMLElement> | React.FocusEvent<HTMLElement> | undefined,\n    data: OnVisibleChangeData,\n  ) => void;\n\n  /**\n   * Delay before the tooltip is shown, in milliseconds.\n   *\n   * @defaultvalue 250\n   */\n  showDelay: number;\n\n  /**\n   * Delay before the tooltip is hidden, in milliseconds.\n   *\n   * @defaultvalue 250\n   */\n  hideDelay: number;\n};\n\n/**\n * The properties that are added to the trigger of the Tooltip\n */\nexport type TooltipTriggerProps = {\n  ref?: React.Ref<never>;\n} & Pick<\n  React.HTMLAttributes<HTMLElement>,\n  'onPointerEnter' | 'onPointerLeave' | 'onFocus' | 'onBlur' | 'aria-describedby' | 'aria-labelledby' | 'aria-label'\n>;\n\n/**\n * Data for the Tooltip's onVisibleChange event.\n */\nexport type OnVisibleChangeData = {\n  visible: boolean;\n};\n\n/**\n * Properties for Tooltip\n */\nexport type TooltipProps = ComponentProps<TooltipSlots> &\n  Partial<Omit<TooltipCommons, 'relationship'>> &\n  Pick<TooltipCommons, 'relationship'> & {\n    /**\n     * The tooltip can have a single JSX child, or a render function that accepts TooltipTriggerProps.\n     *\n     * If no child is provided, the tooltip's target must be set with the `positioning` prop, and its\n     * visibility must be controlled with the `visible` prop.\n     */\n    children?:\n      | (React.ReactElement & { ref?: React.Ref<unknown> })\n      | ((props: TooltipTriggerProps) => React.ReactElement | null)\n      | null;\n  };\n\n/**\n * State used in rendering Tooltip\n */\nexport type TooltipState = ComponentState<TooltipSlots> &\n  TooltipCommons & {\n    children?: React.ReactElement | null;\n\n    /**\n     * Whether the tooltip should be rendered to the DOM.\n     */\n    shouldRenderTooltip?: boolean;\n\n    /**\n     * Ref to the arrow element\n     */\n    arrowRef?: React.Ref<HTMLDivElement>;\n\n    /**\n     * CSS class for the arrow element\n     */\n    arrowClassName?: string;\n  };\n"]}

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,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"../src/","sources":["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","sourcesContent":["export * from './Tooltip';\nexport * from './Tooltip.types';\nexport * from './renderTooltip';\nexport * from './useTooltip';\nexport * from './useTooltipStyles';\n"]}

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":["components/Tooltip/private/constants.ts"],"names":[],"mappings":"AAAA;;AAEG;AACH,OAAO,MAAM,WAAW,GAAG,CAApB;AAEP;;;;;;AAMG;;AACH,OAAO,MAAM,mBAAmB,GAAG,CAA5B","sourcesContent":["/**\n * The height of the tooltip's arrow in pixels.\n */\nexport const arrowHeight = 6;\n\n/**\n * The default value of the tooltip's border radius (borderRadiusMedium).\n *\n * Unfortunately, Popper requires it to be specified as a variable instead of using CSS.\n * While we could use getComputedStyle, that adds a performance penalty for something that\n * will likely never change.\n */\nexport const tooltipBorderRadius = 4;\n"],"sourceRoot":"../src/"}

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

@@ -5,15 +5,15 @@ import { getSlots } from '@fluentui/react-utilities';
  * Render the final JSX of Tooltip
  */
 
-export const renderTooltip = state => {
+export const renderTooltip_unstable = state => {
   const {
     slots,
     slotProps
-  } = getSlots(state, ['root']);
-  return /*#__PURE__*/React.createElement(React.Fragment, null, state.root.children, state.shouldRenderTooltip && /*#__PURE__*/React.createElement(Portal, null, /*#__PURE__*/React.createElement(slots.root, { ...slotProps.root
+  } = 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,MAAM,aAAa,GAAI,KAAD,IAAwB;AACnD,QAAM;AAAE,IAAA,KAAF;AAAS,IAAA;AAAT,MAAuB,QAAQ,CAAe,KAAf,EAAsB,CAAC,MAAD,CAAtB,CAArC;AAEA,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,EAAA,GAAK,SAAS,CAAC;AAAf,GAAX,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":["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","sourcesContent":["import * as React from 'react';\nimport { Portal } from '@fluentui/react-portal';\nimport { getSlots } from '@fluentui/react-utilities';\nimport type { TooltipSlots, TooltipState } from './Tooltip.types';\n\n/**\n * Render the final JSX of Tooltip\n */\nexport const renderTooltip_unstable = (state: TooltipState) => {\n  const { slots, slotProps } = getSlots<TooltipSlots>(state);\n\n  return (\n    <>\n      {state.children}\n      {state.shouldRenderTooltip && (\n        <Portal>\n          <slots.content {...slotProps.content}>\n            {state.withArrow && <div ref={state.arrowRef} className={state.arrowClassName} />}\n            {state.content.children}\n          </slots.content>\n        </Portal>\n      )}\n    </>\n  );\n};\n"],"sourceRoot":"../src/"}

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;

package/lib/components/Tooltip/useTooltip.js

@@ -1,24 +1,18 @@
 import * as React from 'react';
 import { mergeArrowOffset, resolvePositioningShorthand, usePopper } from '@fluentui/react-positioning';
 import { TooltipContext, useFluent } from '@fluentui/react-shared-contexts';
-import { applyTriggerPropsToChildren, getNativeElementProps, useControllableState, useId, useIsomorphicLayoutEffect, useIsSSR, useMergedRefs, useTimeout } from '@fluentui/react-utilities'; // Style values that are required for popper to properly position the tooltip
-
-const tooltipBorderRadius = 4; // Update the root's borderRadius in useTooltipStyles.ts if this changes
-
-const arrowHeight = 6; // Update the arrow's width/height in useTooltipStyles.ts if this changes
-
+import { applyTriggerPropsToChildren, resolveShorthand, useControllableState, useMergedEventCallbacks, useId, useIsomorphicLayoutEffect, useIsSSR, useMergedRefs, useTimeout, getTriggerChild } from '@fluentui/react-utilities';
+import { arrowHeight, tooltipBorderRadius } from './private/constants';
 /**
  * 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 const useTooltip = (props, ref) => {
+export const useTooltip_unstable = props => {
   var _a, _b, _c, _d;
 
   const context = React.useContext(TooltipContext);
@@ -28,12 +22,13 @@ export const useTooltip = (props, ref) => {
   } = useFluent();
   const [setDelayTimeout, clearDelayTimeout] = useTimeout();
   const {
+    appearance,
+    children,
     content,
-    inverted,
     withArrow,
     positioning,
     onVisibleChange,
-    triggerAriaAttribute = 'label',
+    relationship,
     showDelay = 250,
     hideDelay = 250
   } = props;
@@ -54,27 +49,26 @@ export const useTooltip = (props, ref) => {
     });
   }, [clearDelayTimeout, setVisibleInternal, onVisibleChange]);
   const state = {
-    content,
-    inverted,
     withArrow,
     positioning,
     showDelay,
     hideDelay,
-    triggerAriaAttribute,
+    relationship,
     visible,
     shouldRenderTooltip: visible,
-    appearance: props.appearance,
+    appearance,
     // Slots
     components: {
-      root: 'div'
+      content: 'div'
     },
-    root: getNativeElementProps('div', {
-      role: 'tooltip',
-      ...props,
-      ref,
-      id: useId('tooltip-', props.id)
+    content: resolveShorthand(content, {
+      defaultProps: {
+        role: 'tooltip'
+      },
+      required: true
     })
   };
+  state.content.id = useId('tooltip-', state.content.id);
   const popperOptions = {
     enabled: state.visible,
     arrowPadding: 2 * tooltipBorderRadius,
@@ -93,7 +87,7 @@ export const useTooltip = (props, ref) => {
     containerRef,
     arrowRef
   } = usePopper(popperOptions);
-  state.root.ref = useMergedRefs(state.root.ref, containerRef);
+  state.content.ref = useMergedRefs(state.content.ref, containerRef);
   state.arrowRef = arrowRef; // When this tooltip is visible, hide any other tooltips, and register it
   // as the visibleTooltip with the TooltipContext.
   // Also add a listener on document to hide the tooltip if Escape is pressed
@@ -161,54 +155,39 @@ export const useTooltip = (props, ref) => {
   }, [setDelayTimeout, setVisible, state.hideDelay, targetDocument]); // Cancel the hide timer when the pointer enters the tooltip, and restart it when the mouse leaves.
   // This keeps the tooltip visible when the pointer is moved over it.
 
-  state.root.onPointerEnter = useMergedCallbacks(state.root.onPointerEnter, clearDelayTimeout);
-  state.root.onPointerLeave = useMergedCallbacks(state.root.onPointerLeave, onLeaveTrigger);
-  const child = /*#__PURE__*/React.isValidElement(state.root.children) ? state.root.children : undefined; // The props to add to the trigger element (child)
+  state.content.onPointerEnter = useMergedEventCallbacks(state.content.onPointerEnter, clearDelayTimeout);
+  state.content.onPointerLeave = useMergedEventCallbacks(state.content.onPointerLeave, onLeaveTrigger);
+  const child = /*#__PURE__*/React.isValidElement(children) ? getTriggerChild(children) : undefined;
+  const triggerAriaProps = {};
 
-  const triggerProps = {
-    onPointerEnter: useMergedCallbacks((_a = child === null || child === void 0 ? void 0 : child.props) === null || _a === void 0 ? void 0 : _a.onPointerEnter, onEnterTrigger),
-    onPointerLeave: useMergedCallbacks((_b = child === null || child === void 0 ? void 0 : child.props) === null || _b === void 0 ? void 0 : _b.onPointerLeave, onLeaveTrigger),
-    onFocus: useMergedCallbacks((_c = child === null || child === void 0 ? void 0 : child.props) === null || _c === void 0 ? void 0 : _c.onFocus, onEnterTrigger),
-    onBlur: useMergedCallbacks((_d = child === null || child === void 0 ? void 0 : child.props) === null || _d === void 0 ? void 0 : _d.onBlur, onLeaveTrigger)
-  }; // If the target prop is not provided, attach targetRef to the trigger element's ref prop
+  if (relationship === 'label') {
+    // aria-label only works if the content is a string. Otherwise, need to use aria-labelledby.
+    if (typeof state.content.children === 'string') {
+      triggerAriaProps['aria-label'] = state.content.children;
+    } else if (!isServerSideRender) {
+      triggerAriaProps['aria-labelledby'] = state.content.id; // Always render the tooltip even if hidden, so that aria-labelledby refers to a valid element
 
-  const childWithRef = child;
-  const childTargetRef = useMergedRefs(childWithRef === null || childWithRef === void 0 ? void 0 : childWithRef.ref, targetRef);
-
-  if (popperOptions.target === undefined) {
-    triggerProps.ref = childTargetRef;
-  }
+      state.shouldRenderTooltip = true;
+    }
+  } else if (relationship === 'description') {
+    if (!isServerSideRender) {
+      triggerAriaProps['aria-describedby'] = state.content.id; // Always render the tooltip even if hidden, so that aria-describedby refers to a valid element
 
-  if (state.triggerAriaAttribute === 'label') {
-    // aria-label only works if the content is a string. Otherwise, need to use labelledby.
-    if (typeof state.content === 'string') {
-      triggerProps['aria-label'] = state.content;
-    } else {
-      state.triggerAriaAttribute = 'labelledby';
+      state.shouldRenderTooltip = true;
     }
   }
 
-  if (state.triggerAriaAttribute === 'labelledby' && !isServerSideRender) {
-    triggerProps['aria-labelledby'] = state.root.id; // Always render the tooltip even if hidden, so that aria-labelledby refers to a valid element
+  const childTargetRef = useMergedRefs(child === null || child === void 0 ? void 0 : child.ref, targetRef); // Apply the trigger props to the child, either by calling the render function, or cloning with the new props
 
-    state.shouldRenderTooltip = true;
-  } else if (state.triggerAriaAttribute === 'describedby' && !isServerSideRender) {
-    triggerProps['aria-describedby'] = state.root.id;
-    state.shouldRenderTooltip = true;
-  } // Apply the trigger props to the child, either by calling the render function, or cloning with the new props
-
-
-  state.root.children = applyTriggerPropsToChildren(state.root.children, triggerProps);
+  state.children = applyTriggerPropsToChildren(children, { ...triggerAriaProps,
+    ...(child === null || child === void 0 ? void 0 : child.props),
+    // If the target prop is not provided, attach targetRef to the trigger element's ref prop
+    ref: popperOptions.target === undefined ? childTargetRef : child === null || child === void 0 ? void 0 : child.ref,
+    onPointerEnter: useMergedEventCallbacks((_a = child === null || child === void 0 ? void 0 : child.props) === null || _a === void 0 ? void 0 : _a.onPointerEnter, onEnterTrigger),
+    onPointerLeave: useMergedEventCallbacks((_b = child === null || child === void 0 ? void 0 : child.props) === null || _b === void 0 ? void 0 : _b.onPointerLeave, onLeaveTrigger),
+    onFocus: useMergedEventCallbacks((_c = child === null || child === void 0 ? void 0 : child.props) === null || _c === void 0 ? void 0 : _c.onFocus, onEnterTrigger),
+    onBlur: useMergedEventCallbacks((_d = child === null || child === void 0 ? void 0 : child.props) === null || _d === void 0 ? void 0 : _d.onBlur, onLeaveTrigger)
+  });
   return state;
 };
-/**
- * Combine up to two event callbacks into a single function that calls them in order
- */
-
-const useMergedCallbacks = (callback1, callback2) => {
-  return React.useCallback(ev => {
-    callback1 === null || callback1 === void 0 ? void 0 : callback1(ev);
-    callback2 === null || callback2 === void 0 ? void 0 : callback2(ev);
-  }, [callback1, callback2]);
-};
 //# sourceMappingURL=useTooltip.js.map