BarBackButtonMode enum

Controls the behavior of the back button in a Bar widget.

This enum defines modes for displaying the back button in Arcane's bar components, integrating with navigation in AbstractScreen, FillScreen, NavigationScreen, and SliverScreen. Key features include conditional visibility based on navigation state and pinning, ensuring seamless back navigation without heavy animations for performance. Usage: Set in Bar's constructor to manage pop behavior in headers or footers, returning the appropriate IconButton or none based on context.

Inheritance

• Object
• Enum
• BarBackButtonMode

Available extensions

• EnumName

Values

never → const BarBackButtonMode

Never show the back button, useful for root screens or custom navigation in ArcaneApp.

always → const BarBackButtonMode

Always show the back button if navigation can pop, ideal for standard AbstractScreen flows.

whenPinned → const BarBackButtonMode

Show the back button only when the bar is pinned, optimizing for SliverScreen or scrollable UIs.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<BarBackButtonMode>

A constant List of the values in this enum, in order of their declaration.