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

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

@@ -1,75 +0,0 @@
-import type { ReactElement, ReactNode } from "react";
-/**
- * Metadata about the current page state, passed to the render-prop children.
- */
-export type PageMeta = {
-    readonly currentPage: number;
-    readonly endIndex: number;
-    readonly isFirstPage: boolean;
-    readonly isLastPage: boolean;
-    readonly startIndex: number;
-    readonly totalPages: number;
-};
-export type Props<T> = {
-    /**
-     * Render-prop that receives the current page items and page metadata.
-     */
-    readonly children: (pageItems: readonly T[], meta: PageMeta) => ReactNode;
-    /**
-     * Uncontrolled initial page (0-indexed).
-     *
-     * @default 0
-     */
-    readonly defaultPage?: number;
-    /**
-     * Color for the active page indicator.
-     *
-     * @default "cyan"
-     */
-    readonly indicatorColor?: string;
-    /**
-     * Whether keyboard navigation is active.
-     *
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * The full list of items to paginate.
-     */
-    readonly items: readonly T[];
-    /**
-     * Called when the page changes.
-     */
-    readonly onChange?: (page: number) => void;
-    /**
-     * Controlled current page (0-indexed). When provided, the component is controlled.
-     */
-    readonly page?: number;
-    /**
-     * Number of items per page.
-     */
-    readonly pageSize: number;
-    /**
-     * Indicator style.
-     * - `"dots"`: `● ○ ○ ○`
-     * - `"numeric"`: `‹ 1 / 4 ›`
-     * - `"fraction"`: `1/4`
-     *
-     * @default "dots"
-     */
-    readonly style?: "dots" | "fraction" | "numeric";
-};
-/**
- * Paginator component with render-prop children and a page indicator.
- *
- * ```tsx
- * <Paginator items={allItems} pageSize={5}>
- *   {(pageItems, meta) => (
- *     <Box flexDirection="column">
- *       {pageItems.map((item, i) => <Text key={i}>{item}</Text>)}
- *     </Box>
- *   )}
- * </Paginator>
- * ```
- */
-export default function Paginator<T>({ children, defaultPage, indicatorColor, isFocused, items, onChange, page: controlledPage, pageSize, style, }: Props<T>): ReactElement;

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

@@ -1,51 +0,0 @@
-/**
- * Progress bar component for Ink.
- *
- * Based on ink-progress-bar by Frankie Bagnardi (brigand).
- * @see https://github.com/brigand/ink-progress-bar
- *
- * MIT License
- * Copyright (c) Frankie Bagnardi
- */
-import type { ReactElement } from "react";
-import type { Props as TextProps } from "./Text.d.ts";
-export type Props = {
-    /** Fill glyph repeated across the completed portion of the progress bar. Defaults to "█". */
-    readonly character?: string;
-    /**
-     * Override the terminal width used for calculation.
-     * When 0, uses the actual terminal width.
-     * @default 0
-     */
-    readonly columns?: number;
-    /**
-     * Number of columns reserved on the left side (e.g. for labels).
-     * @default 0
-     */
-    readonly left?: number;
-    /**
-     * Completion percentage between 0 and 1.
-     * @default 1
-     */
-    readonly percent?: number;
-    /**
-     * Number of columns reserved on the right side (e.g. for percentage text).
-     * @default 0
-     */
-    readonly right?: number;
-    /**
-     * Whether to pad the remaining space with whitespace.
-     * Useful when rendering the bar over a background color.
-     * @default false
-     */
-    readonly rightPad?: boolean;
-} & Omit<TextProps, "children">;
-/**
- * A terminal progress bar that fills proportionally to a percentage value.
- *
- * ```tsx
- * &lt;ProgressBar percent={0.5} />
- * &lt;ProgressBar percent={0.75} color="green" left={10} right={5} />
- * ```
- */
-export default function ProgressBar({ character, columns: columnsProp, left, percent, right, rightPad, ...textProps }: Props): ReactElement;

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

