widgets library TUI

Stable high-level widget framework for building terminal UIs.

Prefer this library when you want the supported widget surface: app shells, runners, themes, layout/input primitives, scrolling, navigation, animations, and the higher-level component set.

Additional stable entrypoints are available for focused modules:

package:artisanal_widgets/charting.dart
package:artisanal_widgets/selection.dart
package:artisanal_widgets/testing.dart

The legacy package:artisanal_widgets/artisanal_widgets.dart entrypoint remains available for backward compatibility and still exposes additional experimental internals and modules.

Classes

AccentPanel: A panel with a colored vertical accent stripe on one side.
AccentPanelThemeData: Theme data for AccentPanel widgets.
Accordion: An expandable/collapsible section with a header.
ActionButton: A compact, styled button designed for use in dialog footers and inline prompt panels.
ActionChip: An actionable chip that invokes onPressed when activated.
AlertBox
Align
Alignment
AlwaysStoppedAnimation<T>: An Animation that is always stopped at a given value.
Animatable<T>: Transforms a double (typically from an Animation<double>) into a value of type T.
AnimatedBuilder: A general-purpose widget that rebuilds whenever a Listenable notifies.
AnimatedTint: A widget that applies an animated color tint over its child.
AnimatedWidgetBaseState<T extends ImplicitlyAnimatedWidget>: Base state class for ImplicitlyAnimatedWidget.
Animation<T>: An animation with a value of type T.
AnimationController: A TEA-native animation controller.
AnimationStyle: Configurable animation durations and curves for route transitions.
AnimationTickMsg: Message delivered on each animation frame tick.
AnimationTimeline: Small TEA-native animation sequencer built on top of AnimationController.
AnimationTimelineStep: Declarative step used by AnimationTimeline.
ArtisanalApp: A high-level root shell for artisanal widget applications.
AsciiFont: Abstract base class for ASCII art fonts.
AsciiGlyph: Represents a single ASCII art character glyph.
AsciiText: A widget that renders text using large ASCII art font glyphs.
AsyncSnapshot<T>
AutocompleteItem: One row in an AutocompleteOverlay.
AutocompleteOverlay: Docked autocomplete panel for composer fields.
AutocompleteQuery: Result of scanning prompt text for an autocomplete query.
Badge: A compact label with colored background, used for status, priority, or tags.
BlockFocus: A widget that blocks keyboard events from reaching its children.
BorderRadius
BoxConstraints: Box constraints for layout.
BoxDecoration
BreadcrumbItem: An item in a breadcrumb navigation trail.
Breadcrumbs: A horizontal breadcrumb trail showing navigation hierarchy.
Budgeted<W extends Widget>: Wraps child with an explicit budget-aware signal.
BuildContext: An opaque handle to location in the widget tree.
Builder: A widget that delegates its build to a callback.
Button: Flutter-style button widget for triggering callbacks.
Card
CellFilter: Applies one or more UV BufferFilters to the cells painted by child.
Center
ChangeNotifier: A class that can be extended or mixed in that provides a change notification API using VoidCallback for notifications.
Checkbox
CheckboxListTile: Flutter-style checkbox list tile.
CheckedPopupMenuItem<T>: A selectable menu entry with a check indicator.
Chip: A non-interactive chip with optional delete affordance.
ChoiceChip: A selectable chip that displays selected state via ButtonVariant.primary.
ChordController: Owns chord definitions and the live pending-chord snapshot.
ChordHost: Wraps the app (or a subtree) so chord messages update controller and descendants can call ChordController.of without manual wiring.
ChordScope: Inherited access to the app ChordController.
CircularProgressIndicator: Flutter-style circular progress indicator.
ClipRect: A widget that clips its child to its allocated size.
CodeEditor: A higher-level code editor built on top of TextEditor.
ColoredBox: A widget that fills its area with a single solid color.
Column
CommandPalette: A searchable, grouped list displayed in a modal overlay.
CommandPaletteThemeData: Theme data for CommandPalette widgets.
ConnectionBadge: Colored bullet + label for connection state.
ConstantTween<T>: A tween that always returns the same constant value.
ConstrainedBox
Container
Cubic: A cubic Bezier curve defined by two control points.
Curve: A mapping of the unit interval to the unit interval.
Curves: A collection of common animation curves.
CurveTween: An Animatable that applies a Curve to the input value.
DataTable: A simple data table widget that renders tabular data with column headers, row separators, and optional theming.
DataTableCell: Structured content for a DataTable.cells table.
DebugConsole: A scrollable developer console pane.
DebugConsoleController: Mutable controller for a debug console pane.
DebugConsoleEntry: One line in a DebugConsoleController.
DebugConsoleHost: Wraps a subtree with a toggleable debug console overlay.
DebugConsoleScope: Exposes a DebugConsoleController to descendant widgets.
DebugOverlay: A debug overlay that displays rendering metrics.
DecisionCard: A bordered card showing progressive-disclosure decision transparency.
DecisionData: Data for a DecisionCard.
DecisionDetails: Quantitative details for level-3 disclosure.
DecoratedBox: A widget that paints a Decoration either behind or in front of its child.
Decoration
DialogAlert: A simple alert dialog with a title, message, and OK button.
DialogConfirm: A simple yes/no confirmation dialog.
DialogPrompt: A dialog with a text input field.
DialogRoute<T>: A route that displays a modal dialog with an animated barrier.
DialogSelect<T>: A generic searchable, grouped selection list dialog.
DialogSelectItem<T>: A single item in a DialogSelect list.
DialogStack: Manages a stack of modal dialogs.
DialogStackState: State for DialogStack, providing the push/pop/replace/clear API.
DialogThemeData: Theme data for dialog widgets (DialogConfirm, DialogAlert, DialogPrompt, DialogSelect).
DiffCommentAnchor: A commentable position in the rendered diff.
DiffCommentBlock: A comment block to render inline in a GitDiffViewer at a specific renderLine position. The child widget is rendered as an additional row between diff lines, and height tells the viewer how many terminal rows it occupies so scroll metrics stay correct.
DiffCommentLineHighlight: A visual highlight request for a commentable diff line.
DiffCommentLineKey: Stable identity for a commentable line in a pull-request diff.
DiffFile: A file entry in a parsed diff.
DiffReviewController Widgets: Owns TEA review state and the single comment-inclusive scroll position.
DiffReviewFile: One changed file in a DiffReviewPane.
DiffReviewPane: Review surface: selectable file list + unified/split patch viewer.
DiffReviewViewport Widgets: A bounded viewport for code and rich inline review threads.
DiffStyles: Configuration for diff styling.
Divider
DoubleTapGestureRecognizer: Recognizes double-tap gestures.
DoubleTween: An explicit double tween (mostly for documentation clarity).
DragEndDetails: Details for the end of a drag gesture.
DragGestureRecognizer: Recognizes drag gestures.
DragStartDetails: Details for the start of a drag gesture.
DragUpdateDetails: Details for a drag update event.
Drawer: A slide-out panel that overlays content from the left or right.
DropdownButton<T>: A button-styled dropdown that displays one DropdownMenuItem at a time.
DropdownMenuItem<T>: A dropdown menu item for use with DropdownButton.
EdgeInsets
EditorThemeData: Theme data for editable text surfaces such as TextArea, TextEditor, CodeEditor, and MarkdownEditor.
ElasticInCurve: An elastic curve that overshoots and then oscillates at the start.
ElasticInOutCurve: An elastic curve that overshoots and oscillates at both ends.
ElasticOutCurve: An elastic curve that overshoots and then oscillates at the end.
ElevatedButton: Flutter-style elevated button wrapper.
ErrorThrowingWidget: A widget that deliberately throws during build.
EvidenceTerm: A single evidence term in a DecisionCard.
Expanded
ExpansionTile: Flutter-style expansion tile built on top of ListTile.
FadeModalBarrier: A modal barrier that fades in/out with an animated opacity.
FadeTint: A widget that fades a tint in or out over its child.
FileImage: An ImageProvider that loads an image from a file path.
FilePicker
FilledButton: Flutter-style filled button wrapper.
FilterChip: A multi-select chip with optional checkmark indicator.
Flex
Flexible
FlexParentData: Parent-data used by flex containers for each child render object.
FlippedCurve: A curve that is the reverse of another curve.
Focusable: A widget that responds to keyboard input when focused.
FocusController: Controls which focusable widget is currently focused.
FocusScope: Provides a FocusController to descendants.
Frame: A container with optional padding, margin, background and border.
FrecencyEntry: Single frecency observation for a key.
FrecencyStore: Tracks how often and how recently keys are used for ranking lists.
FutureBuilder<T>
GestureArenaManager: Manages gesture arenas for conflict resolution.
GestureDetector
GestureRecognizer: Abstract base class for all gesture recognizers.
GestureTimerHandle: Cancelable handle returned by a gesture timer factory.
GitDiffController: Controller for GitDiffViewer.
GitDiffModel: A git diff viewer bubble.
GitDiffThemeData: Theme data for GitDiffViewer widgets.
GitDiffViewer: A widget for viewing git diffs with syntax highlighting and scrolling.
Gradient
HBox
HelpView: A widget-side help view for rendering KeyMap bindings.
HistoryEntry: A single entry in the undo/redo history.
HistoryPanel: A panel that displays undo/redo command history with a position marker.
HitTestEntry: A single entry in a HitTestResult, linking a render object to the local coordinates at which it was hit.
HitTestResult: Accumulated result of a hit test, ordered deepest-first.
HyperlinkText: A text widget that renders as a clickable hyperlink using OSC 8 escape sequences in terminals that support them.
Icon
IconButton: Flutter-style icon button wrapper.
IconData
Icons
IgnorePointer: A widget that is invisible to hit-testing.
Image: A widget that displays an image in the terminal.
ImageData: Data class holding a decoded image.
ImageProvider: Abstract base class for providing images to the Image widget.
ImplicitlyAnimatedWidget: Abstract base class for widgets that implicitly animate when their properties change.
InheritedWidget: A widget that exposes data to descendants.
InputChip: Flutter-style input chip.
Interval: An interval that starts and/or ends at a fractional point along the curve.
IntTween: A tween that interpolates between two integers.
Key: A Key is an identifier for Widgets.
KeyBinding: A key binding that maps keys to actions with optional help text.
KeyboardListener: A widget that calls a callback when a key is pressed.
KeyHint: A small widget that displays a keyboard shortcut key and its label.
KeyMap: A collection of key bindings forming a key map.
KeymapHubInherited: Inherited access to the app tui.KeymapHub.
KeymapHubScope: Hosts a tui.KeymapHub: listens for stack/pending changes, handles tui.KeymapActionMsg, and exposes the hub via KeymapHubScope.maybeOf.
Label
LayoutBuilder: Builds a widget subtree using the constraints supplied by its parent.
LeafRenderObjectWidget: A render object widget with no children.
LimitedBox: A box that limits its size only when it's unconstrained.
LinearProgressIndicator: Flutter-style linear progress indicator.
Listenable: An object that maintains a list of listeners.
ListenableBuilder: A widget that rebuilds when a Listenable changes.
ListRowThemeData: Theme data for list-like rows with a highlighted/selected state.
ListTile: A single row in a Material-style list with optional leading/trailing controls.
ListView
ListViewController: Controller for scroll position in VirtualListView.
LocalKey: A key that is scoped to local widget identity only.
LoggingNavigatorObserver: A NavigatorObserver that logs navigation events to the console.
LongPressEndDetails: Details for the end of a long-press gesture.
LongPressGestureRecognizer: Recognizes long-press gestures.
LongPressStartDetails: Details for the start of a long-press gesture.
MarkdownEditor: A higher-level Markdown editor with a live rendered preview.
MarkdownText: A widget that renders Markdown content as styled ANSI text.
MediaQuery
MediaQueryData
MemoryImage: An ImageProvider that loads an image from raw bytes.
MetricDisplay: A single-value metric display widget.
Modal
ModalRoute<T>: A modal overlay route with an optional barrier.
MonthlyCalendar: A compact month calendar with independently styled dates and markers.
MouseRegion
MultiChildRenderObjectWidget: A render object widget with multiple children.
Navigator: A widget that manages a stack of Route objects.
NavigatorObserver: An interface for observing the behavior of a Navigator.
NavigatorState: State for Navigator, providing route stack management.
NetworkImage: An ImageProvider that loads an image from an HTTP(S) URL.
Offset: An offset in terminal cell units (column, row).
Opacity
OpenCodeThemes: All 33 OpenCode themes, ported from the official JSON definitions.
OutlinedButton: Flutter-style outlined button wrapper.
OverflowBox: A widget that imposes different constraints on its child than it gets from its parent, possibly allowing the child to overflow the parent.
Overlay: A widget that manages a stack of OverlayEntry objects.
OverlayEntry: An entry in an Overlay.
OverlayState: State for Overlay, providing methods to insert and remove entries.
Padding
PageRoute<T>: A full-screen page route.
Pagination: A page navigation control with prev/next buttons.
PanelBox: A panel with an optional title bar and action buttons.
PerformanceOverlay: A simpler variant of DebugOverlay that only shows render timing.
PermissionDock: Bottom/session dock for agent permission prompts (OpenCode-style).
PopBehavior: Configuration for how a Navigator handles pop requests via keyboard.
PopupMenuButton<T>: Flutter-style popup menu button.
PopupMenuDivider<T>: A non-selectable divider entry for PopupMenuButton.
PopupMenuEntry<T>: Base class for entries used in PopupMenuButton.
PopupMenuItem<T>: A selectable menu entry for PopupMenuButton.
Positioned
ProgressIndicator
PromptFooterBar: A footer bar for inline prompt panels and dialog bottoms.
PromptHistory: Stores recent prompt submissions for arrow-key recall.
PromptStash: In-memory stack of stashed drafts (newest last).
PromptStashEntry: One stashed prompt draft.
PromptStashPanel: Scroll-friendly panel listing stashed drafts (newest first).
ProxyAnimation: An Animation that proxies another animation.
Radio<T>
RadioListTile<T>: Flutter-style radio list tile.
RangeSlider: Flutter-style range slider for selecting a start/end interval.
RangeValues: An immutable pair of values used by RangeSlider.
Rect: A rectangle defined by offset + size, in terminal cell units.
ReloadController: Controller for development-time subtree reloads.
ReloadHost: Rebuildable host for development-time reloads.
ReloadScope: Exposes a ReloadController to descendant widgets.
ReloadSignal: One reload signal emitted by ReloadController.
RenderAlign
RenderBox: A render object with box constraints.
RenderColumn: A vertical column layout.
RenderConstrainedBox
RenderContainer
RenderDelegateBox: A render box that delegates paint to a callback.
RenderIgnorePointer: A render object that never reports a hit, causing hit-testing to skip its subtree and continue to siblings in the parent's child list.
RenderListViewport: Render object backing VirtualListView.
RenderListViewScrollViewport: Render object for _ListViewViewport.
RenderMetricsHolder: Mutable holder for RenderMetrics that WidgetApp updates in-place.
RenderMetricsInjection: A portable render-metrics update payload.
RenderMetricsInjector: Global bus for injecting render metrics from anywhere.
RenderMetricsProgramMonitor: Program interceptor that forwards render-monitor aggregates into overlays.
RenderMetricsProvider: Provides RenderMetricsHolder to the widget tree via InheritedWidget.
RenderObject: A render object represents a layout/paintable node.
RenderObjectWidget: Base class for widgets that create render objects.
RenderPadding
RenderRow: A horizontal row layout.
RenderScrollbar: Render object that draws a vertical scrollbar next to or over child content.
RenderSingleChildViewport: Render object for _SingleChildViewport.
RenderSizedBox
RenderStack
RenderText: Renders a text string with constraints.
RenderViewport: Render object backing Viewport.
RenderWrap
ReplayEventHistoryBrowser
ReplayEventHistoryPanel
ReplayEventHistoryState
ReplayEventPanel
ResizableSplitView: A two-pane view with a pointer-draggable separator.
ReverseTween<T>: A tween that evaluates another tween in reverse.
RichText: A widget that displays styled text using a TextSpan tree.
Route<T>: Abstract base class for routes managed by a Navigator.
RouteSettings: Immutable route metadata.
Row
SawTooth: A sawtooth curve that repeats count times over the unit interval.
ScrollArea: A convenience widget that wraps SingleChildScrollView with optional sizing and an optional Scrollbar.
Scrollbar: A scrollbar that decorates a scrollable child.
ScrollbarGradient: A vertical gradient for scrollbar tracks or thumbs.
ScrollController: Scroll controller interface for scrollable widgets.
ScrollView: A scrollable container for a single child widget.
Select<T>: A button-style dropdown selector that cycles through options.
SelectableTextAreaView: A read-only selectable view of a TextAreaController.
SelectableTextFieldView: A read-only selectable view of a TextEditingController.
SelectOption<T>: An option for use with Select or DropdownButton.
Shadow: Paints a cell-based shadow behind child.
ShortcutsSheet: Modal-friendly panel listing shortcuts for the active surface (and optionally reachable parents).
ShortcutSurfaceScope: Pushes a shortcut surface onto the hub for the lifetime of this widget.
ShrinkWrap
Sidebar: A fixed-width sidebar adjacent to the main content.
SingleChildRenderObjectWidget: A render object widget with a single child.
SingleChildScrollView: A scrollable container for a single child widget.
Size: Size in terminal cell units.
SizedBox
SizedOverflowBox: A widget that is a specific size but passes its original constraints through to its child, which may then overflow.
Slider: Flutter-style slider for selecting a single value.
Spacer
Spinner: A spinner animation definition.
SpinnerController: A ValueNotifier that cycles through Spinner.frames on a periodic timer.
SpinnerIndicator: An animated spinner indicator for loading states.
Spinners: Pre-defined spinner animations.
SplitView: A two-pane view that arranges children along an axis.
Stack
StackParentData
StandardFont: Standard ASCII art font - 5 lines high, clean block style.
State<T extends StatefulWidget>: Mutable state for a StatefulWidget.
StatefulWidget: A widget with mutable state managed by a State object.
StatelessWidget: A widget with a build method and no mutable state.
StaticWidget: A simple widget that wraps a static string or View.
StatusBar: A horizontal bar that displays a row of KeyHint items.
StatusBarThemeData: Theme data for StatusBar widgets.
StatusItem: A typed item that can be displayed in a StatusLine.
StatusLine: A horizontal status bar with left, center, and right regions.
StatusSection: A titled, optionally collapsible block used in sidebars / status panels.
StepIndicator: A step-by-step progress indicator widget.
StepItem: A single step in a StepIndicator.
StepTween: A tween that floors the interpolated value to an integer.
StreamBuilder<T>
StyledAsciiText: A convenience wrapper that applies a Style to AsciiText.
SubagentRow: One nested agent / task line for session footers or task lists.
Switch
SwitchListTile: Flutter-style switch list tile.
TabItem: A tab item for use with Tabs.
Tabs: A horizontal tab bar for switching between views.
TapDownDetails: Details for a tap-down event.
TapGestureRecognizer: Recognizes single-tap gestures.
TapUpDetails: Details for a tap-up event.
Text
TextArea: A multi-line text editor widget powered by the bubbles textarea model.
TextAreaController: Controls the state of a TextArea.
TextButton: Flutter-style text button wrapper.
TextDecorationLayerBinding: Keeps one named range-decoration layer in sync with a text controller.
TextDiagnosticsBinding: Keeps a TextAreaController's diagnostics in sync with its current text.
TextEditingController: Controls the state of a TextField.
TextEditingValue: The current state of a text field.
TextEditor: A higher-level editor surface built on top of TextArea.
TextField: A text input widget supporting single-line and multi-line editing.
TextLineDecorationLayerBinding: Keeps one named whole-line decoration layer in sync with a text controller.
TextPositionDiagnosticsSource: Produces positional diagnostics from a listenable text source.
TextSelection: Range of text that is selected.
TextSpan
Theme: Theme containing semantic colors, text styles, and component themes.
ThemeScope: Provides a theme to descendant widgets via the build context.
Threshold: A curve that jumps from 0.0 to 1.0 when t passes threshold.
TimelineDelayMsg: Message emitted by AnimationTimeline delay steps.
Tint: A widget that applies a color tint over its child.
Toast
ToolCard: Bordered tool card for block tools (OpenCode session-ui basic-tool style).
ToolCardInline: Compact one-line tool invocation (OpenCode-style inline tool).
Tooltip: A hover-triggered message bubble for a child widget.
Transform: A widget that applies spatial transformations to its child.
TreeView<T>: An interactive hierarchical tree backed by bubbles.TreeModel.
TreeViewNode<T>: A node in the compatibility TreeView constructor.
TUIErrorWidget: A widget that displays an error message with red styling.
Tween<T extends dynamic>: A linear interpolation between a begin and end value.
TweenSequence<T>: An Animatable that chains multiple tweens end-to-end with proportional durations.
TweenSequenceItem<T>: A single entry in a TweenSequence.
UniqueKey: A key that is only equal to itself.
ValueKey<T>: A key that uses a value of a particular type to identify itself.
ValueListenable<T>: An interface for subclasses of Listenable that expose a value.
ValueListenableBuilder<T>: A widget that rebuilds when a ValueListenable changes its value.
ValueNotifier<T>: A ChangeNotifier that holds a single value.
VBox
VerticalDivider: A vertical line divider.
Viewport: A string-backed scrollable viewport powered by ViewportModel.
ViewportController: Controller for Viewport.
VirtualListView: A render-object driven list view that only paints visible items.
Visibility
WhichKeyEntry: A single continuation entry shown while a key chord is pending.
WhichKeyPanel: Pending-chord discoverability panel (which-key style).
WhichKeySlot: Renders nothing when idle; when a sequence/chord is pending, paints a banner + WhichKeyPanel from the nearest tui.KeymapHub (preferred) or ChordController.
Widget: Base class for composable TUI widgets.
WidgetApp: Runs a widget tree using an element hierarchy.
WidgetDegradationSignal: Signal controlling widget visibility under degradation.
WidgetScrollController: A simple ScrollController for use with SingleChildScrollView, ScrollView, and ListView.
Wizard
WizardFormStep
Wrap
Zone
ZoneInBoundsMsg: Message sent when a zone is within bounds of a mouse event.

Enums

AccentSide: The side on which the accent stripe is drawn.
AlertVariant
AnimationStatus: The status of an animation.
AsyncConnectionState
AutocompleteTrigger: Trigger kind detected in a prompt field.
Axis
BoxFit: How an image should be inscribed into a box.
ButtonSize: Size variants for Button.
ButtonVariant: Visual style variants for Button.
ConnectionStatus: Compact connection / status pill (connected · degraded · offline).
CrossAxisAlignment
DataTableBorderStyle: Border style for DataTable.
DebugOverlayPosition: Position options for the debug overlay.
DecisionSignal: Signal level for a DecisionCard.
DecorationPosition: Where to paint a decoration relative to the child.
DiffCommentKind: The kind of diff line represented by a DiffCommentAnchor.
DiffCommentLineHighlightKind: The visual role of a commentable diff line.
DiffCommentSide: Which side of a pull-request diff a commentable line belongs to.
DiffViewMode: The display mode for the diff viewer.
DisclosureLevel: Progressive-disclosure level for a DecisionCard.
EvidenceDirection: Direction of an evidence term.
FlexFit
GestureDisposition: The final disposition of a recognizer in the arena.
GestureRecognizerState: The lifecycle state of a gesture recognizer.
HistoryPanelMode: Display mode for HistoryPanel.
HitTestBehavior: Controls how a widget behaves during hit testing.
ImageAutoMode: Controls how ImageRenderMode.auto chooses a rendering backend.
ImageRenderMode: Preferred rendering backend for the Image widget.
ListTileControlAffinity: Position of the control in list-tile-style rows.
MainAxisAlignment
MainAxisSize
MetricTrend: Trend direction for a MetricDisplay.
Overflow
PermissionAction: Action taken on a PermissionDock.
ProgressLabelPosition: Where to display the percentage label relative to the bar.
ProgressStyle: Predefined fill/track character sets for ProgressIndicator.
ReloadMode: The kind of reload requested through ReloadController.
RenderCrossAxisAlignment: Alignment policy along the cross axis for flex layouts.
RenderFlexFit: Fit behavior for flex children.
RenderMainAxisAlignment: Horizontal/vertical alignment policy along the main axis for flex layouts.
RenderMainAxisSize: How much space a flex layout should consume on its main axis.
ReplayEventHistoryFilter
ReplayEventHistoryMode
RoutePopDisposition: Indicates whether the current route should be popped.
SidebarSide: Placement side for the sidebar content.
StackFit
StepStatus: Status of a single step in a StepIndicator.
SubagentStatus: Lifecycle for a SubagentRow.
TerminalShadowStyle: Preset terminal-cell patterns used to paint a Shadow.
TextAlign
TextOverflow
ThemeMode: Controls how ArtisanalApp resolves its shell theme.
TimelineDirection: Playback direction for an AnimationTimeline.
ToolCardStatus: Lifecycle status for a ToolCard / ToolCardInline.
TooltipPosition: Preferred position for tooltip placement relative to its child.
WhichKeyLayout: Layout mode for WhichKeyPanel.
WidgetDegradationPriority: Priority values used by the render-budget engine when deciding which widgets to retain during a degraded frame.
WrapAlignment
WrapCrossAlignment

