API Reference
This section contains automatically generated API documentation from the Hex1b library's XML doc comments.
Namespaces
Browse the API by namespace:
Core
| Namespace | Description |
|---|---|
| Hex1b | Core application types, extension methods, and render context |
Widgets & Nodes
| Namespace | Description |
|---|---|
| Hex1b.Widgets | Widget records that describe UI components |
| Hex1b.Nodes | Mutable node classes that manage state and rendering |
Layout
| Namespace | Description |
|---|---|
| Hex1b.Layout | Layout primitives: Constraints, Size, Rect, SizeHint |
Input & Events
| Namespace | Description |
|---|---|
| Hex1b.Input | Input handling, key bindings, and input routing |
| Hex1b.Events | Event argument types for widget interactions |
Theming
| Namespace | Description |
|---|---|
| Hex1b.Theming | Theme system for customizing colors and characters |
| Hex1b.Tokens | Design tokens for consistent theming |
Advanced
| Namespace | Description |
|---|---|
| Hex1b.Animation | Animation timer and utilities |
| Hex1b.Automation | Terminal automation, input sequences, and snapshot testing |
| Hex1b.Surfaces | Low-level surface rendering and cell manipulation |
Quick Links
Core Types
- Hex1bApp — Main application class that runs the TUI event loop
- WidgetContext<TParent> — Provides access to app state within the widget builder
- Hex1bAppOptions — Configuration for the Hex1b application
Common Widgets
- TextBlockWidget — Display static or dynamic text
- ButtonWidget — Clickable button with focus support
- TextBoxWidget — Text input field
- ListWidget — Selectable list of items
- VStackWidget — Vertical stack layout
- HStackWidget — Horizontal stack layout
- BorderWidget — Draw borders around content
Layout Types
- Constraints — Min/max width/height bounds for layout
- Size — Measured dimensions
- Rect — Position and size for arrangement
- SizeHint — Fill, Content, or Fixed sizing
Extension Methods
Extension methods are documented on their defining class and also listed in the "Extension Methods" section of each type they extend:
- ButtonExtensions — Button widget factory methods
- TextExtensions — Text widget factory methods
- LayoutExtensions — Layout configuration methods
- SizeHintExtensions — Width/Height sizing methods
- InputBindingExtensions — Custom input binding methods
Using the API Reference
Each type page includes:
- Syntax — The type signature
- Inheritance — Base types and interfaces
- Extension Methods — Methods from extension classes that apply to this type
- Members — Constructors, properties, methods, events