@tuiparts/core

Framework-neutral OpenTUI Primitives for tuiparts.sh.

New to the package/recipe split? Start with the primitive and recipe guide.

Installation

Add the package to an existing OpenTUI Core application:

pnpm add @tuiparts/core

The package supports @opentui/core ^0.4.3.

Primitive modules

Primitive modules own terminal interaction and coordination without choosing colors, spacing, glyphs, labels, or fixed visual trees.

| Module | Core interface | Public parts | | --- | --- | --- | | Accordion | AccordionStore | AccordionRootRenderable, AccordionItemRenderable, AccordionTriggerRenderable, AccordionPanelRenderable | | Button | ButtonStore | ButtonRenderable | | Checkbox | CheckboxStore | CheckboxRootRenderable, CheckboxIndicatorRenderable | | CheckboxGroup | CheckboxGroupStore | CheckboxGroupRenderable containing existing Checkbox Roots | | Collapsible | CollapsibleStore | CollapsibleRootRenderable, CollapsibleTriggerRenderable, CollapsiblePanelRenderable | | Dialog | DialogStore | Root, Trigger, Portal, Backdrop, Popup, Title, Description, Close Renderables | | Input | OpenTUI-native state | InputRenderable | | NumberField | NumberFieldStore | Root, Input, Increment, Decrement, and ScrubArea Renderables | | Slider | SliderStore | Root, Track, Range, and Thumb Renderables | | Textarea | OpenTUI-native EditBuffer | TextareaRenderable | | Radio / RadioGroup | RadioGroupStore | RadioGroupRenderable, RadioRootRenderable, RadioIndicatorRenderable | | Switch | SwitchStore | SwitchRootRenderable, SwitchThumbRenderable | | Tabs | TabsStore | TabsRootRenderable, TabsListRenderable, TabsTabRenderable, TabsPanelRenderable | | Toggle | ToggleStore | ToggleRenderable | | ToggleGroup | ToggleGroupStore | ToggleGroupRenderable containing ordinary ToggleRenderable children |

Core callers pass the owning Store between compound parts. React and Solid hide the same wiring behind compound-component context.

import {
  CheckboxIndicatorRenderable,
  CheckboxRootRenderable,
} from "@tuiparts/core/checkbox";

const root = new CheckboxRootRenderable(ctx, {
  defaultChecked: true,
  onCheckedChange: console.log,
});
const indicator = new CheckboxIndicatorRenderable(ctx, { store: root.store });

root.add(indicator);
parent.add(root);

Consumer-owned recipes assemble these parts with native OpenTUI Renderables and choose their presentation. Installable examples live under registry/.

From a repository checkout, run a focused tracer with pnpm --filter @tuiparts/core demo:number-field, pnpm --filter @tuiparts/core demo:slider, pnpm --filter @tuiparts/core demo:checkbox-group, pnpm --filter @tuiparts/core demo:accordion, or pnpm --filter @tuiparts/core demo:collapsible.

Input

InputRenderable preserves OpenTUI's mutable value and event model instead of adding browser-style controlled ownership or defaultValue.

import { InputRenderable } from "@tuiparts/core/input";

const input = new InputRenderable(ctx, {
  value: "initial",
  onInput: console.log,
  onChange: commit,
  onSubmit: submit,
});

onInput reports buffer mutations, onChange reports a changed blur or submit commit, and onSubmit reports successful Enter submission.

Textarea

TextareaRenderable preserves OpenTUI's multiline EditBuffer, native editing methods, and cursor/content/submit callback order. initialValue initializes the native buffer once; no parallel value owner is added.

import { TextareaRenderable } from "@tuiparts/core/textarea";

const textarea = new TextareaRenderable(ctx, {
  initialValue: "Release notes",
  onSubmit: publish,
});

Disabled Textareas reject focus, keyboard editing, paste, and submission while programmatic EditBuffer methods retain their native behavior.

Recipe boundary

Behaviorless presentation such as Badge is distributed as editable registry source rather than a Core package module. Recipes use ordinary TypeScript and native OpenTUI properties; primitive behavior owns no styling infrastructure.

See PRIMITIVE_CONTRACT.md and PRIMITIVES_AND_RECIPES.md for the ownership and composition contract.

License

MIT