BackdropToggleButton class

An animated button with backdrop related functionality.

It can be used to trigger the backdrop functionality of BackdropScaffold.

This button is implicitly used within BackdropAppBar. This button can also be passed to the BackdropAppBar.actions.

When being pressed, BackdropToggleButton looks for a Backdrop instance above it in the widget tree and toggles its opening/closing.

Example:

Widget build(BuildContext context) {
  return MaterialApp(
    title: 'Backdrop Demo',
    home: BackdropScaffold(
      ...
      actions: <Widget>[
        BackdropToggleButton(
          icon: AnimatedIcons.list_view,
        ),
      ],
    ),
  );
}

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• BackdropToggleButton

Constructors

BackdropToggleButton({Key? key, AnimatedIconData icon = AnimatedIcons.close_menu, Color color = Colors.white})

Creates an instance of BackdropToggleButton.

const

Properties

color → Color

The animated icon's foreground color.

final

hashCode → int

The hash code for this object.

no setter, inherited

icon → AnimatedIconData

Animated icon that is used for the contained AnimatedIcon.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited