@fluentui/react-tooltip 0.0.0-nightlyfc5cfdc52420220215.1 → 0.0.0

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

@@ -1,108 +0,0 @@
-import * as React from 'react';
-import type { PositioningShorthand } from '@fluentui/react-positioning';
-import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-/**
- * Slot properties for Tooltip
- */
-export declare type TooltipSlots = {
-    content: NonNullable<Slot<'div'>>;
-};
-/**
- * Properties and state for Tooltip
- */
-declare type TooltipCommons = {
-    /**
-     * 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;
-    /**
-     * (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';
-    /**
-     * 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'> & {
-    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,6 +0,0 @@
-import type { TooltipState } from './Tooltip.types';
-export declare const tooltipClassName = "fui-Tooltip";
-/**
- * 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 +0,0 @@
-export * from './Tooltip';