@huin-core/react-tooltip 1.0.1 → 1.0.3

package/dist/index.d.mts

@@ -0,0 +1,100 @@
+import * as React$1 from 'react';
+import React__default from 'react';
+import { Portal } from '@huin-core/react-portal';
+import * as PopperPrimitive from '@huin-core/react-popper';
+import { DismissableLayer } from '@huin-core/react-dismissable-layer';
+import { Primitive } from '@huin-core/react-primitive';
+
+type PrimitiveButtonProps = React__default.ComponentPropsWithoutRef<typeof Primitive.button>;
+interface TooltipTriggerProps extends PrimitiveButtonProps {
+}
+declare const TooltipTrigger: React__default.ForwardRefExoticComponent<TooltipTriggerProps & React__default.RefAttributes<HTMLButtonElement>>;
+
+interface TooltipProps {
+    children?: React$1.ReactNode;
+    open?: boolean;
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * The duration from when the pointer enters the trigger until the tooltip gets opened. This will
+     * override the prop with the same name passed to Provider.
+     * @defaultValue 700
+     */
+    delayDuration?: number;
+    /**
+     * When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
+     * @defaultValue false
+     */
+    disableHoverableContent?: boolean;
+}
+declare const Tooltip: React$1.FC<TooltipProps>;
+declare const Root: React$1.FC<TooltipProps>;
+
+type PortalProps = React.ComponentPropsWithoutRef<typeof Portal>;
+interface TooltipPortalProps {
+    children?: React.ReactNode;
+    /**
+     * Specify a container element to portal the content into.
+     */
+    container?: PortalProps["container"];
+    /**
+     * Used to force mounting when more control is needed. Useful when
+     * controlling animation with React animation libraries.
+     */
+    forceMount?: true;
+}
+declare const TooltipPortal: React.FC<TooltipPortalProps>;
+
+interface TooltipContentProps extends TooltipContentImplProps {
+    /**
+     * Used to force mounting when more control is needed. Useful when
+     * controlling animation with React animation libraries.
+     */
+    forceMount?: true;
+}
+declare const TooltipContent: React__default.ForwardRefExoticComponent<TooltipContentProps & React__default.RefAttributes<HTMLDivElement>>;
+type DismissableLayerProps = React__default.ComponentPropsWithoutRef<typeof DismissableLayer>;
+type PopperContentProps = React__default.ComponentPropsWithoutRef<typeof PopperPrimitive.Content>;
+interface TooltipContentImplProps extends Omit<PopperContentProps, "onPlaced"> {
+    /**
+     * A more descriptive label for accessibility purpose
+     */
+    "aria-label"?: string;
+    /**
+     * Event handler called when the escape key is down.
+     * Can be prevented.
+     */
+    onEscapeKeyDown?: DismissableLayerProps["onEscapeKeyDown"];
+    /**
+     * Event handler called when the a `pointerdown` event happens outside of the `Tooltip`.
+     * Can be prevented.
+     */
+    onPointerDownOutside?: DismissableLayerProps["onPointerDownOutside"];
+}
+
+interface TooltipProviderProps {
+    children: React__default.ReactNode;
+    /**
+     * The duration from when the pointer enters the trigger until the tooltip gets opened.
+     * @defaultValue 700
+     */
+    delayDuration?: number;
+    /**
+     * How much time a user has to enter another trigger without incurring a delay again.
+     * @defaultValue 300
+     */
+    skipDelayDuration?: number;
+    /**
+     * When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
+     * @defaultValue false
+     */
+    disableHoverableContent?: boolean;
+}
+declare const TooltipProvider: React__default.FC<TooltipProviderProps>;
+
+type PopperArrowProps = React__default.ComponentPropsWithoutRef<typeof PopperPrimitive.Arrow>;
+interface TooltipArrowProps extends PopperArrowProps {
+}
+declare const TooltipArrow: React__default.ForwardRefExoticComponent<TooltipArrowProps & React__default.RefAttributes<SVGSVGElement>>;
+
+export { Root, Tooltip, TooltipArrow, type TooltipArrowProps, TooltipContent, type TooltipContentProps, TooltipPortal, type TooltipPortalProps, type TooltipProps, TooltipProvider, type TooltipProviderProps, TooltipTrigger, type TooltipTriggerProps };

