ParallaxImage class

A widget that paints an image and moves it at a slower speed than the main scrolling content.

Image is rendered in a box with specified extent in the scroll direction.

If scroll controller is provided then this widget reacts to scrolling updates in ScrollController.position which assumes that controller is attached to only one Scrollable. Otherwise this widget looks for nearest Scrollable ancestor and subscribes to scrolling updates on it.

When scroll direction is Axis.vertical the image is scaled to fit width (BoxFit.fitWidth) of parent widget. For Axis.horizontal scroll direction the image is scaled to fit height (BoxFit.fitHeight) of parent widget.

Inheritance

Constructors

ParallaxImage({Key key, @required ImageProvider image, @required double extent, ScrollController controller, Color color, Widget child })
Creates new ParallaxImage. [...]

Properties

child Widget
The optional child of this widget.
final
color Color
Optional color to paint behind the image.
final
controller ScrollController
Scroll controller which determines scroll direction and notifies this widget of scroll position changes. [...]
final
extent → double
Extent of this widget in scroll direction. [...]
final
image ImageProvider
The image to paint.
final
hashCode → int
The hash code for this object.
read-only, inherited
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.
read-only, inherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
override
debugFillProperties(DiagnosticPropertiesBuilder description) → void
Add additional properties associated with the node. [...]
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. [...]
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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.debug }) → String
Returns 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 ==(dynamic other) → bool
The equality operator.
inherited