@lattice-ui/tooltip 0.1.1 → 0.3.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 astra-void
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/out/index.d.ts

@@ -1,6 +1,13 @@
-export { TooltipContent } from "./Tooltip/TooltipContent";
-export { TooltipPortal } from "./Tooltip/TooltipPortal";
-export { TooltipProvider } from "./Tooltip/TooltipProvider";
-export { Tooltip } from "./Tooltip/TooltipRoot";
-export { TooltipTrigger } from "./Tooltip/TooltipTrigger";
+import { TooltipContent } from "./Tooltip/TooltipContent";
+import { TooltipPortal } from "./Tooltip/TooltipPortal";
+import { TooltipProvider } from "./Tooltip/TooltipProvider";
+import { Tooltip as TooltipRoot } from "./Tooltip/TooltipRoot";
+import { TooltipTrigger } from "./Tooltip/TooltipTrigger";
+export declare const Tooltip: {
+    readonly Provider: typeof TooltipProvider;
+    readonly Root: typeof TooltipRoot;
+    readonly Trigger: typeof TooltipTrigger;
+    readonly Portal: typeof TooltipPortal;
+    readonly Content: typeof TooltipContent;
+};
 export type { TooltipContentProps, TooltipPortalProps, TooltipProps, TooltipProviderProps, TooltipTriggerProps, } from "./Tooltip/types";

package/out/init.luau

@@ -1,9 +1,17 @@
 -- Compiled with roblox-ts v3.0.0
 local TS = _G[script]
-local exports = {}
-exports.TooltipContent = TS.import(script, script, "Tooltip", "TooltipContent").TooltipContent
-exports.TooltipPortal = TS.import(script, script, "Tooltip", "TooltipPortal").TooltipPortal
-exports.TooltipProvider = TS.import(script, script, "Tooltip", "TooltipProvider").TooltipProvider
-exports.Tooltip = TS.import(script, script, "Tooltip", "TooltipRoot").Tooltip
-exports.TooltipTrigger = TS.import(script, script, "Tooltip", "TooltipTrigger").TooltipTrigger
-return exports
+local TooltipContent = TS.import(script, script, "Tooltip", "TooltipContent").TooltipContent
+local TooltipPortal = TS.import(script, script, "Tooltip", "TooltipPortal").TooltipPortal
+local TooltipProvider = TS.import(script, script, "Tooltip", "TooltipProvider").TooltipProvider
+local TooltipRoot = TS.import(script, script, "Tooltip", "TooltipRoot").Tooltip
+local TooltipTrigger = TS.import(script, script, "Tooltip", "TooltipTrigger").TooltipTrigger
+local Tooltip = {
+	Provider = TooltipProvider,
+	Root = TooltipRoot,
+	Trigger = TooltipTrigger,
+	Portal = TooltipPortal,
+	Content = TooltipContent,
+}
+return {
+	Tooltip = Tooltip,
+}

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@lattice-ui/tooltip",
-  "version": "0.1.1",
+  "version": "0.3.1",
   "private": false,
   "main": "out/init.luau",
   "types": "out/index.d.ts",
+  "files": [
+    "out",
+    "README.md"
+  ],
   "dependencies": {
-    "@lattice-ui/core": "0.1.1",
-    "@lattice-ui/layer": "0.1.1",
-    "@lattice-ui/popper": "0.1.1"
+    "@lattice-ui/layer": "0.3.1",
+    "@lattice-ui/core": "0.3.1",
+    "@lattice-ui/popper": "0.3.1"
   },
   "devDependencies": {
     "@rbxts/react": "17.3.7-ts.1",
@@ -19,7 +23,7 @@
   },
   "scripts": {
     "build": "rbxtsc -p tsconfig.json",
-    "watch": "rbxtsc -p tsconfig.json -w",
-    "typecheck": "tsc -p tsconfig.typecheck.json"
+    "typecheck": "tsc -p tsconfig.typecheck.json",
+    "watch": "rbxtsc -p tsconfig.json -w"
   }
 }

package/src/Tooltip/TooltipContent.tsx

