studio_ui library
Studio: an app as a well-made piece of studio equipment. Brushed anodised panels with machined edges, recessed glass displays, backlit keys with an indicator light, faders, knobs, toggles and segment meters, under one light from the top, by day in a bright room and by night in low light.
Install StudioTheme once in an app's builder: (or StudioHost,
which adds the toasts and the chassis); give the app's own ThemeData
studioPageTransitions, or route its pages with StudioPage and
StudioSheetPage.
Classes
- AnimatedStudioSurface
-
StudioSurface that moves to each new face on a critically damped
spring (StudioMotion.pressStiffness), from wherever it is: a press, a
release, a focus, a lamp lighting. A new face mid-way turns from where the
surface stands, with no jump back. Under Reduce Motion the change is a
short fade, as
DesignMotionPolicysays. - AnimatedStudioTheme
-
StudioTheme that moves to a new data smoothly (a bright room to low
light, one density to another), as
AnimatedThemedoes; quickly under Reduce Motion. - DefaultDesignLocalizations
- The words in English, with no localizations package.
- DefaultStudioLocalizations
- Studio's words in English.
- 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, 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.
- 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.
-
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
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.
- StudioAppBar
- The top bar: a faceplate across the screen, the page's title printed on it, a back key at its start on a pushed page (a close key in a sheet), the page's actions as keys at its end. A bottom (a StudioTabBar) stands under the title.
- StudioAppShell
-
The app's places and its one act round a root page: StudioScaffold's
key bank on a phone, its rail on a tablet, its side panel on a desk, and
the act a StudioFloatingKey over the page's bottom end, which the
page's StudioScreen keeps clear. An app on a router mounts it through
StudioShell; a preview mounts it directly. - StudioAreaChart
- Values over steps as traces with the glass under them glowing faintly down to the base line.
- StudioAvatar
- A person: a round porthole of readout glass (pale and lit from behind by day, dark by night) set in a metal bezel, their picture in it or, without one, their initials in it.
- StudioAvatarGroup
- People together: their portholes overlapping, the first on top, and a readout porthole of how many more past max.
- StudioBadge
-
A count at the top trailing corner of child, or a lamp when count
is null. The badge reserves space for its readout. Counts above 99 show
99+visually and retain their full value for screen readers. - StudioBanner
- A notice across the page: a strip of glass with a lamp at its start (the indicator for news, red with danger), its words, and an action and a close key at its end.
- StudioBarChart
- Values per step as columns of lit segments, as level meters stand.
- StudioBreadcrumb
- The way here: each place printed in the legend's ink, a small engraved chevron between them, the last (where you are) heavier and not a key. A place you can go back to sinks a recess under its words when pressed.
- StudioButton
- A key. It stands proud of the metal, lit from the top; a press sinks it and its shadow closes, and it springs back when let go.
- StudioCalendar
- A month on a glass panel: the month's name and two small keys to turn it over the weekdays' print, the days' figures under them. The chosen day sits in a slot pressed into the glass with its figure lit; today has a small lamp under its figure. StudioCalendar.range takes a first and a last day, the days between lit dimmer on one band.
- StudioCarousel
- Slides in a glass window, one at a time: a key back, the page lamps, a key on under it. Swipe or press to turn; with the keyboard, the arrows.
- StudioCheckbox
- A checkbox: a small square key that latches in when checked, its check lit in the indicator light. A press sinks it; letting go latches it in or lets it out.
- StudioCheckRow
- A checkbox and its words as one target and one spoken control: a press anywhere on the row latches the key in or out, and keyboard focus lights the key's own edge. note stands under the words. A null onChanged disables it; isError lights the key's rim in the danger colour.
- StudioChip
- A chip: a small latching key with its lamp. Pressed in, it stays down with its lamp lit (a filter that is on); pressed again, it comes up. Given onDeleted, it carries a cross at its end that removes it (a value you chose).
- StudioCodeField
- A one-time code: one small readout window per figure, the figures lit in the indicator; the window the next figure goes in has its rim lit. Paste fills them all; Backspace walks back.
- StudioColorPicker
- A colour: a glass window of its brightness and saturation for the hue, a slot of hues under it (and of opacity, with showAlpha), and a lens of the colour beside its code in a readout. Each thumb is a small metal ring. The arrows move the thumbs.
- StudioColors
- Studio's colours by role.
-
StudioCombobox<
T extends Object> - A field that suggests: type, and the options whose words match open in a glass list under it; the arrows walk them, Enter takes the lit one and the field keeps the keyboard. With requireSelection only an option may stand in it. Given search in place of options, it asks for the options as the typing rests (debounceDuration): while it looks the list says so, and when the search fails the list says that and offers Try again.
- StudioCommand
- A command a StudioCommandPalette finds.
- StudioCommandPalette
- A command palette: a search window over a glass list of commands, grouped under printed headings, that narrows as you type. The arrows walk the list and Enter runs the lit command; the search keeps the keyboard throughout (Enter is taken in its editing-complete, never its submit, so on the web typing carries on).
- StudioCrumb
- One place in a StudioBreadcrumb.
-
StudioDataColumn<
R> - A column of a StudioDataTable: flex shares the width out.
-
StudioDataTable<
R> - A data table on a glass panel: the columns' names printed small along the top (a press sorts by one, an arrow says which way), the rows under them parted by fine lines. A chosen row's lamp is lit in the first column; the header's lamp chooses the page. With a page size, the page readout stands under it.
- StudioDatePicker
- A date field: a glass window showing the chosen day (or hint) with a calendar glyph at its end; a press opens a StudioCalendar under it, and taking a day closes it.
- StudioDateRange
- A span of days, start to end, both in it.
- StudioDateRangePicker
- A span field: a glass window showing the first and last days (or hint); a press opens a range StudioCalendar under it, which closes once the last day is taken.
- StudioDescription
- A term and its value in a StudioDescriptionList.
- StudioDescriptionList
- Terms and their values, as a spec plate: each term printed small as a legend, its value in the body's words beside it (under it on a narrow column), the pairs parted by fine grooves.
- StudioDestination
- One of an app's places.
- StudioDialog
- A brushed-metal dialog with a title, optional content, and actions.
- StudioDisclosure
- A row that opens to show more: its title, a wedge at its end that turns as it opens, and child sliding out under it. A press, Space or Enter opens and closes it; a screen reader hears it expanded or not.
- StudioDisplay
- A display: a pane of glass set into the metal, shadow falling inside it from its top edge. Content is read on it: an episode, a list, notes. Pale by day and dark by night; readout makes it a readout window's glass, lit amber from behind by day and dark by night.
- StudioErrorState
- When a page's data could not load: what happened, and one way forward (onRetry's key, or an action of the app's), in a StudioStatusView's dish with its red lamp.
- StudioFace
- How a surface looks at one moment: what StudioSurface paints and what AnimatedStudioSurface moves between.
- StudioFacePainter
- Paints a StudioFace in light over a box: what StudioSurface draws, public for a part that paints its own face round other paint.
- StudioFader
- A fader: a metal cap with an index line riding a dark slot, the slot lit in the indicator light from its start up to the cap, engraved ticks beside it. Drag the cap or press anywhere along the slot; the arrows step it. Horizontal it is a scrubber or a level; axis vertical stands it up as a mixing desk's fader, its start at the bottom.
- StudioFieldLabel
- A field's label, printed on the metal above it: sentence case, in the legend's ink.
- StudioFieldMessage
- What a field says under it: its helper, or its error beside a lit danger lamp. Nothing when it has neither.
- StudioFile
- A file a StudioFileDrop holds.
- StudioFileDrop
- A tray to put files in: a recess in the metal with an engraved dashed edge, what it takes printed in it and a key that opens the chooser. The files below it each show a row with its size, a fine meter while it goes up, and a key that takes it out.
- StudioFloatingKey
- A floating key: the graphite main key made large and set over the page, with a shadow under it so it reads as standing above the content; its glyph and lamp lit. StudioFloatingKey.extended adds its legend.
- StudioFormField
- Any control with its label above it, its help under it and its error beside a lit lamp in the help's place, read to a screen reader as one field (its name, its hint, its validity). A group of controls (a row or column of them, a segmented choice, a stepper, chips) keeps each control's own node and tap, and the label names the group (mergeSemantics).
- StudioGroove
- A machined groove across a panel: a dark cut with its lower lip catching the light. Rows on a panel are parted by one.
- StudioHost
-
The app's host, mounted once over its navigator (
WidgetsApp.builder): Studio's theme for the brightness asked for, its toasts and the chassis under every page. - StudioHoverCard
- A panel the pointer opens: rest on child and content shows in a raised panel beside it; move away and it goes. It adds to the pointer's view only; what it shows must be reachable another way.
- StudioIconButton
- A square key with a glyph: the bar's back key, a toolbar's action. selected latches it down with its glyph lit, as a key that stays in.
- StudioIconSizes
- Glyph sizes, from a field's small affordance to a dish's glyph.
- StudioInput
- The plain one-line field: a StudioTextField with a hint, or a label, its error and its text hidden for a password. On a page you write, use StudioTextField, which takes the rest.
- StudioInputGroup
- A field with add-ons in one window: leading and trailing stand as engraved plates at its ends (a scheme, a unit), parted from the words by a groove; the window's rim and edge light while the words have the keyboard.
- StudioKbd
-
Keys to press together, each a small raised cap with its legend
engraved:
StudioKbd(['Ctrl', 'K']). A screen reader hears semanticLabel, or the keys one after another. StudioKbd.shortcut shows a whole shortcut, a cap a key, in the platform's order and the reader's words (ui_core's), and says it as a menu does. - StudioKeyRow
- A toolbar: momentary keys side by side in one recessed bank, each inset from the recess so their corners are concentric with it. A key sinks while pressed and springs back; it never latches (that is StudioToggleBank).
- StudioKeyRowItem
- One key of a StudioKeyRow: a legend, a glyph, or both.
- StudioKnob
- A knob: a knurled rotary with a lit pointer, ticks round it on the metal. Drag up or right to turn it up; the arrows step it. With divisions it clicks into detents and settles into the nearest with a small give, as a stepped knob does.
- StudioLamp
- An indicator lamp: a dimple of unlit glass when off (by night its bezel catches the light, so it still reads as a lamp); lit, a small amber light that glows. It warms up and goes dark on a spring.
- StudioLampRing
- A ring of small lamps lit as far round as lit (0 to 1): a fraction shown as a ring, or a pull's progress.
- StudioLegend
- An engraved legend on the metal: small capitals with tracking where the script has capitals (Latin, Greek, Cyrillic), and its own natural form where it has none (Arabic, Hebrew, CJK, Thai), never forced spacing.
- StudioLight
- The light and shadow a surface is painted with, from the theme: how dark a shadow falls and how bright an edge catches the light in this room.
- StudioLineChart
- Values over steps as traces of light: each series a glowing line with a dot at each step, on the scope's graticule.
- StudioLink
- Words that go somewhere, printed in the legend's ink over a fine engraved rule. A press sinks a recess under them; the keyboard's link has the focus ring round it. A null onPressed greys it.
- StudioListBezel
- The bezel an open list stands in: glass in a raised rim with a soft shadow under it, clipped to its corners; child inset padding (4 px, the slots' inset, by default) so a row's slot is concentric with it.
- StudioListGroup
- Rows on one pane of glass, parted by fine rules that start where the rows' words do. A header stands above it as a StudioSectionHeader, a footer under it in small print.
- StudioListTile
- A row on a pane of glass: an optional leading glyph or picture, a title with an optional subtitle, and a value (trailingText) or a control (trailing) at its end.
- StudioLoadingState
- While a page's data is on its way: the chasing lamps over their word, centred.
- StudioLocalizations
- What Studio's parts say on their own that ui_core's words do not hold: counts, each a real plural (one row, two rows), never a number glued to a noun.
- StudioMedia
- A picture behind glass: image in a readout window set into the metal at aspectRatio, a faint reflection across its top. While it loads (or with none) the window shows an engraved picture glyph.
- StudioMenu
-
A menu: builder draws what opens it (a key, given
toggleand whether it isopen), and items open in a glass list under it. Down on the opener opens it too; the arrows walk the rows, a letter jumps to the next row starting with it, Escape closes it. - StudioMenuBar
- A desktop's menu bar: the menus' titles engraved along a brushed faceplate; the open menu's title sits in a slot with its words lit, its list hanging below it. The arrows cross the bar and walk the lists.
- StudioMenuBarMenu
- One menu of a StudioMenuBar: its title and its actions.
-
StudioMenuEntry<
T> - One row of a StudioMenuList.
- StudioMenuItem
- One action in a menu: words, a glyph, its keys.
-
StudioMenuList<
T> - The list an open select or menu shows: rows on glass in a raised bezel, each row inset 4 px from the bezel so its corners are concentric with it. The chosen row's lamp is lit; the keyboard's row, and the pointer's once it moves, sits in a recessed slot. Opened, the keyboard goes to the chosen row (else the first), scrolled into view; a pointer that opened it lights no row until it moves.
- StudioMenuRow
- One row of an open list, drawn for its states: highlighted (the keyboard's row, or the pointer's) sits in a slot pressed into the glass, its corners concentric with the bezel's; chosen lights its lamp at the row's end and sets its words heavier; a disabled row's words are grey, a destructive row's red. Its words stand where a field's words stand.
- StudioMeter
- A level meter: a row (or a column) of segments behind readout glass, lit from the start up to level in the indicator light, the segments past clip in the danger colour (only those: red means clipping), a dark red while unlit so the zone shows. peak holds one segment lit where the level last reached.
- StudioMetrics
- Studio's measures. The corners, the light (always from the top) and the three depths are the look's and are not settings: a key, a pane and a panel are cut the same way on every app.
- StudioMotion
-
Studio's motion, from the objects: springs only, critically damped unless
the object has a click in it. Run them through
DesignMotionPolicy, which honours Reduce Motion. - The phone's bottom bar: a faceplate holding the app's places as a bank of latching keys in a recess. The chosen key is latched in, its lamp lit.
- The tablet's rail: a column of metal at the start holding the app's places as a vertical bank of latching keys, a leading mark above them.
-
StudioPage<
T> -
The router's page for a route pushed over a root: its screen slid in on
its rails in Studio's way (StudioPageTransitionsBuilder), the page it
covers dimming; going back is the reverse. On iOS it pops with iOS's
swipe back from the leading edge too. A go_router route's
pageBuilderreturns it with the route'sstate.pageKey. - StudioPageDots
- Where you are among pages: a row of small lamps, the current one lit. Given onChanged, each lamp is a key (a 44 target round it) that goes to its page.
- StudioPageTransitionsBuilder
-
Studio's page change, for a
PageTransitionsTheme(Flutter's material library's or the one Studio is built on: it is a widgets-level builder). An app's own theme gives it studioPageTransitions. - StudioPagination
-
Pages, as a player picks a track: a key back, the page and the count in
a readout (
03 / 12), a key on. A key at an end goes dark. - StudioPanel
- A panel: a module of brushed anodised metal, flush with the chassis, its top edge catching the light. Controls and legends stand on it; what people read goes on a StudioDisplay set into it.
- StudioPasswordField
- A password field: its words hidden as dots, with a key at its end that shows them while it is pressed in, and hides them again when the field loses the keyboard.
- StudioPieChart
- Shares of a whole as lit arcs round a ring on the scope's glass, a fine gap between them, the total in a readout in the middle.
- StudioPopover
-
A panel that a key opens: builder draws the opener (given
toggleand whether it isopen), and content stands in a raised panel under it, with the keyboard inside it; Escape or a press outside closes it. - StudioPreview
- One page alone, as the app stands it: the same host, the same places and act on a root, the same route on a pushed page or a sheet, with no router.
- StudioProgressBar
- How far something has got: a dark readout window with a row of segments, lit from the start as far as value. With no value it waits: a short lit run sweeps back and forth.
- StudioPullToRefresh
- Pull down to refresh: as the list is pulled, a ring of lamps over it lights one by one; at the top it is armed (all lit), let go and the lamps chase round while onRefresh runs, then a lit check.
- StudioRadii
- Studio's corners: machined, small and concentric. A shape set into another is inset by the difference of their radii.
-
StudioRadio<
T> - A radio button: a round key that latches in when chosen, its lamp lit. Choosing another in the group lets it out.
- StudioRangeFader
- A fader with two caps on one slot, the slot lit between them: a span (a clip's in and out, a range of lengths). Drag either cap; the arrows step the one with the keyboard. startLabel and endLabel name the caps to a screen reader.
- StudioRangeValues
- The two ends of a StudioRangeFader.
- StudioRating
- A score out of max: a row of star lenses, the ones up to value lit in the indicator, the rest dark glass. Each lens is a key that sets the score; the arrows step it. A null onChanged makes it a readout only.
- StudioReadout
- A readout window: by night dark glass, its figures glowing in the indicator light; by day pale glass lit from behind, its figures the indicator deepened to read there. Tabular figures, so they never jitter as they change.
-
StudioReorderableList<
T extends Object> - A list you put in order: rows on glass, each with a knurled grip at its start. Drag a grip (or long-press a row) and the row lifts with a shadow under it; with the keyboard, the row's actions move it up or down, and a screen reader hears where it went.
- StudioScaffold
- An app's frame: its body under its appBar, with its places as the width asks: under 600 px a StudioNavigationBar at the foot; to 1024 px a StudioNavigationRail at the start; wider a StudioSideNavigation. On a phone the page is one sheet of metal; wider, the rail or the side navigation and the page stand as modules in a rack, the chassis between them.
- StudioScreen
- A page: a panel of brushed metal with its topBar (a pushed page's way back stands in it), its body in the page's margins on the 4 px grid, no wider than 1200 px, and its footer fixed at its foot on the bar's metal. In a sheet it is as tall as its content allows and stands on the sheet's own panel.
- StudioScrollArea
- A scrolling pane with its own scrollbar: a fine slot along its edge and a small brushed cap riding it, standing whenever there is more to scroll. Drag the cap, press the slot to page; with the keyboard, the arrows and Page keys scroll it.
- StudioSearchField
- A search field: a glass window with a lens at its start and, once it has words, a key at its end that clears them. Submitting gives up the keyboard, as a search does.
- StudioSectionHeader
- A section's header: its name engraved on the metal as a legend, a machined groove running on from it to the end, and an optional action at the end.
-
StudioSegment<
T> - One key of a StudioSegmentedButton.
-
StudioSegmentedButton<
T> - A segmented button: a bank of latching keys set in a recess, one latched in at a time with its lamp lit. The keys are inset 4 px from the recess, their corners concentric with its own. Arrows move the choice along the bank, Home and End to its ends.
-
StudioSelect<
T> - A select: a glass window showing the chosen setting, a stepper glyph at its end. A press, Down or Up opens the settings under it on glass, the list opening on the chosen one (in view, however long the list); the chosen setting's lamp is lit. Arrows move through the list, a letter goes to the next setting it starts, Enter or Space chooses, Escape closes, and the keyboard comes back to the window. The pointer's row is the keyboard's: a pointer that moves over the list lights the row under it.
-
StudioSelectItem<
T> - One setting a StudioSelect offers.
- StudioSeries
- A named run of values for a chart.
- StudioSheet
- A sheet: a drawer of metal, its top corners machined, a finger slot cut at its top, an optional title printed beside a close key. On a phone it spans the screen; wider it stands 560 px wide.
-
StudioSheetAction<
T> - One key of an action sheet.
-
StudioSheetPage<
T> -
The router's page for a route raised as a sheet: its screen (a
StudioScreen, whose bar then carries the close key) in a StudioSheet drawn out from the bottom edge as showStudioBottomSheet draws one (on ui_core's DesignBottomSheetRoute: a drag takes it down, focus moves in and back), 90% of the screen tall, or as tall as its content when drawer; with fullScreen it rises as a whole page of metal instead (a page route). Its screen reads RoutePresentation.sheet. A go_router route'spageBuilderreturns it with the route'sstate.pageKey. - StudioShellAction
- The app's one act beside its places (record, write, add): the graphite floating key over a root page's bottom end, lit when accent, an aluminium one when not.
- The desktop's side navigation: a panel at the start with the app's name (header) and its places as a column of keys set in a recess, the rack's key column. The chosen place's key is latched in, its legend and lamp lit (by day its cap backlit), as the phone's key bank and the tablet's rail are. A key does not light under the pointer.
- StudioSkeleton
- Where content will be: dark unlit glass in its shape, its light slowly rising and falling while it waits. With motion reduced it stays still.
- StudioSlice
- A share of a StudioPieChart.
- StudioSpacing
- Studio's spacing, on a 4 px grid (DesignSpacingScope declares it).
- StudioSparkline
- A small trace with no frame, for a figure's trend beside it (in a row, a readout). The last point is a lit dot.
- StudioSpinner
- Waiting: a ring of small lamps with the light chasing round it, a fading trail behind. With motion reduced, the ring holds one lamp lit.
- StudioSplitKey
- A split key: a key for the usual action and, butted against it, a narrow key with a chevron that opens the others in a glass list. The narrow key stays down while its list is open; Down on the main key opens it too. lit makes both halves the graphite main key.
- StudioSplitView
- Two panes and a groove between them with a small brushed grip: drag the grip to share the room out; with the keyboard, the arrows move it.
- StudioSpringCurve
- A critically damped spring of stiffness (unit mass) as a curve over a route's duration: the curve reaches 1 where the spring has all but settled. A route's arrival moves as the object would.
- StudioStatusView
- A pane of glass with nothing to show, or that failed: the state's glyph lit in a round readout window, a title, a line on why, and the way on as a key. StudioStatusView.error lights a red lamp beside the title; StudioStatusView.loading shows a spinner and no key.
- StudioStepper
- A count you step: its figures in a readout window between a key that takes one away and a key that adds one, the keys as tall as the window (the control's height, or taller as the figures grow). The arrow keys step it while it has the keyboard; a screen reader reads and steps it as a value. A key at a bound goes dark.
- StudioStepProgress
- Steps along an engraved line, each a lamp with its name printed under it: the steps done lit, the current one lit with a ring round it and its name heavier, the ones to come dark. Read to a screen reader as "Step 2 of 3, Details".
- StudioSurface
- Paints face round child: the cast shadow or the recess, the face lit from the top (sunk by its StudioFace.travel), its glow, its lit rim and its focus light round its edge.
- StudioSwipeAction
- An action a StudioSwipeRow shows.
- StudioSwipeRow
- A row that slides aside to show keys behind it: drag it toward its start or end and startActions or endActions stand in the metal it leaves; dragged far enough, the first action's lamp lights and letting go does it. With the keyboard or a screen reader the actions are the row's own.
- StudioSwitch
- A switch: a metal cap in a dark slot, thrown from one end to the other. On, the slot behind the cap lights in the indicator light. The cap can be dragged; let go, it snaps to the nearer end (or the way it was flung).
- StudioTab
- One of an app shell's places as an app declares it: its glyph, its name and the key on its bank key.
- StudioTabBar
- Tabs: legends engraved along a groove, the chosen one lit with a bar of light under it that slides to the next choice on a spring. Arrows move among them.
- StudioTable
- Rows of words on a glass panel: the columns' names printed small along the top, the rows parted by fine lines, figures to the end. It only shows; StudioDataTable sorts and chooses.
- StudioTableColumn
- A column of a StudioTable.
-
StudioTableController<
R> - Holds a StudioDataTable's rows, sort, selection and page.
- StudioTag
- A small legend window: a few words on readout glass (pale and lit from behind by day, dark by night: a state, a kind), its lamp lit for StudioTagTone.lit or red for StudioTagTone.danger. It is not a key.
-
StudioTagInput<
T extends Object> - Values as small engraved plates in one glass window, with an entry after them that suggests from options (and, given onCreate, makes a new value of its words on Enter or a comma). Each plate's cross removes it; Backspace in the empty entry takes the last. Enter keeps the keyboard in the entry for the next. Given search in place of options, it asks for suggestions as the typing rests (debounceDuration), the list saying while it looks and offering Try again when the search fails.
- StudioTextField
- A text field: a recessed window of glass in the metal, its words on the glass. Focused, the window's rim lights and the caret glows; with an error, the rim lights red and the error stands under it beside a lamp.
- StudioTextTheme
- Studio's type, in its colours. At most four on a screen: a title, body, secondary and one label.
- StudioTheme
-
Studio for child: the theme, the grid its spacing stands on, the tap
floors its controls stand at, and the Material theme under its parts.
Install it once, in an app's
builder:. - StudioThemeData
- Studio's theme: its colours, its type, its density, how strongly its metal shows its brush, and each part's style.
- StudioTime
- A time of day, on a 24-hour clock.
- StudioTimeline
- Events down an engraved line, each a lamp with its title and time beside it: the ones that have happened lit, the line lit down to the last of them.
- StudioTimelineEntry
- One event on a StudioTimeline.
- StudioTimePicker
- A time: two thumbwheels, the hours and the minutes, in one dark housing with a lit colon between them, on a 24-hour clock. minuteInterval steps the minutes.
- StudioToaster
-
Hosts toasts over child: each a strip of readout glass (pale and lit
from behind by day, dark by night) with its lamp lit, its message in the
readout's words, its action a lit legend, rising from the foot of the
screen. Put it above the app's navigator (
WidgetsApp.builder) and show one with showStudioToast. -
StudioToggleBank<
T> - Latching keys in a recessed bank: a key pressed stays down with its own lamp lit until it is pressed again. Several may be in at once unless multiSelectionEnabled is false; then the bank is one choice, read as a radio group. Given iconOf, each key shows its glyph and labelOf names it to a screen reader.
- StudioTooltip
- A thing's name in a small dark readout over it, shown after the pointer rests on it for half a second, at once while it has the keyboard, or after a long press of a finger. The pointer may move onto the readout and it stays; Escape hides it; one shows at a time, and along a row of keys the next shows at once. A screen reader hears message as the thing's tooltip.
- StudioTransportKey
- A transport key: a large round key for play, pause and record. lit turns it to the graphite main key with its glyph and lamp lit (playing); record gives it a red lamp, lit while lit (recording). A press sinks it.
-
StudioTree<
T extends Object> - A tree: rows that open to show the rows under them, each level set in by an engraved line; a small wedge opens and closes a row. The chosen row sits in a slot with its lamp lit.
-
StudioTreeController<
T extends Object> - Holds a StudioTree's nodes, which are open and which are chosen.
- StudioTypeface
- The face Studio sets its words in: Barlow unless an app gives its own.
-
StudioWheelPicker<
T> - A thumbwheel: a drum of items turning behind a dark readout window, the one in the window lit in the indicator. Drag or flick it; it settles on a row. The arrows step it while it has the keyboard; a screen reader steps it as a value.
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.
- StudioDepth
- Where a surface stands under the light: set into the metal, flush with it, or standing proud of it.
- StudioPresentation
- How a page stands in a StudioPreview.
- StudioTagTone
- How a StudioTag reads.
Extensions
- DesignSpringDrive on AnimationController
- Runs an AnimationController on a spring instead of a duration.
- StudioBacklight on StudioFace
- A key latched in, in StudioColors' light.
- StudioFaces on StudioColors
- The faces of Studio's three materials in StudioColors: what the parts start from.
- StudioStyleFace on DesignStyleOf
-
A part's two style layers (DesignStyleOf) put on a StudioFace: the
style's
fill(both tones), itsforeground, and itsedgefor a lit rim. The light, the depths and the corners are the look's. - StudioThemeContext on BuildContext
- Reads Studio's theme from 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):
- studioCapHeightFactor → const double
-
Barlow's capitals as a fraction of its size (its OS/2 cap height, 700,
over its 1000 units per em): what
DesignCapCentercentres a label by. - studioFontFamily → const String
- Studio's one typeface: Barlow, the plain grotesque of instrument legends, in four weights (400 to 700), with tabular figures for readouts.
- studioFontPackage → const String?
-
The package that bundles Studio's face, or null when the app does. Every
Studio text style passes it as
TextStyle.package. -
studioPageTransitions
→ const Map<
TargetPlatform, PageTransitionsBuilder> -
Studio's page change on every platform, with iOS's swipe back from the
screen's leading edge round it there (ui_core's
DesignSwipeBackPageTransitionsBuilder): the builders for a
PageTransitionsTheme, Flutter's material library's or the one Studio is built on.
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. -
paintStudioFace(
Canvas canvas, Rect rect, StudioFace face, StudioLight light, {double ratio = 1}) → void -
Paints
faceinlightoverrectoncanvas: what every Studio surface is. -
paintStudioFocusLight(
Canvas canvas, RRect outline, Color focus, StudioLight light, {bool inside = false}) → void -
Paints Studio's keyboard focus round
outlineoncanvas: the edge lit infocus, StudioMetrics.focusWidth of it hugging the outline with no gap, and a soft glow of the indicator's amber beyond it, as lit studio gear shows it. Nothing lights inside the outline, so the face and its words are untouched. A keyinsidea bank stands in its socket with no room round it: its edge lights just inside its own outline, the glow inward, so nothing spills on its neighbours.focus's alpha fades the whole light. -
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. -
showStudioActionSheet<
T> ({required BuildContext context, required String title, required List< StudioSheetAction< actions, String? message, String cancelLabel = 'Cancel'}) → Future<T> >T?> -
Asks which of a few actions to take: a sheet up from the bottom with
title(andmessage), theactionsas a column of full-width keys, and a cancel key apart under them. Gives the chosen action's value, or null. -
showStudioBottomSheet<
T> ({required BuildContext context, required WidgetBuilder builder, String? title, bool barrierDismissible = true, StudioStyle? style}) → Future< T?> -
Raises
builder's content in a StudioSheet from the bottom edge on ui_core's DesignBottomSheetRoute: a drawer of metal sliding out on its runners, the room's lights lowering; under Reduce Motion it fades. A drag takes it down with the finger; let go past half way, or flung, it closes. Tapping the scrim (whenbarrierDismissible), Escape or Back close it; its finger slot and its close key are a screen reader's ways out. Focus moves in and back. It rises clear of the keyboard. -
showStudioCommandPalette(
BuildContext context, {required List< StudioCommand> commands, String hint = 'Type a command or search', StudioStyle? style}) → Future<void> -
Shows a StudioCommandPalette of
commandsover the page, under a dimmed barrier, and runs the command taken. -
showStudioDialog<
T> ({required BuildContext context, required WidgetBuilder builder, bool? barrierDismissible, bool isAlert = false}) → Future< T?> -
Raises
builder's dialog (a StudioDialog) over the page on ui_core's DesignDialogRoute: the room's lights lower and the module rises toward the light, from 96% of its size to its own, on a spring (StudioMotion.overlayStiffness); under Reduce Motion it fades. Focus moves into it and stays there, and goes back to what held it as it closes. Escape and Back close it; tapping the scrim does whenbarrierDismissible(null: unlessisAlert). A screen reader hears a dialog, or an alert withisAlert. It stands clear of the keyboard. -
showStudioSideSheet<
T> ({required BuildContext context, required String title, required WidgetBuilder builder, double width = 380, bool fromStart = false, StudioStyle? style}) → Future< T?> -
Slides a panel in from the end (or the start, with
fromStart) over a dimmed page: itstitleengraved at its top beside a close key, whatbuildermakes under it. A press on the dimmed page, Escape or a drag back closes it. -
showStudioToast(
BuildContext context, String message, {String? title, String? actionLabel, VoidCallback? onAction, Duration? duration = const Duration(seconds: 4)}) → DesignToastHandle -
Shows a toast saying
messagefrom the nearest StudioToaster: what just happened, with an optionalactionLabelandonAction(Undo). -
studioContrast(
Color a, Color b) → double -
The contrast between
aandb, as WCAG measures it (1 to 21). -
studioLoadFonts(
) → Future< void> -
Loads the face Studio bundles, so the first frame is set in it. Await it
before
runApp: on the web a bundled face otherwise arrives after the first frames, which flash in a fallback face. -
studioRegisteredFamily(
String family) → String -
familyunder the name Flutter registers it by:Barlowwhen the app bundles it,packages/studio_ui/Barlowfrom the package. A test that loads the face itself loads it under this name.
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 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. - 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.
- StudioDensity = DesignDensity
- How tight Studio's controls stand: DesignDensity.standard (a 44 px key), DesignDensity.comfortable (40) or DesignDensity.compact (36). A control's tap target stays at the floor for the input whatever the density.
- StudioStyle = DesignStyle
-
How one part of Studio looks, as Material's
ButtonStyleis: every slot aWidgetStateProperty, read from a part'sstyle:first, then from its component theme on StudioThemeData, then from the look's own default.