@@ -1,96 +0,0 @@
-import type { AnsiColors } from "@visulima/colorize";
-import type { FC, ReactElement } from "react";
-import type { LiteralUnion } from "type-fest";
-import type { Props as IndicatorProps } from "./SelectInputIndicator.d.ts";
-import type { Props as ItemProps } from "./SelectInputItem.d.ts";
-export type Item<V> = {
-    /**
-     * Called automatically when this item is selected (via Enter or number key).
-     * Fires after `onSelect`. Useful for defining per-item behavior inline.
-     */
-    readonly action?: () => void;
-    readonly key?: string;
-    readonly label: string;
-    readonly value: V;
-};
-export type SeparatorItem = {
-    /**
-     * Marks this entry as a non-focusable separator line.
-     */
-    readonly isSeparator: true;
-    readonly key?: string;
-    /**
-     * Custom separator text. Defaults to `"───"`.
-     */
-    readonly label?: string;
-};
-export type SelectInputEntry<V> = Item<V> | SeparatorItem;
-export type Props<V> = {
-    /**
-     * Color used for the selected item and indicator.
-     * @default "blue"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Color used for unselected items.
-     */
-    readonly defaultColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Controlled selected index. When provided, the component becomes controlled
-     * and `initialIndex` is ignored. Update this value in the `onHighlight` callback
-     * to track selection externally. If the index points to a separator, the nearest
-     * selectable item is highlighted instead.
-     */
-    readonly index?: number;
-    /**
-     * Custom component to override the default indicator component.
-     */
-    readonly indicatorComponent?: FC<IndicatorProps>;
-    /**
-     * Index of initially-selected item in `items` array.
-     * Ignored when `index` is provided.
-     * When omitted (`undefined`), no item is highlighted until the user presses a key.
-     * If the index points to a separator, the nearest selectable item is used.
-     */
-    readonly initialIndex?: number;
-    /**
-     * Whether the input is focused. Useful for when there are multiple
-     * inputs on the screen and you need to control which one captures input.
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * Custom component to override the default item component.
-     */
-    readonly itemComponent?: FC<ItemProps>;
-    /** @default [] */
-    readonly items?: ReadonlyArray<SelectInputEntry<V>>;
-    /**
-     * Number of visible items. Useful if the list is long and you want
-     * to limit the display with a scrolling window.
-     */
-    readonly limit?: number;
-    /**
-     * Called when the user highlights a new item via arrow keys or `j`/`k`.
-     * The second argument is the index of the highlighted item in the visible list.
-     */
-    readonly onHighlight?: (item: Item<V>, index: number) => void;
-    /**
-     * Called when the user selects an item via Enter or a number key (1-9).
-     */
-    readonly onSelect?: (item: Item<V>) => void;
-    /**
-     * Whether to reset the selection when items change.
-     * Set to `false` to preserve the current selection across item updates.
-     * @default true
-     */
-    readonly resetOnItemsChange?: boolean;
-};
-/**
- * A select input component for terminal UIs.
- *
- * Renders a list of items with an indicator showing the currently highlighted item.
- * Users can navigate with arrow keys or `j`/`k`, select with Enter, or jump to an
- * item by pressing a number key (1-9).
- */
-export default function SelectInput<V>({ accentColor, defaultColor, index, indicatorComponent, initialIndex, isFocused, itemComponent, items, limit: customLimit, onHighlight, onSelect, resetOnItemsChange, }: Props<V>): ReactElement;

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

@@ -1,36 +0,0 @@
-/**
- * Default indicator component for SelectInput.
- *
- * Based on ink-select-input by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-select-input
- *
- * 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 Props = {
-    /**
-     * Color of the indicator when selected.
-     * @default "blue"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Whether the parent SelectInput has focus.
-     * When `false`, the indicator is dimmed even if the item is selected.
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * Whether this indicator's item is currently selected.
-     * @default false
-     */
-    readonly isSelected?: boolean;
-};
-/**
- * Renders a pointer indicator next to the selected item, or a blank space otherwise.
- * When unfocused, the indicator is rendered with `dimColor` to visually distinguish
- * the active select input from inactive ones.
- */
-export default function SelectInputIndicator({ accentColor, isFocused, isSelected }: Props): ReactElement;

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

