@intentface/ui 0.0.0 → 0.7.0

package/dist/thread/thread.d.ts

@@ -0,0 +1,57 @@
+import { type ReactNode, type RefObject } from "react";
+import type { PrimitiveProps } from "../internal/primitive-props.js";
+import { type ThreadVisibilityState } from "./stores.js";
+export type { ThreadVisibilityState } from "./stores.js";
+export type ThreadScrollToMessageOptions = {
+    /** Viewport edge (or center) to align the row to; scrollIntoView's block. */
+    align?: "start" | "center" | "end" | "nearest";
+    behavior?: ScrollBehavior;
+};
+/**
+ * Public thread surface. Subscribes to the scroll edges, so call it where
+ * isAtTop / isAtBottom are actually read (e.g. a scroll button or a load-older
+ * trigger); the commands and refs are stable and never cause re-renders.
+ */
+export declare const useThread: () => {
+    isAtTop: boolean;
+    isAtBottom: boolean;
+    scrollToBottom: (behavior?: ScrollBehavior) => void;
+    scrollToTop: (behavior?: ScrollBehavior) => void;
+    scrollToMessage: (messageId: string, options?: ThreadScrollToMessageOptions) => boolean;
+    scrollRef: RefObject<HTMLDivElement | null>;
+    contentRef: RefObject<HTMLDivElement | null>;
+};
+/**
+ * Which data-message-id rows are in view, plus the topmost one (the row being
+ * read). Subscribing lazily spins up the tracking observers; when the last
+ * subscriber unmounts they are torn down, so unused threads pay nothing.
+ */
+export declare const useThreadVisibility: () => ThreadVisibilityState;
+export type ThreadAutoScrollMode = "off" | "bottom" | "jump" | "follow";
+export type ThreadRootProps = PrimitiveProps<"div"> & {
+    children?: ReactNode;
+    autoScroll?: ThreadAutoScrollMode;
+    /**
+     * Hold the reading position when rows are prepended (history pagination).
+     * Opt-in: enabling it attaches a passive scroll listener to keep the anchor
+     * current, so leave it off unless older content actually loads in above.
+     */
+    preserveScrollOnPrepend?: boolean;
+};
+export declare const ThreadRoot: ({ autoScroll, preserveScrollOnPrepend, className, render, style, ...elementProps }: ThreadRootProps) => import("react").JSX.Element;
+export type ThreadOverlayState = {
+    /** Which edge this overlay marks, surfaced as data-thread-overlay. */
+    direction: "top" | "bottom";
+};
+export type ThreadOverlayProps = PrimitiveProps<"div", ThreadOverlayState> & {
+    direction: "top" | "bottom";
+};
+export declare const ThreadOverlay: import("react").MemoExoticComponent<({ direction, className, render, style, ...elementProps }: ThreadOverlayProps) => import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>>;
+export type ThreadViewportProps = PrimitiveProps<"div">;
+export declare const ThreadViewport: ({ className, render, style, ...elementProps }: ThreadViewportProps) => import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>;
+export type ThreadContentProps = PrimitiveProps<"div">;
+export declare const ThreadContent: ({ className, render, style, ...elementProps }: ThreadContentProps) => import("react").JSX.Element;
+export type ThreadComposerProps = PrimitiveProps<"div">;
+export declare const ThreadComposer: ({ className, render, style, ...elementProps }: ThreadComposerProps) => import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>;
+export type ThreadPlaceholderProps = PrimitiveProps<"div">;
+export declare const ThreadPlaceholder: ({ className, render, style, ...elementProps }: ThreadPlaceholderProps) => import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>;