Skip to content

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

License

Notifications You must be signed in to change notification settings

pulyaevskiy/parallax-image

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

parallax_image

Parallax image widget for Flutter.

demo.gif

Installation

Add dependency to your pubspec.yaml:

dependencies:
  parallax_image: ^0.1.0

Usage

ParallaxImage can be used with any Scrollable (ListView for instance) and only depends on an instance of ScrollController attached to that scrollable.

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

class MyWidgetState extends State<MyWidget> {
    final ScrollController _controller = new ScrollController();
    @override
    Widget build(BuildContext context) {
        return new ListView(
            controller: _controller,
            children: <Widget>[
                new ParallaxImage(
                    controller: _controller,
                    image: new AssetImage('images/some.jpg'),
                    // Extent of this widget in scroll direction.
                    // In this case it is vertical scroll so it defines 
                    // the height of this widget. 
                    // The image is scaled with BoxFit.fitWidth which makes it
                    // occupy full width of this widget.
                    // Scaled image should normally have height greater 
                    // than this value to allow for parallax effect to be
                    // visible.
                    extent: 100.0,
                ),
                // ...add more list items
            ]
        );
    }
}

Features and bugs

Please file feature requests and bugs at the issue tracker.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published