StudioCommandPalette class

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).

Built on ui_core's DesignCommandPalette. Show it over a page with showStudioCommandPalette.

Reads style's fill (the panel), then StudioThemeData.commandPaletteStyle.

StudioCommandPalette(commands: commands, onSelected: (c) => c.onPressed?.call())
Inheritance

Constructors

StudioCommandPalette({Key? key, required List<StudioCommand> commands, ValueChanged<StudioCommand>? onSelected, String hint = 'Type a command or search', String emptyText = 'No commands match', bool autofocus = false, StudioStyle? style})
A palette of commands.
const

Properties

autofocus → bool
Whether it takes focus when it first appears, as Focus.autofocus does: one part on a route asks for it.
final
commands → List<StudioCommand>
What it finds.
final
emptyText → String
What the list says when nothing matches.
final
hashCode → int
The hash code for this object.
no setterinherited
hint → String
What the search says while empty.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSelected → ValueChanged<StudioCommand>?
Called with the command taken.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style → StudioStyle?
Its style, over StudioThemeData.commandPaletteStyle.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited