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

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

@@ -1,80 +0,0 @@
-import type { BorderStyle, HorizontalAlignment } from "@visulima/tabular";
-import type { ReactElement } from "react";
-/**
- * Scalar value that can be displayed in a table cell.
- */
-type Scalar = bigint | boolean | number | string | null | undefined;
-/**
- * Dictionary with scalar values, representing a single row of data.
- */
-type ScalarDict = Record<string, Scalar>;
-/**
- * Configuration for a single table column.
- */
-type ColumnConfig<T extends ScalarDict> = {
-    /**
-     * Horizontal alignment of cell content.
-     */
-    readonly align?: HorizontalAlignment;
-    /**
-     * Custom header label. Defaults to the key name.
-     */
-    readonly header?: string;
-    /**
-     * Key from the data object to display in this column.
-     */
-    readonly key: keyof T & string;
-    /**
-     * Fixed width for this column in characters.
-     */
-    readonly width?: number;
-};
-type Props<T extends ScalarDict> = {
-    /**
-     * Border style preset name or a custom `BorderStyle` object from `@visulima/tabular`.
-     * @default "default"
-     */
-    readonly borderStyle?: "ascii" | "block" | "default" | "dots" | "double" | "markdown" | "minimal" | "none" | "rounded" | "thick" | BorderStyle;
-    /**
-     * Columns to display and their order.
-     * Accepts simple key strings or `ColumnConfig` objects for advanced control.
-     * If omitted, all keys from the first data item are used.
-     */
-    readonly columns?: ((keyof T & string) | ColumnConfig<T>)[];
-    /**
-     * Array of objects to display as rows.
-     */
-    readonly data: T[];
-    /**
-     * Format a cell value before rendering. Return a string to display in the cell.
-     */
-    readonly formatCell?: (value: Scalar, column: keyof T & string, rowIndex: number) => string;
-    /**
-     * Format a header label before rendering. Return a string to display as the column header.
-     */
-    readonly formatHeader?: (column: keyof T & string) => string;
-    /**
-     * Maximum width of the table in characters. Columns will be truncated or wrapped to fit.
-     */
-    readonly maxWidth?: number;
-    /**
-     * Cell padding (left and right) in characters.
-     * @default 1
-     */
-    readonly padding?: number;
-    /**
-     * Whether to show the header row.
-     * @default true
-     */
-    readonly showHeader?: boolean;
-    /** Placeholder shown in place of `null` or `undefined` cell values. Defaults to an empty string. */
-    readonly skeleton?: string;
-    /**
-     * Enable word wrap instead of truncation when cells exceed their width.
-     * @default false
-     */
-    readonly wordWrap?: boolean;
-};
-declare const _default: <T extends ScalarDict>(props: Props<T>) => ReactElement;
-export default _default;
-export type { ColumnConfig, Props, Scalar, ScalarDict };

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

