patterns library

Carpenter layout plus page infrastructure and high-level business patterns.

Classes

AngleUnit
A physical angle that can be converted without a rendering context.
Application
The root of a Carpenter application.
CallbackCollectionAdapter<T, F>
Adapts a plain asynchronous loader to the legacy CollectionAdapter interface without adding transport behavior.
CarpenterActionBar
CarpenterActionDescriptor
Immutable application action metadata used by Carpenter surfaces to project consistent label, icon, availability, semantics, shortcut, and invocation.
CarpenterActionPalette
State palette for one semantic action color family.
CarpenterActionStyle
Resolved colors for one action after semantic role, prominence, and widget state have been applied.
CarpenterActionTheme
Resolves semantic action color roles, prominence, and interaction state without requiring components to choose raw colors.
CarpenterAdaptiveContext
CarpenterAdaptiveRegion
CarpenterAdaptiveRegionPolicy
CarpenterAdaptiveSplitLayout
Adaptive two/three-region split with optional persisted split position.
CarpenterAppFrame
Lightweight cross-platform frame retained for apps that do not need ApplicationShell regions.
CarpenterApplicationShell
CarpenterAsyncAutosuggest<T>
Async lifecycle wrapper for CarpenterAutosuggest with debounce and stale-result protection.
CarpenterAttachment<T>
CarpenterAttachmentList<T>
CarpenterAttentionBlock
CarpenterAutosuggest<T>
An editable controlled field offering optional suggestions for free text.
CarpenterAvatar
Compact identity primitive for initials, images or arbitrary avatar content.
CarpenterAvatarGroup
Compact overlapping identity group with an automatic overflow avatar.
CarpenterAvatarItem
Identity data for one entry in a CarpenterAvatarGroup, using an image and/or initials.
CarpenterBadge
Compact supplementary label or count. Use status indicators for business status.
CarpenterBlockGroup
Groups related content blocks with a gap larger than field-to-field spacing.
CarpenterBlockList<T>
CarpenterBreadcrumb
CarpenterBreadcrumbs
Hierarchical navigation path with compact text presentation and adaptive overflow.
CarpenterBreakpointRegionPolicy
CarpenterButton
Semantic text action with optional icon, keyboard/focus handling, and caller-controlled execution feedback.
CarpenterCalendar
Controlled month calendar used by date inputs and page-level scheduling UI.
CarpenterCancellationSignal
Cancellation signal shared by asynchronous Carpenter behaviours.
CarpenterCapabilityScope
CarpenterCard
A semantic surface grouping one related block of content.
CarpenterCheckbox
Controlled selection control with unchecked, checked, and mixed presentation.
CarpenterCollectionGroupHeader
CarpenterCollectionPage<T, K>
CarpenterCollectionPageMessages
CarpenterCollectionSearchField<T, K, F>
Search field bound to a CollectionLifecycleController.
CarpenterColorPicker
Opaque RGB color picker with HSV surface and HEX/RGB inputs.
CarpenterComboBox<T>
An editable controlled field whose query may resolve to one selected option.
CarpenterContentTheme
Semantic foreground palette for non-interactive content.
CarpenterContextActionRegion
Makes one semantic action set available through platform-appropriate alternative gestures.
CarpenterControl
Behaviour-only primitive for custom interactive Carpenter components.
CarpenterControllerHost<C extends ChangeNotifier>
CarpenterControlState
Public snapshot of the shared Carpenter interaction state.
CarpenterDataList<T, K>
A structured, scroll-owning list backed by Carpenter collection contracts.
CarpenterDataListMessages
CarpenterDateInput
Controlled date field with masked manual entry and an adaptive picker action.
CarpenterDateRange
CarpenterDateRangeInput
Controlled inclusive date range field with a mask and adaptive picker action.
CarpenterDefinitionList<T>
Responsive term/value presentation for structured object metadata.
CarpenterDetailRegion
CarpenterDialog
A controlled modal composition container with trapped keyboard focus.
CarpenterDialogCollectionBody
CarpenterDomainWorkflowStage<TState, TContext>
CarpenterDragController
CarpenterDraggable<T>
Typed pointer drag source backed by Flutter's drag recognizers and Carpenter sessions.
CarpenterDragPayload<T>
CarpenterDragScope
Shared drag-and-drop runtime for coordinated sources and targets.
CarpenterDragSession
CarpenterDropCapability<T>
CarpenterDropDetails<T>
CarpenterDropdown
A controlled action-menu trigger.
CarpenterDropTarget<T>
Typed drop target with operation negotiation and before/inside/after geometry.
CarpenterDropTargetState<T>
CarpenterEditableTable<T>
Local-data table for editable business grids.
CarpenterEditorConflict
CarpenterEditorController<TRecord>
CarpenterEditorControllerBase<TRecord>
CarpenterEditorForbidden
CarpenterEditorInitialLoading
CarpenterEditorPage<TRecord>
CarpenterEditorReady
CarpenterEditorSaved
CarpenterEditorSaveFailure
CarpenterEditorSaving
CarpenterEditorState
CarpenterEditorValidating
CarpenterEditorValidationFailure
CarpenterEmptyStateDescriptor
CarpenterEntityHeader
Rich entity header retained from the previous record pattern.
CarpenterEntityLayout
CarpenterExpander
Collapsible content surface retained from the previous workbench API.
CarpenterExplorerHistory<L>
Controlled navigation history for an explorer location.
CarpenterExplorerPage
Explorer pattern with navigation, content and optional inspector regions.
CarpenterFeedbackStyle
Resolved passive feedback colors for one semantic feedback role.
CarpenterFeedbackTheme
Maps FeedbackColorRole values to resolved passive feedback styles.
CarpenterFieldBinding<T>
CarpenterFieldContext
CarpenterFieldDescriptor<TValue>
CarpenterFieldFeedback
Semantic supporting feedback for a Carpenter field.
CarpenterFieldGroup
CarpenterFieldShell
Shared semantic frame for Carpenter field controls.
CarpenterFieldStyle
Resolved field colors after availability, focus, hover, and validation state have been applied.
CarpenterFieldTheme
Semantic field palette and state resolver shared by Carpenter input controls.
CarpenterFileCandidate<T>
CarpenterFileDropData<T>
CarpenterFileDropZone<T>
Standalone file drop surface. Link it to a CarpenterFileInput by giving both widgets the same CarpenterFileIntakeController.
CarpenterFileInput<T>
Input-shaped file selector that is also a typed Carpenter drop target.
CarpenterFileIntakeController<T>
Event bridge used by platform adapters and linked drop zones.
CarpenterFilterBar
CarpenterFilterControl
CarpenterFocusTheme
CarpenterFormField
Presentational form row combining a label, optional help text, a caller-owned editor, and an optional error notice. It does not bind or validate the editor automatically.
CarpenterFormPage
CarpenterFormWorkflowStage<TState, TContext>
CarpenterHeaderActions
CarpenterIcon
CarpenterIconButton
Icon-only semantic action that requires an explicit accessible name.
CarpenterIconData
Base contract for non-Flutter icon sources rendered by Carpenter.
CarpenterIcons
Minimal framework-independent glyph ids retained for adapters and examples. Applications may replace these with their own icon font or icon package.
CarpenterInput
CarpenterInputCapabilities
CarpenterInputMask
CarpenterInspector
Recursive readable presentation for map/list payloads and diagnostic data.
CarpenterInteractionOverlay
CarpenterKanban<C, T>
Controlled multi-column board with cross-column and within-column DnD.
CarpenterKanbanCardState<C>
CarpenterKanbanColumn<C, T>
CarpenterKanbanMoveDetails<C, T>
CarpenterLayoutTab<T>
An inline semantic navigation action.
CarpenterListReport<T, K>
CarpenterListTile
Interactive semantic row used by collection and navigation patterns.
CarpenterListTileDetails
CarpenterLoader
Indeterminate circular activity indicator without Material dependency.
CarpenterMaskedInput
Text input that applies a semantic mask while reusing the standard Carpenter field pipeline.
CarpenterMasterDetail
CarpenterMasterDetailPage<T>
CarpenterMemoryRestorationStore
CarpenterMenu
A keyboard- and pointer-operable list of semantic actions.
CarpenterMenuItem
One action presented by a CarpenterMenu.
CarpenterMotionTheme
CarpenterNavigationPolicy
CarpenterNavigationRegion
CarpenterNotice
CarpenterNotification
CarpenterNotificationList
Persistent notification surface. Items remain until caller state removes them.
CarpenterNumberInput
Controlled numeric field with locale-tolerant decimal parsing.
CarpenterObjectPage
CarpenterOption<T>
Immutable selectable option with stable identity, value, display text, accessibility label, and availability.
CarpenterOverlayTheme
CarpenterPage
Infrastructure host shared by page patterns.
CarpenterPageBlocking
CarpenterPageBody
Standard non-scrollable page document body with Carpenter section spacing.
CarpenterPageCapability
CarpenterPageController
CarpenterPageControllerBase
CarpenterPageDescriptor
CarpenterPageEmpty
CarpenterPageFailure
CarpenterPageForbidden
CarpenterPageHeader
CarpenterPageInitialLoading
CarpenterPageReady
CarpenterPageRefreshing
CarpenterPageRegion
Owns page anatomy and optionally its single vertical scroll viewport.
CarpenterPageRestorationController
CarpenterPageScope
CarpenterPageSection
A semantic page section that participates in the document flow.
CarpenterPageState
CarpenterPageStateBoundary
Standard rendering of infrastructure-level page states.
CarpenterPageStatePresentation
CarpenterPageStatus
CarpenterPageUnavailable
CarpenterPaginationBar
Adaptive page navigation with previous/next controls and a compact page window.
CarpenterPermissionRequirement
CarpenterPlanningBoard<L, C, T>
Multi-lane planning surface built from compatible Kanban drag surfaces. Lane expansion and card collections remain controlled by the caller.
CarpenterPlanningLane<L, C, T>
CarpenterPlanningMoveDetails<L, C, T>
CarpenterPopover
A controlled, interactive container attached to an anchor.
CarpenterPrimaryRegion
CarpenterProgress
Linear progress indicator.
CarpenterRadio<T>
One mutually exclusive choice inside a matching CarpenterRadioGroup.
CarpenterRadioGroup<T>
Controlled group of mutually exclusive radio choices with shared selection and keyboard navigation.
CarpenterRecordDetail
CarpenterRecordDetails
CarpenterRecordMetric
CarpenterRecordPage<T>
Full record composition, migrated onto the current page infrastructure.
CarpenterRecordSection
CarpenterRecordSummary
CarpenterRecordTab<T>
CarpenterRecordTabs<T>
CarpenterRefreshCapability
CarpenterRelatedCollection
CarpenterReorderableCollection<T>
Presentation-neutral controlled reorderable collection built on Carpenter DnD.
CarpenterReorderDetails<T>
CarpenterReorderItemState
CarpenterRequestGate<C extends CarpenterCancellationSignal>
Owns the generic "latest request wins" lifecycle used by async UI data.
CarpenterRequestLease<C extends CarpenterCancellationSignal>
One asynchronous request admitted by a CarpenterRequestGate.
CarpenterResourceCancellation
Resource-specific compatibility type over Carpenter's shared cancellation signal.
CarpenterResourceController<T>
Extensible resource lifecycle base for application-specific controllers.
CarpenterResourceFailure
CarpenterResourceLoadRequest
CarpenterRestorationCapability
CarpenterRestorationKey<T>
CarpenterRestorationPolicy
CarpenterRestorationStore
CarpenterRootLayout
Root application composition: navigation + (header + page content).
CarpenterRootLayoutContext
CarpenterSearchCancellation
Cooperative cancellation signal for one suggestion request. Cancelling notifies listeners once but does not abort HTTP or other transport work automatically.
CarpenterSecondaryRegion
CarpenterSectionLayout
Simple page section layout retained for navigation-driven pages.
CarpenterSelect<T>
A controlled field for selecting exactly one value from typed options.
CarpenterSelectableCollection<T>
CarpenterSelectionBar<T>
CarpenterSelectionButtonGroup<T>
Controlled single-choice group for switching one local content scope.
CarpenterSelectionButtonOption<T>
Descriptor for one choice in a controlled CarpenterSelectionButtonGroup.
CarpenterSelectionController<T>
CarpenterSelectionPalette
Selected-state palette for one SelectionColorRole.
CarpenterSelectionStyle
Resolved colors for a selectable control after role, selection, hover, and disabled state have been applied.
CarpenterSelectionTheme
Resolves selection controls from semantic color role, selected state, and WidgetState values.
CarpenterSelectionWorkflowStage<TState, TContext, TItem>
CarpenterShape
Directional start/end shape descriptor for controls that may join a group.
CarpenterShapeTheme
CarpenterSidebar
One visual navigation component used by desktop rails and overlay drawers.
CarpenterSidebarData
CarpenterSidebarItem
CarpenterSidebarSection
CarpenterSizeTheme
CarpenterSpacingTheme
CarpenterSplitView
CarpenterStandardNavigationPolicy
CarpenterStatusIndicator
CarpenterSurfaceCloseScope
CarpenterSurfaceController
CarpenterSurfaceHost
CarpenterSurfaceScope
CarpenterSurfaceTheme
CarpenterSwitch
Controlled binary setting with a visible label and optional supporting description.
CarpenterTab<T>
CarpenterTable<T, K>
CarpenterTableActionCell
Compact, geometry-stable action projection used by table and tree-table rows.
CarpenterTableActions
CarpenterTableColumn<T>
CarpenterTableColumnWidth
CarpenterTableMessages
CarpenterTableText
Text primitive that resolves typography from table component tokens rather than generic label/body roles.
CarpenterTabs<T>
A controlled semantic tab list. Tab content remains caller-owned.
CarpenterTabsLayout<T>
Tabs layout that switches between horizontal tabs and a vertical navigation rail.
CarpenterTag
Compact semantic tag backed by the current status-indicator primitive.
CarpenterText
CarpenterTextArea
CarpenterTextFieldDescriptor
CarpenterTextFieldsDialog
CarpenterTextPromptDialog
Convenience single-field variant of CarpenterTextFieldsDialog.
CarpenterTheme
Inherited boundary that exposes CarpenterThemeData to descendant Carpenter components.
CarpenterThemeData
Immutable semantic theme assembled from generated Carpenter tokens for one brightness, contrast, and density combination.
CarpenterTime
CarpenterTimeInput
Controlled 24-hour field with masked manual entry and an adaptive picker action.
CarpenterTimeline
CarpenterTimelineItem
CarpenterToast
The semantic visual representation of one toast notification.
CarpenterToastDescriptor
CarpenterToasterController
Imperatively manages transient toast presentation, not application state.
CarpenterToastRegion
Hosts a bounded visible toast stack and queues the controller remainder.
CarpenterToggleButton
Binary action button whose selected state is controlled by the caller.
CarpenterToolbar
Semantic toolbar projection over the shared adaptive action-strip behaviour.
CarpenterToolbarItem
CarpenterTooltip
Short, non-interactive supplemental text for an anchored control.
CarpenterTopPanel
CarpenterTopPanelContext
CarpenterTrailingActions
CarpenterTreeController
Imperative navigation surface for a controlled tree.
CarpenterTreeDropDetails<T>
CarpenterTreeFlatNode<T>
CarpenterTreeNode<T>
CarpenterTreeRowState<T>
CarpenterTreeTable<T>
Tabular projection of CarpenterTreeView. Expansion, selection, activation, filtering, reveal and DnD use exactly the same contracts as the regular tree.
CarpenterTreeTableColumn<T>
CarpenterTreeView<T>
Controlled hierarchical collection with keyboard navigation and DnD.
CarpenterTypographyTheme
Resolves semantic Carpenter typography roles and component text treatments into Flutter TextStyle values using the active unit scale.
CarpenterUploadProgress
Determinate upload progress presentation. The caller owns transfer state and updates value; this widget does not start or monitor an upload.
CarpenterValidationResult
CarpenterValidationSummary
Form-level summary of externally computed field errors. An empty map produces no visible content.
CarpenterViewportPolicy
CarpenterWorkflowController<TState, TContext>
CarpenterWorkflowControllerBase<TState, TContext>
CarpenterWorkflowDelegateController<TState, TContext>
CarpenterWorkflowPage<TState, TContext>
CarpenterWorkflowStage<TState, TContext>
CarpenterWorkflowTransition<TState, TContext>
CollectionAdapter<T, F>
Minimal compatibility adapter for collection sources that only expose load.
CollectionController<T, K, F>
Compatibility facade over Carpenter's canonical collection lifecycle.
CollectionCursorPageInfo
Page metadata navigated by a source-owned opaque cursor; a missing boundary means navigation in that direction is unavailable.
CollectionCursorPageRequest
Requests a page using an opaque, source-owned cursor. Consumers must not interpret the cursor as an offset.
CollectionEvent<T, K>
Typed change to a collection snapshot.
CollectionFailure
Transport-neutral failure information for collection loading or mutation.
CollectionInserted<T, K>
Inserts an item, or replaces the existing item when its stable key is already loaded.
CollectionKeysetPageInfo<K>
Page metadata navigated by a source-owned typed ordering key; a missing boundary means navigation in that direction is unavailable.
CollectionKeysetPageRequest<K>
Requests a page on one side of a stable ordering key.
CollectionLifecycleController<T, K, F>
Full collection lifecycle controller: debounce, cancellation, stale-response protection, refresh and progressive loading.
CollectionLoadRequest
Context of one collection request, including its reason and cooperative cancellation signal.
CollectionMetadata
Marker interface for application-owned metadata accompanying a CollectionSnapshot.
CollectionMutationState<K>
Immutable item-level mutation status keyed independently of the current loaded rows.
CollectionOffsetPageInfo
Offset-page metadata supporting both known and unknown totals.
CollectionOffsetPageRequest
Requests a bounded range using a zero-based offset. Use only when the data source supports offset pagination.
CollectionPageInfo
Pagination metadata supplied by the data source for a snapshot.
CollectionPageRequest
Backend-neutral pagination request carried by CollectionQuery.
CollectionProgressivePageInfo
Metadata for accumulated batches with forward loading but no backward page navigation.
CollectionProgressivePageRequest
Requests another batch after an already accumulated set of items.
CollectionQuery<F>
Immutable input to a collection loader: domain filter, search, ordered sort criteria, and a paging request.
CollectionRefreshRequested<T, K>
Marks a snapshot as refreshing.
CollectionRemoved<T, K>
Removes a stable key from the loaded snapshot without deleting anything from the data source.
CollectionReordered<T, K>
Moves a loaded item within the visible item list. This event does not persist ordering.
CollectionRequestCancellation
Collection-specific compatibility type over Carpenter's shared cancellation signal.
CollectionReset<T, K>
Replaces loaded items and resets failure/freshness state through CollectionEventApplication.applyEvent.
CollectionSelection<K>
Immutable key-based selection with explicit and all-matching representations.
CollectionSnapshot<T>
Immutable collection presentation state shared by tables, lists, and page patterns.
CollectionSort
One immutable sort criterion, identified independently of a rendered column.
CollectionUnpagedInfo
Metadata for a complete unpaged result with no forward or backward navigation.
CollectionUnpagedRequest
Requests a collection without a paging boundary. The loader decides the size of the returned snapshot.
CollectionUpdated<T, K>
Replaces a loaded item with the same stable key. Applying an update for an absent key leaves the snapshot unchanged.
Degrees
An angle expressed in degrees.
Em
A value relative to the effective em of the current element.
GravityIcon
Compatibility wrapper around the generic CarpenterIcon renderer.
GravityIconData
A reference to one SVG from Carpenter's bundled Gravity icon set.
GravityIcons
Bundled Gravity UI icon catalog.
LengthUnit
A physical length that can be resolved in a typography context.
LengthUnitContext
Runtime values required to resolve relative length units.
LoadingBoundary
Owns a loading scope and lets its parent choose the loading presentation.
LoadingController
UI-agnostic handle exposed to descendants through BuildContext.loading.
LoadingCubit
Compatibility name for code written against Carpenter's former Bloc-backed loading implementation.
LoadingNotifier
Framework-neutral loading state owner.
LoadingScope
Dependency-injection boundary for loading state.
LoadingState
Immutable snapshot of the operations currently owned by a loading scope.
Milliseconds
A duration expressed in milliseconds.
PaletteTokens
Px
An absolute logical-pixel value.
Radians
An angle expressed in radians.
Rem
A value relative to the root rem configured for the widget subtree.
Seconds
A duration expressed in seconds.
TimeUnit
A physical time value that can be converted to a Dart Duration.
Turns
An angle expressed in complete turns.
Unit
A typed physical UI quantity.
UnitsHandle
Resolves typed units and mutates the local em declaration of an element.
UnitsRoot
Configures the root rem value for a subtree.

