seed_ui library
A themeable widget library for Flutter.
Wrap your app in a ConfigProvider to set the theme, and install
UiKit.navigatorKey so the context-free message and notification
APIs can reach an overlay:
ConfigProvider(
theme: ThemeData(token: SeedToken(colorPrimary: Colors.indigo)),
child: MaterialApp(
navigatorKey: UiKit.navigatorKey,
home: const HomePage(),
),
)
Classes
- Alert
- An inline banner conveying a status message, shown in the page flow rather than floating over it.
- AlertDefaults
-
Defaults for every Alert under a
ConfigProvider. - AlertToken
- Per-component design tokens for Alert.
- AutoComplete
- A text field that offers to finish what is being typed: a city, an e-mail domain, a name from a long list.
- AutoCompleteOption
- One suggestion of an AutoComplete.
- AutoCompleteToken
- Per-component design tokens for AutoComplete.
- Avatar
- A component for representing users or objects.
- AvatarDefaults
-
Defaults for every Avatar under a
ConfigProvider. - AvatarGroup
- A group of Avatar components that can overlap.
- AvatarToken
- Token overrides for Avatar.
- BackTop
- A float button that takes a page back to its top, shown once the page has been scrolled far enough to need it.
- Badge
- A count or dot pinned to the corner of what it describes.
- BadgeDefaults
- Per-component design tokens for Badge.
- BadgeToken
-
Every field is an override; a null one falls back to the value derived from
the global theme. Supply one globally through
ThemeData(components: ComponentsConfig(badge: BadgeToken(...))), or per instance via Badge.token. -
Breadcrumb<
T> -
Where the reader is, as the path that led there:
Home / Projects / Seed. -
BreadcrumbItem<
T> - One step of a Breadcrumb's path.
- BreadcrumbToken
- Per-component design tokens for Breadcrumb.
- Button
- A pressable button with hover, press, loading and disabled states.
- ButtonColor
- The colour family a Button draws from. The colour a Button draws from: one of the kit's presets, or any colour you name.
- ButtonCustomColor
- A ButtonColor naming a colour outright, rather than a theme preset.
- ButtonDefaults
-
Defaults for every Button under a
ConfigProvider. - ButtonToken
- Per-component design tokens for Button.
- Card
- A content container.
- CardDefaults
-
Defaults for every Card under a
ConfigProvider. - CardMeta
- Presentational metadata for a Card.
- CardTab
- A tab in a Card's Card.tabList — a key and a bar label.
- CardToken
- Per-component design tokens for Card — its own token table.
- CheckableTag
- A toggleable Tag, selected or not. Useful as a filter chip.
-
CheckableTagGroup<
T> - A set of CheckableTags selecting one or several values.
- CheckableTagGroupDefaults
-
Defaults for every CheckableTagGroup under a
ConfigProvider. -
CheckableTagOption<
T> - One option in a CheckableTagGroup.
- Checkbox
- A checkbox for an independent boolean choice, usually confirmed later by a form submit.
- CheckboxDefaults
- Per-component design tokens for Checkbox.
-
CheckboxGroup<
T> - A set of checkboxes selecting several values from a list.
- CheckboxGroupDefaults
-
Defaults for every CheckboxGroup under a
ConfigProvider. -
CheckboxOption<
T> - One option in a CheckboxGroup.
- CheckboxToken
-
Every field is an override; a null one falls back to the value derived from
the global theme. Supply one globally through
ThemeData(components: ComponentsConfig(checkbox: CheckboxToken(...))), or per instance via Checkbox.token. - CheckPainter
- A tick (or a dash, when indeterminate) sized to the paint box. Used by the checkbox and progress. Give the CustomPaint the size you want.
- ChevronPainter
- A chevron ("›"), sized to the paint box and pointing right. Rotate it to repoint (the Collapse expand icon turns it a quarter-turn when open).
- Collapse
- A set of collapsible panels.
- CollapseDefaults
-
Defaults for every Collapse under a
ConfigProvider. - CollapseItem
- One panel in a Collapse — a label header and its content body.
- CollapseToken
- Per-component design tokens for Collapse — the Collapse token table.
- ColorGroup
- The full set of shades a single semantic color expands into.
- ColorPicker
- A colour, chosen from a square of shades, a strip of hues and a strip of opacity, typed in, or taken from ready ones.
- ColorPickerDefaults
-
Defaults for every ColorPicker and ColorPickerPanel under a
ConfigProvider. - ColorPickerPanel
- The panel of a ColorPicker, standing on its own: in a page, a drawer, a card.
- ColorPickerToken
- Per-component design tokens for ColorPicker and ColorPickerPanel.
- ColorPreset
- A titled run of ready colours offered under a ColorPicker's panel: the brand's, the last few used.
- Compact
- Joins a run of controls into one: square where they meet, rounded only at the ends, and a single line between neighbours rather than two.
- CompactSlot
- What a control reads to find out that it has been joined to its neighbours, and on which sides.
- ComponentDefaults
-
Default props for components under a
ConfigProvider. - ComponentsConfig
- Strongly-typed container for all component-specific token overrides.
- ConfigProvider
- Supplies a ThemeData to the widgets below it.
- ControlSize
- Sealed hierarchy representing component sizes in seed_ui.
- CountArgs
- Arguments passed to CountConfig.formatter when rendering a custom character counter.
- CountConfig
- Character-count behaviour for a Input. Unlike Input.maxLength (a hard cap enforced while typing), max is a soft limit: exceeding it marks the field with a warning but does not truncate — unless exceedFormatter is given.
- Countdown
- A running count of the time to a moment, or since one.
- CountdownController
- A handle on a running Countdown, for driving it from outside the build.
- CountdownDefaults
-
Defaults for every Countdown under a
ConfigProvider. - CountdownToken
- Per-component design tokens for Countdown.
- CreateTabData
-
Seed values for a tab added through the
+button, returned from Tabs.onCreateTab. Any null field falls back to the automatic default — an autoincremented key and aTab Nlabel. - CrossPainter
- The close cross ("×"), sized to the paint box. Shared by the dismiss buttons of notification, modal, drawer and alert.
- DashedBorderPainter
- Draws a dashed rounded-rect border, which BoxDecoration cannot. Used by the dashed button variant.
- DateCell
- What a day on the panel knows about itself.
- DateFields
- Which fields a date format asks for, and so what a picker collects.
- DatePicker
- A field that collects a calendar date.
- DatePickerDefaults
-
Defaults for every DatePicker under a
ConfigProvider. - DatePickerToken
- Per-component design tokens for DatePicker.
- DatePreset
- A named date on the rail beside the panel — "Today", "This time last year", whatever the form is about.
- DateRange
- Two dates and everything between them.
- DateRangePicker
- A field that collects a stretch of days.
- DateRangePickerDefaults
-
Defaults for every DateRangePicker under a
ConfigProvider. - DateRangePreset
- A named stretch of time on the rail beside the panel.
- DateTag
- One day the field is holding, as its tag knows it.
- DisabledTime
- Which times a TimePicker refuses to offer.
- Divider
- A line that separates content: blocks of a page, or words and buttons in a row.
- DividerDefaults
-
Defaults for every Divider under a
ConfigProvider. - DividerToken
- Per-component design tokens for Divider.
- DrawerApi
- Sliding side panels, reached through the Drawer getter.
- DrawerConfig
- Everything a single drawer can be configured with.
- DrawerToken
- Per-component design tokens for Drawer.
-
Dropdown<
T> - A menu that floats from a trigger.
- DropdownController
- Opens and closes a Dropdown from outside it.
- DropdownDefaults
-
Defaults for every Dropdown under a
ConfigProvider. -
DropdownDivider<
T> - A horizontal divider between Dropdown entries.
-
DropdownEntry<
T> - Base type for the entries of a Dropdown menu: an item, a divider or a titled group.
-
DropdownGroup<
T> - A titled group of Dropdown entries.
-
DropdownItem<
T> - A selectable row in a Dropdown menu.
-
DropdownMenuList<
T> - Renders a list of DropdownEntrys as menu rows. Used inside a DropdownPanel.
- DropdownPanel
- The elevated surface a dropdown menu — or any floating panel such as a Select's options — is painted on: background, radius, shadow and clipping.
- DropdownToken
- Per-component design tokens for Dropdown.
- Empty
- An empty-state placeholder. Shows an illustration, a description and optional actions when there is nothing to display.
- EmptyDefaults
-
Defaults for every Empty under a
ConfigProvider. - EmptyToken
- Per-component design tokens for Empty.
- ExplicitBox
- A ControlSize naming a width and height.
- ExplicitHeight
- A ControlSize naming a height, leaving the width to the component.
- ExplicitWidth
- A ControlSize naming a width and leaving the height to the presets.
- FloatButton
- A button that floats above the page — the round action button that sits in a corner, alone or at the head of a FloatButtonGroup.
- FloatButtonController
- Opens and closes a FloatButtonGroup from outside the build.
- FloatButtonCustom
- Positions supplied by the caller — FloatButtonLayout.custom.
- FloatButtonDefaults
-
Defaults for every FloatButton and FloatButtonGroup under a
ConfigProvider. - FloatButtonFan
- An arc of items swept around the trigger — FloatButtonLayout.fan.
- FloatButtonGrid
- A rectangular block of items — FloatButtonLayout.grid.
-
FloatButtonGroup<
T> - A FloatButton that opens into several.
-
FloatButtonItem<
T> - One action inside a FloatButtonGroup.
- FloatButtonLayout
- How a FloatButtonGroup spreads its items when it opens.
- FloatButtonLine
- A straight run of items — FloatButtonLayout.vertical or FloatButtonLayout.horizontal.
- FloatButtonToken
- Per-component design tokens for FloatButton and FloatButtonGroup.
- Form
- A form: a set of named fields, the values they hold, and the rules they answer to.
- FormController
- The values a form holds, and everything that can be done to them.
- FormDefaults
- Per-component design tokens for Form.
-
FormFieldHandle<
T> - What a field is doing and what may be done to it.
-
FormItem<
T> - One field of a Form: a label, a control, and whatever the rules have to say about it.
- FormList
- A field that repeats: a list of rows the reader adds to and takes from.
- FormListEntry
- One row of a repeating field.
- FormListHandle
- What a repeating field is holding and what may be done to it.
- FormRule
- One thing a value has to satisfy.
- FormToken
- Every field is an override; a null one falls back to the value derived from the global theme.
- HolderPainter
- A drag-handle grip — two columns of three dots, sized to the paint box. Marks a draggable row.
- Input
- A single- or multi-line text field with the kit's styling: a bordered box that brightens to the primary colour on focus, with optional affixes and a clear button.
- InputDefaults
-
Defaults for every Input under a
ConfigProvider. - InputNumber
- A numeric input with stepper buttons.
- InputNumberDefaults
-
Defaults for every InputNumber under a
ConfigProvider. - InputNumberToken
- Per-component design tokens for InputNumber.
- InputOtp
- A code typed one character to a cell: the six digits a text message or an authenticator app hands over.
- InputOtpToken
- Per-component design tokens for InputOtp.
- InputToken
- Per-component design tokens for Input.
-
Listy<
T, G extends Object, R extends Object> - A long list that groups its rows into sections with sticky headers — the long list.
- ListyController
- Drives a Listy's scroll position from outside the widget.
- ListyDefaults
- Per-component design tokens for Listy — its own token table.
- ListyHeader
- A header above a Listy's rows that can answer to the pull.
- ListyLoadMore
- Loads more rows as the list nears its end — the "infinite list" pattern, declared rather than wired up by hand.
- ListyPull
- How far the list has been pulled past its top, handed to ListyHeader.builder so a header can react to the drag.
- ListyScrollTo
- A scroll target for ListyController.scrollTo.
- ListyStyles
-
Overrides for the surfaces Listy draws around your content — the
semantic slots (
root,item,groupHeader), as Flutter decorations. - ListyToken
-
Every field is an override; a null one falls back to the value derived from
the global theme. Supply one globally through
ThemeData(components: ComponentsConfig(listy: ListyToken(...))), or per instance via Listy.token. -
Menu<
T> - A list of places to go: a sidebar, a top bar, the sections of a settings page.
- MenuDefaults
-
Defaults for every Menu under a
ConfigProvider. -
MenuDivider<
T> - A thin line between entries of a Menu.
-
MenuEntry<
T> - Base type for the entries of a Menu: an item, a group or a divider.
-
MenuGroup<
T> - A titled run of entries inside a Menu.
-
MenuItem<
T> - A place in a Menu, or, with children, the title of a submenu.
- MenuToken
- Per-component design tokens for Menu.
- MessageApi
- Brief, centred status toasts, reached through the message getter.
- MessageConfig
- Everything a single message can be configured with.
- MessageToken
- Per-component design tokens for MessageConfig.
- ModalApi
- Blocking dialogs, reached through the Modal getter.
- ModalConfig
- Everything a single modal can be configured with.
- ModalToken
- Per-component design tokens for ModalConfig.
- MultiDatePicker
- A field that collects any number of days.
- MultiDatePickerDefaults
-
Defaults for every MultiDatePicker under a
ConfigProvider. - MultiRangeSlider
- A slider whose handles may be put in and taken out.
- MultiRangeSliderDefaults
-
Defaults for every MultiRangeSlider under a
ConfigProvider. - NotificationApi
- Corner-anchored cards carrying a headline, detail text and optional actions, reached through the notification getter.
- NotificationConfig
- Everything a single notification can be configured with.
- NotificationToken
- Per-component design tokens for NotificationConfig.
- Pagination
- A pager for splitting a long list across pages.
- PaginationDefaults
-
Defaults for every Pagination under a
ConfigProvider. - PaginationSimple
-
Turns on Pagination's compact "simple" mode.
Pass a
PaginationSimple()to enable it, with readOnly to show the page as text instead of an editable input. - PaginationToken
- Per-component design tokens for Pagination.
- PasswordConfig
- Password behaviour for a Input: masks the text and, by default, offers a reveal toggle.
- PercentPosition
- Placement and alignment configuration of percentage info in Progress.
- Popconfirm
- A lightweight confirmation bubble anchored to its trigger.
- PopconfirmDefaults
-
Defaults for every Popconfirm under a
ConfigProvider. - PopconfirmToken
- Per-component design tokens for Popconfirm.
- Popover
- A floating card with a title and a body.
- PopoverController
- Controls one anchored popover: an overlay layer positioned near a target.
- PopoverDefaults
-
Defaults for every Popover under a
ConfigProvider. - PopoverLayer
- A widget that shows an anchored content popover around its child.
- PopoverToken
- Per-component design tokens for Popover.
- Progress
-
A progress indicator for a task whose completion is known, as a bar or a
ring — matching
Progress. - ProgressBorderRadius
- Corner radius configuration for line Progress bars.
- ProgressDefaults
-
Defaults for every Progress under a
ConfigProvider. - ProgressRange
- A percentage range for Progress.rangeColors.
- ProgressSteps
- Detailed step configuration for Progress.steps.
- ProgressToken
- Per-component design tokens for Progress.
-
Radio<
T> - A radio button for one choice among a group. Usually driven by a RadioGroup; use it directly only for a standalone two-state control.
- RadioDefaults
- Height preset for button-style options. Per-component design tokens for Radio.
-
RadioGroup<
T> - A set of radio buttons selecting one value from a list.
- RadioGroupDefaults
-
Defaults for every RadioGroup under a
ConfigProvider. -
RadioOption<
T> - One option in a RadioGroup.
- RadioToken
-
Every field is an override; a null one falls back to the value derived from
the global theme. Supply one globally through
ThemeData(components: ComponentsConfig(radio: RadioToken(...))), or per instance via Radio.token. - RailInsets
- The gaps a rail keeps at its ends — one per side, per axis.
- RailPainter
- Paints the rail behind a row of markers.
- RailSegment
- One run of a rail: the line that joins the markers of a Timeline or a Steps.
- RangeSlider
- A groove with two handles, for choosing a span.
- Rate
- A rating in stars: how a reader marks a film, a meal, an answer.
- RateDefaults
-
Defaults for every Rate under a
ConfigProvider. - RateToken
- Per-component design tokens for Rate.
- Result
- A full-width status page for the outcome of an operation — a completed purchase, a 404, a permission error.
- ResultToken
- Per-component design tokens for Result.
- Ribbon
- A label banded across the top corner of what it describes.
- RibbonDefaults
-
Defaults for every Ribbon under a
ConfigProvider. - RibbonToken
- Per-component design tokens for Ribbon.
- SearchConfig
- Search-box behaviour for a Input: a trailing button (or icon) that reports the value through onSearch.
- SearchIcon
- A fixed-size search magnifier, ready to drop into a row.
- SeedLocalizations
- The words the kit says on its own account.
- SeedToken
- The minimal set of inputs an entire theme is derived from.
-
Segmented<
T> - A single-select control laid out as a strip of segments, with a thumb that slides to the chosen one — for switching between a few mutually exclusive options in place.
- SegmentedController
- Drives an overflowing Segmented from outside the build.
- SegmentedDefaults
-
Defaults for every Segmented under a
ConfigProvider. -
SegmentedOption<
T> - One option in a Segmented.
- SegmentedToken
- Per-component design tokens for Segmented.
-
Select<
T> - A dropdown for choosing one or more values from a list.
- SelectDefaults
-
Defaults for every Select under a
ConfigProvider. -
SelectOption<
T> - One choice in a Select.
-
SelectSearch<
T> -
Search behaviour for a Select — the
showSearchobject form. Passing one to Select.search enables filtering by typing. - SelectToken
- Per-component design tokens for Select.
- Skeleton
- A stand-in for content that is still loading: grey blocks where an avatar, a title and a paragraph will be, with a light sweeping across them.
- SkeletonAvatar
- A round or square block where an avatar will be.
- SkeletonButton
- A block where a button will be.
- SkeletonDefaults
-
Defaults for every Skeleton and skeleton block under a
ConfigProvider. - SkeletonImage
- A square block where a picture will be.
- SkeletonInput
- A block where a text field will be.
- SkeletonNode
- A block of the size of child, drawn over it: for a placeholder shaped like nothing above — a chart, a map — or with an icon of your own on it.
- SkeletonParagraph
- The lines of a Skeleton's paragraph.
- SkeletonTitle
- The title bar of a Skeleton.
- SkeletonToken
- Per-component design tokens for Skeleton and its blocks.
- Slider
- A groove with one handle, for choosing a number on a scale.
- SliderController
- A groove with a handle, for choosing a number by dragging.
- SliderDefaults
-
Defaults for every Slider under a
ConfigProvider. - SliderMark
- A labelled point on a Slider's scale.
- SliderToken
- Per-component design tokens for Slider and RangeSlider.
- SliderZone
- A stretch of a slider's scale, coloured.
- SortableList
- A list whose items can be dragged to reorder, with the others sliding smoothly out of the way in both directions.
- SortableListDefaults
-
Defaults for every SortableList under a
ConfigProvider. - SortableListToken
- Per-component design tokens for SortableList — the lift shadow, corner rounding and colours a dragged row takes on.
- Spin
-
A spinning loading indicator matching
Spin. - SpinDefaults
-
Defaults for every Spin under a
ConfigProvider. - Spinner
- An indeterminate circular progress indicator.
- SpinToken
- Design tokens for Spin.
- StatusIcon
- Status glyph drawn as a filled circle, or a spinner for StatusType.loading. Shared by message, notification, alert, modal, result and progress.
- StepItem
- One step.
- Steps
- A progress indicator for a task with stages.
- StepsController
- Drives a Steps from outside the widget — the wizard's "next" and "back".
- StepsDefaults
-
Defaults for every Steps under a
ConfigProvider. - StepsToken
- Per-component design tokens for Steps — its own token table.
- Switch
- A toggle for an immediate on/off setting — flipping it should take effect at once, with no separate save step.
- SwitchDefaults
- Per-component design tokens for Switch.
- SwitchToken
-
Every field is an override; a null one falls back to the value derived from
the global theme. Supply one globally through
ThemeData(components: ComponentsConfig(switchToken: SwitchToken(...))), or per instance via Switch.token. - TabBarExtra
- Extra content pinned to the ends of a Tabs bar. Use TabBarExtra.right for the common single-side case, or supply both left and right.
- TabItem
- One tab: a label in the bar and its content panel.
-
Table<
T> - Rows and columns, with a heading.
- TableCellSpan
- How many places a cell takes up.
-
TableColumn<
T> - One column of a Table.
- TableColumnDefaults
- What every column of a Table falls back to.
- TableDefaults
-
Defaults for every Table under a
ConfigProvider. -
TableExpandable<
T> - Opening a row to show more under it.
- TableFilter
- One choice in a column's filter menu.
- TableFilterControls
- What a filter panel of your own is handed.
- TableFilterPanel
- A filter panel of your own, in place of the menu of TableColumn.filters.
- TablePagination
- Showing a table's rows a page at a time.
- TableScroll
- How much room a Table gives itself, and which way it scrolls.
-
TableSelection<
T> - Picking rows out of a table.
-
TableSelectionEntry<
T> - One entry in the menu beside a table's select-all box.
- TableSort
- Which column a table is sorted by, and which way.
- TableSticky
- Keeping the heading in view while the page scrolls past the table.
- TableStyle
- How one row or one cell of a Table is dressed, decided by the caller.
- TableToken
- Per-component design tokens for Table.
- Tabs
- A tabbed panel.
- TabsController
- Drives a Tabs programmatically: read or change the active tab, mutate the tab list, and listen for changes. Attach through Tabs.controller.
- TabsDefaults
-
Defaults for every Tabs under a
ConfigProvider. - TabsToken
- Per-component design tokens for Tabs — its own token table.
- Tag
- A small label for categorising or marking content.
- TagColor
- A preset colour for a Tag, mapping to the theme's status palettes. The colour a Tag draws from: one of the kit's presets, or any colour you name.
- TagCustomColor
- A TagColor naming a colour outright, rather than a theme preset.
- TagDefaults
-
Defaults for every Tag under a
ConfigProvider. - TagToken
- Per-component design tokens for Tag.
- ThemeData
- A resolved theme for the kit.
- TimeFields
- Which fields a time format asks for, and so which columns a picker shows.
- Timeline
- A vertical list of events.
- TimelineDefaults
-
Defaults for every Timeline under a
ConfigProvider. - TimelineEntry
- Anything that can sit in Timeline.items: a single TimelineItem, or a TimelineGroupItem standing for a run of them.
- TimelineGroupController
- Opens and closes a TimelineGroupItem from outside the timeline.
- TimelineGroupItem
- A run of nodes on the same axis that collapses down to its first few.
- TimelineItem
- One node on a Timeline — a dot on the axis and its content.
- TimelineToken
- Per-component design tokens for Timeline — its own token table.
- TimePicker
- A field that collects a time of day.
- TimePickerDefaults
-
Defaults for every TimePicker under a
ConfigProvider. - TimePickerToken
- Per-component design tokens for TimePicker.
- Token
- The resolved theme values components actually read.
- Tooltip
- A short text hint that surfaces on hover, tap or long-press.
- TooltipDefaults
-
Defaults for every Tooltip under a
ConfigProvider. - TooltipToken
- Per-component design tokens for Tooltip.
- Tour
- A guided walk through a screen.
- TourButton
- How one of a step's buttons is drawn and what it does.
- TourController
- Drives a Tour from outside the widget.
- TourDefaults
-
Defaults for every Tour under a
ConfigProvider. - TourGap
- The room the highlight leaves around a target, and how round its corners are.
- TourMask
- Whether a tour dims the page behind it, and in what colour.
- TourStep
- One stop on a Tour.
- TourToken
- Per-component design tokens for Tour — its own token table.
- Tree
- A hierarchical list.
- TreeDefaults
-
Defaults for every Tree under a
ConfigProvider. - TreeDropDetails
- A pending or completed drag-and-drop, passed to Tree.onDrop and Tree.allowDrop.
- TreeNode
- One node in a Tree — a title and optional children.
- TreeToken
- Per-component design tokens for Tree — its own token table.
- UiKit
-
Entry point for the kit's context-free APIs such as
messageandnotification. -
Upload<
T> - A file list with a picker trigger, progress per file, and retry and remove actions.
- UploadActions
- The handlers a row or tile would have wired up, handed to Upload.itemBuilder so a replacement can keep them.
- UploadDefaults
-
Defaults for every Upload under a
ConfigProvider. -
UploadItem<
T> - One file in an Upload.
- UploadToken
- Per-component design tokens for Upload.
- UserIcon
- A fixed-size user silhouette, ready to drop into an avatar.
Enums
- AvatarShape
- The shape of an Avatar.
- BadgeStatus
- The state a standalone Badge reports.
- ButtonIconPlacement
- Control height preset for a Button. Which side of a Button's words its icon stands on.
- ButtonPreset
- The presets ButtonColor offers, as an enum you can switch over.
- ButtonShape
- Outline shape of a Button.
- ButtonVariant
- How a Button is filled and bordered.
- CardType
- A Card's nesting role.
- CardVariant
- How a Card draws its edge.
- ClosePlacement
-
Where a close button stands in a
Modalor a notification, and what makes room for it. - CollapseIconPosition
- Which side of a Collapse header the expand icon sits on.
- CollapsibleTrigger
- What toggles a CollapseItem.
- ColorFormat
- How a ColorPicker writes a colour out in its fields.
- CompactPosition
- Where a control stands in a Compact group.
- CountdownType
- Which way a Countdown runs.
- DatePanelMode
- Which panel a DatePicker is showing.
- DatePickerKind
- What a DatePicker collects.
- DatePickerVariant
- How a DatePicker is filled and bordered.
- DividerOrientation
- Which way a Divider runs.
- DividerTitlePlacement
- Where a horizontal Divider's title sits along the line.
- DividerVariant
- How a Divider's line is drawn.
- DrawerPlacement
- Edge a drawer slides in from.
- DropdownTrigger
- How a Dropdown is opened.
- EmptyImage
- Which illustration an Empty draws.
- EmptySlot
- Which component is asking for the "no data" placeholder.
- FloatButtonDirection
- Which way a FloatButtonGroup opens.
- FloatButtonDragStart
- What picks up a draggable FloatButton or FloatButtonGroup.
- FloatButtonLabelPlacement
- Which side of a FloatButton its label hangs on.
- FloatButtonTrigger
- What opens a FloatButtonGroup.
- FormLayout
- Where a field's label stands in relation to what it labels.
- FormRequiredMark
- How a field that must be answered is marked.
- FormTrigger
- When a field's rules are asked.
- GapPlacement
- Placement of the gap in a dashboard ring Progress.
- InputNumberMode
- How an InputNumber presents its controls.
- InputOtpCharacters
- Which characters an InputOtp takes.
- InputStatus
- A validation status that recolours a Input's border.
- ListyScrollAlign
- Where a ListyController.scrollTo target should come to rest.
- MenuMode
- How a Menu lays itself out and where its submenus open.
- MessagePlacement
- Screen edge a message is anchored to.
- NotificationPlacement
- Screen corner a notification is anchored to.
- PercentInfoAlign
- Horizontal alignment of the info label in Progress.
- PercentInfoType
- Type of info label placement in Progress (outside track or inside track).
- PopoverAnimation
- How a floating surface arrives.
- PopoverPlacement
- Where a popover sits relative to its anchor.
- PopoverTrigger
- What opens a Popover.
- ProgressStepFill
- Mode of filling individual step segments in a step-style Progress.
- ProgressType
- Shape of a Progress.
- RadioButtonStyle
- Fill treatment for button-style options.
- RadioOptionType
- How a RadioGroup renders its options.
- RibbonPlacement
- Which end of its container a Ribbon is pinned to.
- SegmentedArrow
- Which end of an overflowing Segmented an arrow steps towards.
- SegmentedDirection
- Layout axis for a Segmented.
- SelectMode
- How a Select behaves: pick one value, several, or freely create new ones.
- SelectStatus
- A validation status that recolours a Select's border.
- SelectVariant
- The box style of a Select, variants.
- SliderMarkSide
- Which side of the rail a mark's label is written on.
- SoftSize
-
The shared height preset for the kit's controls — small, middle (the
default) or large — mapping to the
controlHeighttoken scale. Reused across Button, Input, Select, Radio, Segmented and Pagination. - SpinDirection
-
Which way a
SpinButtonsteps. - SpinPosition
- Position of the spinner indicator relative to its container or overlay mask.
- StatusType
- Semantic status shared by every feedback component.
- StepsOrientation
- Which way the steps run.
- StepsOverflow
- What a horizontal run does when its steps will not fit.
- StepStatus
- Where a step stands.
- StepsType
- How a Steps draws itself.
- StepsVariant
- Whether markers are filled or outlined.
- StepTitlePlacement
- Whether a title sits beside its marker or under it.
- TabContentPosition
- Horizontal placement of a tab's content within its panel.
- TabEditAction
- What an edit gesture on an TabsType.editableCard requested.
- TableAlign
- Which edge a column's content is drawn against.
- TableColumnFixed
- Which edge a column is pinned to, if any.
- TableFilterMode
- How a column's choices are laid out.
- TablePaginationPosition
- Where a table's pager stands, and which edge it is drawn against.
- TableSelectionMode
- Whether rows are picked one at a time or many.
- TableSortOrder
- Which way a column is sorted.
- TabPosition
- Which edge the tab bar sits on.
- TabScrollAlign
- Where the selected tab lands when the bar scrolls it into view.
- TabsType
- The visual style of a Tabs bar.
- TagPreset
- The presets TagColor offers, as an enum you can switch over.
- TagVariant
- How a Tag is filled and bordered.
- TimelineItemPosition
- Which side an item's content takes in TimelineMode.alternate.
- TimelineMode
- Where the axis and content sit relative to each other.
- TimelineOrientation
- Whether the axis runs down the page or across it.
- TimelineVariant
- Variant style for the timeline dots.
- TimePickerVariant
- How a TimePicker is filled and bordered.
- TooltipTrigger
- A small text bubble describing the widget it wraps.
- TourPlacement
- Where a tour panel sits relative to the step's target.
- TourType
- How a tour panel is painted.
- TreeDropPosition
- Where a dragged node lands relative to the drop target.
- UploadStatus
- Where a single file stands.
- UploadVariant
- How the chosen files are laid out.
Extensions
- MaterialThemeFromThemeData on ThemeData
- Hands Material a theme that matches this one.
- MaterialThemeFromToken on Token
- Hands Material a theme that matches the kit's.
- ThemeContext on BuildContext
-
Shorthand for reading theme values:
context.softToken.colorPrimary.
Constants
- stepsRingPadding → const double
- How much wider than its marker a progress ring sits — the room a run reserves when Steps.percent or Steps.progress is in play.
Properties
- Drawer → DrawerApi
-
The global drawer API.
no setter
- message → MessageApi
-
The global message API.
no setter
- Modal → ModalApi
-
The global modal API.
no setter
- notification → NotificationApi
-
The global notification API.
no setter
Functions
-
addMonths(
DateTime date, int months) → DateTime -
datemoved bymonths, clamped to the end of the month it lands in. -
dateOnly(
DateTime date) → DateTime -
The day
datefalls on, with the clock set to midnight. -
daysInMonth(
int year, int month) → int -
How many days
monthofyearhas. February included. -
formatDate(
DateTime date, String format, {List< String> months = _englishMonths, List<String> weekdays = _englishWeekdays, String am = 'AM', String pm = 'PM'}) → String -
Writes
dateout according toformat. -
formatTime(
Duration time, String format, {String am = 'AM', String pm = 'PM'}) → String -
Writes
timeout according toformat. -
generate(
Color color, {bool dark = false, Color? background}) → List< Color> -
Builds the ten shades of
color. -
inkOn(
Color fill) → Color -
The ink to write on a
fill: black or white, whichever reads on it. -
isSameDay(
DateTime a, DateTime b) → bool -
Whether
aandbfall on the same day. -
isSameMonth(
DateTime a, DateTime b) → bool -
Whether
aandbfall in the same month. -
monthGrid(
int year, int month, {int firstDayOfWeek = 1}) → List< DateTime> - The six weeks a month panel shows, as 42 days from Monday-or-whichever.
-
normalizeTime(
Duration time, TimeFields fields) → Duration -
Rounds
timedown to whatfieldscan express, and wraps it into a day. -
parseDate(
String text, String format, {List< String> months = _englishMonths, DateTime? fallback}) → DateTime? -
Reads
textback againstformat, or null when it does not say a date. -
parseHexColor(
String value) → Color - Reads a CSS-style hex string into a Color.
-
parseTime(
String text, String format, {String am = 'AM', String pm = 'PM'}) → Duration? -
Reads
textback againstformat, or null when it does not say a time. -
quarterOf(
DateTime date) → int -
Which quarter of the year
datefalls in, from 1 to 4. -
startOfQuarter(
DateTime date) → DateTime -
The first day of the quarter
datefalls in. -
startOfWeek(
DateTime date, {int firstDayOfWeek = DateTime.monday}) → DateTime -
The first day of the week
datefalls in, counting fromfirstDayOfWeek— which is not Monday everywhere. -
weekdayOrder(
{int firstDayOfWeek = 1}) → List< int> - The seven weekday numbers a panel heads its columns with, in order.
-
weekOfYear(
DateTime date) → int -
Which week of the year
datefalls in, by the ISO reckoning: weeks run Monday to Sunday, and week one is the one holding the first Thursday.
Typedefs
- DateCellBuilder = Widget Function(BuildContext context, DateCell cell, Widget child)
- Draws a day cell.
- DateTagBuilder = Widget Function(BuildContext context, DateTag tag, Widget child)
- Draws one tag in the field.
- DrawerHandle = void Function()
- Dismisses an open drawer ahead of any user interaction.
-
DropdownItemBuilder<
T> = Widget Function(BuildContext context, DropdownItem< T> item, bool hovered) - Draws the inside of one menu row: its icon, its words, whatever else.
- EmptyBuilder = Widget Function(BuildContext context, EmptySlot slot)
-
Builds the "no data" placeholder for
slot. -
FloatButtonItemBuilder<
T> = Widget Function(BuildContext context, FloatButtonItem< T> item, Widget child) -
Wraps one built item, e.g. to put it in a
Tooltipor aBadge. - FloatButtonPlacer = Offset Function(int index, int count)
-
Where item
indexofcountgoes, measured from the trigger's centre. -
FormValidator
= FutureOr<
String?> Function(Object? value) - What a rule found wrong with a value, if anything.
- MessageHandle = void Function()
- Dismisses an open message ahead of its timeout.
- ModalHandle = void Function()
- Dismisses an open modal ahead of any user interaction.
- NotificationHandle = void Function()
- Dismisses an open notification ahead of its timeout.
- SeedRefinement = SeedToken Function(SeedToken inherited)
- Changes the seed a theme is about to be derived from.
- SegmentedArrowBuilder = Widget Function(BuildContext context, SegmentedArrow arrow, VoidCallback step)
- Builds one of the two arrows a scrolling Segmented offers.
- SliderMarkBuilder = Widget Function(BuildContext context, SliderMark mark, bool active, Widget child)
- Draws a mark.
- TokenRefinement = Token Function(Token derived)
- The last word on a derived token set — see ThemeData.refineTokens.