@@ -1,144 +0,0 @@
-import { React, Slot } from "@lattice-ui/core";
-import { DismissableLayer, Presence } from "@lattice-ui/layer";
-import { usePopper } from "@lattice-ui/popper";
-import { useTooltipContext } from "./context";
-import type { TooltipContentProps } from "./types";
-
-type TooltipContentImplProps = {
-  enabled: boolean;
-  visible: boolean;
-  onDismiss: () => void;
-  asChild?: boolean;
-  placement?: TooltipContentProps["placement"];
-  offset?: TooltipContentProps["offset"];
-  padding?: TooltipContentProps["padding"];
-} & Pick<TooltipContentProps, "children" | "onEscapeKeyDown" | "onInteractOutside" | "onPointerDownOutside">;
-
-function toGuiObject(instance: Instance | undefined) {
-  if (!instance || !instance.IsA("GuiObject")) {
-    return undefined;
-  }
-
-  return instance;
-}
-
-function TooltipContentImpl(props: TooltipContentImplProps) {
-  const tooltipContext = useTooltipContext();
-
-  const popper = usePopper({
-    anchorRef: tooltipContext.triggerRef,
-    contentRef: tooltipContext.contentRef,
-    placement: props.placement,
-    offset: props.offset,
-    padding: props.padding,
-    enabled: props.enabled,
-  });
-
-  const setContentRef = React.useCallback(
-    (instance: Instance | undefined) => {
-      tooltipContext.contentRef.current = toGuiObject(instance);
-    },
-    [tooltipContext.contentRef],
-  );
-
-  if (props.asChild) {
-    const child = props.children;
-    if (!React.isValidElement(child)) {
-      error("[TooltipContent] `asChild` requires a child element.");
-    }
-
-    return (
-      <DismissableLayer
-        enabled={props.enabled}
-        modal={false}
-        onDismiss={props.onDismiss}
-        onEscapeKeyDown={props.onEscapeKeyDown}
-        onInteractOutside={props.onInteractOutside}
-        onPointerDownOutside={props.onPointerDownOutside}
-      >
-        <Slot AnchorPoint={popper.anchorPoint} Position={popper.position} Visible={props.visible} ref={setContentRef}>
-          {child}
-        </Slot>
-      </DismissableLayer>
-    );
-  }
-
-  return (
-    <DismissableLayer
-      enabled={props.enabled}
-      modal={false}
-      onDismiss={props.onDismiss}
-      onEscapeKeyDown={props.onEscapeKeyDown}
-      onInteractOutside={props.onInteractOutside}
-      onPointerDownOutside={props.onPointerDownOutside}
-    >
-      <frame
-        AnchorPoint={popper.anchorPoint}
-        BackgroundTransparency={1}
-        BorderSizePixel={0}
-        Position={popper.position}
-        Size={UDim2.fromOffset(0, 0)}
-        Visible={props.visible}
-        ref={setContentRef}
-      >
-        {props.children}
-      </frame>
-    </DismissableLayer>
-  );
-}
-
-export function TooltipContent(props: TooltipContentProps) {
-  const tooltipContext = useTooltipContext();
-  const open = tooltipContext.open;
-  const forceMount = props.forceMount === true;
-
-  const handleDismiss = React.useCallback(() => {
-    tooltipContext.close();
-  }, [tooltipContext]);
-
-  if (!open && !forceMount) {
-    return undefined;
-  }
-
-  if (forceMount) {
-    return (
-      <TooltipContentImpl
-        asChild={props.asChild}
-        enabled={open}
-        offset={props.offset}
-        onDismiss={handleDismiss}
-        onEscapeKeyDown={props.onEscapeKeyDown}
-        onInteractOutside={props.onInteractOutside}
-        onPointerDownOutside={props.onPointerDownOutside}
-        padding={props.padding}
-        placement={props.placement}
-        visible={open}
-      >
-        {props.children}
-      </TooltipContentImpl>
-    );
-  }
-
-  return (
-    <Presence
-      exitFallbackMs={0}
-      present={open}
-      render={(state) => (
-        <TooltipContentImpl
-          asChild={props.asChild}
-          enabled={state.isPresent}
-          offset={props.offset}
-          onDismiss={handleDismiss}
-          onEscapeKeyDown={props.onEscapeKeyDown}
-          onInteractOutside={props.onInteractOutside}
-          onPointerDownOutside={props.onPointerDownOutside}
-          padding={props.padding}
-          placement={props.placement}
-          visible={state.isPresent}
-        >
-          {props.children}
-        </TooltipContentImpl>
-      )}
-    />
-  );
-}