Mixins

AnimationMixin<T extends StatefulWidget>: Mixin for State classes that host one or more AnimationControllers.
FocusableWidget: Mixin for widgets that need to track focus state.

Extensions

ThemeContext on BuildContext: Convenience accessors for theme lookup on BuildContext.

Properties

currentTheme → Theme: Returns the current global theme.
no setter
hasDarkBackground → bool: Whether the terminal has a dark background.
no setter

Functions

applyAutocompleteInsertion(String text, AutocompleteQuery query, String insertion, {int? cursor}) → String: Replace the active trigger token in text with insertion.
bestPopupAnchorRenderObject(Element host, RenderObject root) → RenderObject: Returns the render object to use as the anchor for a popup menu.
colorToUvColor(Color? color) → UvColor?
constrainContent(String content, {int? width, int? height}) → String
copyStyle(Style? base) → Style: Copies base (or a fresh Style) and sets Style.hasDarkBackground to the current terminal background state.
defaultGestureTimerFactory(Duration delay, void callback()) → GestureTimerHandle: Default timer factory backed by dart:async Timer.
detectAutocompleteQuery(String text, {int? cursor}) → AutocompleteQuery?: Scan text for a trailing @… or /… token (OpenCode-style).
drawStyledContent(Canvas canvas, String content, int startX, int startY, UvStyle bgStyle, {bool transparent = false, int? contentWidth, int? contentHeight}) → void
filterAutocompleteItems(Iterable<AutocompleteItem> items, String query, {FrecencyStore? frecency, int limit = 12}) → List<AutocompleteItem>: Case-insensitive substring filter; optional frecency re-rank.
firstRenderObject(Element element) → RenderObject?: Returns the first RenderOb in the subtree of element.
globalOffset(RenderObject renderObject) → ({double x, double y}): Returns the global offset of a RenderObject.
hasUnsupportedPlainContainerControls(String text) → bool
horizontalFromAlignment(Alignment alignment) → HorizontalAlign
keyToIdOrFallback(Key? key, Object fallback) → String: Returns a stable string ID for a possibly-null key.
mathMin(int a, int b) → int
needsPlainContainerCanvasComposition(String content) → bool
offsetForHorizontal(HorizontalAlign align, int containerWidth, int childWidth) → int
offsetForVertical(VerticalAlign align, int containerHeight, int childHeight) → int
padToStackSize(String content, int targetWidth, int targetHeight) → String
padToWidth(String content, int targetWidth, int targetHeight) → String
renderColoredContent(String content, Color color) → String
renderContainerContent({required String contentStr, EdgeInsets? padding, EdgeInsets? margin, num? width, num? height, Color? background, Color? foreground, Color? color, Decoration? decoration, Decoration? foregroundDecoration, Alignment? alignment, HorizontalAlign align = HorizontalAlign.left, VerticalAlign verticalAlign = VerticalAlign.top}) → String
renderObjectsInSubtree(Element element) → Iterable<RenderObject>: Returns all RenderObjects in the subtree of element.
renderPlainContainerContent({required String content, required int contentHeight, required int targetWidth, required int targetHeight, required int marginLeft, required int marginTop, required int padLeft, required int padTop, required int alignedX, required int alignedY}) → String
renderSpan(TextSpan span, Style? baseStyle) → String
renderWidget(Widget widget) → String
resolveDimension(num? value) → int?
resolveDimensionDouble(num? value) → double?
roundClamp(num value) → int
setHasDarkBackground(bool value) → void: Updates the dark background state.
setTheme(Theme theme) → void: Sets the global theme.
shortHash(Object? object) → String: Short 5-hex hash for diagnostics.
showDialog<T>({required BuildContext context, required RouteWidgetBuilder builder, bool barrierDismissible = true, Color? barrierColor, String? barrierLabel, bool useSafeArea = true, Alignment alignment = Alignment.center, num? width, num? height, RouteSettings? routeSettings, AnimationStyle? animationStyle}) → Future<T?>: Shows a material design dialog.
textAreaStylesFromTheme(Theme theme) → TextAreaStyles
updateThemeFromBackground(String? hex) → void: Updates theme based on background hex color (e.g., '#1a1a1a').
verticalFromAlignment(Alignment alignment) → VerticalAlign
viewToString(Object v) → String
whichKeyEntriesFromChords(Iterable<KeyChordBinding> bindings, {String? prefixKeyLabel}) → List<WhichKeyEntry>: Builds WhichKeyEntrys from KeyChordBindings that share a prefix.
whichKeyEntriesFromContinuations(Iterable<ShortcutContinuation> continuations) → List<WhichKeyEntry>: Builds WhichKeyEntrys from hub ShortcutContinuations.
withImageAutoCapabilities<T>(TerminalCapabilities capabilities, T callback()) → T
withImageAutoConfiguration<T>({required ImageAutoMode mode, TerminalCapabilities? capabilities, int? cellPixelWidth, int? cellPixelHeight, required T callback()}) → T
withImageAutoMode<T>(ImageAutoMode mode, T callback()) → T