Enums

ActionColorRole
Semantic color family for interactive actions.
ActionColorSlot
Theme slot resolved for an action color family and prominence.
ActionExecutionPhase
Presentation phase of an asynchronous or externally tracked action.
ActionProminence
Visual emphasis of an action, independent from its semantic color role.
CarpenterActionIconPosition
Position of an action icon relative to its label.
CarpenterAttachmentPhase
CarpenterCardSurfaceRole
Semantic background role for a CarpenterCard.
CarpenterContextActionTrigger
Input source that requested a contextual action surface.
CarpenterDensity
Global density preference used by semantic sizing and spacing resolution.
CarpenterDragActivation
CarpenterDragOperation
CarpenterDropAxis
CarpenterDropPosition
CarpenterEditorMode
CarpenterEmptyStateKind
CarpenterFramePlatform
CarpenterKanbanLoadState
CarpenterListTilePresentation
CarpenterLoadingPresentation
CarpenterNavigationPresentation
CarpenterNoticeTone
Semantic feedback surface for page and action-level messages.
CarpenterPageHeaderBehavior
Controls whether the page header participates in the page scroll flow.
CarpenterPageKind
CarpenterPageStateKind
CarpenterRegionPresentation
CarpenterRegionRole
CarpenterRegionScrollOwnership
Declares whether the semantic region or its child owns vertical scrolling.
CarpenterResourceLoadReason
CarpenterRestorationLifetime
CarpenterRootLayoutPresentation
CarpenterSelectionMode
CarpenterSplitNarrowRegion
CarpenterSplitOrientation
CarpenterSurfaceKind
CarpenterTableColumnAlignment
CarpenterTableColumnVerticalAlignment
CarpenterTableColumnWidthPolicy
CarpenterTableTypographyRole
CarpenterTabsOrientation
CarpenterTagTone
Semantic tag tone retained from the previous Carpenter API.
CarpenterToastPlacement
CarpenterToolbarGroup
CarpenterToolbarPresentation
CarpenterToolbarPriority
CarpenterTreeLoadState
Loading state of a node whose children may be resolved lazily.
CarpenterTreeSelectionMode
CarpenterViewportClass
CheckboxValue
Tri-state checkbox value.
CollectionContentState
Meaning of collection content, distinct from an active request or request failure.
CollectionFreshness
Whether the currently visible items are considered up to date.
CollectionLoadPhase
Load operation currently affecting a collection, separate from freshness, content emptiness, and item mutations.
CollectionMultiSelectionBehavior
Pointer and keyboard semantics used by a multiple-selection collection.
CollectionMutationPhase
Execution phase of an item-level mutation, independent of collection loading.
CollectionReconciliation
How an optimistic local change relates to its authoritative result.
CollectionRequestReason
Why a lifecycle controller invoked its loader, so adapters can choose appropriate fetching or caching behavior.
CollectionSelectionMode
Selection policy expressed in stable item keys, not loaded row positions.
CollectionSortDirection
Ordering requested for one collection sort key; the data adapter performs the sort.
ContentColorRole
Semantic foreground color for non-action content.
ContrastMode
Requested contrast level for semantic Carpenter colors.
ControlSize
Semantic size scale used by compact controls.
DialogDismissPolicy
Policy controlling which implicit gestures may dismiss a dialog.
FeedbackColorRole
Semantic color family for passive feedback and status presentation.
FieldAvailability
Interaction availability of an input field.
FieldSize
Semantic size scale used by fields and field-like controls.
IconSize
Semantic size scale used by icons.
OptionsLoadState
Loading state for option-producing controls such as selects and suggestions.
OverlayPlacement
Preferred placement of anchored overlay content relative to its anchor.
SelectionColorRole
Semantic color family for selection indicators and selected surfaces.
ShapeRole
Semantic endpoint shape used by grouped surfaces and controls.
ToastDuration
Semantic lifetime of transient toast feedback.
TooltipDelay
Semantic delay before tooltip presentation.
TypographyEmphasis
Semantic weight applied within a TypographyRole.
TypographyRole
Semantic typography family chosen independently from emphasis and color.