@@ -1,104 +0,0 @@
-/**
- * Tabs component for Ink.
- *
- * Inspired by ink-tab by Julien Deniau.
- * @see https://github.com/jdeniau/ink-tab
- *
- * MIT License
- * Copyright (c) Julien Deniau (github.com/jdeniau)
- */
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement, ReactNode } from "react";
-import type { LiteralUnion } from "type-fest";
-import type { Props as TabProps } from "./Tab.d.ts";
-/**
- * Keyboard navigation configuration for Tabs.
- */
-export type KeyMap = {
-    /**
-     * Key names that move to the next tab.
-     * Defaults to `["rightArrow"]` for row layouts and `["downArrow"]` for column layouts.
-     */
-    readonly next?: ReadonlyArray<string>;
-    /**
-     * Key names that move to the previous tab.
-     * Defaults to `["leftArrow"]` for row layouts and `["upArrow"]` for column layouts.
-     */
-    readonly previous?: ReadonlyArray<string>;
-    /**
-     * Whether Meta/Cmd + 1–9 jumps to a specific tab.
-     * @default true
-     */
-    readonly useNumbers?: boolean;
-    /**
-     * Whether the Tab key cycles through tabs (only when `isFocused` is not managed by Ink).
-     * @default true
-     */
-    readonly useTab?: boolean;
-};
-/**
- * Color customization for active tab styling.
- */
-export type TabColors = {
-    readonly activeTab?: {
-        readonly backgroundColor?: LiteralUnion<AnsiColors, string>;
-        readonly color?: LiteralUnion<AnsiColors, string>;
-    };
-};
-export type Props = {
-    /**
-     * Tab elements to render.
-     */
-    readonly children: ReactNode;
-    /**
-     * Active tab colors. When `isFocused` is `false`, the active tab uses gray.
-     */
-    readonly colors?: TabColors;
-    /**
-     * Name of the tab to select initially (uncontrolled mode).
-     * Ignored when `value` is provided.
-     */
-    readonly defaultValue?: string;
-    /**
-     * Layout direction for the tab bar.
-     * @default "row"
-     */
-    readonly flexDirection?: "column" | "column-reverse" | "row" | "row-reverse";
-    /**
-     * Whether the tabs are focused and respond to keyboard input.
-     * - `true`: focused, uses active colors.
-     * - `false`: unfocused, uses gray active color, ignores input.
-     * - `undefined`/`null`: always active (focus not managed by Ink).
-     * @default undefined
-     */
-    readonly isFocused?: boolean | null;
-    /**
-     * Custom keyboard mappings.
-     */
-    readonly keyMap?: KeyMap;
-    /**
-     * Called when the active tab changes.
-     */
-    readonly onChange: (name: string, activeTab: ReactElement<TabProps>) => void;
-    /**
-     * Whether to display 1-based index numbers before each tab name.
-     * @default true
-     */
-    readonly showIndex?: boolean;
-    /**
-     * Controlled active tab name. When provided, the component is controlled —
-     * the parent owns the active tab state and must update it via `onChange`.
-     * When omitted, the component manages its own state (uncontrolled mode).
-     */
-    readonly value?: string;
-    /**
-     * Width of the container Box. Also determines the separator width in column layouts.
-     */
-    readonly width?: number | string;
-};
-/**
- * Tabbed navigation component. Renders a row or column of tabs with keyboard
- * navigation (arrow keys, Tab, number keys) and calls `onChange` when the
- * active tab changes.
- */
-export default function Tabs({ children, colors: colorsProp, defaultValue, flexDirection, isFocused, keyMap: keyMapProp, onChange, showIndex, value, width, }: Props): ReactElement;

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

@@ -1,63 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement, ReactNode } from "react";
-import type { LiteralUnion } from "type-fest";
-import type { Styles } from "../styles.d.ts";
-export type Props = {
-    /**
-     * Hide the element from screen readers.
-     */
-    readonly "aria-hidden"?: boolean;
-    /**
-     * A label for the element for screen readers.
-     */
-    readonly "aria-label"?: string;
-    /**
-     * Same as `color`, but for the background.
-     */
-    readonly backgroundColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Make the text bold.
-     */
-    readonly bold?: boolean;
-    readonly children?: ReactNode;
-    /**
-     * Change text color. Ink uses @visulima/colorize under the hood, so all its functionality is supported.
-     */
-    readonly color?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Dim the color (make it less bright).
-     */
-    readonly dimColor?: boolean;
-    /**
-     * Inverse background and foreground colors.
-     */
-    readonly inverse?: boolean;
-    /**
-     * Make the text italic.
-     */
-    readonly italic?: boolean;
-    /**
-     * Make the text crossed out with a line.
-     */
-    readonly strikethrough?: boolean;
-    /**
-     * Make the text underlined.
-     */
-    readonly underline?: boolean;
-    /**
-     * Controls how text wraps when it exceeds the container width.
-     *
-     * - `wrap` (default) — Wrap at word boundaries; break inside words only when a single word exceeds the width.
-     * - `wrap-anywhere` — Break at any character boundary, even when a whitespace break exists earlier.
-     * - `wrap-preserve-words` — Wrap at word boundaries; never break inside words (long words may overflow).
-     * - `wrap-strict` — Enforce exact width; always break at the column limit.
-     * - `truncate` / `truncate-end` — Truncate at the end with an ellipsis.
-     * - `truncate-start` — Truncate at the start with an ellipsis.
-     * - `truncate-middle` — Truncate in the middle with an ellipsis.
-     */
-    readonly wrap?: Styles["textWrap"];
-};
-/**
- * This component can display text and change its style to make it bold, underlined, italic, or strikethrough.
- */
-export default function Text({ "aria-hidden": ariaHidden, "aria-label": ariaLabel, backgroundColor, bold, children, color, dimColor, inverse, italic, strikethrough, underline, wrap, }: Props): ReactElement | null;

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

