@visulima/tui 1.0.0-alpha.4 → 1.0.0-alpha.5

package/dist/ink/components/confirm-input.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/console-overlay.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/content-switcher.d.ts

@@ -1,49 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement, ReactNode } from "react";
-import type { LiteralUnion } from "type-fest";
-export type ContentSwitcherOption = {
-    readonly content: ReactNode;
-    readonly icon?: ReactNode;
-    readonly id: string;
-    readonly label: string;
-};
-export type Props = {
-    /**
-     * Accent color for the selected segment.
-     * @default "blue"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Auto-focus the switcher on mount.
-     */
-    readonly autoFocus?: boolean;
-    /**
-     * Initial selected id (uncontrolled).
-     */
-    readonly defaultValue?: string;
-    /**
-     * Disable input.
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * Called when the selection changes.
-     */
-    readonly onChange?: (id: string) => void;
-    /**
-     * Segments to toggle between.
-     */
-    readonly options: ReadonlyArray<ContentSwitcherOption>;
-    /**
-     * Controlled selected id.
-     */
-    readonly value?: string;
-};
-/**
- * Segmented control that flips between mutually exclusive content. More
- * compact than `Tabs`: the selected segment is highlighted as a pill, and
- * only the active segment's content is rendered.
- * @param props See {@link Props}.
- * @returns A `ReactElement` with a segmented header row and the active
- * panel's content beneath it.
- */
-export default function ContentSwitcher({ accentColor, autoFocus, defaultValue, isDisabled, onChange, options, value, }: Props): ReactElement;

package/dist/ink/components/cursor-context.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/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/date-picker.d.ts

@@ -1,53 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement } from "react";
-import type { LiteralUnion } from "type-fest";
-export type Props = {
-    /**
-     * Accent color used by the inner calendar when open.
-     * @default "blue"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Auto-focus the picker on mount.
-     */
-    readonly autoFocus?: boolean;
-    /**
-     * Initial selected date when uncontrolled.
-     */
-    readonly defaultValue?: Date;
-    /**
-     * Override the way the selected date is rendered in the input row.
-     */
-    readonly formatValue?: (date: Date) => string;
-    /**
-     * Disable the picker.
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * Upper bound for selectable dates.
-     */
-    readonly maxDate?: Date;
-    /**
-     * Lower bound for selectable dates.
-     */
-    readonly minDate?: Date;
-    /**
-     * Fired when the user commits a date with Enter.
-     */
-    readonly onChange?: (date: Date) => void;
-    /**
-     * Placeholder rendered when no date is selected.
-     * @default "Pick a date"
-     */
-    readonly placeholder?: string;
-    /**
-     * Controlled selected date.
-     */
-    readonly value?: Date;
-};
-/**
- * Compact date input. Shows the currently-selected date; Enter / Space opens
- * the inline `Calendar` for navigation. Enter inside the calendar commits the
- * date and closes the picker.
- */
-export default function DatePicker({ accentColor, autoFocus, defaultValue, formatValue, isDisabled, maxDate, minDate, onChange, placeholder, value, }: Props): ReactElement;

package/dist/ink/components/definition-list.d.ts

@@ -1,37 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement, ReactNode } from "react";
-import type { LiteralUnion } from "type-fest";
-export type DefinitionItem = {
-    readonly description: ReactNode;
-    readonly key?: string;
-    readonly term: ReactNode;
-};
-export type Props = {
-    /**
-     * Spacing between term and description columns.
-     * @default 2
-     */
-    readonly columnGap?: number;
-    /**
-     * Entries to render.
-     */
-    readonly items: ReadonlyArray<DefinitionItem>;
-    /**
-     * Inline items display on the same row; stacked items display with the term above the description.
-     * @default "inline"
-     */
-    readonly layout?: "inline" | "stacked";
-    /**
-     * Color applied to the term.
-     * @default "cyan"
-     */
-    readonly termColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Minimum width used to align inline terms.
-     */
-    readonly termWidth?: number;
-};
-/**
- * Key/value style definition list. Equivalent to the HTML `&lt;dl>` element.
- */
-export default function DefinitionList({ columnGap, items, layout, termColor, termWidth }: Props): ReactElement;

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/diff-view.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/divider.d.ts

