terminal_ui library

Terminal-style Flutter controls on a monospace character grid.

Load the bundled fonts with termLoadFonts and wrap your application in TermTheme. TermThemeData.dark and TermThemeData.light provide the night and paper palettes. TermPane, TermButton and TermScaffold share box-drawn frames, inverse selection and keyboard navigation.

Classes

AnimatedTermTheme
A TermTheme that blends to a new data over duration (a preset switch, light to dark), as Material's AnimatedTheme does. The face and the stroke change half way; under Reduce Motion it cuts.
DefaultDesignLocalizations
The words in English, with no localizations package.
DefaultTermLocalizations
The words in English, with no localizations package.
DesignAdaptiveShell
An app's frame: destinations in a bar, a rail or a sidebar by the shell's width (DesignNavigationMode.fromWidth, or mode), and the app's body beside it (above a bar). The look paints each destination (destinationBuilder) and the navigation round them (navigationBuilder); the shell gives them their keys, their meaning to a screen reader and their place.
DesignAnchoredOverlay
A surface anchored to anchorBuilder's widget: a popover (DesignOverlayTrigger.press, focusOnOpen), a hover card (DesignOverlayTrigger.hover) or a menu (arrowKeyNavigation on).
DesignBandScale
Categories side by side (bars): count bands from start to end, paddingInner of each step between bands and paddingOuter at the ends. A value is a band's index; map gives its centre.
DesignBottomSheetController
Drives an open DesignBottomSheetRoute's size from outside it, as DraggableScrollableController drives a sheet, on the route's spring. The caller makes it, gives it to one route at a time, and disposes it.
DesignBottomSheetDetails
What a DesignBottomSheetRoute's panel paints from.
DesignBottomSheetDragHandle
A bottom sheet's drag handle, painted by builder: a button that moves the sheet to its next size (from the largest back to the smallest; a sheet of one size closes), Up and Down to a larger or smaller size when focused, and a screen reader's increase and decrease. Put it in a DesignBottomSheetRoute's panel.
DesignBottomSheetRoute<T>
A modal bottom sheet. Push it with Navigator.push; its panel is builder's, the screen's width, rising from the bottom edge.
DesignCalendar
One or more month grids over a DesignCalendarController.
DesignCalendarController
A calendar's state: the shown month, the keyboard's day and the selection.
DesignCalendarDay
One day as the grid paints it.
DesignCalendarHeader
A month's header, as DesignCalendar.headerBuilder gets it.
DesignCapCenter
Draws a one-line label or text entry so that the middle of its capitals is the middle of its own box, as Baseline puts a baseline where it is told.
DesignCarousel
Slides itemBuilder builds, itemCount of them.
DesignCarouselControls
What a carousel's controls act on.
DesignChart
A cartesian chart (line, area, bars, a sparkline): the look draws series from the scales and ticks in builder's details; the chart picks points, says them, and springs from one set of data to the next.
DesignChartDetails
A DesignChart as its look draws it.
DesignChartPoint
A point of a DesignChartSeries: x and y, or a gap where y is null.
DesignChartPointRef
A point of a chart: the indexth point of the seriesth series.
DesignChartSeries
A named run of points, in order along x.
DesignChartTable
A chart's data as a table, the alternative an app shows instead of the chart (a screen reader's "Show data table"): a row per x value, a column per series (DesignChartTable.new), or a row per slice with its value and share (DesignChartTable.slices). A screen reader reads a table, its column headers and cells, a missing value as "Empty"; cellBuilder paints each cell, and the columns are as wide as their widest cell.
DesignChartTableCellDetails
A cell of a DesignChartTable.
DesignColorArea
A saturation (across) and brightness (up) area for controller's hue.
DesignColorAreaDetails
What the look paints the area from.
DesignColorController
A colour being picked, as hue, saturation, brightness and alpha.
DesignColorPicker
An area over a hue slider (and an alpha slider), on one controller.
DesignColorSlider
A slider for one channel of controller's colour.
DesignCombobox<T extends Object>
A text field that suggests options as you type.
DesignComboboxField
The field, as DesignCombobox.fieldBuilder gets it: wire controller and focusNode to the look's text input, and submit to its onEditingComplete (and give it no onSubmitted; see submit).
DesignCommand
A command in a palette.
DesignCommandPalette
The palette's body: the field over the results. Put it in a route with showDesignCommandPalette, or anywhere (a sidebar's search).
DesignCommandShortcut
Opens a palette from anywhere under it on activators (Ctrl+K and Cmd+K).
DesignContextMenu
A menu of menuChildren that opens over child, where the user asks for it.
DesignControlBox
A control's box: at least minHeight tall, as wide as its child (or as the width it is told to be), with child placed by alignment and its text given even leading (TextLeadingDistribution.even).
DesignDataTable<R>
The rows of a DesignTableController's page under a header row, with one tab stop for the rows. The look paints the header cells, the cells, and each row around its cells.
DesignDateField
A date typed in segments, in the reader's order: value is a calendar day (its time ignored), null when empty; onChanged gets the day once every segment holds one, and null when one is cleared.
DesignDateRange
A range of days, start to end inclusive; end is null while only the start is chosen.
DesignDateSegmentDetails
One segment of a DesignDateField or DesignTimeField, as the look paints it.
DesignDensity
How compact a look's controls stand, as Material's VisualDensity: each step of vertical takes heightStep from a control's height and each step of horizontal paddingStep from its padding at either side, from -4 (tightest) to 4 (roomiest).
DesignDestinationDetails
What a look paints a destination from.
DesignDialog
An alert's or a simple dialog's layout: title and content scroll together over actions, which stay put. The actions sit side by side, sharing the row on a compact screen and aligned at the end on a larger screen. When their labels do not fit, including at a large text size, they stack, one to a line, the last given (the confirm) on top and the first (the dismissive one) at the bottom, as Material and iOS stack them.
DesignDialogAction
An action at the foot of a DesignDialog.
DesignDialogActionDetails
What the look paints a DesignDialogAction from.
DesignDialogDetails
What a DesignDialogRoute's builder paints from.
DesignDialogFrameDetails
What the look paints a DesignDialog's frame and action bar from.
DesignDialogRoute<T>
A modal dialog or alert. Push it with Navigator.push; its page is builder's, over a barrier.
DesignField
A control with its label, help and error.
DesignFieldParts
What a DesignField's builder lays out.
DesignForm
A Form that, on a submit that fails, shows every error, moves focus to the first field that is wrong (scrolling it into view) and tells a screen reader how many fields need attention; after that, errors update as the reader edits.
DesignFormField<T>
A FormField whose control DesignForm can focus: give focusNode to the control.
DesignFormState
The state of a DesignForm: submit and reset it.
DesignHaptics
The haptics ui_core's behaviours play: one callback per moment; a null callback plays nothing.
DesignHapticsScope
Puts haptics in force for child: the table every ui_core behaviour below reads with DesignHaptics.of.
DesignInputGroup
A field and its add-ons as one control.
DesignKeylineFace
Marks child as one face for the checks in package:ui_core_test: a control's face or a well (a field's, a list's, a table's) whose pixels may not show it, or a picture with things placed on it.
DesignKeylineRegion
Marks child as a card or a section whose contents share keylines: a keyline is the line that what starts a row (or ends one) sits on, so a card's title, its rows' words, its fields and its dividers start on one line, and its switches, chevrons and selects end on another.
DesignLinearScale
A number line: min at start, max at end.
DesignListDetail<T extends Object>
A list (listBuilder) and the detail of selectedItem (detailBuilder), as Compose's ListDetailPaneScaffold.
DesignLocalizations
The words a design system says on its own. The behaviours' words: the names a screen reader hears for a part with no text of its own (a carousel, a sheet's barrier, a split view's handle) and the messages they announce (a slide turned, a row moved, the results found), each also a parameter on its behaviour, which a null leaves to this. And the general words a look shows or says by itself (Cancel, Close, Today, Next month, "2 of 5"), under MaterialLocalizations' names where Flutter has the word, so a look built on any app (MaterialApp, CupertinoApp, WidgetsApp) has them.
DesignMenuBar
A row of menus.
DesignMenuEntry
An item of a menubar: a command, a submenu (children), or a divider.
DesignMotionPolicy
The Reduce Motion policy: which spring a component actually runs.
DesignNavigationDestination
A destination: its name and glyphs, as Material's NavigationDestination.
DesignNavigationDetails
What a look lays the navigation out from.
DesignNumberField
A number typed or stepped: value the number, null when empty; onChanged gets it as it is taken (Enter, the focus leaving, a step), not on each key typed.
DesignNumberFieldButtonDetails
One of a number field's step buttons, as the look paints it.
DesignNumberFieldDetails
The field, as DesignNumberField.fieldBuilder gets it: wire controller, focusNode, keyboardType, inputFormatters and onEditingComplete to the look's text input.
DesignOtpController
Holds a code: its text, its length, whether it is whole.
DesignOtpField
A one-time code drawn as boxes over one input.
DesignOtpSlot
One box, as DesignOtpField.slotBuilder gets it.
DesignOverlayAnchor
The anchor, as DesignAnchoredOverlay.anchorBuilder gets it.
DesignOverlayInfo
What DesignAnchoredOverlay.overlayBuilder paints the surface from.
DesignOverlayPadding
The edges a surface opened under it keeps clear of, beyond the screen's safe area and the on-screen keyboard: a look's own chrome over its pages, such as a desktop side bar a page's overlay runs under.
DesignOverlayPlacement
Where a surface goes relative to its anchor.
DesignPasswordController
Whether a password shows: true while it is hidden.
DesignPasswordDetails
What a DesignPasswordReveal's builder paints from.
DesignPasswordReveal
Holds whether a password shows and gives the field and its toggle what they need. The field keeps its focus and caret as it flips; with hideOnBlur a shown password hides again when focus leaves the field.
DesignPieChart
A pie or donut: the look draws slices from the angles in builder's details; the chart picks a slice, says it, and springs from one set of values to the next.
DesignPieChartDetails
A DesignPieChart as its look draws it.
DesignPieSlice
A slice of a DesignPieChart: a label and its value.
DesignPieSliceDetails
A slice as drawn.
DesignPressable
Makes any widget a control (press, focus, hover and what a screen reader hears), with no look of its own.
DesignPressableState
The state of a DesignPressable: states is what its builder was last given.
DesignPullToRefresh
child, a scroll view, refreshed by onRefresh on a pull.
DesignPullToRefreshState
The refresher's state: refresh runs one (a keyboard shortcut, a menu's "Refresh").
DesignRangeSlider
A slider of values between min and max.
DesignRangeTrack
The track's state, for the look to paint its rail and the filled part.
DesignRangeValues
A range's two ends.
DesignRating
A rating of itemCount items filled up to value (0, none, to itemCount): onChanged gets the value a tap, a drag, a key or a screen reader sets.
DesignRatingItemDetails
One item of a DesignRating, as the look paints it.
DesignRefreshDetails
What the look paints the indicator from.
DesignReorderableList<T extends Object>
A list of items the reader puts in order; onReorder gets an item's place from and its new place to (counted after it left).
DesignReorderItem
An item's place and moves, as DesignReorderableList.itemBuilder gets them.
DesignScale
Values to positions and back.
DesignScaleTick
A tick on a scale: a value, its position, its label.
DesignScrollArea
child, a scroll view on controller, with a scrollbar from thumbBuilder (and trackBuilder) on its end edge (or bottom).
DesignScrollThumb
A scrollbar's geometry and state, for the look to paint.
DesignSearchError
A search that failed, as a combobox's or a tag input's errorBuilder gets it: paint a message and a "Try again" (DesignLocalizations.retryButtonLabel) that calls retry, lit while focused.
DesignSheetInfo
What a side sheet's panel gets to paint with.
DesignSheetPageRoute<T>
A full-screen sheet presented as an opaque page of the navigator. The whole page rises on a spring and returns along the same path. With Reduce Motion it fades. Escape and Back respect the page's PopScope.
DesignSideSheetRoute<T>
A modal side sheet. Push it with Navigator.push; its panel is builder's, sized to width (at most the screen less minGap) and the full height.
DesignSpacing
The step a look's spacing stands on: every padding, gap and spacing token a multiple of grid.
DesignSpacingScope
Declares the spacing a look's parts stand on for the subtree, as a theme does; DesignSpacing.of reads it.
DesignSplitAction
An action in a split button's menu.
DesignSplitButton
A main action with a menu of actions beside it.
DesignSplitView
first and second side by side (or stacked, axis vertical), split at fraction of the room (the first pane's share).
DesignStyle
How one part of a look looks, as Material's ButtonStyle is: every slot resolves for the part's states (WidgetState.disabled, WidgetState.hovered, WidgetState.focused, WidgetState.pressed, WidgetState.selected, WidgetState.error).
DesignStyleOf
A part's style layers read at its states: its own style:, then its component theme (first wins). Each getter is the first layer's value for states, or null, so the part goes on to the theme-wide knobs and its own default.
DesignSwipeAction
An action behind a row.
DesignSwipeActionDetails
What the look paints an action from.
DesignSwipeActions
child with startActions behind its start edge and endActions behind its end edge.
DesignSwipeActionsController
Opens and closes a DesignSwipeActions row from outside, and says whether it is open, as flutter_slidable's controller does. The caller makes it, gives it to one row, and disposes it; with no row it does nothing.
DesignSwipeBackPageTransitionsBuilder
builder's page transition with iOS's swipe back from the screen's leading edge round it.
DesignTab
A tab: its name, and what a look paints it with.
DesignTabBar
A bar of tabs, controller choosing among them; the look paints each tab (tabBuilder) and the indicator under them (indicatorBuilder), or over them (indicatorPosition).
DesignTabController
Which tab is selected, and where a swipe or a change has got to: Material's TabController without Material. A DesignTabBar and a DesignTabView given the same one follow each other. The caller makes it, with a TickerProvider (TickerProviderStateMixin), and disposes it.
DesignTabDetails
What a look paints a tab from.
DesignTabIndicatorDetails
Where a look paints the indicator, and the selected tab's states.
DesignTableColumn<R>
A column of a DesignTableController.
DesignTableController<R>
A table's data and its view of it: the filter, the sort, the selection and the page.
DesignTableRow<R>
One row, as DesignDataTable.rowBuilder gets it.
DesignTabView
The pages of controller's tabs, one per tab, swiped between: Material's TabBarView without Material. Swiping moves the controller's DesignTabController.animation, so a bar's indicator follows the finger; let go, the pages spring to the nearer page (or the next, flung) on the controller's spring. A change from the bar springs the pages the same way. Each page is its tab's panel to a screen reader; pages off screen are not built, unless a page keeps itself alive.
DesignTagDetails
One tag, as DesignTagInput.tagBuilder gets it.
DesignTagInput<T extends Object>
Values chosen as tags, with a field that suggests and makes more.
DesignTapTarget
Lays child out at least minSize (the floor for what reaches the controls, DesignTapTargets.of, when null), placed by alignment, and sends a tap anywhere in that area to the child's centre: the control's layout, the area a tap reaches and the box a screen reader outlines are one.
DesignTapTargets
The least area a tap must reach on a control, by what reaches it: 44 by 44 for a finger (Apple's Human Interface Guidelines), 24 by 24 for a pointer (WCAG 2.2, success criterion 2.5.8, level AA).
DesignTapTargetScope
Declares the targets a look's controls stand at for the subtree, as a theme does; DesignTapTargets.of reads them.
DesignTextEntryBox
A text entry's box: at least minHeight tall, holding child, an editable as wide as the box, with one line centred in it and hint on the typed text's baseline while controller is empty.
DesignTimeField
A time of day typed in segments, on the reader's clock: value the time, null when empty; onChanged gets it once every segment holds one, and null when one is cleared.
DesignTimeOfDay
A time of day with no date: an hour (0–23), a minute and a second.
DesignTimeScale
Time, in local dates: min at start, max at end. Its values are milliseconds since the epoch (DateTime.millisecondsSinceEpoch); its ticks fall on calendar steps (seconds to years) and read as the reader's times and dates.
DesignToast
What a toast says and does. The look reads the fields it paints; data carries anything else it needs (a tone, an icon).
DesignToastDetails
What the look's DesignToaster.toastBuilder paints one toast from.
DesignToaster
Hosts toasts over child: put it above the app's navigator (WidgetsApp.builder), then call DesignToaster.of and DesignToasterState.show from anywhere below.
DesignToasterState
The state of a DesignToaster: show and dismiss toasts through it.
DesignToastHandle
A shown or waiting toast, as DesignToasterState.show returns it.
DesignToggleGroup<T>
A row (or column) of toggles over options.
DesignTooltip
A tooltip of message for child, painted by tooltipBuilder.
DesignTree<T extends Object>
The open rows of controller, one tab stop for all of them.
DesignTreeController<T extends Object>
A tree's nodes and which are open and selected.
DesignTreeItem<T extends Object>
A row's paint state.
DesignTreeRow<T extends Object>
A shown row of a tree.
DesignValueHandle
A focusable value between min and max.
DesignWheelColumn
One column of a DesignWheelPicker: its rows, their names and which of them can be chosen.
DesignWheelColumnDetails
One column of a DesignWheelPicker, as the look frames it: its lens, a band behind the centre row, a focus ring.
DesignWheelItemDetails
One row of a DesignWheelPicker, as the look paints it.
DesignWheelPicker
A wheel picker of linked columns: selection holds a row per column, columns gives the columns for a selection, and onChanged gets every pick as a whole, valid selection.
RenderDesignCapCenter
The render object of DesignCapCenter: keeps its child's size and paints it moved up or down so that its one-line label's capitals sit on the box's middle.
RenderDesignTapTarget
DesignTapTarget's render object: its child laid out as given, itself at least minSize, the child placed by alignment, a hit anywhere in it sent to the child's centre.
TermActionSheet<T>
The face of showTermActionSheet: a sheet of action rows.
TermAreaChart
An area chart: a TermLineChart with the dots under each line filled in its ink, faint, the line itself solid; the foot is 0 unless min says otherwise.
TermAvatar
Someone, as their initials in bold on a block of colour picked from the palette by their name (the same name, the same colour), a cell either side: AL. lines 2 makes it two lines tall for a profile.
TermAvatarGroup
A few people side by side, a cell apart, and +3 for the rest.
TermBadge
A badge that counts: the number in bold on a block of tone's ink, a cell either side, 3; past max it says 99+. A screen reader hears the count and semanticLabel.
TermBanner
A banner: a line in tone across the top of what it is about, its glyph and a bar in the tone's ink at the start, message, and an action at the end (a TermButton: retry, open). A screen reader hears it as it appears.
TermBarChart
Bars across the screen, one a line, as a terminal charts disk use: the label, a bar of blocks to the eighth of a cell with dots for the cells left, the value at the end.
TermBlocksPainter
Paints a bar of block elements across size: value of it in whole eighths of a cell (█▉▊▋▌▍▎▏) in color, each empty cell after it a dot (·) in track, so the cells left can be counted, as a terminal draws a progress bar.
TermBracketBand
A pair of brackets one line tall round child, in the rule's ink, at its middle line however tall the targets inside make it. Under the keyboard's focus the cursor stands on the brackets' cells, the brackets cut out of it.
TermBracketFace
A button's face: label in brackets one line tall, padCols either side, filled in the accent when filled, the press filling in, the keyboard's focus the cursor over it, its brackets cut out (hollow when filled).
TermBracketPainter
Paints a bracket in the first cell and its pair in the last cell of size, each a single line splitting into a double one as doubled goes from 0 to 1. Between them, fill covers the inner cells: a press, a selection or a filled button, in inverse video.
TermBraillePainter
Paints one braille cell: the eight dots, those in bits in color and the rest not at all.
TermBreadcrumb
Where you are, as a path: ~/atlas-api/runs/#1482, each step back a link, the last one bold, where you are. It reads left to right in any app, as a path does.
TermButton
A button, as a terminal program draws one: its label in brackets, [ Deploy ], one line tall and as many cells wide as the label and its brackets take, with the key that works it written after it.
TermButtonGroup
Buttons on one line, a cell apart, as a program's toolbar prints them: [ rerun ] [ cancel ] [ logs ]. Where the line is short they wrap.
TermCalendar
A month as cal prints it: the month's name between ‹ and ›, the weekdays in two letters, each day in its own cells, the chosen one in inverse video, the keyboard's in brackets, today underlined, a range's days on a shaded ground. The arrows move by a day, Page Up and Down by a month.
TermCaret
The block caret, a cell wide, blinking at the terminal's half-second: after a prompt that waits for input. It stays lit under Reduce Motion. A screen reader skips it.
TermCellFace
One choice's cells inside brackets: label a cell either side, in inverse video when on, the press filling in, the keyboard's focus the cursor on its cells (TermCursorCells; on a chosen one, hollow: its end cells in the accent, its fill cleared, its words in the accent).
TermCells
Lays child out cols cells wide and lines lines tall on the grid in force; either left null takes the child's own size.
TermCheckbox
A checkbox, [x], with its label after it on the same line when given (the whole line is then its target, as a terminal's form toggles one).
TermChip
A chip that filters: label in round brackets, ( failed ), chosen in inverse video with a ✓ in the cells kept for it, so choosing moves nothing. The keyboard's focus is the cursor over it, its brackets cut out (on a chosen chip, hollow).
TermColorPicker
A colour picker drawn in cells: an area of saturation across and brightness up, each cell two half-block pixels as a terminal draws a picture; a hue bar of cells under it; the colour's hex; and the palette's sixteen colours to take one from.
TermColumn
A column of a TermTable.
TermCombobox<T extends Object>
A field that suggests as you type: the matches listed in a pane right under the frame, the one the arrows are on under the cursor, Return taking it.
TermCommandPalette
A command palette standing on a page: > and a field, then commands ranked as the query is typed, grouped under their DesignCommand.group, each with its matched letters lit and its DesignCommand.shortcut at the end. Up and Down move the highlight (the pointer moves it too), Return runs it. Open one over the screen with showTermCommandPalette.
TermConfirmDialog
The terminal's question as a dialog: message, then proceed? [y/N], answered with y or n (Return takes the capital: no) or the buttons.
TermContextMenu
A menu over child that opens where it is asked for: at the pointer on a right click or a long press, at the focused widget on Shift+F10 or the Menu key, and from a screen reader's "Show menu". Its rows are a TermMenuBar menu's: menuChildren are commands, submenus (›), checks and rules, each command's key dim at the end.
TermCursorCells
The keyboard's focus as Terminal marks it, on cells with no brackets of their own: the cursor (TermCursorPainter), a block of the accent over child's cells with a pair of brackets cut out of its end cells, the words in inkOf. hollow for cells in inverse video already: the cursor takes their end cells, and their fill is the part's to clear.
TermCursorPainter
The cursor on a part with no brackets of its own (a row, a tab, a choice in a group): the block of termPaintCursor over size, and in its first and last cells a pair of brackets one line tall cut out of it in knockout, the cursor's own edges, so the block never reads as a chosen part's inverse video.
TermCursorSpan
The keyboard's focus on words with no cells of their own round them (a link, a heading, a crumb): the cursor, a block of the accent behind child reaching reach cells past it on either side (into the spaces round it), the words in termCursorInk. A press fills the words alone, so the two never read as one.
TermDataTable<R>
A table you work in, on DesignDataTable: headings that sort when pressed (↑ or ↓ after the one sorted), rows that select with a press or Space ([x] in the first column) and open with Enter, the arrows moving a > down the rows, one tab stop for them all. The page's rows come from the controller: its filter, sort and page.
TermDatePicker
A date chosen under its field: the field in a frame, as a TermSelect is, writing the date 2026-11-14; pressed, a TermCalendar opens in place under it, and a day chosen closes it.
TermDateRangePicker
A range of dates chosen under its field, 2026-11-02 → 2026-11-09: the first day pressed is its start, the next its end, the days between shaded as the pointer moves; the end closes it.
TermDescriptionList
Terms and their values, as key: value pairs print: the terms dim in a column as wide as the longest, a dotted leader to each value; on a narrow screen, each value under its term.
TermDialog
A dialog's face: a raised pane, its line doubled (it has the focus), its title cut into the top line, content inside and actions along the last line, at the end. At most cols cells wide.
TermDisclosure
A part that opens to show more: ▸ title, pressed ▾ title with child revealed under it from its top line, a short reveal with no bounce (none under Reduce Motion).
TermDivider
A rule across the line (or down it, TermDivider.vertical), at the theme's stroke; with label, label ──────.
TermEmptyState
What stands in place of a list with nothing in it: a dim glyph, title, what to try in message, and an action, on the list's own start edge, as a terminal prints it.
TermFace
A monospace face and its advance, which travel together: the advance (one character's width, as a fraction of the font size) is the width of a cell of the grid, so a face can only be set with its own.
TermFieldFrame
Frames a field's child (its one line) with parts' label and note.
TermFieldLine
A field on one line, as a config file or a terminal program's form lays one out: parts' label, then the value in brackets, [ value ], and the help or the error on the line under the value.
TermFileField
A field for files: a framed box titled labelText saying where they come from, a browse button that calls onBrowse (the app opens its own picker), and each file chosen as a tag with × to take it away.
TermFramePainter
Paints a frame through the middle of the outer cells of size: a single line, splitting into a double one as doubled goes from 0 to 1, with topGaps and bottomGaps cut out for the words in its borders.
TermGrid
One cell of the character grid, and the arithmetic of whole cells.
TermHoverCard
A raised pane that comes up while a pointer rests on child (or the keyboard is on it, or a finger holds it): more about a person, a commit or a link, read without leaving the screen.
TermIconButton
A one-glyph button: glyph in brackets, [?], three cells wide, read to a screen reader as semanticLabel.
TermInset
Room inside a pane, in whole cells across and whole lines down, so what a pane holds stays on the grid.
TermInventoryGallery
termInventory, listed group by group in Terminal's own look: each group a pane-style header with its count, each row its name, its part's class (and the ui_core behaviour it stands on), then the live part or the reason it is left out.
TermKey
A key or a chord shown beside an action: keys in the dim ink, its letters in the words' face. A screen reader hears the keys as written, or, made TermKey.of an activator, in the reader's words (designShortcutLabel: "Ctrl+K" for ^K). Under touch it draws nothing (termKeysShown).
TermLineChart
A line chart plotted in braille dots, two across and four down each cell: the most and least values dim at the start, a rule along the foot, xLabels under it, and a key of each series' ● and name.
A link in running text: its words underlined in the accent, a press in inverse video of the words' ink, the keyboard's focus the cursor, a block of the accent half a cell past the words each side. A screen reader hears a link.
TermListTile
A row of a list, as a terminal program lists things: title in the words' ink, subtitle dim, leading (a status glyph) before them and trailing (a time, a count, a key) at the end.
TermLocalizations
The words Terminal's parts say and write. Each counted one takes its count whole, so a language words its own plural forms (one, few, many, …) rather than having a word added to a number.
TermMedia
A picture in a box-drawn frame, whole cells wide and lines tall, caption set into the top line; until it loads (or if it can't), a shade with its alt words dim in the middle.
TermMenu
A menu, by what opened it: a raised pane of rows revealed from its top line, each with its key dim at the end. The keys and the pointer mark a row with the accent (its words, and a block at its start). The keys start on the first row; the arrows walk it, round from the last to the first, Home and End go to the ends, a letter to the next row it starts; Return picks, Escape closes and the keys are back on what opened it.
TermMenuBar
A menubar, as a full-screen terminal program draws one: the menus' names along the top line, the open one in inverse video, each menu a raised pane revealed in place under its name; the arrows move along and into them, Escape closes.
TermMenuItem
One item of a TermMenu.
TermMenuReveal
A menu opening from its anchor: revealed from the anchor's side, the menu itself never moving, as wide as it is from its first frame and the same tree once open.
TermMenuRow
A menu's row: label (and trailing, a key or a count, dim at the end). The chosen row (checked, or WidgetState.selected in states) stands in inverse video, as a press does; under the pointer the row's words take the accent, and where the keys are the cursor stands on it (TermCursorCells: the row in the accent, a pair of brackets cut out of its end cells; on the chosen row, hollow), so neither reads as a second choice. In an open menu (TermMenuMarks round it) one row is current: the keys' row, which the pointer moves as it moves onto a row, shown once the keys or the pointer have moved in a menu the pointer opened. In the rule's ink when disabled. One line for a pointer, two for a finger.
TermMeter
A meter: how full something is, as blocks to the eighth of a cell with dots for the cells left, in green, then yellow past high's warning and red past full's, and the reading after it: ███████▌··· 72%. A screen reader hears the reading.
TermMotion
Terminal's motion: springs for what eases (a press, a frame doubling as it takes focus, a switch's thumb), steps for what ticks (the caret's blink, the spinner's frames), and for structure, no travel at all: a screen changes in a cut or a very short fade, and a menu opens where it stays, under its field.
TermNavigationBar
The navigation at a phone's foot, written as a terminal multiplexer lists its windows: 1:home 2:runs* 3:deploy 4:config, the current one in inverse video and marked *, so it reads without colour too.
TermNavigationDestination
A place the app's navigation goes: its label, and the key that goes there (shortcut, shown beside it).
TermNavigationRail
A rail of destinations down the screen's edge, for a tablet: each a glyph over its number, the current one in inverse video, a rule beside the rail.
TermNumberField
A number and the two keys that step it: [-] 3 [+], the number as wide as its widest value so nothing shifts as it counts, in the reader's digits. The number is the one stop for the keyboard: Up and Down step it, Home and End take it to min and max; the keys are the pointer's. A screen reader hears it as a value it can raise and lower.
TermOtpField
A one-time code: length cells, each in its own brackets, [4][8][ ], the next one's caret a block in the accent; a dim - halves an even code. Paste fills it; a phone offers the code from its messages.
TermPageDots
Where you are in a short run of pages: · · ● · ·, a cell each, the current one solid in the accent. With onChanged each dot is a target.
TermPageRoute<T>
A full screen pushed with Terminal's screen change (TermPageTransitionsBuilder), whatever the app's theme says; on iOS a swipe from the leading edge takes it back (termPageTransitions).
TermPageTransitionsBuilder
Terminal's screen change, for a PageTransitionsTheme: the screen clears to the theme's background at once, the new one's content fades up in place over TermMotion.screen, and going back is a cut. Under Reduce Motion both are cuts.
TermPagination
Pages, as a pager prints them: ‹ 1 … 4 [5] 6 … 21 ›, the page you are on in inverse video, a gap for the pages between; where the line is short, ‹ 5/21 ›. A screen reader hears each page's number and which is current.
TermPalette
The sixteen ANSI colours and the terminal's own background and foreground, as a terminal emulator's colour scheme holds them.
TermPane
A box-drawn frame round child, one cell thick, with title cut into its top line and footer into its bottom one: Terminal's card, group and window.
TermPaneScope
Whether the pane round a part is the one with the keyboard: a list's chosen row is in inverse video in the active pane and a faint shade in the others, so one bright bar and one doubled line say where the keys go. A part in no pane reads as active.
TermPasswordField
A password field: the words typed written *, a [show] at the end of the line that writes them out until pressed again, the field keeping its caret as it flips.
TermPopover
A raised pane by what opened it, revealed from its top line on a press, as a menu is; focus goes in, Escape or a tap outside closes it.
TermProgressBar
A progress bar of block glyphs, cols cells wide, filled in eighths of a cell (█▉▊▋▌▍▎▏), with the percentage after it. value null is a three-cell block that steps back and forth. A screen reader hears the percentage as its value.
TermPullToRefresh
A scroll view refreshed by a pull: one line over the list says what the pull will do (↓ pull to refresh, ↑ let go to refresh), then the spinner while it works and ✓ up to date once done.
TermRadio<T>
A radio button, (•), one of a group sharing groupValue, with its label after it on the same line when given.
TermRangeSlider
A range slider: two blocks on one rule, the part between them heavy in the accent: ──█━━━━━━━█─────. They cannot cross; the arrows move the one with the keyboard, a drag the nearer one.
TermRating
A rating: a mark a step, * given and · not, and the count after it: * * * · · 3/5. The keyboard's focus is the cursor over the marks, the brackets it closes round them cut out of it, and the arrows move it a mark, Home and End to none and all, a digit to that many. A tap or a drag puts it on a mark (a tap left of the first: none). The pointer over it previews the marks it would give, the one hover a rating keeps. A screen reader hears a slider, "3 of 5".
TermReorderableList<T extends Object>
A list you put in order: each row a ≡ handle and its words; drag the handle (or long-press the row on a phone), or use the row's move up and move down actions. The row on the move is drawn raised, framed in the accent.
TermRulePainter
Paints a horizontal rule through the middle of a line, from one end to the other, with gaps cut out.
TermScaffold
An app's shell that fits its screen: the topBar over the body and the statusLine under it; the destinations as a TermNavigationBar at a phone's foot, a TermNavigationRail beside a tablet's body, a TermSideBar pane at a desk. It goes by its own width (under 600, to 1100, past it), so a shell in a pane of a wider screen fits the pane.
TermScrollArea
child, a scroll view on controller, with a bar one cell wide down its end: a light rule for the track, a block for the thumb, lit in the accent while held; it shows while scrolling and under a pointer, and steps off rather than fade.
TermSectionHeader
The heading over a run of rows: title in bold, then a rule to the end of the line, then trailing dim (a count, a key), as runs ──── 12. A screen reader hears title as a heading.
TermSelect<T>
A select: the frame a TermTextField has, with the chosen value's label on its line and a ▾ at the end. A press, Return, Space or Down opens a menu of items under it, exactly as wide as the field, the chosen one in inverse video and the cursor on it. Up and Down move through it, round from the last to the first, Home and End go to the ends, a letter to the next item it starts; Return chooses, Escape closes it and the keys are back on the field. The pointer over an item, and the keys on one, mark it with the accent: its words, and a block at its start.
TermSelectItem<T>
One choice in a TermSelect: its value, the label shown, and an optional dim detail beside it.
TermSeries
One line of a TermLineChart or TermAreaChart.
TermSheet
A sheet: a raised pane standing on the foot of the screen, title cut into its top line, child, then actions at the end, the strongest last. It is a TermDialog that stands where a thumb reaches; show one with showTermSheet.
TermSheetAction<T>
One choice of showTermActionSheet.
TermSideBar
The side pane at a desk: destinations as rows, each with its glyph and key, the current one in inverse video, in a pane titled title, with children under them (a project list, a session).
TermSideSheet
A side sheet's face: a raised pane the screen's height, title cut into its top line, the keys that work in its bottom one.
TermSkeleton
Where words will be: lines lines of shade a font's height tall, in whole cells, the last one shorter, still (a terminal doesn't shimmer); a screen reader hears semanticLabel once.
TermSlider
A slider: a rule across its width, the part up to the value heavy in the accent, the value a block one cell wide that steps from cell to cell: ━━━━━━█──────────. The arrows move it by step, Page Up and Down by a tenth, Home and End to the ends; a drag or a tap on the rule puts it there. The keyboard's focus is the cursor: a block of the accent a line tall across the rail, the rule and the value cut out of it; in hand, the value fills its cell. A screen reader hears a slider.
TermSparkline
A trend in one line: a block per cell, its height in eighths of the line (▁▂▃▅▇), the last value's cell in the accent.
TermSpinner
A braille spinner, one cell: ⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏, a frame every 80 ms, painted rather than drawn from the font so every platform shows the same dots. It holds still under Reduce Motion. A screen reader hears semanticLabel (the localized "loading" when null), never the dots.
TermSplitButton
A button with a menu of the same action's other ways: [ deploy ][▾]. The label runs onPressed; the arrow opens actions under it, revealed in place.
TermSplitView
Two panes split by a rule you drag, a cell wide: the rule turns heavy and takes the accent while held, focused or under a pointer; the arrows move it a step, as tmux resizes a pane.
TermSpring
Builds builder with a value that springs from where it is to target whenever target changes. spatial runs the token as a spatial spring (something moves or resizes), else as an effects spring (a fill or a colour); under Reduce Motion both settle without overshoot, and a keyboard focus indicator (focus) is cut: it stands at its target at once, with no fade.
TermStateSprings
Builds a face with how far its press and its keyboard focus have come, each 0 to 1 on Terminal's springs: a press fills in quickly, the cursor comes with a short glide (cut under Reduce Motion).
TermStatusLine
The status line at the foot of a screen: mode in a block of the accent, then segments (the project, the branch, the counts), and at the end the keys that work here, written ^K palette ? help. One line, on the surface's ground.
TermStatusSegment
One stretch of a TermStatusLine: words, in an optional color.
TermStatusView
A whole view's state, in the middle of its room: the spinner (or ✗, or ✓) and title on one line, message dim under it, and action (a retry, say) under that. A screen reader hears the change as it happens.
TermStepper
Ticks builder through whole steps: frame 0, 1, 2, … every period, as a terminal's caret blinks and its spinner turns. Under Reduce Motion, or when running is false, it holds at frame 0.
TermSteps
A run of steps, as a wizard or a pipeline shows them: ✓ source ── ✓ build ── ● test ── ○ deploy, each with its mark so it reads without colour; on a narrow screen, one under another.
TermStyleOf
layers read at states the way Terminal reads them: the first layer with a value wins, slot by slot, and a text style keeps only its colour and weight.
TermSwitch
A switch, [■ ] off and [ ■] on: a block that slides between the two cells inside its brackets, dim at the start when off and in the accent at the end when on, so it reads without colour. With a label, the words follow it on the line.
TermTabBar
A tab bar: each tab its number and its label, 1 steps 2 log 3 env, the chosen one in inverse video. The number is the key that picks it (with Alt), and the app binds it.
TermTable
A table as a command prints one: the headings dim over a rule, the columns two cells apart, numbers lined up at the end, each row one line. When every column has its width and they don't fit, it scrolls sideways rather than wrap.
TermTag
A tag: label on a ground tinted by tone, a cell either side, as a terminal prints a label in colour: prod. With onDeleted a × after the words takes it away.
TermTagInput<T extends Object>
A field that gathers tags: each value chosen a TermTag with its × on the line over the frame, the field suggesting from options as you type, a comma or Return making the tag, Backspace in an empty field taking the last one back.
TermTapTarget
Lays a control's face out at the look's tap floor, rounded up to whole cells and lines, so a target padded to the floor still ends on the lattice: two lines for a finger, one for a pointer.
TermTextField
A text field drawn as a terminal form draws one: three lines tall, a frame whose top line carries labelText and whose bottom line carries helperText or, while there is one, errorText after a ✗; the words typed on the line between, after an optional prompt ($, >, ~/).
TermTheme
Puts Terminal's look over child: its theme, the grid grown by the reader's text scale, its tap floors (two lines for a finger, one for a pointer), its words' default style, and the Material theme under its text fields pinned so no platform density moves them.
TermThemeData
How Terminal looks: a palette and the roles drawn from it, the face and the cell grid, the stroke every box line is drawn at, and a style for each part.
TermTime
A time of day as a TermTimeField holds one: an hour on a 24-hour clock and a minute, with no date or zone (and no Material type in the look's API).
TermTimeField
A time typed as a terminal takes one, 14:30, on a 24-hour clock: the words checked as they are typed, the arrows stepping it by step minutes. Its figures are the reader's digits (Arabic's ١٤:٣٠), and either theirs or ASCII ones type it.
TermTimeline
What happened, in order: the time dim at the start, each entry's mark (✓, ✗, !, ·) in its tone's ink on a rule that runs down to the next, the title and its detail after.
TermTimelineEntry
One entry of a TermTimeline.
TermToast
One toast's face, as TermToaster paints it from details.
TermToaster
Hosts Terminal's toasts over child: put it in the app's builder, above the navigator, and show one with TermToaster.show.
TermToggleGroup<T>
Toggles in one pair of brackets, [ list │ tiles │ log ], each chosen one in inverse video: one choice (multiSelectionEnabled false, a segmented control) or each on its own (a toggle group). The arrows move along it; Space and Return press.
TermTooltip
A line of words on a block of the foreground's ink, shown while a pointer rests on child or the keyboard is on it, and after a long press; a screen reader hears message as child's tooltip.
TermTopBar
The title line at the top of a screen: leading (a back key), title in bold, subtitle dim after it (a path: atlas-api › runs; on a short line it keeps its last steps whole, …#1481 › change, and on one too short for the title as well, the steps stand alone in its place, so where you are stays), and actions at the end. One line under a pointer, two under a finger (its buttons' floor), on the surface's ground with a rule under it.
TermTree<T extends Object>
A tree as tree prints one: ├─ and └─ before each node, │ carrying each open branch down, ▸ or ▾ on a node with children; the keyboard's row under the cursor, the chosen in bold accent. The arrows walk it (→ opens, ← closes or climbs), Enter opens a leaf.
TermWholeLines
child, a vertical scroll view, given whole lines of the height it is offered (what is left over stays empty under it) and brought to rest on a whole line after every scroll, so its edges cut between lines, never through one, as a terminal's window does.

Enums

DesignBranchBackBehavior
Where back goes from a branch at its root page.
DesignCalendarMode
How a calendar selects.
DesignChartXAxis
What a DesignChart's x values are.
DesignColorChannel
A channel a DesignColorSlider sets.
DesignDateSegmentType
The kinds of segment a date or a time field is typed in.
DesignInput
What reaches a look's controls: a finger, or a pointer (a mouse, a trackpad, a stylus that hovers).
DesignMenuLevel
Where a DesignMenuBar's builder paints: the bar, a menu or a submenu.
DesignNavigationMode
How a shell shows its destinations.
DesignOverlayAlign
How a surface lines up with its anchor along the side it sits on.
DesignOverlaySide
Which side of the anchor a surface sits on. start and end follow the text direction.
DesignOverlayTrigger
What opens an anchored surface.
DesignRefreshMode
Where a pull stands.
DesignScrollbarVisibility
When a DesignScrollArea's scrollbar shows.
DesignSelection
A page's selection, for its select-all checkbox.
DesignSheetEdge
Which edge a DesignSideSheetRoute comes from.
DesignSortDirection
Which way a column sorts.
DesignSplitPart
Which part of a split button a builder paints.
DesignToastClosedReason
Why a toast left.
DesignWindowSizeClass
Material's window size classes, by width in logical pixels.
TermAnsi
One of the sixteen ANSI slots of a TermPalette: which one is the accent (TermThemeData.from's accentSlot).
TermBracketShape
The shape of a bracket pair: square [ ] for a button and a checkbox, round ( ) for a radio.
TermStatus
How a TermStatusView stands.
TermStepState
How a step of TermSteps stands.
TermStroke
The weight of the box lines: box drawing's two, light (─ │ ┌) and heavy (━ ┃ ┏). A width between them would read as a web border.
TermTone
What a message means, each with its glyph so it reads without colour: i, ✓, !, ✗.

Extensions

DesignSpringDrive on AnimationController
Runs an AnimationController on a spring instead of a duration.
TermGridContext on BuildContext
The theme and the grid at a BuildContext.

Constants

designSpringTolerance → const Tolerance
When a spring-driven controller counts as settled, in the controller's own units (a 0–1 progress, or dp for a position):
termFallbackFontFamily → const String
The family a script JetBrains Mono lacks falls back to: Liberation Mono, whose Hebrew keeps the same 600/1000 em advance, so a right-to-left word takes the same cells.
termFontFamily → const String
The family every word is set in: JetBrains Mono NL, a monospace whose advance (600/1000 em) is the width of one cell of the grid.
termFontPackage → const String?
The package that bundles Terminal's faces, or null when the app does. Every Terminal text style passes it as TextStyle.package.
termInventory → const DesignInventory
Every inventory row: Terminal's part for it, live, or the reason it has none.
termPageTransitions → const Map<TargetPlatform, PageTransitionsBuilder>
The platform builders for Terminal page transitions. A route fades in on push and cuts back on pop. On iOS it also supports swiping back from the leading edge.
termSpinnerFrames → const List<int>
The dots of one braille cell lit for each frame of Terminal's spinner: a dot running round the cell, as ⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏ draws it. Bits follow Unicode's braille order (dot 1 is bit 0).

Functions

designMatchScore(String text, String query) → int?
How well query finds text: null not at all, higher better. A prefix beats a word's start, which beats a substring, which beats the letters in order.
designReduceMotionOf(BuildContext context) → bool
Whether the reader asked for reduced motion at context: Android's Remove animations or the web's prefers-reduced-motion (MediaQuery.disableAnimationsOf), or iOS's Reduce Motion (dart:ui's AccessibilityFeatures.reduceMotion, which MediaQuery does not carry).
designShortcutKeys(BuildContext context, MenuSerializableShortcut shortcut, {TargetPlatform? platform, bool appleSymbols = true}) → List<String>
The keys of shortcut (a SingleActivator or a CharacterActivator), one string a key, modifiers first, as Flutter's MenuItemButton labels them:
designShortcutLabel(BuildContext context, MenuSerializableShortcut shortcut, {TargetPlatform? platform, bool appleSymbols = true}) → String
designShortcutKeys joined as a menu row shows them: "⌃ ⇧ N" with Apple's symbols (Flutter's spacing), "Shift+Command+N" in words on macOS and iOS, "Ctrl+Shift+N" elsewhere.
designSpring({required double dampingRatio, required double stiffness}) → SpringDescription
The Flutter spring for the token (ζ = dampingRatio, k = stiffness): SpringDescription.withDampingRatio(mass: 1, stiffness: k, ratio: ζ), so damping = 2ζ√k. Compose's spring(dampingRatio, stiffness) is written against unit mass, so the two run the same curve.
designSpringSimulation(SpringDescription spring, {required double from, required double to, double velocity = 0, Tolerance tolerance = designSpringTolerance}) → SpringSimulation
The simulation of spring from from to to, starting at velocity units per second, that settles at tolerance and lands exactly on to.
designSwipeBack(Map<TargetPlatform, PageTransitionsBuilder> builders, {Set<TargetPlatform> platforms = const {TargetPlatform.iOS}}) → Map<TargetPlatform, PageTransitionsBuilder>
builders with the entries for platforms (iOS, by default) wrapped in DesignSwipeBackPageTransitionsBuilder, so a page there pops with a swipe from the screen's leading edge and otherwise plays the look's push.
showDesignCommandPalette({required BuildContext context, required DesignCommandPalette palette(ValueChanged<DesignCommand> run), Widget surfaceBuilder(BuildContext context, Widget palette)?, Color barrierColor = const Color(0x66000000), DesignBarrierBuilder? barrierBuilder, String? barrierLabel, AlignmentGeometry alignment = const Alignment(0, -0.6)}) → Future<void>
Opens palette in a modal route over a barrier; surfaceBuilder paints the panel around it. A command runs after the route has closed and focus is back where it was.
showTermActionSheet<T>({required BuildContext context, required List<TermSheetAction<T>> actions, String? title, String? message, String cancelLabel = 'cancel', TermStyle? style}) → Future<T?>
A list of actions at the screen's foot: title cut into the top line, message dim under it, a row per action (lit under the keyboard or a pointer, the destructive in red) and cancel last. Completes with the chosen action's value, or null.
showTermCommandPalette({required BuildContext context, required List<DesignCommand> commands, String title = 'commands', String hintText = 'type a command', String emptyText = 'no command matches', String? initialQuery, int cols = 64}) → Future<void>
Opens a TermCommandPalette of commands over the screen, the screen behind dimmed, at most cols cells wide, a quarter of the way down. It comes up in place in a very short fade; a chosen command runs once the palette has closed and focus is back where it was. Escape or a tap outside closes it. Pair it with DesignCommandShortcut for ^K.
showTermConfirmDialog({required BuildContext context, required String title, required String message, required String confirmLabel, String cancelLabel = 'no', bool isDestructiveAction = false, String? typedConfirmation, bool? sheet}) → Future<bool?>
Asks message as a y/N question and completes with true for yes, false for no and null when dismissed. See TermConfirmDialog. Under 600 wide it stands as a sheet at the foot of the screen, where a thumb reaches; sheet decides it instead when given.
showTermDialog<T>({required BuildContext context, required WidgetBuilder builder, bool barrierDismissible = true, bool isAlert = false, String? semanticLabel, bool useRootNavigator = true}) → Future<T?>
Raises the dialog builder makes over the app, the screen behind dimmed, and completes with what it pops. The dialog comes up where it stays, in a very short fade on TermMotion.surface (under Reduce Motion, a fade of the route's own); it keeps the focus inside while open and gives it back as it closes, and Escape, Android's back or a tap outside (when barrierDismissible) close it, through any PopScope in it.
showTermSheet<T>({required BuildContext context, required WidgetBuilder builder, bool barrierDismissible = true, bool isAlert = false, String? semanticLabel, bool useRootNavigator = true}) → Future<T?>
Raises the sheet builder makes at the foot of the screen, the screen behind dimmed, and completes with what it pops. Like a dialog it comes up where it stays in a very short fade on TermMotion.surface, keeps the focus inside while open, and a tap outside (when barrierDismissible), Escape or Android's back closes it. isAlert and semanticLabel are showTermDialog's.
showTermSideSheet<T>({required BuildContext context, required WidgetBuilder builder, DesignSheetEdge edge = DesignSheetEdge.end, int cols = 44, String? semanticLabel, bool useRootNavigator = true}) → Future<T?>
Raises the side sheet builder makes at the screen's edge (the end, by default), cols cells wide, the screen behind dimmed: it comes up in place in a very short fade, a finger drags it away, Escape or a tap outside closes it, and it completes with what it pops.
termContrast(Color a, Color b) → double
The contrast ratio of a against b, 1 to 21, as WCAG reckons it.
termCursorInk(TermThemeData theme, Color rest, double focus, {bool hollow = false}) → Color
The words' colour as the keyboard's focus comes (focus, 0 to 1): from rest towards the ink words take on the cursor's accent, or on a part the cursor hollows (hollow: one in inverse video already, its fill cleared) towards the accent on the ground.
termDate(DateTime date, {DesignLocalizations? localizations}) → String
date as a terminal writes one, 2026-11-14: year, month and day in that order, in localizations' digits when given (Arabic's ٢٠٢٦-١١-١٤), else ASCII.
termDoubleGap(TermGrid grid, double stroke) → double
How far apart the two lines of a double line stand at grid: about a third of a cell, as a font's ═ draws them.
termKeyLabel(SingleActivator activator) → String
activator's keys as a terminal writes them: ^ for Control, M- for Alt (Meta, as Emacs and readline say), ⌘ for Command, ⇧ for Shift, then the key (⏎ Return, esc, tab, ␣ Space, arrows as ↑↓←→).
termKeysShown(BuildContext context) → bool
Whether keys are shown here: where a keyboard and a pointer reach the app (DesignInput.pointer, from DesignTapTargets). Under touch there are no keys to press, so the look leaves them out: a TermKey draws nothing, a button's keys and a menu row's step aside, a status line's keys go, and so do the keys in the bottom line of a palette, a dialog, a sheet and a toast. A pane's footer is the app's own words: give keys there only where this is true.
termLoadFonts() → Future<void>
Loads the faces Terminal bundles, so the first frame is set in them. Await it before runApp: on the web a bundled face otherwise arrives after the first frames, which flash in a fallback face and off the grid.
termMatchRanges(String text, String query) → List<(int, int)>
Where query matched text, as designMatchScore ranks it: the prefix, the word or the run of letters it found, or each letter in order. Ranges are start inclusive, end exclusive; empty when nothing matched.
termPaintCursor(Canvas canvas, Rect band, Color color, double amount, double cellWidth, {bool hollow = false}) → void
The cursor over band: a block of color over every cell, amount of the way in; hollow, the band's first and last cellWidth only, as the cursor stands on a part already in inverse video.
termReadable(Color color, {required Color on, double ratio = 4.5}) → Color
color stepped lighter (on a dark on) or darker (on a light one) in its own hue until it reads at ratio on on: a brand colour made fit to be Terminal's accent.
termRegisteredFamily(String family) → String
family under the name Flutter registers it by: JetBrainsMono when the app bundles it, packages/terminal_ui/JetBrainsMono from the package. A test that loads the faces itself loads them under this name.
termRowShade(TermThemeData theme) → Color
The shade a selected row sits on: the rule's ink, faint, over the background.
termStroke(TermThemeData theme, TermGrid grid) → double
One line's stroke at grid: the theme's width grown with the words.

Typedefs

DesignBarrierBuilder = Widget Function(BuildContext context, Animation<double> animation)
Paints a modal part's barrier in place of its barrier colour: a look's own screen over the page behind (Ben-Day dots, a blur, a grain).
DesignBottomSheetBuilder = Widget Function(BuildContext context, DesignBottomSheetDetails details)
Builds a bottom sheet's panel from details.
DesignCalendarDayBuilder = Widget Function(BuildContext context, DesignCalendarDay day, Set<WidgetState> states)
Paints one day for its states (WidgetState.selected when chosen, WidgetState.focused while the keyboard is on it, hovered, pressed, disabled).
DesignChartBuilder = Widget Function(BuildContext context, DesignChartDetails details)
Draws a chart from its details.
DesignChartFormat = String Function(double value)
Formats a value for labels, readouts and speech.
DesignChartTableCellBuilder = Widget Function(BuildContext context, DesignChartTableCellDetails cell)
Paints a cell of a DesignChartTable.
DesignComboboxFieldBuilder = Widget Function(BuildContext context, DesignComboboxField field)
Paints the field.
DesignDateFieldFrameBuilder = Widget Function(BuildContext context, Set<WidgetState> states, Widget segments)
Frames a date or time field's laid-out segments (its box, its focus ring); states are the field's: focused (a segment has the focus), hovered, disabled, error.
DesignDateLiteralBuilder = Widget Function(BuildContext context, String literal)
Paints the text between a field's segments ("/", ".", ":", Japanese's year mark U+5E74).
DesignDateSegmentBuilder = Widget Function(BuildContext context, DesignDateSegmentDetails details)
Paints one segment of a date or time field. A segment is a tap target: a look gives its face the floor (DesignTapTarget).
DesignDestinationBuilder = Widget Function(BuildContext context, DesignNavigationDestination destination, DesignDestinationDetails details)
Paints a destination.
DesignDialogActionBuilder = Widget Function(BuildContext context, DesignDialogAction action, DesignDialogActionDetails details)
Paints an action of a DesignDialog.
DesignDialogBuilder = Widget Function(BuildContext context, DesignDialogDetails details)
Builds a dialog route's page: the look's dialog, which details lets it move as the route opens and closes.
DesignDialogPartBuilder = Widget Function(BuildContext context, DesignDialogFrameDetails details, Widget child)
Wraps a part of a DesignDialog (its frame or its action bar) in the look's paint.
DesignDividerBuilder = Widget Function(BuildContext context, Set<WidgetState> states, Axis axis)
Builds a split view's divider for its states (focused while the keyboard is on it, hovered, pressed while dragged).
DesignFieldBuilder = Widget Function(BuildContext context, DesignFieldParts parts)
Lays out a field's parts.
DesignHandleBuilder = Widget Function(BuildContext context, Set<WidgetState> states)
Builds a handle's face for its states (focused while the keyboard is on it, hovered, pressed while dragged, disabled).
DesignInputGroupBuilder = Widget Function(BuildContext context, Set<WidgetState> states, Widget child)
Builds the group's frame around child (the field and its add-ons) for states: WidgetState.focused while anything inside has focus, WidgetState.hovered, WidgetState.disabled and WidgetState.error.
DesignListSurfaceBuilder = Widget Function(BuildContext context, Widget list)
Paints the list's surface around list (a panel, its shadow).
DesignMenuItemBuilder = Widget Function(BuildContext context, DesignMenuEntry entry, DesignMenuLevel level, Set<WidgetState> states)
Paints an item for its states (WidgetState.focused while the keyboard is on it, WidgetState.selected for the active menu title, hovered, pressed, disabled). In a menu whose highlight follows the pointer, one item at most is focused or hovered: the current one.
DesignMenuSurfaceBuilder = Widget Function(BuildContext context, DesignOverlayInfo info, List<Widget> items)
Paints a menu's panel round its items (scroll them when DesignOverlayInfo.maxSize is short): a menubar's menus, a context menu's.
DesignNavigationBuilder = Widget Function(BuildContext context, DesignNavigationDetails details)
Lays out and paints the navigation round its destinations.
DesignNumberFieldBuilder = Widget Function(BuildContext context, DesignNumberFieldDetails details)
Paints the field's text input.
DesignNumberFieldButtonBuilder = Widget Function(BuildContext context, DesignNumberFieldButtonDetails details)
Paints a step button: a look gives it a finger's floor (DesignTapTarget).
DesignNumberFieldLayoutBuilder = Widget Function(BuildContext context, Widget field, Widget decrement, Widget increment)
Lays out the field and its decrement and increment buttons.
DesignOptionBuilder<T> = Widget Function(BuildContext context, T option, Set<WidgetState> states)
Paints one option for its states: WidgetState.focused while it is highlighted (the keyboard's place in the list), WidgetState.selected when it is the combobox's value, WidgetState.disabled when it cannot be taken, and a pointer's hovered and pressed.
DesignOptionSearch<T> = FutureOr<Iterable<T>> Function(String query)
Searches for the options matching query.
DesignOtpContextMenuBuilder = Widget Function(BuildContext context, TextSelectionToolbarAnchors anchors, List<ContextMenuButtonItem> items)
Draws the field's edit menu: Flutter's toolbar arguments, so a look can hand them on (Material's AdaptiveTextSelectionToolbar.buttonItems, Cupertino's CupertinoAdaptiveTextSelectionToolbar.buttonItems) or draw its own. items is the Paste item (its label from its ContextMenuButtonType, in the app's language); pressing it pastes and closes the menu.
DesignOtpLayoutBuilder = Widget Function(BuildContext context, List<Widget> slots)
Lays out the boxes (a row; a look may put a dash in the middle).
DesignOtpSlotBuilder = Widget Function(BuildContext context, DesignOtpSlot slot)
Paints one box.
DesignOverlayAnchorBuilder = Widget Function(BuildContext context, DesignOverlayAnchor anchor)
Paints the anchor.
DesignOverlaySurfaceBuilder = Widget Function(BuildContext context, DesignOverlayInfo info)
Paints the surface.
DesignPaletteLayoutBuilder = Widget Function(BuildContext context, Widget field, Widget results)
A palette's list, as DesignCommandPalette.layoutBuilder lays it out.
DesignPieChartBuilder = Widget Function(BuildContext context, DesignPieChartDetails details)
Draws a pie chart from its details.
DesignPressableBuilder = Widget Function(BuildContext context, Set<WidgetState> states, Widget? child)
Builds a pressable's face for its current states (hovered, focused, pressed, disabled, selected, error). child is the pressable's own child, passed through so a face that does not change with state is built once.
DesignRatingItemBuilder = Widget Function(BuildContext context, DesignRatingItemDetails details)
Paints one item of a rating.
DesignRatingLayoutBuilder = Widget Function(BuildContext context, List<Widget> items)
Lays out a rating's items, in reading order.
DesignScrollbarBuilder = Widget Function(BuildContext context, DesignScrollThumb thumb)
Paints a scrollbar's thumb or track.
DesignSearchErrorBuilder = Widget Function(BuildContext context, DesignSearchError error)
Paints a failed search (error) in the list's surface.
DesignSwipeActionBuilder = Widget Function(BuildContext context, DesignSwipeAction action, DesignSwipeActionDetails details)
Paints an action.
DesignTabBuilder = Widget Function(BuildContext context, DesignTab tab, DesignTabDetails details)
Paints a tab.
DesignTabIndicatorBuilder = Widget Function(BuildContext context, DesignTabIndicatorDetails details)
Paints the indicator, laid out in DesignTabIndicatorDetails.rect.
DesignTableHeaderBuilder<R> = Widget Function(BuildContext context, DesignTableColumn<R> column, DesignSortDirection? sort, Set<WidgetState> states)
A sortable header, as DesignDataTable.headerBuilder gets it.
DesignTagBuilder<T> = Widget Function(BuildContext context, T value, DesignTagDetails tag)
Paints one tag.
DesignTagLayoutBuilder = Widget Function(BuildContext context, List<Widget> tags, Widget field)
Lays out the tags and the field (a wrap, by default).
DesignToastBuilder = Widget Function(BuildContext context, DesignToastDetails details)
Paints one toast.
DesignToastStackBuilder = Widget Function(BuildContext context, List<Widget> toasts)
Lays out the shown toasts, oldest first.
DesignToggleItemBuilder<T> = Widget Function(BuildContext context, T value, Set<WidgetState> states)
Builds an item's face for its states (selected, focused while the keyboard is on it, hovered, pressed, disabled).
DesignWheelColumnBuilder = Widget Function(BuildContext context, DesignWheelColumnDetails details, Widget wheel)
Frames one column of a DesignWheelPicker round its wheel.
DesignWheelItemBuilder = Widget Function(BuildContext context, DesignWheelItemDetails details)
Builds one row of a DesignWheelPicker.
TermCrumb = ({String label, VoidCallback? onPressed})
One step of a TermBreadcrumb: its words, and where pressing it goes (null for the last, where you are).
TermGap = ({double end, double start})
A gap cut into a frame's top or bottom line, where its title or its note stands: from start to end, in pixels from the frame's left.
TermStyle = DesignStyle
How one Terminal part looks in each of its states, as Material's ButtonStyle is: ui_core's DesignStyle under Terminal's name.