ui_core library
What every look stands on: the press, focus and semantics every control is built on, motion, and the headless behaviours each look paints. Every look's package depends on it and re-exports it.
Classes
- DefaultDesignLocalizations
- 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
DraggableScrollableControllerdrives 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 noonSubmitted; 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, at the end, while they fit; on a narrow screen or 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.
- A destination: its name and glyphs, as Material's NavigationDestination.
- 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
fromand its new placeto(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
errorBuildergets 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.
-
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
ButtonStyleis: 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
TabControllerwithout 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
TabBarViewwithout 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.
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.
- 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.
Extensions
- DesignSpringDrive on AnimationController
- Runs an AnimationController on a spring instead of a duration.
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):
Functions
-
designMatchScore(
String text, String query) → int? -
How well
queryfindstext: 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'sAccessibilityFeatures.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'sMenuItemButtonlabels 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'sspring(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
springfromfromtoto, starting atvelocityunits per second, that settles attoleranceand lands exactly onto. -
designSwipeBack(
Map< TargetPlatform, PageTransitionsBuilder> builders, {Set<TargetPlatform> platforms = const {TargetPlatform.iOS}}) → Map<TargetPlatform, PageTransitionsBuilder> -
builderswith the entries forplatforms(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
palettein a modal route over a barrier;surfaceBuilderpaints the panel around it. A command runs after the route has closed and focus is back where it was.
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);statesare 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
detailslets 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) forstates: 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 while its menu is open, 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. - 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
fieldand itsdecrementandincrementbuttons. -
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< Function(String query)T> > -
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'sCupertinoAdaptiveTextSelectionToolbar.buttonItems) or draw its own.itemsis 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).childis 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.