@@ -1,40 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement } from "react";
-import type { LiteralUnion } from "type-fest";
-export type Props = {
-    /**
-     * Custom character to use instead of the default line character.
-     */
-    readonly character?: string;
-    /**
-     * Color of the divider line.
-     */
-    readonly color?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Render the divider with dim color.
-     */
-    readonly dimColor?: boolean;
-    /**
-     * Optional label rendered in the middle of a horizontal divider.
-     */
-    readonly label?: string;
-    /**
-     * Padding around the label.
-     * @default 1
-     */
-    readonly labelPadding?: number;
-    /**
-     * Total length of the divider. When omitted, horizontal dividers stretch to
-     * fill the available space and vertical dividers default to one row.
-     */
-    readonly length?: number;
-    /**
-     * Orientation of the divider.
-     * @default "horizontal"
-     */
-    readonly orientation?: "horizontal" | "vertical";
-};
-/**
- * Horizontal or vertical divider line, optionally with a centered label.
- */
-export default function Divider({ character, color, dimColor, label, labelPadding, length, orientation }: Props): ReactElement;

package/dist/ink/components/error-boundary.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/error-overview.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/file-picker/file-picker.d.ts

@@ -1,58 +0,0 @@
-import type { ReactElement } from "react";
-import type { FileEntry, FilePickerFilter } from "./types.d.ts";
-export type Props = {
-    /**
-     * Color for the focused item highlight.
-     * @default "cyan"
-     */
-    readonly accentColor?: string;
-    /**
-     * Color for directory entries.
-     * @default "blue"
-     */
-    readonly directoryColor?: string;
-    /**
-     * Color for file entries.
-     * @default "white"
-     */
-    readonly fileColor?: string;
-    /**
-     * File filter options.
-     */
-    readonly filter?: FilePickerFilter;
-    /**
-     * Starting directory path.
-     * @default process.cwd()
-     */
-    readonly initialPath?: string;
-    /**
-     * Whether keyboard navigation is active.
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * Maximum number of visible items (viewport height).
-     * @default 10
-     */
-    readonly limit?: number;
-    /**
-     * Called when escape is pressed.
-     */
-    readonly onCancel?: () => void;
-    /**
-     * Called when a file is selected (enter on a file entry).
-     */
-    readonly onSelect?: (entry: FileEntry) => void;
-    /**
-     * Show file permissions column.
-     * @default false
-     */
-    readonly showPermissions?: boolean;
-    /**
-     * Show file size column.
-     * @default false
-     */
-    readonly showSize?: boolean;
-};
-declare const FilePicker: ({ accentColor, directoryColor, fileColor, filter, initialPath, isFocused, limit, onCancel, onSelect, showPermissions, showSize, }: Props) => ReactElement;
-export default FilePicker;

package/dist/ink/components/file-picker/types.d.ts

@@ -1,35 +0,0 @@
-/**
- * A single entry (file or directory) returned by the file system hook.
- */
-export type FileEntry = {
-    readonly isDirectory: boolean;
-    readonly isHidden: boolean;
-    readonly name: string;
-    readonly path: string;
-    readonly permissions: string;
-    readonly size: number;
-};
-/**
- * Filter options for the file picker.
- */
-export type FilePickerFilter = {
-    /**
-     * Allowed file extensions (e.g. `[".ts", ".tsx"]`). Empty or omitted means all.
-     */
-    readonly extensions?: ReadonlyArray<string>;
-    /**
-     * Whether to include directories in the list.
-     * @default true
-     */
-    readonly showDirectories?: boolean;
-    /**
-     * Whether to include regular files in the list.
-     * @default true
-     */
-    readonly showFiles?: boolean;
-    /**
-     * Whether to include hidden files (names starting with `.`).
-     * @default false
-     */
-    readonly showHidden?: boolean;
-};

package/dist/ink/components/file-picker/use-file-system.d.ts

@@ -1,16 +0,0 @@
-import type { FileEntry, FilePickerFilter } from "./types.d.ts";
-type UseFileSystemOptions = {
-    readonly filter: FilePickerFilter;
-    readonly initialPath: string;
-};
-type UseFileSystemResult = {
-    readonly currentPath: string;
-    readonly entries: ReadonlyArray<FileEntry>;
-    readonly error: string | undefined;
-    readonly goUp: () => void;
-    readonly isLoading: boolean;
-    readonly navigateTo: (path: string) => void;
-    readonly refresh: () => void;
-};
-export default function useFileSystem(options: UseFileSystemOptions): UseFileSystemResult;
-export {};

package/dist/ink/components/focus-context.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;