SharedAxisTransition class

Defines a transition in which outgoing and incoming elements share a fade transition.

The shared axis pattern provides the transition animation between UI elements that have a spatial or navigational relationship. For example, transitioning from one page of a sign up page to the next one.

Consider using SharedAxisTransition within a PageTransitionsTheme if you want to apply this kind of transition to MaterialPageRoute transitions within a Navigator (see SharedAxisPageTransitionsBuilder for example code).

This transition can also be used directly in a PageTransitionSwitcher.transitionBuilder to transition from one widget to another as seen in the following example:

int _selectedIndex = 0;

final List<Color> _colors = [Colors.white, Colors.red, Colors.yellow];

@override
Widget build(BuildContext context) {
  return Scaffold(
    appBar: AppBar(
      title: const Text('Page Transition Example'),
    ),
    body: PageTransitionSwitcher(
      // reverse: true, // uncomment to see transition in reverse
      transitionBuilder: (
        Widget child,
        Animation<double> primaryAnimation,
        Animation<double> secondaryAnimation,
      ) {
        return SharedAxisTransition(
          animation: primaryAnimation,
          secondaryAnimation: secondaryAnimation,
          transitionType: SharedAxisTransitionType.horizontal,
          child: child,
        );
      },
      child: Container(
        key: ValueKey<int>(_selectedIndex),
        color: _colors[_selectedIndex],
        child: Center(
          child: FlutterLogo(size: 300),
        )
      ),
    ),
    bottomNavigationBar: BottomNavigationBar(
      items: const <BottomNavigationBarItem>[
        BottomNavigationBarItem(
          icon: Icon(Icons.home),
          title: Text('White'),
        ),
        BottomNavigationBarItem(
          icon: Icon(Icons.business),
          title: Text('Red'),
        ),
        BottomNavigationBarItem(
          icon: Icon(Icons.school),
          title: Text('Yellow'),
        ),
      ],
      currentIndex: _selectedIndex,
      onTap: (int index) {
        setState(() {
          _selectedIndex = index;
        });
      },
    ),
  );
}
Inheritance

Constructors

SharedAxisTransition({Key? key, required Animation<double> animation, required Animation<double> secondaryAnimation, required SharedAxisTransitionType transitionType, Color? fillColor, Widget? child})
Creates a SharedAxisTransition.
const

Properties

animation → Animation<double>
The animation that drives the child's entrance and exit.
final
child → Widget?
The widget below this widget in the tree.
final
fillColor → Color?
The color to use for the background color during the transition.
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
secondaryAnimation → Animation<double>
The animation that transitions child when new content is pushed on top of it.
final
transitionType → SharedAxisTransitionType
Determines which type of shared axis transition is used.
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}) → 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