radartui_test library

Classes

Action<T extends Intent>
An action that can be invoked in response to an Intent.
ActionDispatcher
Dispatches Actions in response to Intents.
Actions
A widget that maps Intent types to Actions for its descendants.
Align
Positions its child within itself according to alignment.
Alignment
A position within a rectangle, expressed as offsets from center.
AppBinding
The concrete binding that combines all mixin bindings into a single initialized instance.
AppLogger
Application-wide logger that writes messages to a log file.
AsyncSnapshot<T>
Immutable representation of the most recent interaction with an asynchronous computation.
BindingBase
The abstract base class for all bindings.
Border
Describes a border made of box-drawing characters for each side.
BoxConstraints
Immutable layout constraints with min/max width and height.
BuildContext
An abstract interface for locating ancestor widgets, analogous to Flutter's BuildContext.
Builder
A stateless utility widget that calls a builder callback to obtain its child.
Button
A pressable button widget that responds to keyboard input.
ButtonStyle
Defines the visual style properties for a Button.
CallbackAction
An Action subclass that delegates invocation to a callback.
Card
A material-design-inspired card with an optional background color, border, and padding.
Cell
Represents a single character cell with optional text styling.
Center
Centers its child within itself.
ChangeNotifier
A class that can be extended or mixed in that provides a change notification API.
Checkbox
A material-design checkbox that toggles between checked (✓) and unchecked states.
CircularProgressIndicator
A circular (ring) progress indicator.
Clipboard
A simple in-memory clipboard for cut, copy, and paste operations.
Color
A terminal color using ANSI 16-color palette values (0–15).
Colors
Predefined Color constants following material naming conventions.
Column
A Flex that lays out children in a vertical line.
ComponentElement
An Element that composes other widgets but does not create a render object.
Container
A convenience widget that combines common painting, positioning, and sizing.
DataCell
A single cell value within a DataRow.
DataColumn
Configuration for a single column in a DataTable.
DataRow
A single row of DataCells in a DataTable.
DataTable
A table widget that displays data in rows and columns with configurable headers, cell alignment, and optional row selection.
DefaultTabController
Provides a TabController to descendant widgets via inheritance.
DefaultTextStyle
An inherited widget that sets the default TextStyle for descendant Text and RichText widgets.
Dialog
A modal dialog with a title, message, and optional action buttons.
Divider
A horizontal line that separates content.
A dropdown selector that lets the user choose one item from a list.
A data model for a single option in a DropdownButton.
EdgeInsets
Immutable insets for each edge of a terminal rectangle.
Element
A node in the widget tree, analogous to Flutter's Element.
Expanded
A Flexible child that is forced to fill its allocated space (FlexFit.tight).
ExpansionTile
A widget that expands or collapses to reveal children below a title.
ExpansionTileController
Controls the expanded/collapsed state of an ExpansionTile.
ExpansionTileParentData
Parent data for children of RenderExpansionTile, storing their offset.
Finder
Flex
A widget that displays its children in a horizontal or vertical line.
Flexible
A widget that controls how a child of a Flex container is sized.
Focus
A widget that attaches a FocusNode to the widget tree and forwards key events.
FocusManager
Manages focus across the widget tree, analogous to Flutter's FocusManager.
FocusNode
Represents a focus scope node in the focus tree.
FocusScope
Manages a group of FocusNodes within a focus scope.
Form
A container for form fields that manages validation and submission.
FormField<T>
A single form field that manages its own value, validation, and saving.
FormFieldState<T>
The mutable state for a FormField, tracking value and validation errors.
FormScope
An inherited widget that provides FormState to descendant widgets.
FormState
The mutable state for a Form, managing field registration and validation.
FutureBuilder<T>
Widget that builds itself based on the latest snapshot of interaction with a Future.
GlobalKey
A key that is unique across the entire app, analogous to Flutter's GlobalKey.
GridParentData
Parent data for children of RenderGridView, storing their offset.
GridView<T>
A scrollable grid of selectable items with keyboard navigation.
Icon
Displays a single Unicode character (glyph) with optional color styling.
Icons
Common icon glyphs for use with Icon or Text.
InheritedElement
An Element that owns an InheritedWidget, analogous to Flutter's InheritedElement.
InheritedWidget
A widget that propagates information down the tree, analogous to Flutter's InheritedWidget.
Intent
An opaque object representing a user intent triggered by a shortcut.
Key
An identification key for widgets, analogous to Flutter's Key.
KeyboardBackend
Abstract interface for keyboard input backends.
KeyEvent
Represents a keyboard input event with optional modifier keys.
KeyFinder
KeyParser
Parses raw terminal input bytes into KeyEvent objects.
LayoutBuilder
Builds its child widget tree based on the parent's BoxConstraints.
LayoutConstants
Layout-related constants used across the framework.
LinearProgressIndicator
A horizontal bar that fills proportionally to value (0.0–1.0).
ListView<T>
A scrollable list of selectable items with keyboard navigation.
LocalKey
A key that is unique to the widget tree, analogous to Flutter's LocalKey.
MediaQuery
An inherited widget that provides MediaQueryData to its descendants.
MediaQueryData
Contains terminal dimensions and safe area insets.
A horizontal menu bar containing MenuBarItem entries.
A top-level menu entry containing a label and a list of MenuItem children.
A single entry inside a MenuBarItem dropdown.
ModalRoute<T>
A route that displays a modal dialog with a barrier overlay.
MultiChildRenderObjectElement
An Element for MultiChildRenderObjectWidget, managing a list of children.
MultiChildRenderObjectWidget
A RenderObjectWidget with a list of children, analogous to Flutter's MultiChildRenderObjectWidget.
A widget that manages a stack of routes, analogous to Flutter's Navigator.
An observer that receives notifications about route transitions, analogous to Flutter's NavigatorObserver.
The mutable state for a Navigator widget.
Offset
An immutable 2D integer offset with x and y coordinates.
OutputBuffer
Manages a grid of character cells and renders diffs to the terminal.
Overlay
A widget that stacks its child and overlay entries, analogous to Flutter's Overlay.
OverlayEntry
An entry in an Overlay, analogous to Flutter's OverlayEntry.
OverlayPortal
A convenience widget that wraps its child in an Overlay.
OverlayState
The mutable state for an Overlay widget.
Padding
Insets its child by the given padding.
PageRoute<T>
A route backed by a builder function, analogous to Flutter's PageRoute.
ParentDataElement
An Element that owns a ParentDataWidget.
ParentDataWidget<T extends ParentData>
A widget that applies ParentData to its child's render object, analogous to Flutter's ParentDataWidget.
Positioned
Controls where a child is positioned within a Stack.
Radio<T>
A single radio button that selects one value from a mutually exclusive group.
RawKeyboard
A KeyboardBackend that reads raw key events from stdin.
RealTerminalBackend
A TerminalBackend that writes directly to the real terminal via FFI.
RenderAlign
The render object for Align, which positions its child according to an Alignment value.
RenderButton
Render object that paints a button with background, text, and focus styling.
RenderCard
The render object for Card, responsible for drawing a box-drawing border and optional background fill around its child.
RenderCheckbox
Render object that paints a checkbox with border, fill, and check indicator.
RenderCircularProgressIndicator
The render object for CircularProgressIndicator, which paints a single animation frame character and optional label.
RenderContainer
Render object that paints a container with optional background, border, padding, and margin.
RenderDivider
Render object that paints a horizontal divider line.
RenderDropdownButton
Render object that paints the closed dropdown button with text and arrow.
RenderDropdownMenu
Render object that paints the open dropdown menu popup with selectable items.
RenderExpansionTile
Render object that paints an expandable tile with a header and children.
RenderFlex
The render object for Flex, responsible for measuring and positioning children along a main axis with flex expansion support.
RenderGridView
Render object that lays out children in a grid with configurable columns and spacing.
RenderLayoutBuilder
The render object for LayoutBuilder, which invokes a builder callback with the parent's BoxConstraints during layout.
RenderLinearProgressIndicator
Render object that paints a linear progress bar with determinate or indeterminate fill.
RenderMenuBar
Render object that paints a horizontal menu bar with optional dropdown menus.
RenderObjectElement
An Element that owns a RenderObjectWidget, analogous to Flutter's RenderObjectElement.
RenderObjectWidget
A widget that creates and manages a RenderObject, analogous to Flutter's RenderObjectWidget.
RenderPadding
The render object for Padding, which insets its child by the given EdgeInsets.
RenderRadio
Render object that paints a radio button with border, fill, and indicator.
RenderRichText
Render object that lays out and paints a TextSpan tree with line wrapping.
RenderSizedBox
The render object for SizedBox, which constrains its child to a fixed size.
RenderSlider
Render object that paints a horizontal slider track, thumb, and optional label.
RenderSparkline
The render object for Sparkline, which paints block characters proportional to each data value.
RenderStack
The render object for Stack, which layers children on top of each other and positions them via StackParentData.
RenderTabBar
Render object that paints a horizontal row of tabs with an active indicator.
RenderText
Render object that lays out and paints plain text with wrapping and overflow.
RenderTextField
Render object that paints a text input field with cursor and border.
RenderToggle
Render object that paints a toggle switch with border, indicator, and optional label.
RenderVerticalDivider
Render object that paints a vertical divider line.
RichText
A widget that renders a TextSpan tree with mixed styles and line wrapping.
Route<T>
An abstract route in the navigation stack, analogous to Flutter's Route.
RouteAware
An interface for objects that need to be notified about route changes, analogous to Flutter's RouteAware.
RouteObserver<R extends Route>
A NavigatorObserver that notifies RouteAware subscribers of route transitions, analogous to Flutter's RouteObserver.
RouteSettings
Configuration data for a Route, analogous to Flutter's RouteSettings.
Row
A Flex that lays out children in a horizontal line.
ScrollController
Controls scroll position and notifies listeners of changes, analogous to Flutter's ScrollController.
ShortcutActionsHandler
A widget that connects Shortcuts to Actions by listening for key events.
ShortcutActivator
Represents a keyboard shortcut (key + optional modifiers).
Shortcuts
A widget that maps ShortcutActivators to Intents for its descendants.
SingleChildRenderObjectElement
An Element for SingleChildRenderObjectWidget, managing a single child.
SingleChildRenderObjectWidget
A RenderObjectWidget with a single optional child, analogous to Flutter's SingleChildRenderObjectWidget.
SingleChildScrollView
A box in which a single child can be scrolled vertically ororizontally.
Size
An immutable 2D integer size with width and height.
SizedBox
A widget with a fixed width and height.
Slider
A horizontal slider for selecting a numeric value within a range.
Spacer
Takes up empty space in a Flex container (Row or Column).
Sparkline
A compact inline chart that renders a list of numeric data as a sparkline.
Stack
A widget that layers its children on top of each other.
StackParentData
Parent data used by Positioned to specify a child's placement in a Stack.
State<T extends StatefulWidget>
The logic and internal state for a StatefulWidget, analogous to Flutter's State.
StatefulElement
An Element that owns a StatefulWidget, analogous to Flutter's StatefulElement.
StatefulWidget
A widget that has mutable state, analogous to Flutter's StatefulWidget.
StatelessElement
An Element that owns a StatelessWidget, analogous to Flutter's StatelessElement.
StatelessWidget
A widget that does not require mutable state, analogous to Flutter's StatelessWidget.
StatusBar
A horizontal bar typically rendered at the bottom of the screen.
StreamBuilder<T>
Widget that builds itself based on the latest snapshot of interaction with a Stream.
Tab
A single tab entry displayed in a TabBar.
TabBar
A horizontal row of Tab widgets that lets the user switch views.
TabBarView
Displays the content corresponding to the active tab in a TabBar.
TabController
Controls the active tab index for TabBar and TabBarView.
Terminal
Abstract interface for terminal operations such as writing and cursor control.
TerminalBackend
Abstract interface for low-level terminal I/O operations.
TestBinding
TestKeyboard
TestOutputBuffer
TestTerminal
Text
A run of text with optional styling.
TextEditingController
A controller for managing text content, cursor position, and selection state.
TextField
A single-line or multi-line text input field.
TextFinder
TextFormField
A convenience widget that combines a TextField with form field validation.
TextSelection
Represents a text selection range within a string.
TextSpan
An immutable span of styled text with optional children.
TextStyle
Describes the style of terminal text — color, weight, slant, and decorations.
Theme
An inherited widget that provides ThemeData to descendant widgets.
ThemeData
Describes the visual appearance of the application.
Toast
Displays a transient overlay message at the bottom of the screen.
Toggle
A boolean toggle switch (on/off).
TreeController
Manages the expand/collapse state of a TreeView.
TreeView<T>
A collapsible tree view that renders hierarchical data.
TypeFinder<T extends Widget>
UniqueKey
A key that is unique by identity, analogous to Flutter's UniqueKey.
ValueKey<T>
A key that uses a value for equality comparison, analogous to Flutter's ValueKey.
VerticalDivider
A vertical line that separates content.
Widget
The base class for all widgets, analogous to Flutter's Widget.
WidgetTester