package/src/Tooltip/TooltipPortal.tsx

@@ -1,28 +0,0 @@
-import { React } from "@lattice-ui/core";
-import { Portal, PortalProvider, usePortalContext } from "@lattice-ui/layer";
-import type { TooltipPortalProps } from "./types";
-
-function TooltipPortalWithOverrides(props: TooltipPortalProps) {
-  const portalContext = usePortalContext();
-  const container = props.container ?? portalContext.container;
-  const displayOrderBase = props.displayOrderBase ?? portalContext.displayOrderBase;
-
-  return (
-    <PortalProvider container={container} displayOrderBase={displayOrderBase}>
-      <Portal>{props.children}</Portal>
-    </PortalProvider>
-  );
-}
-
-export function TooltipPortal(props: TooltipPortalProps) {
-  const hasOverrides = props.container !== undefined || props.displayOrderBase !== undefined;
-  if (hasOverrides) {
-    return (
-      <TooltipPortalWithOverrides container={props.container} displayOrderBase={props.displayOrderBase}>
-        {props.children}
-      </TooltipPortalWithOverrides>
-    );
-  }
-
-  return <Portal>{props.children}</Portal>;
-}

package/src/Tooltip/TooltipProvider.tsx

@@ -1,43 +0,0 @@
-import { React } from "@lattice-ui/core";
-import { TooltipProviderContext } from "./context";
-import type { TooltipProviderContextValue, TooltipProviderProps } from "./types";
-
-export function TooltipProvider(props: TooltipProviderProps) {
-  const delayDuration = props.delayDuration ?? 700;
-  const skipDelayDuration = props.skipDelayDuration ?? 300;
-  const lastOpenTimestampRef = React.useRef<number>();
-
-  const markOpen = React.useCallback(() => {
-    lastOpenTimestampRef.current = os.clock();
-  }, []);
-
-  const resolveOpenDelay = React.useCallback(
-    (requestedDelay?: number) => {
-      const baseDelay = requestedDelay ?? delayDuration;
-      const lastOpenTimestamp = lastOpenTimestampRef.current;
-      if (lastOpenTimestamp === undefined) {
-        return baseDelay;
-      }
-
-      const elapsedMs = (os.clock() - lastOpenTimestamp) * 1000;
-      if (elapsedMs <= skipDelayDuration) {
-        return math.min(baseDelay, skipDelayDuration);
-      }
-
-      return baseDelay;
-    },
-    [delayDuration, skipDelayDuration],
-  );
-
-  const contextValue = React.useMemo<TooltipProviderContextValue>(
-    () => ({
-      delayDuration,
-      skipDelayDuration,
-      resolveOpenDelay,
-      markOpen,
-    }),
-    [delayDuration, markOpen, resolveOpenDelay, skipDelayDuration],
-  );
-
-  return <TooltipProviderContext.Provider value={contextValue}>{props.children}</TooltipProviderContext.Provider>;
-}

package/src/Tooltip/TooltipRoot.tsx

@@ -1,76 +0,0 @@
-import { React, useControllableState } from "@lattice-ui/core";
-import { TooltipContextProvider, useTooltipProviderContext } from "./context";
-import type { TooltipProps } from "./types";
-
-export function Tooltip(props: TooltipProps) {
-  const providerContext = useTooltipProviderContext();
-  const [open, setOpenState] = useControllableState<boolean>({
-    value: props.open,
-    defaultValue: props.defaultOpen ?? false,
-    onChange: props.onOpenChange,
-  });
-
-  const triggerRef = React.useRef<GuiObject>();
-  const contentRef = React.useRef<GuiObject>();
-  const openDelayTaskRef = React.useRef<thread>();
-
-  const cancelPendingOpen = React.useCallback(() => {
-    const openDelayTask = openDelayTaskRef.current;
-    if (!openDelayTask) {
-      return;
-    }
-
-    task.cancel(openDelayTask);
-    openDelayTaskRef.current = undefined;
-  }, []);
-
-  const setOpen = React.useCallback(
-    (nextOpen: boolean) => {
-      setOpenState(nextOpen);
-      if (nextOpen) {
-        providerContext.markOpen();
-      }
-    },
-    [providerContext, setOpenState],
-  );
-
-  const openWithDelay = React.useCallback(() => {
-    cancelPendingOpen();
-
-    const resolvedDelay = providerContext.resolveOpenDelay(props.delayDuration);
-    if (resolvedDelay <= 0) {
-      setOpen(true);
-      return;
-    }
-
-    openDelayTaskRef.current = task.delay(resolvedDelay / 1000, () => {
-      openDelayTaskRef.current = undefined;
-      setOpen(true);
-    });
-  }, [cancelPendingOpen, props.delayDuration, providerContext, setOpen]);
-
-  const close = React.useCallback(() => {
-    cancelPendingOpen();
-    setOpen(false);
-  }, [cancelPendingOpen, setOpen]);
-
-  React.useEffect(() => {
-    return () => {
-      cancelPendingOpen();
-    };
-  }, [cancelPendingOpen]);
-
-  const contextValue = React.useMemo(
-    () => ({
-      open,
-      setOpen,
-      openWithDelay,
-      close,
-      triggerRef,
-      contentRef,
-    }),
-    [close, open, openWithDelay, setOpen],
-  );
-
-  return <TooltipContextProvider value={contextValue}>{props.children}</TooltipContextProvider>;
-}

