@visulima/tui 1.0.0-alpha.2 → 1.0.0-alpha.21

package/dist/ink/components/ConfirmInput.d.ts

@@ -1,40 +0,0 @@
-/**
- * Confirm input component for Ink.
- *
- * Inspired by ink-ui ConfirmInput by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-ui
- *
- * MIT License
- * Copyright (c) Vadym Demedes (github.com/vadimdemedes)
- */
-import type { ReactElement } from "react";
-export type Props = {
-    /**
-     * The default action when pressing Enter without typing Y or N.
-     * @default "confirm"
-     */
-    readonly defaultChoice?: "cancel" | "confirm";
-    /**
-     * Whether the input is disabled.
-     * @default false
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * Called when the user cancels (presses N).
-     */
-    readonly onCancel: () => void;
-    /**
-     * Called when the user confirms (presses Y).
-     */
-    readonly onConfirm: () => void;
-    /**
-     * Whether pressing Enter submits the default choice.
-     * @default true
-     */
-    readonly submitOnEnter?: boolean;
-};
-/**
- * Renders a Y/N confirmation prompt. Shows "Y/n" when default is confirm,
- * or "y/N" when default is cancel.
- */
-export default function ConfirmInput({ defaultChoice, isDisabled, onCancel, onConfirm, submitOnEnter }: Props): ReactElement;

package/dist/ink/components/ConsoleOverlay.d.ts

@@ -1,52 +0,0 @@
-/**
- * Console overlay component for Ink.
- *
- * Captures console.log/warn/error/debug output and displays it
- * in a dockable panel within the TUI, similar to browser devtools.
- */
-import type { ReactElement } from "react";
-import type { ConsoleLevel } from "../hooks/use-console-capture.d.ts";
-export type ConsoleOverlayDock = "bottom" | "top";
-export type Props = {
-    /**
-     * Dock position within the parent container.
-     * @default "bottom"
-     */
-    readonly dock?: ConsoleOverlayDock;
-    /**
-     * Which console levels to capture.
-     * @default ["log", "info", "warn", "error", "debug"]
-     */
-    readonly filter?: ReadonlyArray<ConsoleLevel>;
-    /**
-     * Visible height in rows.
-     * @default 8
-     */
-    readonly height?: number;
-    /**
-     * Maximum entries to keep in the buffer.
-     * @default 200
-     */
-    readonly maxEntries?: number;
-    /**
-     * Show the log level label.
-     * @default true
-     */
-    readonly showLevel?: boolean;
-    /**
-     * Show timestamps on each entry.
-     * @default true
-     */
-    readonly showTimestamp?: boolean;
-};
-/**
- * A dockable console overlay that captures and displays console output.
- *
- * ```tsx
- * &lt;Box flexDirection="column" height="100%">
- *     &lt;Box flexGrow={1}>{mainContent}&lt;/Box>
- *     &lt;ConsoleOverlay dock="bottom" height={6} />
- * &lt;/Box>
- * ```
- */
-export default function ConsoleOverlay({ dock, filter, height, maxEntries, showLevel, showTimestamp }: Props): ReactElement;

package/dist/ink/components/Cursor.d.ts

@@ -1,43 +0,0 @@
-import type { RefObject } from "react";
-import React from "react";
-import type { DOMElement } from "../dom.d.ts";
-export type Props = {
-    /**
-     * Optional reference to anchor cursor coordinates to a different element.
-     * If omitted, `<Cursor>` uses the parent container as anchor.
-     * If `anchorRef` is set but currently unresolved, Ink hides the cursor for that frame.
-     * If multiple `<Cursor>` components are rendered in one frame, the last rendered one controls the terminal cursor position.
-     */
-    readonly anchorRef?: RefObject<DOMElement | null>;
-    /**
-     * Horizontal offset from anchor content origin.
-     */
-    readonly x?: number;
-    /**
-     * Vertical offset from anchor content origin.
-     */
-    readonly y?: number;
-};
-/**
- * Declaratively position the terminal cursor.
- * `&lt;Cursor>` must not be rendered inside `&lt;Text>`.
- *
- * **Inline mode** (no props): place `&lt;Cursor />` after a `&lt;Text>` node and the
- * cursor appears where that text ended — even when text wraps across lines.
- *
- * **Anchor mode**: pass `anchorRef` and/or `x`/`y` to position relative to
- * another element's content origin.
- * @example Inline mode — cursor follows text naturally
- * ```jsx
- * <Box>
- *     <Text>{prompt + value}</Text>
- *     <Cursor />
- * </Box>
- * ```
- * @example Anchor mode — offset from a referenced element
- * ```jsx
- * <Box ref={ref} />
- * <Cursor anchorRef={ref} x={5} />
- * ```
- */
-export default function Cursor({ anchorRef, x, y }: Props): React.JSX.Element;

