ShortcutsViewerDialog class

A comprehensive shortcuts viewer dialog that displays all available keyboard shortcuts organized by category.

This dialog presents keyboard shortcuts in a user-friendly format with:

  • Categorized shortcuts (General, Selection, Navigation, etc.)
  • Platform-specific key symbols (⌘ on macOS, Ctrl on Windows/Linux)
  • Action descriptions alongside each shortcut
  • Searchable and scrollable interface

The dialog automatically formats shortcuts based on the current platform, showing appropriate symbols for modifier keys (Command, Control, Alt, Shift).

Example usage:

void showShortcuts(BuildContext context) {
  showDialog(
    context: context,
    builder: (context) => ShortcutsViewerDialog(
      shortcuts: controller.shortcuts.shortcuts,
      actions: controller.shortcuts.getAllActions(),
    ),
  );
}

See also:

Inheritance
Available extensions

Constructors

ShortcutsViewerDialog({Key? key, required Map<LogicalKeySet, String> shortcuts, Map<String, NodeFlowAction> actions = const {}})
Creates a shortcuts viewer dialog.
const

Properties

actions Map<String, NodeFlowAction>
The map of action IDs to NodeFlowAction objects.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shortcuts Map<LogicalKeySet, String>
The map of keyboard shortcuts to action IDs.
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.
inherited
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
withAnnotationLayer(NodeFlowController<T> controller) Widget

Available on Widget, provided by the AnnotationLayerSupport extension

Wraps this widget with an annotation layer.

Operators

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