@termuijs/widgets 0.1.1 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Karanjot Singh
+
+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.

package/README.md

@@ -1,6 +1,6 @@
 # @termuijs/widgets
 
-20+ base widgets for building terminal UIs. Boxes, text, tables, gauges, spinners, inputs.
+The building blocks for terminal UIs. Boxes, text, tables, progress bars, spinners, gauges, and a virtualized list that handles millions of rows without breaking a sweat.
 
 ## Install
 
@@ -12,53 +12,86 @@ Requires `@termuijs/core` as a peer dependency.
 
 ## Widgets
 
-| Widget | What it does |
-|--------|-------------|
-| `Box` | Container with flexbox layout. Supports borders, padding, margin |
-| `Text` | Renders styled text. Supports color, bold, italic, underline, strikethrough |
-| `Table` | Data table with headers, column alignment, and row selection |
-| `ProgressBar` | Horizontal bar with percentage fill |
-| `Spinner` | Animated loading indicator with multiple styles |
-| `Gauge` | Circular or arc gauge for numeric values |
-| `TextInput` | Single-line text input with cursor |
-| `List` | Scrollable list with selection |
-| `LogView` | Tailing log viewer |
+| Widget | What it is |
+|--------|-----------|
+| `Box` | Container with flexbox layout, borders, padding, margin |
+| `Text` | Styled text. Color, bold, italic, underline, strikethrough, dim |
+| `Table` | Data table with headers, column alignment, row selection |
+| `ProgressBar` | Horizontal bar with percentage fill and optional label |
+| `Spinner` | Animated loading indicator. Ships with multiple animation styles |
+| `Gauge` | Arc or circular gauge for numeric values |
+| `TextInput` | Single-line text input with cursor, placeholder, and change callback |
+| `List` | Scrollable list with keyboard selection. Good for small datasets |
+| `VirtualList` | Scroll-virtualized list. Renders only the visible rows, so 1M items costs the same as 10 |
+| `LogView` | Tailing log viewer with auto-scroll and configurable buffer limit |
 | `Sparkline` | Inline line chart from an array of numbers |
-| `StatusIndicator` | Colored dot with label |
+| `StatusIndicator` | Colored dot with a label (ok / warn / error / unknown) |
+| `BarChart` | Horizontal or vertical bar chart with grouping |
+| `Scrollbar` | Standalone scrollbar indicator |
 
 ## Usage
 
 ```typescript
-import { Box, Text, Table, ProgressBar } from '@termuijs/widgets';
+import { Box, Text, ProgressBar, VirtualList } from '@termuijs/widgets'
 
 const container = new Box({
     flexDirection: 'column',
     border: 'rounded',
     padding: 1,
-});
+})
+
+container.addChild(new Text({ content: 'Downloads', bold: true }))
+container.addChild(new ProgressBar({ value: 0.73, width: 30 }))
+
+// VirtualList renders only visible rows
+const list = new VirtualList({
+    totalItems: 100_000,
+    renderItem: (i) => `Row ${i}`,
+    onSelect: (i) => console.log('picked', i),
+})
+container.addChild(list)
+```
 
-container.addChild(new Text({ content: 'Downloads', bold: true }));
-container.addChild(new ProgressBar({ value: 0.73, width: 30 }));
+## VirtualList
 
-const table = new Table({
-    columns: ['Name', 'Size', 'Status'],
-    data: [
-        { Name: 'app.js', Size: '14kb', Status: 'done' },
-        { Name: 'style.css', Size: '3kb', Status: 'pending' },
-    ],
-});
+The standout addition. It only paints the items that fit in the viewport, plus a small overscan buffer above and below. A list of 100,000 items renders the same ~26 rows as a list of 10.
 
-container.addChild(table);
+```typescript
+const list = new VirtualList({
+    totalItems: data.length,
+    itemHeight: 1,
+    overscan: 2,
+    renderItem: (index) => `${data[index].name} — ${data[index].status}`,
+    onSelect: (index) => inspect(data[index]),
+})
+
+// Navigation
+list.selectNext()
+list.selectPrev()
+list.pageDown()
+list.selectFirst()
+list.selectLast()
+list.scrollTo(500)
+list.confirm()        // fires onSelect with current index
+
+// Update data on the fly
+list.setTotalItems(newData.length)
+list.setRenderItem((i) => newData[i].label)
 ```
 
 ## Every widget supports
 
-- `visible` - Show or hide
-- `focusable` - Whether Tab stops on this widget
-- `style` - Colors, borders, padding, margin
-- `markDirty()` - Flags the widget for re-render
+- `visible` — show or hide
+- `focusable` — whether Tab stops on this widget
+- `style` — colors, borders, padding, margin
+- `markDirty()` — flags the widget for re-render on the next frame
 - Focus ring rendering when focused
 
+
+## Documentation
+
+Full docs at [www.termui.io/docs/widgets/overview](https://www.termui.io/docs/widgets/overview).
+
 ## License
 
 MIT