parallax_image 0.3.1+1

Flutter Android iOS web

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

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

demo.gif

Installation #

Add dependency to your pubspec.yaml:

dependencies:
  parallax_image: [latest version]

Usage #

ParallaxImage can be used with any Scrollable (ListView for instance). When created, it subscribes to scroll updates on nearest Scrollable ancestor. It is also possible to specify custom ScrollController in which case this widget subscribes to updates on ScrollController.position (assumes that controller is attached to only one Scrollable).

class MyWidget extends StatefulWidget {
  @override
  MyWidgetState createState() => new MyWidgetState();
}

class MyWidgetState extends State<MyWidget> {
  final _controller = new ScrollController();

  @override
  Widget build(BuildContext context) {
    return new ListView(controller: _controller, children: [
      new ParallaxImage(
        image: new AssetImage('images/january.jpg'),
        // Extent of this widget in scroll direction.
        // In this case it is vertical scroll so extent defines
        // the height of this widget.
        // The image is scaled with BoxFit.fitWidth which makes it
        // occupy full width of this widget.
        // After image is scaled it should normally have height greater
        // than this value to allow for parallax effect to be
        // visible.
        extent: 100.0,
        // Optionally specify child widget.
        child: new Text('January'),
        // Optinally specify scroll controller.
        controller: _controller,
      ),
      // ...add more list items
    ]);
  }
}

See example/ folder for a complete demo.

Features and bugs #

Please file feature requests and bugs at the issue tracker.

24
likes
110
pub points
89%
popularity

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

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

anatoly.pulyaevskiy@gmail.com

License

BSD (LICENSE)

Dependencies

flutter

More

Packages that depend on parallax_image