Extensions

CarpenterSurfaceBuildContext on BuildContext
CollectionEventApplication on CollectionSnapshot<T>
Pure application of collection events to an immutable snapshot using caller-owned stable keys.
LoadingBuildContext on BuildContext
UnitLiterals on num
Numeric literals for typed units.
UnitsBuildContext on BuildContext
Adds context.units(...), context.units.set(...), and context.units.reset().

Constants

palette → const PaletteTokens

Functions

carpenterFileDragPayload<T>({required Iterable<CarpenterFileCandidate<T>> files, Object? id, Set<CarpenterDragOperation> allowedOperations = const {CarpenterDragOperation.copy, CarpenterDragOperation.move}}) → CarpenterDragPayload<CarpenterFileDropData<T>>
carpenterFormatDate(DateTime value) → String
carpenterFormatDateRange(CarpenterDateRange value) → String
carpenterFormatRgbHex(Color color) → String
carpenterFormatTime(CarpenterTime value) → String
carpenterParseDate(String value) → DateTime?
carpenterParseDateRange(String value) → CarpenterDateRange?
carpenterParseRgbColor(String source) → Color?
carpenterParseTime(String value) → CarpenterTime?
carpenterTableCellAlignment(CarpenterTableColumnAlignment horizontal, CarpenterTableColumnVerticalAlignment vertical) → AlignmentDirectional
carpenterTreeContains<T>(CarpenterTreeNode<T> root, Object id) → bool
findCarpenterTreeNode<T>(Iterable<CarpenterTreeNode<T>> roots, Object id) → CarpenterTreeNode<T>?
findCarpenterTreePath<T>(Iterable<CarpenterTreeNode<T>> roots, Object id) → List<CarpenterTreeNode<T>>?
Returns the root-to-node path for id, or null when the node is absent.
flattenCarpenterTree<T>(List<CarpenterTreeNode<T>> roots, Set<Object> expandedIds) → List<CarpenterTreeFlatNode<T>>
flattenFilteredCarpenterTree<T>(List<CarpenterTreeNode<T>> roots, Set<Object> expandedIds, CarpenterTreeNodePredicate<T> predicate) → List<CarpenterTreeFlatNode<T>>
Flattens a filtered tree while retaining ancestors of matching nodes.
showCarpenterDialog<T>({required BuildContext context, required String title, required Widget content, required CarpenterDialogActionsBuilder<T> actionsBuilder, DialogDismissPolicy dismissPolicy = DialogDismissPolicy.escapeOnly, String? semanticLabel, FocusNode? initialFocusNode}) → Future<T?>
Opens a typed Carpenter modal route and completes with the value supplied to an action's CarpenterDialogClose.