Typedefs

AnimationStatusListener = void Function(AnimationStatus status): Signature for callbacks that receive AnimationStatus changes.
AsyncWidgetBuilder<T> = Widget Function(BuildContext context, AsyncSnapshot<T> snapshot)
CmdCallback = Cmd? Function(): Callback that may return a command.
CommandPaletteController = CommandPaletteController: Compatibility alias for the shared Artisanal palette controller.
CommandPaletteItem = CommandPaletteItem: Compatibility alias for the shared Artisanal palette item.
CommandPaletteMatch = CommandPaletteMatch: Compatibility alias for the shared Artisanal scored match.
ConstrainedTextBuilder = String Function(int maxWidth): Produces text after accounting for the width available during layout.
DiffReviewThreadBuilder = Widget Function(BuildContext context, DiffReviewThreadPlacement placement): Builds the expanded body of a visible review thread.
FocusChangedCallback = void Function(bool focused)
FocusKeyCallback = Cmd? Function(KeyMsg msg)
FocusListener = void Function()
GestureDoubleTapCallback = Cmd? Function(): Callback for double-tap events.
GestureDragEndCallback = Cmd? Function(DragEndDetails details): Callback for the end of a drag gesture.
GestureDragStartCallback = Cmd? Function(DragStartDetails details): Callback for the start of a drag gesture.
GestureDragUpdateCallback = Cmd? Function(DragUpdateDetails details): Callback for drag update events.
GestureLongPressCallback = Cmd? Function(): Callback for long-press events.
GestureLongPressEndCallback = Cmd? Function(LongPressEndDetails details): Callback for the end of a long-press gesture.
GestureLongPressStartCallback = Cmd? Function(LongPressStartDetails details): Callback for the start of a long-press gesture.
GestureTapCallback = Cmd? Function(): Callback for simple tap events (press + release within slop).
GestureTapCancelCallback = Cmd? Function(): Callback for tap cancellation (pointer moved beyond slop).
GestureTapDownCallback = Cmd? Function(TapDownDetails details): Callback for tap-down events with position and modifier details.
GestureTapUpCallback = Cmd? Function(TapUpDetails details): Callback for tap-up events with position details.
GestureTimerFactory = GestureTimerHandle Function(Duration delay, void callback()): Factory used by gesture recognizers to schedule time-based transitions.
GestureWheelCallback = Cmd? Function(MouseMsg msg): Callback for mouse wheel events (passes through raw MouseMsg).
IndexedSeparatorBuilder = Widget Function(BuildContext context, int index)
IndexedWidgetBuilder = Widget Function(BuildContext context, int index): A scrollable list of child widgets.
MarkdownLinkTapCallback = Cmd? Function(String url)
MouseEnterCallback = Cmd? Function(MouseMsg msg): Callback for mouse enter events.
MouseExitCallback = Cmd? Function(MouseMsg msg): Callback for mouse exit events.
ReloadWidgetBuilder = Widget Function(BuildContext context, int revision): Builder used by ReloadHost.
RouteFactory = Route? Function(RouteSettings settings): A factory function that creates a route from settings.
RouteWidgetBuilder = Widget Function(BuildContext context): A builder that creates a widget for a route.
TextChangedCallback = void Function(String value): Signature for text change notifications from TextField.
TextDecorationLayerBuilder = Iterable<TextDecorationRange> Function(String text): Builds range decorations from plain text.
TextDiagnosticsBuilder = Iterable<TextPositionDiagnosticRange> Function(String text): Builds positional diagnostics from plain text.
TextFieldController = TextEditingController: Alias for TextEditingController for backward compatibility.
TextLineDecorationLayerBuilder = Iterable<TextLineDecoration> Function(String text): Builds whole-line decorations from plain text.
TextPositionDiagnosticsBuilder = Iterable<TextPositionDiagnosticRange> Function(String text): Builds positional diagnostics from plain text.
TimelineStepBuilder = AnimationTimelineStep Function(int index, AnimationController controller): Builds one timeline step for a staged controller choreography.
TimelineStepCallback = Cmd? Function(TimelineDirection direction): Invoked by AnimationTimelineStep.callback.
TreeViewItemBuilder<T> = Widget Function(BuildContext context, TreeRow<T> row): Builds a widget for one projected bubbles.TreeRow.
TreeViewItemCallback<T> = Cmd? Function(TreeItem<T> item): Handles selection or activation of a tree item.
TreeViewToggleCallback<T> = Cmd? Function(TreeItem<T> item, bool expanded): Handles a change to a branch's expansion state.
TweenConstructor = Tween Function(dynamic value): Callback type for constructing a new Tween from a target value.
TweenVisitor = Tween? Function(Tween? tween, dynamic targetValue, TweenConstructor constructor): Callback type for visiting tweens in AnimatedWidgetBaseState.forEachTween.
ValueCmdCallback<T> = Cmd? Function(T value): Callback that receives a value and may return a command.
VoidCallback = void Function(): Signature of callbacks that have no arguments and return no data.
WizardValidateFunc = String? Function(String value)

Exceptions / Errors

FlutterError: Simple error class for widget framework errors.