Enums

Axis
The orientation of a layout axis.
ConnectionState
The state of connection to an asynchronous computation.
CrossAxisAlignment
How children should be placed along the cross axis of a flex layout.
FontFamily
Font family options for terminal text rendering.
KeyCode
Represents the type of key pressed on the keyboard.
MainAxisAlignment
How children should be placed along the main axis of a flex layout.
MainAxisSize
How much space a flex layout should occupy along its main axis.
TextOverflow
How text overflow should be handled.
VerticalDirection
The vertical direction in which a flex layout flows.

Mixins

FocusableState<T extends StatefulWidget>
A mixin for State subclasses that need focus management.
RendererBinding
Binding that connects the rendering pipeline to the output buffer.
SchedulerBinding
Binding that schedules and dispatches frames via microtasks.
ScrollableState<T extends StatefulWidget>
A mixin for State subclasses that need scroll management.
ServicesBinding
Binding that provides access to terminal I/O and keyboard services.
WidgetsBinding
Binding that glues the widget framework to the terminal and manages the widget tree lifecycle.

Extensions

BuildContextNavigation on BuildContext
Extension on BuildContext providing convenient access to navigation.

Properties

find ↔ Finder
getter/setter pair

Functions

charWidth(int codePoint) → int
Returns the display width (number of terminal columns) of a single codePoint.
findByKey(Key key) → Finder
findByType<T extends Widget>() → Finder
findText(String text) → Finder
showDialog<T>({required BuildContext context, required WidgetBuilder builder, bool barrierDismissible = true, Color? barrierColor, Alignment alignment = Alignment.center}) → Future<T?>
Displays a modal Dialog above the current route.
stringWidth(String text) → int
Returns the total display width of text in terminal columns.
testWidgets(String description, Future<void> callback(WidgetTester tester)) → void

Typedefs

AsyncWidgetBuilder<T> = Widget Function(BuildContext context, AsyncSnapshot<T> snapshot)
Signature for strategies that build widgets based on asynchronous interaction.
FrameCallback = void Function(Duration timeStamp)
Signature for frame-related callbacks.
LayoutWidgetBuilder = Widget Function(BuildContext context, BoxConstraints constraints)
Signature for a function that builds a widget tree given BoxConstraints.
RouteBuilder = Widget Function(BuildContext context)
Signature for a function that builds a route's widget.
RoutePredicate = bool Function(Route route)
Signature for a predicate that determines whether a route meets criteria.
ShutdownCallback = void Function()
Signature for callbacks invoked during WidgetsBinding.shutdown.
ValueChanged<T> = void Function(T value)
Signature for callbacks that report a value change.
VoidCallback = void Function()
Signature for callbacks with no arguments.
WidgetBuilder = Widget Function(BuildContext context)
Signature for a function that builds a widget given a BuildContext.

Exceptions / Errors

Exception thrown when a Navigator method is called after disposal.
RadartuiError
The base error type for RadarTUI framework exceptions.