@textui/widgets 0.1.0 → 0.2.0

package/README.md

@@ -1,7 +1,8 @@
 # @textui/widgets
 
-The component catalog: eighty-seven components built out of the four primitives
-in [`@textui/core`](https://github.com/softov/textui/tree/main/packages/core).
+[![npm](https://img.shields.io/npm/v/@textui/widgets?label=%40textui%2Fwidgets)](https://www.npmjs.com/package/@textui/widgets) [![license](https://img.shields.io/npm/l/@textui/widgets)](https://github.com/softov/textui/blob/main/LICENSE)
+
+The component catalog: eighty-seven components built out of the four primitives in [`@textui/core`](https://www.npmjs.com/package/@textui/core).
 
 ```bash
 npm install @textui/widgets
@@ -20,12 +21,9 @@ import { Card, Row, Badge } from '@textui/widgets';
 
 ## Importing is registering
 
-There is nothing to call first. `<Card/>` compiles to a node that carries the
-imported function, and the runtime uses that in preference to any registry - so
-a screen written in JSX renders with the registry empty.
+There is nothing to call first. `<Card/>` compiles to a node that carries the imported function, and the runtime uses that in preference to any registry - so a screen written in JSX renders with the registry empty.
 
-`registerBuiltins(app)` exists for the other case: a screen named in data, where
-a string has to resolve to something.
+`registerBuiltins(app)` exists for the other case: a screen named in data, where a string has to resolve to something.
 
 ```ts
 import { createApp } from '@textui/core';
@@ -34,9 +32,7 @@ import { registerBuiltins } from '@textui/widgets';
 const app = createApp({ terminal, root, onBoot: registerBuiltins });
 ```
 
-It registers the catalog, the surface layouts and the built-in shells in one
-call, and returns one `Disposable` that takes all of it back out. For a static
-render, `renderOnce(node, { components: CATALOG })` is the same idea.
+It registers the catalog, the surface layouts and the built-in shells in one call, and returns one `Disposable` that takes all of it back out. For a static render, `renderOnce(node, { components: CATALOG })` is the same idea.
 
 ## What is here
 
@@ -54,16 +50,22 @@ render, `renderOnce(node, { components: CATALOG })` is the same idea.
 | `shells` | 4 | The frame around an application |
 | `panel` | 1 | A pane that opens a resource with whatever viewer is registered |
 
-One file per component, in a folder per group - `src/display/badge.ts`. `ls
-src/display/` is the inventory.
+One file per component, in a folder per group - `src/display/badge.ts`. `ls src/display/` is the inventory.
 
 ## Runtime
 
-No dependencies beyond `@textui/core`, and no `node:` imports. Node 22+ and Bun.
+No dependencies beyond [`@textui/core`](https://www.npmjs.com/package/@textui/core), and no `node:` imports. Node 22+ and Bun.
 
 ## Documentation
 
 <https://softov.github.io/textui/>
 
-Every component has its own page, with the prop table generated from the source
-and a working example - see [`docs/components/`](https://softov.github.io/textui/components/).
+Every component has its own page, with the prop table generated from the source and a working example - see [`docs/components/`](https://softov.github.io/textui/components/).
+
+<!-- family -->
+
+---
+
+Part of **[TextUI](https://github.com/softov/textui)** - [documentation](https://softov.github.io/textui/) - [getting started](https://softov.github.io/textui/getting-started.html)
+
+[`@textui/kit`](https://www.npmjs.com/package/@textui/kit) one install · [`@textui/core`](https://www.npmjs.com/package/@textui/core) the runtime · **`@textui/widgets`** the catalog · [`@textui/terminal`](https://www.npmjs.com/package/@textui/terminal) adapters and input · [`@textui/testing`](https://www.npmjs.com/package/@textui/testing) the harness · [`@textui/cli`](https://www.npmjs.com/package/@textui/cli) the CLI

package/dist/control/checkbox.d.ts

@@ -5,6 +5,8 @@ export interface CheckboxProps extends BoxProps {
     /** Neither checked nor unchecked - a parent of mixed children. */
     indeterminate?: boolean;
     onChange?(checked: boolean): void;
+    /** Take the keyboard on arrival. */
+    autoFocus?: boolean;
 }
 export declare const Checkbox: (props: CheckboxProps) => import("@textui/core").RenderOutput;
 //# sourceMappingURL=checkbox.d.ts.map

package/dist/control/checkbox.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkbox.d.ts","sourceRoot":"","sources":["../../src/control/checkbox.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG7C,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kEAAkE;IAClE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACnC;AAED,eAAO,MAAM,QAAQ,+DAoCnB,CAAC"}
+{"version":3,"file":"checkbox.d.ts","sourceRoot":"","sources":["../../src/control/checkbox.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG7C,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kEAAkE;IAClE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,oCAAoC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,eAAO,MAAM,QAAQ,+DAoCnB,CAAC"}

package/dist/control/checkbox.js

@@ -1,8 +1,8 @@
 import { defineComponent, h, useFocus, useInput, useTheme } from '@textui/core';
 export const Checkbox = defineComponent('Checkbox', (props) => {
     const theme = useTheme();
-    const { label, checked = false, indeterminate, onChange, disabled, ...rest } = props;
-    const focus = useFocus({ disabled });
+    const { label, checked = false, indeterminate, onChange, disabled, autoFocus, ...rest } = props;
+    const focus = useFocus({ disabled, autoFocus });
     useInput((event) => {
         if (disabled)
             return false;

package/dist/control/radio-group.d.ts

@@ -12,6 +12,8 @@ export interface RadioGroupProps extends BoxProps {
     label?: string;
     /** Lay the options out in a row instead of a column. */
     inline?: boolean;
+    /** Take the keyboard on arrival. */
+    autoFocus?: boolean;
 }
 export declare const RadioGroup: (props: RadioGroupProps) => import("@textui/core").RenderOutput;
 //# sourceMappingURL=radio-group.d.ts.map

package/dist/control/radio-group.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"radio-group.d.ts","sourceRoot":"","sources":["../../src/control/radio-group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG7C,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,eAAO,MAAM,UAAU,iEAwCrB,CAAC"}
+{"version":3,"file":"radio-group.d.ts","sourceRoot":"","sources":["../../src/control/radio-group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG7C,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,oCAAoC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,eAAO,MAAM,UAAU,iEAwCrB,CAAC"}

package/dist/control/radio-group.js

@@ -1,8 +1,8 @@
 import { defineComponent, h, useFocus, useInput, useTheme } from '@textui/core';
 export const RadioGroup = defineComponent('RadioGroup', (props) => {
     const theme = useTheme();
-    const { options, value, onChange, label, inline, disabled, ...rest } = props;
-    const focus = useFocus({ disabled });
+    const { options, value, onChange, label, inline, disabled, autoFocus, ...rest } = props;
+    const focus = useFocus({ disabled, autoFocus });
     const index = Math.max(0, options.findIndex((o) => o.value === value));
     useInput((event) => {
         if (disabled)

package/dist/control/text-area.d.ts

@@ -47,16 +47,29 @@ export interface TextAreaProps extends BoxProps {
      */
     caretTone?: SemanticVariant;
     /**
-     * What the caret looks like. An underline under the character it is on by
-     * default; `block` fills the cell instead.
+     * What the caret looks like. **The theme's `cursor` by default**, so the
+     * drawn caret and the terminal's own are the same shape, and an underline
+     * when the theme leaves it to the terminal.
      *
      * Both **mark a cell rather than occupying one**. The caret used to be a
      * glyph pushed in between the text before it and the text after, so every
      * character to its right sat one column off from where it would be once the
      * caret moved on, and the row was a cell wider than its own text. On a
      * wrapped row that extra cell is the one that does not fit.
+     *
+     * That is also why the theme's `bar` arrives here as an underline: a bar
+     * *between* two characters is exactly the caret this one is not.
      */
     caretStyle?: 'underline' | 'block';
+    /**
+     * Put a selection on the system clipboard as it is made. On by default.
+     *
+     * Selecting with the mouse is how text leaves a terminal, and an application
+     * that reports mouse events has taken the terminal's own select-and-copy
+     * away - so it owes one back. The copy goes out over OSC 52 and into the
+     * store, which is the half a paste inside the application can read.
+     */
+    copyOnSelect?: boolean;
     /**
      * Blink the caret while the field has the keyboard. On by default.
      *

package/dist/control/text-area.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text-area.d.ts","sourceRoot":"","sources":["../../src/control/text-area.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAY,eAAe,EAAE,MAAM,cAAc,CAAC;AAcxE,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gEAAgE;IAChE,QAAQ,CAAC,IAAI,IAAI,CAAC;IAClB,gEAAgE;IAChE,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IACrC;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,IAAI,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;IACnC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,+DA6OnB,CAAC"}
+{"version":3,"file":"text-area.d.ts","sourceRoot":"","sources":["../../src/control/text-area.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAwB,eAAe,EAAS,MAAM,cAAc,CAAC;AAiB3F,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gEAAgE;IAChE,QAAQ,CAAC,IAAI,IAAI,CAAC;IAClB,gEAAgE;IAChE,UAAU,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IACrC;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,IAAI,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;IACnC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,+DA4jBnB,CAAC"}