Typedefs

CarpenterCollectionRenderer<T> = Widget Function(BuildContext context, CollectionSnapshot<T> snapshot)
CarpenterControlBuilder = Widget Function(BuildContext context, CarpenterControlState state)
CarpenterControllerFactory<C extends ChangeNotifier> = C Function(BuildContext context)
CarpenterDataListItemBuilder<T> = Widget Function(BuildContext context, T item)
CarpenterDefinitionTerm<T> = String Function(T item)
CarpenterDefinitionValueBuilder<T> = Widget Function(BuildContext context, T item)
CarpenterDetailBuilder<T> = Widget Function(BuildContext context, T value)
CarpenterDialogActionsBuilder<T> = List<CarpenterActionDescriptor> Function(CarpenterDialogClose<T> close)
CarpenterDialogClose<T> = void Function([T? result])
CarpenterDragCanceledCallback = void Function(Velocity velocity, Offset offset)
CarpenterDragSessionCallback = void Function(CarpenterDragSession? session)
CarpenterDropAcceptance<T> = bool Function(CarpenterDropDetails<T> details)
CarpenterDropCallback<T> = void Function(CarpenterDropDetails<T> details)
CarpenterDropTargetBuilder<T> = Widget Function(BuildContext context, CarpenterDropTargetState<T> state)
CarpenterFileAcceptance<T> = bool Function(CarpenterFileCandidate<T> file)
CarpenterFilesChanged<T> = void Function(List<CarpenterFileCandidate<T>> files)
CarpenterIconSource = Object
Value accepted by Carpenter icon slots.
CarpenterInspectorFieldFilter = bool Function(String key, Object? value)
CarpenterInspectorLabelBuilder = String Function(String key)
CarpenterInspectorScalarBuilder = String Function(Object? value)
CarpenterKanbanCardBuilder<C, T> = Widget Function(BuildContext context, T card, CarpenterKanbanCardState<C> state)
CarpenterKanbanColumnCallback<C, T> = void Function(CarpenterKanbanColumn<C, T> column)
CarpenterKanbanMoveAcceptance<C, T> = bool Function(CarpenterKanbanMoveDetails<C, T> details)
CarpenterKanbanMoveCallback<C, T> = void Function(CarpenterKanbanMoveDetails<C, T> details)
CarpenterNavigationBuilder = Widget Function(BuildContext context, CarpenterNavigationPresentation presentation)
CarpenterPageSurfaceOpener = Future<Object?> Function(Object destination)
CarpenterPlanningLaneExpansionChanged = void Function(Object laneId, bool expanded)
CarpenterPlanningMoveCallback<L, C, T> = void Function(CarpenterPlanningMoveDetails<L, C, T> details)
CarpenterReorderCallback<T> = void Function(CarpenterReorderDetails<T> details)
CarpenterReorderItemBuilder<T> = Widget Function(BuildContext context, T item, CarpenterReorderItemState state)
CarpenterResourceLoader<T> = Future<T> Function(CarpenterResourceLoadRequest request)
CarpenterRootHeaderBuilder = Widget Function(BuildContext context, CarpenterRootLayoutContext layout)
CarpenterSuggestionLoader<T> = Future<List<CarpenterOption<T>>> Function(String query, CarpenterSearchCancellation cancellation)
Loads options for a trimmed query and a per-request cancellation signal. Return the complete suggestion list for that query. The autosuggest owns the signal and ignores cancelled or superseded completions; the loader owns any transport resources.
CarpenterTableActionsBuilder<T> = CarpenterTableActions Function(T item)
CarpenterTableCellBuilder<T> = Widget Function(BuildContext context, T item)
Builds the content displayed in one table cell for item.
CarpenterTableColumnWidthChanged = void Function(String columnId, LengthUnit width)
Reports the caller-visible width selected for a resized table column.
CarpenterTableFooterCellBuilder<T> = Widget Function(BuildContext context, List<T> items)
Builds one footer cell from all rows currently supplied to the editable table. Calculate totals from items rather than maintaining a second independent list.
CarpenterTopPanelBuilder = Widget Function(BuildContext context, CarpenterTopPanelContext panel)
CarpenterTreeActionsBuilder<T> = List<CarpenterActionDescriptor> Function(CarpenterTreeNode<T> node)
CarpenterTreeActivation<T> = void Function(CarpenterTreeNode<T> node)
CarpenterTreeDropAcceptance<T> = bool Function(CarpenterTreeDropDetails<T> details)
CarpenterTreeDropCallback<T> = void Function(CarpenterTreeDropDetails<T> details)
CarpenterTreeExpansionChanged = void Function(Object nodeId, bool expanded)
CarpenterTreeIconBuilder<T> = CarpenterIconSource? Function(CarpenterTreeNode<T> node)
CarpenterTreeNodeBuilder<T> = Widget Function(BuildContext context, CarpenterTreeNode<T> node, CarpenterTreeRowState<T> state)
CarpenterTreeNodeCallback<T> = void Function(CarpenterTreeNode<T> node)
CarpenterTreeNodePredicate<T> = bool Function(CarpenterTreeNode<T> node)
CarpenterTreeRowBuilder<T> = Widget Function(BuildContext context, CarpenterTreeNode<T> node, CarpenterTreeRowState<T> state, Widget prefix)
CarpenterTreeSelectionChanged = void Function(Set<Object> selectedIds)
CarpenterTreeTableActionsBuilder<T> = CarpenterTableActions Function(CarpenterTreeNode<T> node)
Builds the primary and secondary semantic actions represented by a tree-table column.
CarpenterTreeTableCellBuilder<T> = Widget Function(BuildContext context, CarpenterTreeNode<T> node)
Builds the content displayed in one tree-table cell for node.
CarpenterTreeTableColumnWidthChanged = void Function(String columnId, LengthUnit width)
Reports the caller-visible width selected for a resized tree-table column.
CarpenterValueEquality<T> = bool Function(T first, T second)
CollectionLifecycleLoader<T, F> = Future<CollectionSnapshot<T>> Function(CollectionQuery<F> query, CollectionLoadRequest request)
Loads a complete snapshot for query and the supplied request context.
CollectionLoader<T, F> = Future<CollectionSnapshot<T>> Function(CollectionQuery<F> query)
Compatibility loader returning a complete snapshot for a query without request-reason or cancellation context.
CollectionLoadMore<T, F> = Future<CollectionSnapshot<T>> Function(CollectionQuery<F> query, CollectionSnapshot<T> current, CollectionLoadRequest request)
Returns the complete accumulated snapshot after loading another batch.
LoadingBoundaryBuilder = Widget Function(BuildContext context, LoadingState state, Widget child)
Builds UI around a locally-owned LoadingNotifier.

Exceptions / Errors

MissingUnitContextException
Thrown when a relative unit lacks required runtime context.
UnitParseException
A parse failure with the source representation that caused it.