Skip to content
A Flutter widget that moves according to a scroll controller.
Dart Objective-C Java
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc/images Add example Mar 15, 2018
example add Dart 2 support Jul 21, 2018
lib add Dart 2 support Jul 21, 2018
test add Dart 2 support Jul 21, 2018
.gitignore init project Mar 3, 2018
CHANGELOG.md add Dart 2 support Jul 21, 2018
LICENSE Initial commit Mar 3, 2018
README.md add Dart 2 support Jul 21, 2018
pubspec.yaml add Dart 2 support Jul 21, 2018

README.md

flutter_parallax

A Flutter widget that moves according to a scroll controller.

Pub

Features

  • Can contain any widget.
  • Configurable parallax scroll direction.
  • Customizable parallax delegate.
  • For widgets inside and outside a scroll view (list items and list backgrounds for example).

Screenshot

Getting started

In the pubspec.yaml of your flutter project, add the following dependency:

dependencies:
  ...
  flutter_parallax: "^0.1.2"

In your library add the following import:

import 'package:flutter_parallax/flutter_parallax.dart';

For help getting started with Flutter, view the online documentation.

Example

new Parallax.inside(
    child: new Image.network('https://flutter.io/images/homepage/header-illustration.png'),
    mainAxisExtent: 150.0,
);

You can find more examples in the Example project.

Constructors

  • The Parallax.inside, that computes the parallax offset from its position in its first Scrollable parent. Useful for list or grid items.
  • The Parallax.outside, that computes the parallax offset from the percentage of the scrollable's container extent. Useful for a list or grid background.
  • The Parallax.custom takes a ParallaxDelegate, which provides the ability to customize additional aspects of the child model. For example, a ParallaxDelegate can control the algorithm used to computes the parallax offset of the child within its parent.

Changelog

Please see the Changelog page to know what's recently changed.

Contributions

Feel free to contribute to this project.

If you find a bug or want a feature, but don't know how to fix/implement it, please fill an issue.
If you fixed a bug or implemented a new feature, please send a pull request.

You can’t perform that action at this time.