package/dist/ink/components/CursorContext.d.ts

@@ -1,12 +0,0 @@
-import type { Context } from "react";
-import type { CursorPosition } from "../log-update.d.ts";
-export type Props = {
-    /**
-     * Set the cursor position relative to the Ink output.
-     *
-     * Pass `undefined` to hide the cursor.
-     */
-    readonly setCursorPosition: (position: CursorPosition | undefined) => void;
-};
-declare const CursorContext: Context<Props>;
-export default CursorContext;

package/dist/ink/components/Dialog.d.ts

@@ -1,93 +0,0 @@
-import type { ReactElement, ReactNode } from "react";
-import type { ScrollViewRef } from "./index.d.ts";
-export type Props = {
-    /**
-     * Background color for the dialog. Defaults to the detected terminal
-     * background color, falling back to `"black"`.
-     */
-    readonly backgroundColor?: string;
-    /**
-     * Border color.
-     * @default "cyan"
-     */
-    readonly borderColor?: string;
-    /**
-     * Border style.
-     * @default "round"
-     */
-    readonly borderStyle?: "arrow" | "bold" | "classic" | "double" | "doubleSingle" | "round" | "single" | "singleDouble";
-    /**
-     * Dialog content.
-     */
-    readonly children: ReactNode;
-    /**
-     * Override terminal columns. Useful in renderToString or testing contexts
-     * where useWindowSize is unavailable.
-     */
-    readonly columns?: number;
-    /**
-     * Footer content rendered below the scrollable area.
-     * Useful for hints like "Press ? to close".
-     */
-    readonly footer?: ReactNode;
-    /**
-     * Maximum height as a fraction of terminal rows (0-1) or absolute rows.
-     * Values <= 1 are treated as fractions; values > 1 as absolute row counts.
-     * @default 0.8
-     */
-    readonly maxHeight?: number;
-    /**
-     * Padding inside the dialog border.
-     * @default 2
-     */
-    readonly paddingX?: number;
-    /**
-     * Vertical padding inside the dialog border.
-     * @default 1
-     */
-    readonly paddingY?: number;
-    /**
-     * Override terminal rows. Useful in renderToString or testing contexts
-     * where useWindowSize is unavailable.
-     */
-    readonly rows?: number;
-    /**
-     * Scrollbar visual style.
-     * @default "block"
-     */
-    readonly scrollbarStyle?: "arrow" | "block" | "bold" | "classic" | "dots" | "double" | "doubleSingle" | "line" | "round" | "single" | "singleDouble" | "thick";
-    /**
-     * Ref to the internal ScrollView for programmatic scrolling.
-     */
-    readonly scrollRef?: React.Ref<ScrollViewRef>;
-    /**
-     * Title rendered at the top of the dialog. If a string is provided,
-     * it is rendered as bold cyan text.
-     */
-    readonly title?: ReactNode;
-    /**
-     * Whether the dialog is visible. When `false`, nothing is rendered.
-     * @default true
-     */
-    readonly visible?: boolean;
-    /**
-     * Dialog width in columns.
-     * @default 60
-     */
-    readonly width?: number;
-};
-/**
- * A centered overlay dialog with automatic scrolling and scrollbar when
- * content exceeds the available terminal height.
- *
- * Uses the terminal's detected background color by default so the
- * dialog blends with the user's theme.
- *
- * ```tsx
- * &lt;Dialog title="Help" footer={&lt;Text dimColor>Press Esc to close&lt;/Text>}>
- *   &lt;Text>Dialog content here&lt;/Text>
- * &lt;/Dialog>
- * ```
- */
-declare const Dialog: ({ backgroundColor: backgroundColorProp, borderColor, borderStyle, children, columns: columnsProp, footer, maxHeight: maxHeightProp, paddingX, paddingY, rows: rowsProp, scrollbarStyle: scrollbarStyleProp, scrollRef: externalScrollRef, title, visible, width, }: Props) => ReactElement | null;
-export default Dialog;

