@visulima/tui-kit 1.0.0 → 1.0.2

package/dist/select-input-indicator.d.ts

@@ -3,30 +3,26 @@ import { ReactElement } from 'react';
 import { LiteralUnion } from 'type-fest';
 type Props = {
   /**
-  * Color of the indicator when selected.
-  * @default "blue"
-  */
+   * 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
-  */
+   * 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
-  */
+   * 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.
-*/
-declare function SelectInputIndicator({
-  accentColor,
-  isFocused,
-  isSelected
-}: Props): ReactElement;
+ * 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.
+ */
+declare function SelectInputIndicator({ accentColor, isFocused, isSelected }: Props): ReactElement;
 export { Props, SelectInputIndicator, type Props as SelectInputIndicatorProps, SelectInputIndicator as default };

package/dist/select-input-item.d.ts

@@ -3,39 +3,33 @@ import { ReactElement } from 'react';
 import { LiteralUnion } from 'type-fest';
 type Props = {
   /**
-  * Color of the label when selected.
-  * @default "blue"
-  */
+   * Color of the label when selected.
+   * @default "blue"
+   */
   readonly accentColor?: LiteralUnion<AnsiColors, string>;
   /**
-  * Color of the label when not selected.
-  */
+   * 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
-  */
+   * 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
-  */
+   * Whether this item is currently selected.
+   * @default false
+   */
   readonly isSelected?: boolean;
   /**
-  * Text label to display for this item.
-  */
+   * 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`.
-*/
-declare function SelectInputItem({
-  accentColor,
-  defaultColor,
-  isFocused,
-  isSelected,
-  label
-}: Props): ReactElement;
+ * Renders an item label, using `accentColor` when selected and `defaultColor` otherwise.
+ * When unfocused, selected items are rendered with `dimColor`.
+ */
+declare function SelectInputItem({ accentColor, defaultColor, isFocused, isSelected, label }: Props): ReactElement;
 export { Props, SelectInputItem, type Props as SelectInputItemProps, SelectInputItem as default };

package/dist/select-input.d.ts

@@ -5,9 +5,9 @@ import { Props as Props$1 } from "./select-input-indicator.js";
 import { Props as Props$2 } from "./select-input-item.js";
 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.
-  */
+   * 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;
@@ -15,96 +15,83 @@ type Item<V> = {
 };
 type SeparatorItem = {
   /**
-  * Marks this entry as a non-focusable separator line.
-  */
+   * Marks this entry as a non-focusable separator line.
+   */
   readonly isSeparator: true;
   readonly key?: string;
   /**
-  * Custom separator text. Defaults to `"───"`.
-  */
+   * Custom separator text. Defaults to `"───"`.
+   */
   readonly label?: string;
 };
 type SelectInputEntry<V> = Item<V> | SeparatorItem;
 type Props<V> = {
   /**
-  * Color used for the selected item and indicator.
-  * @default "blue"
-  */
+   * Color used for the selected item and indicator.
+   * @default "blue"
+   */
   readonly accentColor?: LiteralUnion<AnsiColors, string>;
   /**
-  * Color used for unselected items.
-  */
+   * 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.
-  */
+   * 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.
-  */
+   * Custom component to override the default indicator component.
+   */
   readonly indicatorComponent?: FC<Props$1>;
   /**
-  * 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.
-  */
+   * 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
-  */
+   * 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.
-  */
+   * Custom component to override the default item component.
+   */
   readonly itemComponent?: FC<Props$2>;
   /** @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.
-  */
+   * 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.
-  */
+   * 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).
-  */
+   * 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
-  */
+   * 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).
-*/
-declare function SelectInput<V>({
-  accentColor,
-  defaultColor,
-  index,
-  indicatorComponent,
-  initialIndex,
-  isFocused,
-  itemComponent,
-  items,
-  limit: customLimit,
-  onHighlight,
-  onSelect,
-  resetOnItemsChange
-}: Props<V>): ReactElement;
+ * 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).
+ */
+declare function SelectInput<V>({ accentColor, defaultColor, index, indicatorComponent, initialIndex, isFocused, itemComponent, items, limit: customLimit, onHighlight, onSelect, resetOnItemsChange }: Props<V>): ReactElement;
 export { Item, Props, SelectInput, SelectInputEntry, type Item as SelectInputItemType, type Props as SelectInputProps, type SeparatorItem as SelectInputSeparator, SeparatorItem, SelectInput as default };

package/dist/shimmer-text.d.ts

@@ -3,45 +3,39 @@ import { ReactElement } from 'react';
 import { LiteralUnion } from 'type-fest';
 type Props = {
   /**
-  * Width of the highlighted band in characters.
-  * @default 3
-  */
+   * Width of the highlighted band in characters.
+   * @default 3
+   */
   readonly bandWidth?: number;
   /**
-  * Base color of the non-highlighted text.
-  */
+   * Base color of the non-highlighted text.
+   */
   readonly color?: LiteralUnion<AnsiColors, string>;
   /**
-  * Highlight color of the sweeping band.
-  * @default "white"
-  */
+   * Highlight color of the sweeping band.
+   * @default "white"
+   */
   readonly highlightColor?: LiteralUnion<AnsiColors, string>;
   /**
-  * Milliseconds between frames of the shimmer.
-  * @default 60
-  */
+   * Milliseconds between frames of the shimmer.
+   * @default 60
+   */
   readonly interval?: number;
   /**
-  * Text to render with a shimmer sweep.
-  */
+   * Text to render with a shimmer sweep.
+   */
   readonly text: string;
 };
 /**
-* Text with an animated highlight band that sweeps across the characters.
-* Perfect for "generating…" states.
-* @param props Component props.
-* @param props.bandWidth Number of characters in the bright band.
-* @param props.color Color applied to characters outside the band.
-* @param props.highlightColor Color applied to characters inside the band.
-* @param props.interval Milliseconds between frames.
-* @param props.text Content to shimmer.
-* @returns A single `Text` element composed of per-character `Text` children.
-*/
-declare function ShimmerText({
-  bandWidth,
-  color,
-  highlightColor,
-  interval,
-  text
-}: Props): ReactElement;
+ * Text with an animated highlight band that sweeps across the characters.
+ * Perfect for "generating…" states.
+ * @param props Component props.
+ * @param props.bandWidth Number of characters in the bright band.
+ * @param props.color Color applied to characters outside the band.
+ * @param props.highlightColor Color applied to characters inside the band.
+ * @param props.interval Milliseconds between frames.
+ * @param props.text Content to shimmer.
+ * @returns A single `Text` element composed of per-character `Text` children.
+ */
+declare function ShimmerText({ bandWidth, color, highlightColor, interval, text }: Props): ReactElement;
 export { Props, ShimmerText, type Props as ShimmerTextProps, ShimmerText as default };

package/dist/sidebar.d.ts

@@ -3,45 +3,38 @@ import { ReactNode, ReactElement } from 'react';
 import { LiteralUnion } from 'type-fest';
 type Props = {
   /**
-  * Main content, filling the remaining width.
-  */
+   * Main content, filling the remaining width.
+   */
   readonly children: ReactNode;
   /**
-  * Draw a border/rule between the sidebar and the content.
-  * @default true
-  */
+   * Draw a border/rule between the sidebar and the content.
+   * @default true
+   */
   readonly divider?: boolean;
   /**
-  * Color of the divider rule.
-  * @default "gray"
-  */
+   * Color of the divider rule.
+   * @default "gray"
+   */
   readonly dividerColor?: LiteralUnion<AnsiColors, string>;
   /**
-  * Which side the sidebar sits on.
-  * @default "left"
-  */
+   * Which side the sidebar sits on.
+   * @default "left"
+   */
   readonly side?: "left" | "right";
   /**
-  * Sidebar content.
-  */
+   * Sidebar content.
+   */
   readonly sidebar: ReactNode;
   /**
-  * Fixed sidebar width in cells.
-  * @default 24
-  */
+   * Fixed sidebar width in cells.
+   * @default 24
+   */
   readonly width?: number;
 };
 /**
-* A two-pane layout: a fixed-width sidebar and a flexible content area, with an
-* optional vertical divider rule between them. The sidebar can sit on either
-* side.
-*/
-declare function Sidebar({
-  children,
-  divider,
-  dividerColor,
-  side,
-  sidebar,
-  width
-}: Props): ReactElement;
+ * A two-pane layout: a fixed-width sidebar and a flexible content area, with an
+ * optional vertical divider rule between them. The sidebar can sit on either
+ * side.
+ */
+declare function Sidebar({ children, divider, dividerColor, side, sidebar, width }: Props): ReactElement;
 export { Props, Sidebar, type Props as SidebarProps, Sidebar as default };

package/dist/slider.d.ts

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

package/dist/sparkline.d.ts

@@ -3,40 +3,34 @@ import { ReactElement } from 'react';
 import { LiteralUnion } from 'type-fest';
 type Props = {
   /**
-  * Color applied to the chart glyphs.
-  */
+   * Color applied to the chart glyphs.
+   */
   readonly color?: LiteralUnion<AnsiColors, string>;
   /**
-  * Data points to plot. Values may be any real numbers.
-  */
+   * Data points to plot. Values may be any real numbers.
+   */
   readonly data: ReadonlyArray<number>;
   /**
-  * Render with shade glyphs (`░▒▓█`) instead of vertical bars, for a
-  * textured, monochrome-friendly look.
-  * @default false
-  */
+   * Render with shade glyphs (`░▒▓█`) instead of vertical bars, for a
+   * textured, monochrome-friendly look.
+   * @default false
+   */
   readonly dither?: boolean;
   /**
-  * Optional fixed maximum for the vertical scale.
-  * When omitted the maximum data value is used.
-  */
+   * Optional fixed maximum for the vertical scale.
+   * When omitted the maximum data value is used.
+   */
   readonly max?: number;
   /**
-  * Optional fixed minimum for the vertical scale.
-  * When omitted the minimum data value is used.
-  */
+   * Optional fixed minimum for the vertical scale.
+   * When omitted the minimum data value is used.
+   */
   readonly min?: number;
 };
 /**
-* Inline bar chart using Unicode block glyphs.
-* @returns A `ReactElement` containing the glyph string, or `null` when
-* `data` is empty.
-*/
-declare function Sparkline({
-  color,
-  data,
-  dither,
-  max,
-  min
-}: Props): ReactElement | null;
+ * Inline bar chart using Unicode block glyphs.
+ * @returns A `ReactElement` containing the glyph string, or `null` when
+ * `data` is empty.
+ */
+declare function Sparkline({ color, data, dither, max, min }: Props): ReactElement | null;
 export { Props, Sparkline, type Props as SparklineProps, Sparkline as default };

package/dist/spinner.d.ts

@@ -2,16 +2,14 @@ import { SpinnerName } from '@visulima/spinner';
 import { ReactElement } from 'react';
 type Props = {
   /**
-  * Type of a spinner.
-  * Accepts any preset from `@visulima/spinner` (cli-spinners + custom frame sets).
-  * @default "dots"
-  */
+   * Type of a spinner.
+   * Accepts any preset from `@visulima/spinner` (cli-spinners + custom frame sets).
+   * @default "dots"
+   */
   readonly type?: SpinnerName;
 };
 /**
-* Spinner component that renders an animated loading indicator.
-*/
-declare function Spinner({
-  type
-}: Props): ReactElement;
+ * Spinner component that renders an animated loading indicator.
+ */
+declare function Spinner({ type }: Props): ReactElement;
 export { Props, Spinner, type Props as SpinnerProps, Spinner as default };