@@ -1,48 +0,0 @@
-/**
- * Text input component for Ink.
- *
- * Inspired by ink-ui TextInput by Vadim Demedes and ink-text-input by Sindre Sorhus.
- * @see https://github.com/vadimdemedes/ink-ui
- *
- * MIT License
- * Copyright (c) Vadym Demedes (github.com/vadimdemedes)
- */
-import type { ReactElement } from "react";
-export type Props = {
-    /** @default "" */
-    readonly defaultValue?: string;
-    /**
-     * When true, all input is ignored and text is dimmed.
-     * @default false
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * When true, renders asterisks instead of the actual characters.
-     * @default false
-     */
-    readonly mask?: boolean;
-    /**
-     * Fires on every keystroke with the updated text.
-     */
-    readonly onChange?: (value: string) => void;
-    /**
-     * Fires when the user presses Enter.
-     */
-    readonly onSubmit?: (value: string) => void;
-    /**
-     * Greyed-out text shown when the input is empty.
-     */
-    readonly placeholder?: string;
-    /**
-     * Autocomplete candidates. The first case-sensitive prefix match is shown
-     * dimmed after the current input. Press right-arrow or Enter to accept.
-     */
-    readonly suggestions?: ReadonlyArray<string>;
-};
-/**
- * A single-line text input with cursor navigation, optional placeholder,
- * autocomplete suggestions, and password masking.
- *
- * Supports arrow keys, Home/End, Ctrl+A/E, Ctrl+U/K/W, Backspace, Delete.
- */
-export default function TextInput({ defaultValue, isDisabled, mask, onChange, onSubmit, placeholder, suggestions }: Props): ReactElement;

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

@@ -1,62 +0,0 @@
-/**
- * Multi-line text input component for Ink.
- *
- * Provides a full-featured textarea with cursor navigation, selection,
- * clipboard support, undo/redo, and viewport scrolling.
- */
-import type { ReactElement } from "react";
-export type Props = {
-    /** @default "" */
-    readonly defaultValue?: string;
-    /**
-     * When true, all input is ignored and text is dimmed.
-     * @default false
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * When true, the component responds to keyboard input.
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * Maximum visible rows before viewport scrolling kicks in.
-     * When set, the textarea will grow from `rows` to `maxRows` before scrolling.
-     */
-    readonly maxRows?: number;
-    /**
-     * Fires on every edit with the updated text.
-     */
-    readonly onChange?: (value: string) => void;
-    /**
-     * Fires when the user presses Meta+Enter or Ctrl+Enter.
-     */
-    readonly onSubmit?: (value: string) => void;
-    /**
-     * Greyed-out text shown when the textarea is empty.
-     */
-    readonly placeholder?: string;
-    /**
-     * Number of visible rows (viewport height).
-     * @default 5
-     */
-    readonly rows?: number;
-    /**
-     * Show line numbers in the left gutter.
-     * @default false
-     */
-    readonly showLineNumbers?: boolean;
-    /**
-     * Number of spaces inserted for a Tab key press.
-     * @default 2
-     */
-    readonly tabSize?: number;
-};
-/**
- * A multi-line text input with cursor navigation, selection, clipboard, undo/redo,
- * paste support, and viewport scrolling.
- *
- * ```tsx
- * <Textarea defaultValue="Hello\nWorld" rows={10} onChange={setValue} onSubmit={handleSubmit} />
- * ```
- */
-export default function Textarea({ defaultValue, isDisabled, isFocused, maxRows, onChange, onSubmit, placeholder, rows, showLineNumbers, tabSize, }: Props): ReactElement;

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