package/dist/ink/components/DiffView.d.ts

@@ -1,71 +0,0 @@
-import type { ReactElement } from "react";
-export type DiffViewMode = "split" | "unified";
-export type InlineDiffMode = "chars" | "words";
-export type Props = {
-    /**
-     * Number of unchanged context lines around changes.
-     * @default 3
-     */
-    readonly context?: number;
-    /**
-     * Pre-computed unified diff string. If provided, `oldText`/`newText` are ignored.
-     */
-    readonly diff?: string;
-    /**
-     * Enable character-level inline diff highlighting within changed lines.
-     * @default true
-     */
-    readonly inlineDiff?: boolean;
-    /**
-     * Granularity of inline diff highlighting.
-     * - `"chars"` — character-level (best for code)
-     * - `"words"` — word-level (best for prose)
-     * @default "chars"
-     */
-    readonly inlineDiffMode?: InlineDiffMode;
-    /**
-     * Programming language for syntax highlighting within diff lines.
-     * When provided, diff content is highlighted with Shiki.
-     */
-    readonly language?: string;
-    /**
-     * Display mode: unified (interleaved) or split (side-by-side).
-     * @default "unified"
-     */
-    readonly mode?: DiffViewMode;
-    /**
-     * Label for the new version.
-     */
-    readonly newLabel?: string;
-    /**
-     * Modified text ("new" / right side).
-     */
-    readonly newText?: string;
-    /**
-     * Label for the old version.
-     */
-    readonly oldLabel?: string;
-    /**
-     * Original text ("old" / left side).
-     */
-    readonly oldText?: string;
-    /**
-     * Whether to display line numbers.
-     * @default true
-     */
-    readonly showLineNumbers?: boolean;
-    /**
-     * Shiki theme for syntax highlighting.
-     * @default "github-dark-default"
-     */
-    readonly theme?: string;
-};
-/**
- * Display file differences with colored additions/deletions.
- *
- * ```tsx
- * <DiffView oldText="hello" newText="hello world" />
- * <DiffView diff={unifiedDiffString} mode="split" />
- * ```
- */
-export default function DiffView({ context, diff: diffProp, inlineDiff, inlineDiffMode, language, mode, newLabel, newText, oldLabel, oldText, showLineNumbers, theme, }: Props): ReactElement;

package/dist/ink/components/ErrorBoundary.d.ts

@@ -1,17 +0,0 @@
-import type { ReactNode } from "react";
-import { PureComponent } from "react";
-type Props = {
-    readonly children: ReactNode;
-    readonly onError: (error: Error) => void;
-};
-type State = {
-    readonly error?: Error;
-};
-export default class ErrorBoundary extends PureComponent<Props, State> {
-    static displayName: string;
-    static getDerivedStateFromError(error: Error): State;
-    state: State;
-    componentDidCatch(error: Error): void;
-    render(): ReactNode;
-}
-export {};

package/dist/ink/components/ErrorOverview.d.ts

@@ -1,6 +0,0 @@
-import type { ReactElement } from "react";
-type Props = {
-    readonly error: Error;
-};
-export default function ErrorOverview({ error }: Props): ReactElement;
-export {};

package/dist/ink/components/FocusContext.d.ts

@@ -1,17 +0,0 @@
-import type { Context } from "react";
-export type Props = {
-    readonly activate: (id: string) => void;
-    readonly activeId?: string;
-    readonly add: (id: string, options: {
-        autoFocus: boolean;
-    }) => void;
-    readonly deactivate: (id: string) => void;
-    readonly disableFocus: () => void;
-    readonly enableFocus: () => void;
-    readonly focus: (id: string) => void;
-    readonly focusNext: () => void;
-    readonly focusPrevious: () => void;
-    readonly remove: (id: string) => void;
-};
-declare const FocusContext: Context<Props>;
-export default FocusContext;

package/dist/ink/components/Gradient.d.ts

