carousel_slider 1.4.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 100

carousel_slider #

A carousel slider widget, support infinite scroll and custom child widget, with auto play feature.

Installation #

Add carousel_slider: ^1.3.0 in your pubspec.yaml dependencies. And import it:

import 'package:carousel_slider/carousel_slider.dart';

How to use #

Simply create a CarouselSlider widget, and pass the required params:

  height: 400.0,
  items: [1,2,3,4,5].map((i) {
    return Builder(
      builder: (BuildContext context) {
        return Container(
          width: MediaQuery.of(context).size.width,
          margin: EdgeInsets.symmetric(horizontal: 5.0),
          decoration: BoxDecoration(
            color: Colors.amber
          child: Text('text $i', style: TextStyle(fontSize: 16.0),)

Params #

   items: items,
   height: 400,
   aspectRatio: 16/9,
   viewportFraction: 0.8,
   initialPage: 0,
   enableInfiniteScroll: true,
   reverse: false,
   autoPlay: true,
   autoPlayInterval: Duration(seconds: 3),
   autoPlayAnimationDuration: Duration(milliseconds: 800),
   autoPlayCurve: Curves.fastOutSlowIn,
   pauseAutoPlayOnTouch: Duration(seconds: 10),
   enlargeCenterPage: true,
   onPageChanged: callbackFunction,
   scrollDirection: Axis.horizontal,

You can pass the above params to the class. If you pass the height params, the aspectRatio param will be ignore.

Build item widgets on demand #

This method will save memory and build item when it will be visible. Can be used to build different child item widgets related to content or by item index.

   itemCount: 15,
   itemBuilder: (BuildContext context, int itemIndex) =>
            child: Text(itemIndex.toString()),

Instance methods #

You can use the instance methods to programmatically take control of the pageView's position.

.nextPage({Duration duration, Curve curve}) #

Animate to the next page

.previousPage({Duration duration, Curve curve}) #

Animate to the previous page

.jumpToPage(int page) #

Jump to the given page.

.animateToPage(int page, {Duration duration, Curve curve}) #

Animate to the given page.

Example #

Let a carousel slide play automatically or use buttons:


Show dot indicator or play carousel in cover mode:


Pause slideshow for a set amount of time on user touch input:


For a more detail example please take a look at the example folder.

Faq #

Can I display a dotted indicator for the slider? #

Yes, you can.

class CarouselWithIndicator extends StatefulWidget {
  _CarouselWithIndicatorState createState() => _CarouselWithIndicatorState();

class _CarouselWithIndicatorState extends State<CarouselWithIndicator> {
  int _current = 0;

  Widget build(BuildContext context) {
    return Stack(
      children: [
          items: child,
          autoPlay: true,
          aspectRatio: 2.0,
          onPageChangedCallback: (index) {
            setState(() {
              _current = index;
          top: 0.0,
          left: 0.0,
          right: 0.0,
          child: Row(
            children: map<Widget>(imgList, (index, url) {
              return Container(
                width: 8.0,
                height: 8.0,
                margin: EdgeInsets.symmetric(vertical: 10.0, horizontal: 2.0),
                decoration: BoxDecoration(
                  color: _current == index ? Color.fromRGBO(0, 0, 0, 0.9) : Color.fromRGBO(0, 0, 0, 0.4)

Can I pause the slider if i touch it? #

Yes. Use the pauseAutoPlayOnTouch which takes a duration and when set, enables touch detection. Touch Detection is only active if the autoPlay property is set to true. If the screen is touched it will pause the automatic playback for the set duration. if touched again during the time out the timer is reset to the duration passed to pauseAutoPlayOnTouch.

This feature can be useful if you want users to be able to interact with the screen and not have the pages continue sliding, forcing the user to repeatedly swipe back. One such example could be a commercial advertisement where the customers can react to something they like.

Can I disable the infinite loop mode? #

Yes. This was added by popular demand in patch 1.2.0.
Just set the constructor argument enableInfiniteScroll to false.


The example folder contains an example showcasing all features.

If something is missing, feel free to open a ticket or contribute!

1.4.1 #

Fix #

  • Fix animateTo()/jumpTo() with non-zero initialPage

1.4.0 #

Add #

  • Add on-demand item feature

Fix #

  • Fix setState() called after dispose() bug

1.3.1 #

Add #

  • Scroll physics option

Fix #

  • onPage indexing bug

1.3.0 #

Deprecation #

  • Remove the deprecated param: interval, autoPlayDuration, distortion, updateCallback. Please use the new param.

Fix #

  • Fix enlargeCenterPage option is not working in vertical carousel slider.

1.2.0 #

Add #

  • Vertical scroll support
  • Enable/disable infinite scroll

1.1.0 #

Add #

  • Added pauseAutoPlayOnTouch option
  • Add documentation

1.0.1 #

Add #

  • Update doc

1.0.0 #

Add #

  • Added distortion option

0.0.6 #

Fix #

  • Fix hard coded number

0.0.5 #

Fix #

  • Fix initialPage bug, fix crash when widget is disposed.

v0.0.2 #

Remove useless dependencies, add changelog.

v0.0.1 #

Initial version.


carousel_slider_example #

This exmaple shows four carousel slider examples:

  • Image slider with custom button control
  • Image slider with custom caption
  • Image slider with full width display
  • Image slider with indicator


Running #

flutter run

Building #

flutter build ios # or flutter build apk

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  carousel_slider: ^1.4.1

2. Install it

You can install packages from the command line:

with Flutter:

$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:carousel_slider/carousel_slider.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Feb 27, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.5
  • Flutter: 1.12.13+hotfix.8

Health suggestions

Format lib/carousel_slider.dart.

Run flutter format to format lib/carousel_slider.dart.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.28.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies