SplitButton class

Represents a button with two parts that can be invoked separately. One part behaves like a standard button and the other part invokes a flyout.

To show the flyout programmatically, use a GlobalKey<SplitButtonState> to invoke SplitButtonState.showFlyout:

final splitButtonKey = GlobalKey<SplitButtonState>();

SplitButton(
  key: splitButtonKey,
  ...,
),

splitButtonKey.currentState?.showFlyout();

Constructors

SplitButton({Key? key, required Widget child, SplitButtonSecondaryBuilder? secondaryBuilder, required Widget flyout, VoidCallback? onInvoked, bool enabled = true}): Creates a split button
const
SplitButton.toggle({Key? key, required Widget child, required bool checked, SplitButtonSecondaryBuilder? secondaryBuilder, required Widget flyout, VoidCallback? onInvoked, bool enabled = true}): Creates a split toggle button
const

checked → bool: Whether the split button is checked
final
child → Widget: The primary widget to be displayed
final
enabled → bool: Whether the button is enabled
final
flyout → Widget: The widget to be displayed when the flyout is requested
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onInvoked → VoidCallback?: When the primary part of the button is invoked
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
secondaryBuilder → SplitButtonSecondaryBuilder?: The secondary widget to be displayed. If not provided, the default chevron down icon is displayed.
final

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SplitButton>: Creates the mutable state for this widget at a given location in the tree.
override
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}) → 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