material_ribbon library

Material 3 components for building a productive, adaptive ribbon UI.

Classes

CommandInvocation
Describes a command request sent to a host command handler.
MaterialRibbon
The top-level adaptive Material 3 ribbon command surface.
RibbonActionChip
An action chip using the shared Chip theme and application-owned behavior. Can be placed in MaterialRibbon.headerActions or any scroll view.
RibbonChip
A selectable command chip for navigation surfaces such as a Backstage menu.
RibbonCol
A compact vertical control stack for use inside a RibbonGroup.
RibbonColorPicker
A palette button backed by RibbonGallery, with optional hover preview.
RibbonComboBox<T>
A compact labelled dropdown intended for a ribbon group.
RibbonComboBoxItem<T>
An item displayed by RibbonComboBox.
RibbonCommand
One command can expose an action, toggle, menu, split-button, or gallery.
RibbonCommandFeedback
A lifecycle event that lets the host show progress, success, or error UI.
RibbonCommandPalette
A search field that filters and invokes a collection of ribbon commands.
RibbonContext
Immutable application state used to resolve ribbon visibility and commands.
RibbonController
Selects ribbon tabs and reveals tabs or groups programmatically.
RibbonCustomizationPanel
A controlled customization surface for Quick Access commands and tab order.
RibbonFeaturedGallery<T>
A compact gallery that keeps selected, high-frequency items in a ribbon group and exposes the complete collection from its expansion button.
RibbonFontPicker
A font family dropdown with each option rendered in its own typeface.
RibbonGallery<T>
A dense, keyboard-accessible grid for pictures, colours, and document styles.
RibbonGalleryItem<T>
A selectable value and its visual representation in a RibbonGallery.
RibbonGroup
A labelled group of commands and custom controls within a RibbonTab.
RibbonHorizontalScrollView
A horizontally scrolling ribbon surface with a visible scrollbar.
RibbonKeyTip
Adds a visible KeyTip badge to an application-defined ribbon control.
RibbonKeyTipController
Controls which KeyTip badges are visible on a MaterialRibbon.
RibbonKeyTipState
The externally observable state of the KeyTip interaction.
RibbonKeyTipTarget
Registers an application-defined action for a KeyTip sequence.
RibbonLocalizations
Strings used by built-in ribbon controls and their accessibility labels.
RibbonLocalizationsScope
Makes RibbonLocalizations available to descendant ribbon controls.
RibbonPersonalization
Immutable, serializable user choices for the Quick Access Toolbar and tabs.
RibbonPersonalizationStore
Adapter for app-owned persistence (SharedPreferences, database, etc.).
RibbonPopup
A standard popup surface for ribbon menus, galleries, and pickers.
RibbonRowGrid
A compact control grid for use inside a RibbonGroup.
RibbonShortcut
An application-defined keyboard shortcut that invokes a ribbon command.
RibbonShortcutRegistry
Mutable shortcut collection with conflict inspection. Wrap an application root in CallbackShortcuts using bindingsFor for application-wide scope. Mutable shortcut collection with conflict inspection.
RibbonSpinBox
A numeric field with ribbon-sized increment and decrement affordances.
RibbonTab
A ribbon tab whose visibility can depend on the current RibbonContext.
RibbonTextBox
A controlled text field sized for placement in a RibbonGroup.
TextFormatControls
A ready-made font-size slider and text-colour picker row.

Typedefs

RibbonCommandErrorHandler = void Function(CommandInvocation invocation, Object error, StackTrace stackTrace)
RibbonCommandFeedbackHandler = void Function(RibbonCommandFeedback feedback)
RibbonCommandHandler = FutureOr<void> Function(CommandInvocation invocation)
RibbonPersonalizationMigration = Map<String, Object?> Function(int sourceVersion, Map<String, Object?> json)