@@ -1,43 +0,0 @@
-/**
- * Default item component for SelectInput.
- *
- * Based on ink-select-input by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-select-input
- *
- * 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 Props = {
-    /**
-     * Color of the label when selected.
-     * @default "blue"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Color of the label when not selected.
-     */
-    readonly defaultColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Whether the parent SelectInput has focus.
-     * When `false`, the selected item is dimmed.
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * Whether this item is currently selected.
-     * @default false
-     */
-    readonly isSelected?: boolean;
-    /**
-     * Text label to display for this item.
-     */
-    readonly label: string;
-};
-/**
- * Renders an item label, using `accentColor` when selected and `defaultColor` otherwise.
- * When unfocused, selected items are rendered with `dimColor`.
- */
-export default function SelectInputItem({ accentColor, defaultColor, isFocused, isSelected, label }: Props): ReactElement;

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

@@ -1,92 +0,0 @@
-/**
- * Slider component for Ink.
- *
- * A keyboard-driven range input for terminal UIs, supporting
- * horizontal and vertical orientations.
- */
-import type { AnsiColors } from "@visulima/colorize";
-import type { ReactElement } from "react";
-import type { LiteralUnion } from "type-fest";
-export type Props = {
-    /**
-     * Accent color for the filled portion of the track and thumb.
-     * @default "green"
-     */
-    readonly accentColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Color for the empty portion of the track.
-     * @default "gray"
-     */
-    readonly defaultColor?: LiteralUnion<AnsiColors, string>;
-    /**
-     * Initial value when uncontrolled.
-     * @default 0
-     */
-    readonly defaultValue?: number;
-    /**
-     * Character used for the empty portion of the track.
-     * @default "░"
-     */
-    readonly emptyCharacter?: string;
-    /**
-     * Character used for the filled portion of the track.
-     * @default "█"
-     */
-    readonly filledCharacter?: string;
-    /**
-     * When true, all input is ignored and the slider is dimmed.
-     * @default false
-     */
-    readonly isDisabled?: boolean;
-    /**
-     * When true, the component responds to keyboard input.
-     * @default true
-     */
-    readonly isFocused?: boolean;
-    /**
-     * Maximum value.
-     * @default 100
-     */
-    readonly max?: number;
-    /**
-     * Minimum value.
-     * @default 0
-     */
-    readonly min?: number;
-    /**
-     * Fires whenever the value changes.
-     */
-    readonly onChange?: (value: number) => void;
-    /**
-     * Layout direction of the slider.
-     * @default "horizontal"
-     */
-    readonly orientation?: "horizontal" | "vertical";
-    /**
-     * Increment size for arrow key presses.
-     * @default 1
-     */
-    readonly step?: number;
-    /**
-     * Character used to indicate the current position.
-     * @default "●"
-     */
-    readonly thumbCharacter?: string;
-    /**
-     * Controlled value. When provided, `defaultValue` is ignored.
-     */
-    readonly value?: number;
-    /**
-     * Width of the slider track in columns (horizontal) or rows (vertical).
-     * @default 20
-     */
-    readonly width?: number;
-};
-/**
- * A keyboard-driven slider / range input.
- *
- * ```tsx
- * &lt;Slider defaultValue={50} min={0} max={100} onChange={setValue} />
- * ```
- */
-export default function Slider({ accentColor, defaultColor, defaultValue, emptyCharacter, filledCharacter, isDisabled, isFocused, max, min, onChange, orientation, step, thumbCharacter, value: controlledValue, width, }: Props): ReactElement;

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

@@ -1,7 +0,0 @@
-import type { ReactElement } from "react";
-/**
- * A flexible space that expands along the major axis of its containing layout.
- *
- * It's useful as a shortcut for filling all the available space between elements.
- */
-export default function Spacer(): ReactElement;

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

@@ -1,42 +0,0 @@
-/**
- * Spinner component for Ink.
- *
- * Based on ink-spinner by Vadim Demedes.
- * @see https://github.com/vadimdemedes/ink-spinner
- *
- * MIT License
- * Copyright (c) Vadym Demedes (github.com/vadimdemedes)
- *
- * 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.
- */
-import type { SpinnerName } from "cli-spinners";
-import type { ReactElement } from "react";
-export type Props = {
-    /**
-     * Type of a spinner.
-     * See [cli-spinners](https://github.com/sindresorhus/cli-spinners) for available spinners.
-     * @default "dots"
-     */
-    readonly type?: SpinnerName;
-};
-/**
- * Spinner component that renders an animated loading indicator.
- *
- * Uses spinners from [cli-spinners](https://github.com/sindresorhus/cli-spinners).
- */
-export default function Spinner({ type }: Props): ReactElement;

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