package/src/Tooltip/TooltipTrigger.tsx

@@ -1,75 +0,0 @@
-import { React, Slot } from "@lattice-ui/core";
-import { useTooltipContext } from "./context";
-import type { TooltipTriggerProps } from "./types";
-
-function toGuiObject(instance: Instance | undefined) {
-  if (!instance || !instance.IsA("GuiObject")) {
-    return undefined;
-  }
-
-  return instance;
-}
-
-export function TooltipTrigger(props: TooltipTriggerProps) {
-  const tooltipContext = useTooltipContext();
-
-  const setTriggerRef = React.useCallback(
-    (instance: Instance | undefined) => {
-      tooltipContext.triggerRef.current = toGuiObject(instance);
-    },
-    [tooltipContext.triggerRef],
-  );
-
-  const handleOpen = React.useCallback(() => {
-    if (props.disabled) {
-      return;
-    }
-
-    tooltipContext.openWithDelay();
-  }, [props.disabled, tooltipContext]);
-
-  const handleClose = React.useCallback(() => {
-    tooltipContext.close();
-  }, [tooltipContext]);
-
-  const eventHandlers = React.useMemo(
-    () => ({
-      MouseEnter: handleOpen,
-      MouseLeave: handleClose,
-      SelectionGained: handleOpen,
-      SelectionLost: handleClose,
-    }),
-    [handleClose, handleOpen],
-  );
-
-  if (props.asChild) {
-    const child = props.children;
-    if (!child) {
-      error("[TooltipTrigger] `asChild` requires a child element.");
-    }
-
-    return (
-      <Slot Event={eventHandlers} ref={setTriggerRef}>
-        {child}
-      </Slot>
-    );
-  }
-
-  return (
-    <textbutton
-      Active={props.disabled !== true}
-      AutoButtonColor={false}
-      BackgroundTransparency={1}
-      BorderSizePixel={0}
-      Event={eventHandlers}
-      Selectable={props.disabled !== true}
-      Size={UDim2.fromOffset(140, 36)}
-      Text="Tooltip Trigger"
-      TextColor3={Color3.fromRGB(240, 244, 250)}
-      TextSize={15}
-      ref={setTriggerRef}
-    >
-      {props.children}
-    </textbutton>
-  );
-}

package/src/Tooltip/context.ts

@@ -1,21 +0,0 @@
-import { createStrictContext, React } from "@lattice-ui/core";
-import type { TooltipContextValue, TooltipProviderContextValue } from "./types";
-
-const [TooltipContextProvider, useTooltipContext] = createStrictContext<TooltipContextValue>("Tooltip");
-
-const DEFAULT_TOOLTIP_PROVIDER_CONTEXT: TooltipProviderContextValue = {
-  delayDuration: 700,
-  skipDelayDuration: 300,
-  resolveOpenDelay: (requestedDelay) => requestedDelay ?? 700,
-  markOpen: () => {
-    // default no-op
-  },
-};
-
-const TooltipProviderContext = React.createContext<TooltipProviderContextValue>(DEFAULT_TOOLTIP_PROVIDER_CONTEXT);
-
-function useTooltipProviderContext() {
-  return React.useContext(TooltipProviderContext);
-}
-
-export { TooltipContextProvider, TooltipProviderContext, useTooltipContext, useTooltipProviderContext };

