@fluentui/react-tooltip 9.0.0-rc.9 → 9.0.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@fluentui/react-tooltip",
-  "version": "9.0.0-rc.9",
+  "version": "9.0.0",
   "description": "React components for building web experiences",
   "main": "lib-commonjs/index.js",
   "module": "lib/index.js",
-  "typings": "lib/index.d.ts",
+  "typings": "dist/index.d.ts",
   "sideEffects": false,
   "repository": {
     "type": "git",
@@ -28,16 +28,16 @@
   "devDependencies": {
     "@fluentui/eslint-plugin": "*",
     "@fluentui/react-conformance": "*",
-    "@fluentui/react-conformance-griffel": "9.0.0-beta.5",
+    "@fluentui/react-conformance-griffel": "9.0.0-beta.9",
     "@fluentui/scripts": "^1.0.0"
   },
   "dependencies": {
-    "@fluentui/react-portal": "9.0.0-rc.9",
-    "@fluentui/react-positioning": "9.0.0-rc.8",
-    "@fluentui/react-shared-contexts": "9.0.0-rc.7",
-    "@fluentui/react-theme": "9.0.0-rc.7",
-    "@fluentui/react-utilities": "9.0.0-rc.8",
-    "@griffel/react": "1.0.3",
+    "@fluentui/react-portal": "^9.0.0",
+    "@fluentui/react-positioning": "^9.0.0",
+    "@fluentui/react-shared-contexts": "^9.0.0",
+    "@fluentui/react-theme": "^9.0.0",
+    "@fluentui/react-utilities": "^9.0.0",
+    "@griffel/react": "1.2.0",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {
@@ -48,9 +48,7 @@
   },
   "beachball": {
     "disallowedChangeTypes": [
-      "major",
-      "minor",
-      "patch"
+      "major"
     ]
   },
   "exports": {

package/lib/Tooltip.d.ts

@@ -1 +0,0 @@
-export * from './components/Tooltip/index';

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

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

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

@@ -1,118 +0,0 @@
-import * as React from 'react';
-import type { PositioningShorthand } from '@fluentui/react-positioning';
-import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-import type { PortalProps } from '@fluentui/react-portal';
-/**
- * Slot properties for Tooltip
- */
-export declare type TooltipSlots = {
-    /**
-     * The text or JSX content of the tooltip.
-     */
-    content: NonNullable<Slot<'div'>>;
-};
-/**
- * Properties and state for Tooltip
- */
-declare type TooltipCommons = Pick<PortalProps, 'mountNode'> & {
-    /**
-     * (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.
-     */
-    relationship: 'label' | 'description' | 'inaccessible';
-    /**
-     * 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 normal
-     */
-    appearance?: 'normal' | 'inverted';
-    /**
-     * Render an arrow pointing to the target element
-     *
-     * @defaultvalue false
-     */
-    withArrow?: boolean;
-    /**
-     * Configure the positioning of the tooltip
-     *
-     * @defaultvalue above
-     */
-    positioning?: PositioningShorthand;
-    /**
-     * Control the tooltip's visibility programatically.
-     *
-     * This can be used in conjunction with onVisibleChange to modify the tooltip's show and hide behavior.
-     *
-     * If not provided, the visibility will be controlled by the tooltip itself, based on hover and focus events on the
-     * trigger (child) element.
-     */
-    visible?: boolean;
-    /**
-     * Notification when the visibility of the tooltip is changing
-     */
-    onVisibleChange?: (event: React.PointerEvent<HTMLElement> | React.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
-    /**
-     * Delay before the tooltip is shown, in milliseconds.
-     *
-     * @defaultvalue 250
-     */
-    showDelay: number;
-    /**
-     * Delay before the tooltip is hidden, in milliseconds.
-     *
-     * @defaultvalue 250
-     */
-    hideDelay: number;
-};
-/**
- * The properties that are added to the trigger of the Tooltip
- */
-export declare type TooltipTriggerProps = {
-    ref?: React.Ref<never>;
-} & Pick<React.HTMLAttributes<HTMLElement>, 'onPointerEnter' | 'onPointerLeave' | 'onFocus' | 'onBlur' | 'aria-describedby' | 'aria-labelledby' | 'aria-label'>;
-/**
- * Data for the Tooltip's onVisibleChange event.
- */
-export declare type OnVisibleChangeData = {
-    visible: boolean;
-};
-/**
- * Properties for Tooltip
- */
-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.
-     */
-    shouldRenderTooltip?: boolean;
-    /**
-     * Ref to the arrow element
-     */
-    arrowRef?: React.Ref<HTMLDivElement>;
-    /**
-     * CSS class for the arrow element
-     */
-    arrowClassName?: string;
-};
-export {};

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

@@ -1,5 +0,0 @@
-export * from './Tooltip';
-export * from './Tooltip.types';
-export * from './renderTooltip';
-export * from './useTooltip';
-export * from './useTooltipStyles';

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

@@ -1,12 +0,0 @@
-/**
- * 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/renderTooltip.d.ts

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

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

@@ -1,10 +0,0 @@
-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_unstable,
- * before being passed to renderTooltip_unstable.
- *
- * @param props - props from this instance of Tooltip
- */
-export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;

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

@@ -1,11 +0,0 @@
-import type { TooltipSlots, TooltipState } from './Tooltip.types';
-import type { SlotClassNames } from '@fluentui/react-utilities';
-/**
- * @deprecated Use `tooltipClassNames.root` instead.
- */
-export declare const tooltipClassName = "fui-Tooltip";
-export declare const tooltipClassNames: SlotClassNames<TooltipSlots>;
-/**
- * Apply styling to the Tooltip slots based on the state
- */
-export declare const useTooltipStyles_unstable: (state: TooltipState) => TooltipState;

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export { Tooltip, renderTooltip_unstable, tooltipClassName, tooltipClassNames, useTooltipStyles_unstable, useTooltip_unstable, } from './Tooltip';
-export type { OnVisibleChangeData, TooltipProps, TooltipSlots, TooltipState, TooltipTriggerProps } from './Tooltip';

package/lib-commonjs/Tooltip.d.ts

@@ -1 +0,0 @@
-export * from './components/Tooltip/index';

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

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

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

@@ -1,118 +0,0 @@
-import * as React from 'react';
-import type { PositioningShorthand } from '@fluentui/react-positioning';
-import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-import type { PortalProps } from '@fluentui/react-portal';
-/**
- * Slot properties for Tooltip
- */
-export declare type TooltipSlots = {
-    /**
-     * The text or JSX content of the tooltip.
-     */
-    content: NonNullable<Slot<'div'>>;
-};
-/**
- * Properties and state for Tooltip
- */
-declare type TooltipCommons = Pick<PortalProps, 'mountNode'> & {
-    /**
-     * (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.
-     */
-    relationship: 'label' | 'description' | 'inaccessible';
-    /**
-     * 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 normal
-     */
-    appearance?: 'normal' | 'inverted';
-    /**
-     * Render an arrow pointing to the target element
-     *
-     * @defaultvalue false
-     */
-    withArrow?: boolean;
-    /**
-     * Configure the positioning of the tooltip
-     *
-     * @defaultvalue above
-     */
-    positioning?: PositioningShorthand;
-    /**
-     * Control the tooltip's visibility programatically.
-     *
-     * This can be used in conjunction with onVisibleChange to modify the tooltip's show and hide behavior.
-     *
-     * If not provided, the visibility will be controlled by the tooltip itself, based on hover and focus events on the
-     * trigger (child) element.
-     */
-    visible?: boolean;
-    /**
-     * Notification when the visibility of the tooltip is changing
-     */
-    onVisibleChange?: (event: React.PointerEvent<HTMLElement> | React.FocusEvent<HTMLElement> | undefined, data: OnVisibleChangeData) => void;
-    /**
-     * Delay before the tooltip is shown, in milliseconds.
-     *
-     * @defaultvalue 250
-     */
-    showDelay: number;
-    /**
-     * Delay before the tooltip is hidden, in milliseconds.
-     *
-     * @defaultvalue 250
-     */
-    hideDelay: number;
-};
-/**
- * The properties that are added to the trigger of the Tooltip
- */
-export declare type TooltipTriggerProps = {
-    ref?: React.Ref<never>;
-} & Pick<React.HTMLAttributes<HTMLElement>, 'onPointerEnter' | 'onPointerLeave' | 'onFocus' | 'onBlur' | 'aria-describedby' | 'aria-labelledby' | 'aria-label'>;
-/**
- * Data for the Tooltip's onVisibleChange event.
- */
-export declare type OnVisibleChangeData = {
-    visible: boolean;
-};
-/**
- * Properties for Tooltip
- */
-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.
-     */
-    shouldRenderTooltip?: boolean;
-    /**
-     * Ref to the arrow element
-     */
-    arrowRef?: React.Ref<HTMLDivElement>;
-    /**
-     * CSS class for the arrow element
-     */
-    arrowClassName?: string;
-};
-export {};

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

@@ -1,5 +0,0 @@
-export * from './Tooltip';
-export * from './Tooltip.types';
-export * from './renderTooltip';
-export * from './useTooltip';
-export * from './useTooltipStyles';

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

@@ -1,12 +0,0 @@
-/**
- * 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-commonjs/components/Tooltip/renderTooltip.d.ts

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

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

@@ -1,10 +0,0 @@
-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_unstable,
- * before being passed to renderTooltip_unstable.
- *
- * @param props - props from this instance of Tooltip
- */
-export declare const useTooltip_unstable: (props: TooltipProps) => TooltipState;

package/lib-commonjs/components/Tooltip/useTooltipStyles.d.ts

@@ -1,11 +0,0 @@
-import type { TooltipSlots, TooltipState } from './Tooltip.types';
-import type { SlotClassNames } from '@fluentui/react-utilities';
-/**
- * @deprecated Use `tooltipClassNames.root` instead.
- */
-export declare const tooltipClassName = "fui-Tooltip";
-export declare const tooltipClassNames: SlotClassNames<TooltipSlots>;
-/**
- * Apply styling to the Tooltip slots based on the state
- */
-export declare const useTooltipStyles_unstable: (state: TooltipState) => TooltipState;

package/lib-commonjs/index.d.ts

@@ -1,2 +0,0 @@
-export { Tooltip, renderTooltip_unstable, tooltipClassName, tooltipClassNames, useTooltipStyles_unstable, useTooltip_unstable, } from './Tooltip';
-export type { OnVisibleChangeData, TooltipProps, TooltipSlots, TooltipState, TooltipTriggerProps } from './Tooltip';