@@ -1,24 +0,0 @@
-import type { ReactElement, ReactNode } from "react";
-import type { Styles } from "../styles.d.ts";
-export type Props<T> = {
-    /**
-     * Function that is called to render every item in the `items` array. The first argument is the item itself, and the second argument is the index of that item in the `items` array. Note that a `key` must be assigned to the root component.
-     */
-    readonly children: (item: T, index: number) => ReactNode;
-    /**
-     * Array of items of any type to render using the function you pass as a component child.
-     */
-    readonly items: T[];
-    /**
-     * Styles to apply to a container of child elements. See &lt;Box> for supported properties.
-     */
-    readonly style?: Styles;
-};
-/**
- * `&lt;Static>` component permanently renders its output above everything else. It's useful for displaying activity like completed tasks or logs—things that don't change after they're rendered (hence the name "Static").
- *
- * It's preferred to use `&lt;Static>` for use cases like these when you can't know or control the number of items that need to be rendered.
- *
- * For example, [Tap](https://github.com/tapjs/node-tap) uses `&lt;Static>` to display a list of completed tests. [Gatsby](https://github.com/gatsbyjs/gatsby) uses it to display a list of generated pages while still displaying a live progress bar.
- */
-export default function Static<T>(props: Props<T>): ReactElement;

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

@@ -1,28 +0,0 @@
-/**
- * StaticRender component — pre-renders children once and caches the result.
- *
- * When mounted, StaticRender renders its children into a Region via
- * prepareYogaTree() in the Ink layout phase, then caches the result on the
- * DOM node. On subsequent renders, the cached Region is composited directly
- * via addRegionTree(), skipping the entire subtree traversal.
- *
- * Children are passed as a render function `() => ReactNode`. Once the cache
- * is ready, the component stops calling the function so React does not
- * re-reconcile the subtree on subsequent renders.
- *
- * Use this for content that renders once and doesn't change (e.g., completed
- * task output, logged messages, static headers).
- *
- * Ported from jacob314/ink (Google LLC, Apache-2.0).
- * @license Apache-2.0
- */
-import type { ReactNode } from "react";
-import React from "react";
-import type { Styles } from "../styles.d.ts";
-export type Props = {
-    readonly children: () => ReactNode;
-    readonly style?: Styles;
-    readonly width?: number;
-};
-declare const StaticRender: ({ children, style, width }: Props) => React.ReactNode;
-export default StaticRender;

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

@@ -1,26 +0,0 @@
-/**
- * Status message component for Ink.
- *
- * Inspired by ink-ui StatusMessage 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";
-import type { Variant } from "./variant-config.d.ts";
-export type StatusMessageVariant = Variant;
-export type Props = {
-    /**
-     * Message content.
-     */
-    readonly children: ReactNode;
-    /**
-     * Determines the icon and color of the status message.
-     */
-    readonly variant: StatusMessageVariant;
-};
-/**
- * Renders a status notification with a colored icon and message text.
- */
-export default function StatusMessage({ children, variant }: Props): ReactElement;

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

@@ -1,16 +0,0 @@
-import type { Context } from "react";
-export type Props = {
-    /**
-     * Stderr stream passed to `render()` in `options.stderr` or `process.stderr` by default.
-     */
-    readonly stderr: NodeJS.WriteStream;
-    /**
-     * Write any string to stderr while preserving Ink's output. It's useful when you want to display external information outside of Ink's rendering and ensure there's no conflict between the two. It's similar to `<Static>`, except it can't accept components; it only works with strings.
-     */
-    readonly write: (data: string) => void;
-};
-/**
- * `StderrContext` is a React context that exposes the stderr stream.
- */
-declare const StderrContext: Context<Props>;
-export default StderrContext;

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