package/dist/index.d.ts

@@ -0,0 +1,100 @@
+import * as React$1 from 'react';
+import React__default from 'react';
+import { Portal } from '@huin-core/react-portal';
+import * as PopperPrimitive from '@huin-core/react-popper';
+import { DismissableLayer } from '@huin-core/react-dismissable-layer';
+import { Primitive } from '@huin-core/react-primitive';
+
+type PrimitiveButtonProps = React__default.ComponentPropsWithoutRef<typeof Primitive.button>;
+interface TooltipTriggerProps extends PrimitiveButtonProps {
+}
+declare const TooltipTrigger: React__default.ForwardRefExoticComponent<TooltipTriggerProps & React__default.RefAttributes<HTMLButtonElement>>;
+
+interface TooltipProps {
+    children?: React$1.ReactNode;
+    open?: boolean;
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    /**
+     * The duration from when the pointer enters the trigger until the tooltip gets opened. This will
+     * override the prop with the same name passed to Provider.
+     * @defaultValue 700
+     */
+    delayDuration?: number;
+    /**
+     * When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
+     * @defaultValue false
+     */
+    disableHoverableContent?: boolean;
+}
+declare const Tooltip: React$1.FC<TooltipProps>;
+declare const Root: React$1.FC<TooltipProps>;
+
+type PortalProps = React.ComponentPropsWithoutRef<typeof Portal>;
+interface TooltipPortalProps {
+    children?: React.ReactNode;
+    /**
+     * Specify a container element to portal the content into.
+     */
+    container?: PortalProps["container"];
+    /**
+     * Used to force mounting when more control is needed. Useful when
+     * controlling animation with React animation libraries.
+     */
+    forceMount?: true;
+}
+declare const TooltipPortal: React.FC<TooltipPortalProps>;
+
+interface TooltipContentProps extends TooltipContentImplProps {
+    /**
+     * Used to force mounting when more control is needed. Useful when
+     * controlling animation with React animation libraries.
+     */
+    forceMount?: true;
+}
+declare const TooltipContent: React__default.ForwardRefExoticComponent<TooltipContentProps & React__default.RefAttributes<HTMLDivElement>>;
+type DismissableLayerProps = React__default.ComponentPropsWithoutRef<typeof DismissableLayer>;
+type PopperContentProps = React__default.ComponentPropsWithoutRef<typeof PopperPrimitive.Content>;
+interface TooltipContentImplProps extends Omit<PopperContentProps, "onPlaced"> {
+    /**
+     * A more descriptive label for accessibility purpose
+     */
+    "aria-label"?: string;
+    /**
+     * Event handler called when the escape key is down.
+     * Can be prevented.
+     */
+    onEscapeKeyDown?: DismissableLayerProps["onEscapeKeyDown"];
+    /**
+     * Event handler called when the a `pointerdown` event happens outside of the `Tooltip`.
+     * Can be prevented.
+     */
+    onPointerDownOutside?: DismissableLayerProps["onPointerDownOutside"];
+}
+
+interface TooltipProviderProps {
+    children: React__default.ReactNode;
+    /**
+     * The duration from when the pointer enters the trigger until the tooltip gets opened.
+     * @defaultValue 700
+     */
+    delayDuration?: number;
+    /**
+     * How much time a user has to enter another trigger without incurring a delay again.
+     * @defaultValue 300
+     */
+    skipDelayDuration?: number;
+    /**
+     * When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
+     * @defaultValue false
+     */
+    disableHoverableContent?: boolean;
+}
+declare const TooltipProvider: React__default.FC<TooltipProviderProps>;
+
+type PopperArrowProps = React__default.ComponentPropsWithoutRef<typeof PopperPrimitive.Arrow>;
+interface TooltipArrowProps extends PopperArrowProps {
+}
+declare const TooltipArrow: React__default.ForwardRefExoticComponent<TooltipArrowProps & React__default.RefAttributes<SVGSVGElement>>;
+
+export { Root, Tooltip, TooltipArrow, type TooltipArrowProps, TooltipContent, type TooltipContentProps, TooltipPortal, type TooltipPortalProps, type TooltipProps, TooltipProvider, type TooltipProviderProps, TooltipTrigger, type TooltipTriggerProps };