@cdx-ui/primitives 0.0.1-beta.144 → 0.0.1-beta.146

package/src/tooltip/types.ts

@@ -0,0 +1,85 @@
+import type { ComponentRef, ReactNode, RefObject } from 'react';
+import type { PressableProps, View, ViewProps } from 'react-native';
+import type {
+  ResolvedTooltipPlacement,
+  TooltipPlacement,
+  TooltipTriggerMode,
+} from './getTooltipPosition';
+
+export interface ITooltipProps extends Omit<ViewProps, 'children'> {
+  readonly children?: ReactNode;
+  readonly isDisabled?: boolean;
+  /**
+   * Milliseconds to wait before showing the tooltip.
+   * @default `0`
+   */
+  readonly enterDelay?: number;
+  /**
+   * Milliseconds to wait before hiding the tooltip.
+   * @default `0`
+   */
+  readonly leaveDelay?: number;
+  /**
+   * Controlled open state.
+   */
+  readonly isOpen?: boolean;
+  /**
+   * Uncontrolled initial open state.
+   * @default `false`
+   */
+  readonly defaultOpen?: boolean;
+  /**
+   * Called when the tooltip opens.
+   */
+  readonly onOpen?: () => void;
+  /**
+   * Called when the tooltip closes.
+   */
+  readonly onClose?: () => void;
+  /**
+   * Preferred placement relative to the trigger.
+   * @default `'top'`
+   */
+  readonly placement?: TooltipPlacement;
+  /**
+   * Distance in pixels between the tooltip and the trigger.
+   * @default `8`
+   */
+  readonly offset?: number;
+  /**
+   * Interaction that opens the tooltip. On web, `hover` opens on hover and focus; on native, long press.
+   * `focus` opens on focus (web) or long press (native). `click` toggles on press — on web, dismisses on outside click or Escape.
+   * @default `'hover'`
+   */
+  readonly trigger?: TooltipTriggerMode;
+}
+
+export interface TooltipContextValue {
+  readonly open: boolean;
+  readonly setOpen: (open: boolean) => void;
+  readonly requestOpen: () => void;
+  readonly requestClose: () => void;
+  readonly clearTimers: () => void;
+  readonly isDisabled: boolean;
+  readonly enterDelay: number;
+  readonly leaveDelay: number;
+  readonly placement: TooltipPlacement;
+  readonly offset: number;
+  readonly trigger: TooltipTriggerMode;
+  readonly triggerRef: RefObject<ComponentRef<typeof View> | null>;
+  readonly contentId: string;
+  readonly triggerId: string;
+  readonly resolvedPlacement: ResolvedTooltipPlacement | null;
+  readonly setResolvedPlacement: (placement: ResolvedTooltipPlacement) => void;
+}
+
+export interface ITooltipTriggerProps extends PressableProps {
+  /** When true, merges trigger props onto the single child element. */
+  readonly asChild?: boolean;
+  readonly children?: ReactNode;
+}
+
+export interface ITooltipContentProps extends ViewProps {
+  readonly asChild?: boolean;
+  readonly children?: ReactNode;
+}