package/src/Tooltip/types.ts

@@ -1,59 +0,0 @@
-import type { LayerInteractEvent } from "@lattice-ui/layer";
-import type { PopperPlacement } from "@lattice-ui/popper";
-import type React from "@rbxts/react";
-
-export type TooltipSetOpen = (open: boolean) => void;
-
-export type TooltipContextValue = {
-  open: boolean;
-  setOpen: TooltipSetOpen;
-  openWithDelay: () => void;
-  close: () => void;
-  triggerRef: React.MutableRefObject<GuiObject | undefined>;
-  contentRef: React.MutableRefObject<GuiObject | undefined>;
-};
-
-export type TooltipProviderContextValue = {
-  delayDuration: number;
-  skipDelayDuration: number;
-  resolveOpenDelay: (requestedDelay?: number) => number;
-  markOpen: () => void;
-};
-
-export type TooltipProviderProps = {
-  delayDuration?: number;
-  skipDelayDuration?: number;
-  children?: React.ReactNode;
-};
-
-export type TooltipProps = {
-  open?: boolean;
-  defaultOpen?: boolean;
-  delayDuration?: number;
-  onOpenChange?: (open: boolean) => void;
-  children?: React.ReactNode;
-};
-
-export type TooltipTriggerProps = {
-  asChild?: boolean;
-  disabled?: boolean;
-  children?: React.ReactElement;
-};
-
-export type TooltipPortalProps = {
-  container?: BasePlayerGui;
-  displayOrderBase?: number;
-  children?: React.ReactNode;
-};
-
-export type TooltipContentProps = {
-  asChild?: boolean;
-  forceMount?: boolean;
-  placement?: PopperPlacement;
-  offset?: Vector2;
-  padding?: number;
-  onEscapeKeyDown?: (event: LayerInteractEvent) => void;
-  onPointerDownOutside?: (event: LayerInteractEvent) => void;
-  onInteractOutside?: (event: LayerInteractEvent) => void;
-  children?: React.ReactNode;
-};

package/src/index.ts

@@ -1,12 +0,0 @@
-export { TooltipContent } from "./Tooltip/TooltipContent";
-export { TooltipPortal } from "./Tooltip/TooltipPortal";
-export { TooltipProvider } from "./Tooltip/TooltipProvider";
-export { Tooltip } from "./Tooltip/TooltipRoot";
-export { TooltipTrigger } from "./Tooltip/TooltipTrigger";
-export type {
-  TooltipContentProps,
-  TooltipPortalProps,
-  TooltipProps,
-  TooltipProviderProps,
-  TooltipTriggerProps,
-} from "./Tooltip/types";

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "out",
-    "declaration": true,
-    "typeRoots": [
-      "./node_modules/@rbxts",
-      "../../node_modules/@rbxts",
-      "./node_modules/@lattice-ui",
-      "../../node_modules/@lattice-ui"
-    ],
-    "types": ["types", "compiler-types"]
-  },
-  "include": ["src"]
-}

package/tsconfig.typecheck.json

@@ -1,25 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "noEmit": true,
-    "baseUrl": "..",
-    "rootDir": "..",
-    "paths": {
-      "@lattice-ui/checkbox": ["checkbox/src/index.ts"],
-      "@lattice-ui/core": ["core/src/index.ts"],
-      "@lattice-ui/dialog": ["dialog/src/index.ts"],
-      "@lattice-ui/focus": ["focus/src/index.ts"],
-      "@lattice-ui/layer": ["layer/src/index.ts"],
-      "@lattice-ui/menu": ["menu/src/index.ts"],
-      "@lattice-ui/popover": ["popover/src/index.ts"],
-      "@lattice-ui/popper": ["popper/src/index.ts"],
-      "@lattice-ui/radio-group": ["radio-group/src/index.ts"],
-      "@lattice-ui/style": ["style/src/index.ts"],
-      "@lattice-ui/switch": ["switch/src/index.ts"],
-      "@lattice-ui/system": ["system/src/index.ts"],
-      "@lattice-ui/tabs": ["tabs/src/index.ts"],
-      "@lattice-ui/toggle-group": ["toggle-group/src/index.ts"],
-      "@lattice-ui/tooltip": ["tooltip/src/index.ts"]
-    }
-  }
-}