@@ -1,29 +0,0 @@
-import { EventEmitter } from "node:events";
-import type { Context } from "react";
-export type PublicProps = {
-    /**
-     * A boolean flag determining if the current `stdin` supports `setRawMode`. A component using `setRawMode` might want to use `isRawModeSupported` to nicely fall back in environments where raw mode is not supported.
-     */
-    readonly isRawModeSupported: boolean;
-    /**
-     * Ink exposes this function via own `<StdinContext>` to be able to handle Ctrl+C, that's why you should use Ink's `setRawMode` instead of `process.stdin.setRawMode`. If the `stdin` stream passed to Ink does not support setRawMode, this function does nothing.
-     */
-    readonly setRawMode: (value: boolean) => void;
-    /**
-     * The stdin stream passed to `render()` in `options.stdin`, or `process.stdin` by default. Useful if your app needs to handle user input.
-     */
-    readonly stdin: NodeJS.ReadStream;
-};
-export type Props = PublicProps & {
-    readonly internal_eventEmitter: EventEmitter;
-    readonly internal_exitOnCtrlC: boolean;
-    /**
-     * Enable or disable bracketed paste mode on the terminal. When enabled, pasted text is wrapped in escape sequences that allow it to be distinguished from typed input.
-     */
-    readonly setBracketedPasteMode: (value: boolean) => void;
-};
-/**
- * `StdinContext` is a React context that exposes the input stream.
- */
-declare const StdinContext: Context<Props>;
-export default StdinContext;

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

@@ -1,16 +0,0 @@
-import type { Context } from "react";
-export type Props = {
-    /**
-     * Stdout stream passed to `render()` in `options.stdout` or `process.stdout` by default.
-     */
-    readonly stdout: NodeJS.WriteStream;
-    /**
-     * Write any string to stdout while preserving Ink's output. It's useful when you want to display external information outside of Ink's rendering and ensure there's no conflict between the two. It's similar to `<Static>`, except it can't accept components; it only works with strings.
-     */
-    readonly write: (data: string) => void;
-};
-/**
- * `StdoutContext` is a React context that exposes the stdout stream where Ink renders your app.
- */
-declare const StdoutContext: Context<Props>;
-export default StdoutContext;

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

@@ -1,44 +0,0 @@
-import type { ForwardRefExoticComponent, RefAttributes } from "react";
-import type { UseStopwatchResult } from "../hooks/use-stopwatch.d.ts";
-export type StopwatchRef = Omit<UseStopwatchResult, "elapsed" | "isRunning" | "laps">;
-export type Props = {
-    /**
-     * Whether to start counting immediately.
-     *
-     * @default false
-     */
-    readonly autoStart?: boolean;
-    /**
-     * Make the rendered text bold.
-     */
-    readonly bold?: boolean;
-    /**
-     * Text color for the rendered time.
-     */
-    readonly color?: string;
-    /**
-     * Custom formatter for the elapsed time.
-     * Receives elapsed milliseconds, returns a display string.
-     *
-     * @default formatDuration (MM:SS or HH:MM:SS)
-     */
-    readonly format?: (elapsed: number) => string;
-    /**
-     * Tick interval in milliseconds.
-     *
-     * @default 1000
-     */
-    readonly interval?: number;
-};
-/**
- * A count-up stopwatch component.
- *
- * Exposes `start`, `stop`, `toggle`, `reset`, and `lap` methods via ref.
- *
- * ```tsx
- * const ref = useRef<StopwatchRef>(null);
- * <Stopwatch ref={ref} autoStart />
- * ```
- */
-declare const Stopwatch: ForwardRefExoticComponent<Props & RefAttributes<StopwatchRef>>;
-export default Stopwatch;

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

@@ -1,25 +0,0 @@
-/**
- * Tab 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 { ReactElement, ReactNode } from "react";
-export type Props = {
-    /**
-     * Tab content to render when the tab is active.
-     */
-    readonly children: ReactNode;
-    /**
-     * Unique name identifying this tab.
-     */
-    readonly name: string;
-};
-/**
- * A single tab within a Tabs container.
- * The `name` prop identifies the tab; `children` is rendered when active.
- */
-export default function Tab({ children }: Props): ReactElement;