@@ -1,38 +0,0 @@
-import { multilineGradient } from "@visulima/colorize/gradient";
-import type { ReactElement, ReactNode } from "react";
-/**
- * A color stop for the gradient — hex string, CSS color name, RGB tuple, RGB object, or positioned stop.
- */
-type GradientStop = Parameters<typeof multilineGradient>[0][number];
-/**
- * Built-in gradient presets.
- */
-type GradientName = "atlas" | "cristal" | "fruit" | "instagram" | "mind" | "morning" | "pastel" | "passion" | "rainbow" | "retro" | "summer" | "teen" | "vice";
-/**
- * Custom gradient colors — an array of color stops accepted by `@visulima/colorize`'s gradient API.
- */
-type GradientColors = GradientStop[];
-export type Props = {
-    /**
-     * The content to colorize.
-     *
-     * Multiple `&lt;Text>` children are treated as separate nodes, which preserves layout when `&lt;Gradient>` is placed inside a `&lt;Box flexDirection="column">`.
-     *
-     * If you want a continuous gradient across multiple lines, pass a single string or a single `&lt;Text>` with `\n`.
-     */
-    readonly children: ReactNode;
-    /**
-     * [Colors to use to make the gradient.](https://visulima.com/packages/colorize)
-     *
-     * Mutually exclusive with `name`.
-     */
-    readonly colors?: GradientColors;
-    /**
-     * The name of a built-in gradient preset.
-     *
-     * Mutually exclusive with `colors`.
-     */
-    readonly name?: GradientName;
-};
-export default function Gradient({ children, colors, name }: Props): ReactElement | null;
-export type { GradientColors, GradientName };

package/dist/ink/components/Help.d.ts

@@ -1,49 +0,0 @@
-import type { ReactElement } from "react";
-import type { KeyBinding } from "../hooks/use-key-bindings.d.ts";
-export type Props = {
-    /**
-     * Key bindings to display. Typically the `bindings` array returned by `useKeyBindings`.
-     */
-    readonly bindings: readonly KeyBinding[];
-    /**
-     * Color for description text.
-     *
-     * @default undefined (uses dimColor)
-     */
-    readonly descriptionColor?: string;
-    /**
-     * Color for key labels.
-     *
-     * @default "cyan"
-     */
-    readonly keyColor?: string;
-    /**
-     * Maximum number of columns in full mode.
-     *
-     * @default 3
-     */
-    readonly maxColumns?: number;
-    /**
-     * Display mode.
-     * - `"short"`: Single-line horizontal bar, truncated to terminal width.
-     * - `"full"`: Multi-column layout grouped by `group` field.
-     *
-     * @default "short"
-     */
-    readonly mode?: "full" | "short";
-    /**
-     * Separator between key-description pairs in short mode.
-     *
-     * @default " \u00b7 "
-     */
-    readonly separator?: string;
-};
-/**
- * Renders a keybinding help bar from an array of `KeyBinding` definitions.
- *
- * ```tsx
- * <Help bindings={bindings} />
- * <Help bindings={bindings} mode="full" />
- * ```
- */
-export default function Help({ bindings, descriptionColor, keyColor, maxColumns, mode, separator, }: Props): ReactElement;

package/dist/ink/components/Link.d.ts

@@ -1,34 +0,0 @@
-import type { ReactElement, ReactNode } from "react";
-type Props = {
-    readonly children: ReactNode;
-    /**
-     * Determines whether the URL should be printed for unsupported terminals.
-     *
-     * - `true` (default): appends the URL after the text, e.g. `"My website https://example.com"`
-     * - `false`: renders just the text with no URL
-     * - `function`: custom fallback formatting, e.g. `(text, url) => \`[\${text}](\${url})\``
-     * @default true
-     */
-    readonly fallback?: ((text: string, url: string) => string) | boolean;
-    /**
-     * The URL to link to.
-     */
-    readonly url: string;
-};
-/**
- * An Ink component that creates clickable links in the terminal using OSC 8 hyperlink sequences.
- *
- * [Supported terminals.](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)
- *
- * For unsupported terminals, the link will be printed after the text: `My website https://example.com`.
- *
- * ```tsx
- * import { Link, Text } from "@visulima/tui/ink";
- *
- * <Link url="https://example.com">
- *     <Text color="cyan">My Website</Text>
- * </Link>
- * ```
- */
-export default function Link({ children, fallback, url }: Props): ReactElement;
-export type { Props };

package/dist/ink/components/Markdown.d.ts