@@ -1,52 +0,0 @@
-import type { ForwardRefExoticComponent, RefAttributes } from "react";
-import type { UseTimerResult } from "../hooks/use-timer.d.ts";
-export type TimerRef = Omit<UseTimerResult, "isFinished" | "isRunning" | "remaining">;
-export type Props = {
-    /**
-     * Whether to start the timer immediately.
-     *
-     * @default false
-     */
-    readonly autoStart?: boolean;
-    /**
-     * Make the rendered text bold.
-     */
-    readonly bold?: boolean;
-    /**
-     * Text color for the rendered time.
-     */
-    readonly color?: string;
-    /**
-     * Total countdown duration in milliseconds.
-     */
-    readonly duration: number;
-    /**
-     * Custom formatter for the remaining time.
-     * Receives remaining milliseconds, returns a display string.
-     *
-     * @default formatDuration (MM:SS or HH:MM:SS)
-     */
-    readonly format?: (remaining: number) => string;
-    /**
-     * Tick interval in milliseconds.
-     *
-     * @default 1000
-     */
-    readonly interval?: number;
-    /**
-     * Called once when the timer reaches zero.
-     */
-    readonly onTimeout?: () => void;
-};
-/**
- * A countdown timer component.
- *
- * Exposes `start`, `stop`, `toggle`, and `reset` methods via ref.
- *
- * ```tsx
- * const ref = useRef<TimerRef>(null);
- * <Timer ref={ref} duration={60_000} autoStart />
- * ```
- */
-declare const Timer: ForwardRefExoticComponent<Props & RefAttributes<TimerRef>>;
-export default Timer;

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

@@ -1,16 +0,0 @@
-import type { ReactElement, ReactNode } from "react";
-export type Props = {
-    /**
-     * Screen-reader-specific text to output. If this is set, all children will be ignored.
-     */
-    readonly accessibilityLabel?: string;
-    readonly children?: ReactNode;
-    /**
-     * Function that transforms children output. It accepts children and must return transformed children as well. Note that when children use `<Text>` styling props (e.g. `color`, `bold`), the string will contain ANSI escape codes.
-     */
-    readonly transform: (children: string, index: number) => string;
-};
-/**
- * Transform a string representation of React components before they're written to output. For example, you might want to apply a gradient to text, add a clickable link, or create some text effects. These use cases can't accept React nodes as input; they expect a string. That's what the <Transform> component does: it gives you an output string of its child components and lets you transform it in any way.
- */
-export default function Transform({ accessibilityLabel, children, transform }: Props): ReactElement | null;

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

@@ -1,35 +0,0 @@
-/**
- * Unordered list component for Ink.
- *
- * Inspired by ink-ui UnorderedList 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 UnorderedListEntry = {
-    /**
-     * Content of the list entry. Can be a string or nested list.
-     */
-    readonly children?: ReadonlyArray<UnorderedListEntry>;
-    /**
-     * Display text for this item.
-     */
-    readonly label: ReactNode;
-};
-export type Props = {
-    /**
-     * Entries to render as a bullet list.
-     */
-    readonly items: ReadonlyArray<UnorderedListEntry>;
-    /**
-     * Custom bullet symbol(s). A string uses the same symbol at all depths.
-     * An array cycles through symbols by nesting depth.
-     */
-    readonly marker?: ReadonlyArray<string> | string;
-};
-/**
- * Renders a bullet list with nesting support.
- */
-export default function UnorderedList({ items, marker }: Props): ReactElement;

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

@@ -1,75 +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;
-};
-/**
- * A file system browser component for picking files from the terminal.
- *
- * ```tsx
- * <FilePicker
- *   onSelect={(entry) => console.log("Selected:", entry.path)}
- *   filter={{ extensions: [".ts", ".tsx"] }}
- * />
- * ```
- */
-export default function FilePicker({ accentColor, directoryColor, fileColor, filter, initialPath, isFocused, limit, onCancel, onSelect, showPermissions, showSize, }: Props): ReactElement;

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

@@ -1,3 +0,0 @@
-export type { Props as FilePickerProps } from "./FilePicker.d.ts";
-export { default as FilePicker } from "./FilePicker.d.ts";
-export type { FileEntry, FilePickerFilter } from "./types.d.ts";

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

@@ -1,38 +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?: readonly 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: readonly 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/scroll/ControlledScrollView.d.ts

@@ -1,43 +0,0 @@
-import type React from "react";
-import type { ReactNode, Ref } from "react";
-import type { Props as BoxProps } from "../Box.d.ts";
-export interface ControlledScrollViewProps extends BoxProps {
-    children?: ReactNode;
-    debug?: boolean;
-    onContentHeightChange?: (height: number, previousHeight: number) => void;
-    onItemHeightChange?: (index: number, height: number, previousHeight: number) => void;
-    onViewportSizeChange?: (size: {
-        height: number;
-        width: number;
-    }, previousSize: {
-        height: number;
-        width: number;
-    }) => void;
-    /**
-     * Number of extra items to render above/below the viewport when virtualized.
-     * @default 3
-     */
-    overscan?: number;
-    scrollOffset: number;
-    /**
-     * Only render items visible in the viewport plus overscan.
-     * Items must be measured first (first render always renders all items).
-     * @default false
-     */
-    virtualize?: boolean;
-}
-export interface ControlledScrollViewRef {
-    getBottomOffset: () => number;
-    getContentHeight: () => number;
-    getItemHeight: (index: number) => number;
-    getItemPosition: (index: number) => {
-        height: number;
-        top: number;
-    } | null;
-    getViewportHeight: () => number;
-    remeasure: () => void;
-    remeasureItem: (index: number) => void;
-}
-export declare const ControlledScrollView: ({ children, debug, onContentHeightChange, onItemHeightChange, onViewportSizeChange, overscan, ref, scrollOffset, virtualize, ...boxProps }: ControlledScrollViewProps & {
-    ref?: Ref<ControlledScrollViewRef>;
-}) => React.JSX.Element;

package/dist/ink/components/scroll/ScrollBar.d.ts

@@ -1,20 +0,0 @@
-import React from "react";
-import type { Props as BoxProps } from "../Box.d.ts";
-type ScrollBarPlacement = "inset" | "left" | "right";
-type ScrollBarStyle = BoxProps["borderStyle"] | "block" | "line" | "thick" | "dots";
-interface ScrollBarProps {
-    autoHide?: boolean;
-    color?: string;
-    contentHeight: number;
-    dimColor?: boolean;
-    placement?: ScrollBarPlacement;
-    scrollOffset: number;
-    style?: ScrollBarStyle;
-    thumbChar?: string;
-    trackChar?: string;
-    viewportHeight: number;
-}
-declare const ScrollBar: React.FC<ScrollBarProps>;
-export type { ScrollBarPlacement, ScrollBarProps, ScrollBarStyle };
-export { ScrollBar };
-export default ScrollBar;

package/dist/ink/components/scroll/ScrollBarBox.d.ts

@@ -1,15 +0,0 @@
-import type React from "react";
-import type { Props as BoxProps } from "../Box.d.ts";
-interface ScrollBarBoxProps extends BoxProps {
-    children?: React.ReactNode;
-    contentHeight: number;
-    scrollBarAutoHide?: boolean;
-    scrollBarPosition?: "left" | "right";
-    scrollOffset: number;
-    thumbChar?: string;
-    viewportHeight: number;
-}
-declare const ScrollBarBox: ({ borderColor, borderDimColor, borderLeftColor, borderLeftDimColor, borderRightColor, borderRightDimColor, borderStyle, children, contentHeight, height, scrollBarAutoHide, scrollBarPosition, scrollOffset, thumbChar, viewportHeight, ...boxProps }: ScrollBarBoxProps) => React.JSX.Element;
-export type { ScrollBarBoxProps };
-export { ScrollBarBox };
-export default ScrollBarBox;