@@ -1,34 +0,0 @@
-import type { ReactElement } from "react";
-export type Props = {
-    /**
-     * The Markdown source string.
-     */
-    readonly children: string;
-    /**
-     * Shiki theme for code block syntax highlighting.
-     * @default "github-dark-default"
-     */
-    readonly codeTheme?: string;
-    /**
-     * Maximum width for text wrapping. Defaults to terminal width.
-     */
-    readonly maxWidth?: number;
-    /**
-     * Enable streaming mode for progressive rendering.
-     * When true, the component re-renders on every prop change and handles
-     * incomplete Markdown gracefully (e.g., unclosed code fences, partial lists).
-     * Useful for rendering AI-generated text arriving token-by-token.
-     * @default false
-     */
-    readonly streaming?: boolean;
-};
-/**
- * Render Markdown content as Ink terminal UI elements.
- *
- * ```tsx
- * <Markdown>{"# Hello\n\nThis is **bold** and *italic*."}</Markdown>
- * <Markdown codeTheme="github-dark-default">{"```js\nconst x = 1;\n```"}</Markdown>
- * <Markdown streaming>{"# Streaming\n\nText arriving..."}</Markdown>
- * ```
- */
-export default function Markdown({ children, codeTheme, maxWidth: maxWidthProp, streaming }: Props): ReactElement;

package/dist/ink/components/MultiSelect.d.ts

@@ -1,63 +0,0 @@
-/**
- * Multi-select input component for Ink.
- *
- * Inspired by ink-ui MultiSelect by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-ui
- *
- * MIT License
- * Copyright (c) Vadym Demedes (github.com/vadimdemedes)
- */
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement } from "react";
-import type { LiteralUnion } from "type-fest";
-export type MultiSelectOption = {
-    readonly key?: string;
-    readonly label: string;
-    readonly value: string;
-};
-export type Props = {
-    /**
-     * Color for the focused item indicator and selected checkmarks.
-     * @default "blue"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Color for unselected, unfocused option labels.
-     */
-    readonly defaultColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Initially selected values.
-     */
-    readonly defaultValue?: ReadonlyArray<string>;
-    /**
-     * When true, all input is ignored and labels are dimmed.
-     * @default false
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * Whether the parent has focus. When false, indicators are dimmed.
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * Number of visible options before scrolling.
-     * When omitted, auto-limits to terminal height.
-     */
-    readonly limit?: number;
-    /**
-     * Fires when the set of selected values changes (space to toggle).
-     */
-    readonly onChange?: (values: ReadonlyArray<string>) => void;
-    /**
-     * Fires when the user presses Enter to submit.
-     */
-    readonly onSubmit?: (values: ReadonlyArray<string>) => void;
-    /**
-     * Available choices to pick from.
-     */
-    readonly options: ReadonlyArray<MultiSelectOption>;
-};
-/**
- * Renders a multi-choice selection list with checkboxes and keyboard navigation.
- */
-export default function MultiSelect({ accentColor, defaultColor, defaultValue, isDisabled, isFocused, limit: customLimit, onChange, onSubmit, options, }: Props): ReactElement;

package/dist/ink/components/Newline.d.ts

@@ -1,12 +0,0 @@
-import type { ReactElement } from "react";
-export type Props = {
-    /**
-     * Number of newlines to insert.
-     * @default 1
-     */
-    readonly count?: number;
-};
-/**
- * Adds one or more newline (`\n`) characters. Must be used within `<Text>` components.
- */
-export default function Newline({ count }: Props): ReactElement;

package/dist/ink/components/OrderedList.d.ts

@@ -1,30 +0,0 @@
-/**
- * Ordered list component for Ink.
- *
- * Inspired by ink-ui OrderedList by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-ui
- *
- * MIT License
- * Copyright (c) Vadym Demedes (github.com/vadimdemedes)
- */
-import type { ReactElement, ReactNode } from "react";
-export type OrderedListEntry = {
-    /**
-     * Nested sub-items, rendered as a sub-list with hierarchical numbering.
-     */
-    readonly children?: ReadonlyArray<OrderedListEntry>;
-    /**
-     * Display text for this item.
-     */
-    readonly label: ReactNode;
-};
-export type Props = {
-    /**
-     * Entries to render as a numbered list.
-     */
-    readonly items: ReadonlyArray<OrderedListEntry>;
-};
-/**
- * Renders a numbered list with hierarchical nesting support.
- */
-export default function OrderedList({ items }: Props): ReactElement;