FLUTTER INTRO SLIDER

Flutter Intro Slider is a flutter plugin that helps you make a cool intro for your app. Create intro has never been easier and faster

Table of Contents

Installing

Add to pubspec.yaml file

dependencies:
  intro_slider: ^2.4.0

Import

import 'package:intro_slider/intro_slider.dart';

Demo

default custom 1 custom 2

Code example

Default config

default config image

Code example (click to expand)
class IntroScreenState extends State<IntroScreen> {
 List<Slide> slides = [];

 @override
 void initState() {
   super.initState();

   slides.add(
     new Slide(
       title: "ERASER",
       description: "Allow miles wound place the leave had. To sitting subject no improve studied limited",
       pathImage: "images/photo_eraser.png",
       backgroundColor: Color(0xfff5a623),
     ),
   );
   slides.add(
     new Slide(
       title: "PENCIL",
       description: "Ye indulgence unreserved connection alteration appearance",
       pathImage: "images/photo_pencil.png",
       backgroundColor: Color(0xff203152),
     ),
   );
   slides.add(
     new Slide(
       title: "RULER",
       description:
       "Much evil soon high in hope do view. Out may few northward believing attempted. Yet timed being songs marry one defer men our. Although finished blessing do of",
       pathImage: "images/photo_ruler.png",
       backgroundColor: Color(0xff9932CC),
     ),
   );
 }

 void onDonePress() {
   // Do what you want
 }

 @override
 Widget build(BuildContext context) {
   return new IntroSlider(
     slides: this.slides,
     onDonePress: this.onDonePress,
   );
 }
}

Custom config

custom config image

Code example (click to expand)
class IntroScreenState extends State<IntroScreen> {
 List<Slide> slides = [];

 @override
 void initState() {
   super.initState();

   slides.add(
     new Slide(
       title:
           "A VERY LONG TITLE A VERY LONG TITLE A VERY LONG TITLE A VERY LONG TITLE A VERY LONG TITLE A VERY LONG TITLE A VERY LONG TITLE A VERY LONG TITLE A VERY LONG TITLE",
       maxLineTitle: 2,
       styleTitle:
           TextStyle(color: Colors.white, fontSize: 30.0, fontWeight: FontWeight.bold, fontFamily: 'RobotoMono'),
       description:
           "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc,",
       styleDescription:
           TextStyle(color: Colors.white, fontSize: 20.0, fontStyle: FontStyle.italic, fontFamily: 'Raleway'),
       marginDescription: EdgeInsets.only(left: 20.0, right: 20.0, top: 20.0, bottom: 70.0),
       centerWidget: Text("Replace this with a custom widget", style: TextStyle(color: Colors.white)),
       colorBegin: Color(0xffFFDAB9),
       colorEnd: Color(0xff40E0D0),
       backgroundImage: 'images/photo_eraser.png',
       directionColorBegin: Alignment.topLeft,
       directionColorEnd: Alignment.bottomRight,
       onCenterItemPress: () {},
     ),
   );
   slides.add(
     new Slide(
       title: "MUSEUM",
       styleTitle:
           TextStyle(color: Color(0xffD02090), fontSize: 30.0, fontWeight: FontWeight.bold, fontFamily: 'RobotoMono'),
       description: "Ye indulgence unreserved connection alteration appearance",
       styleDescription:
           TextStyle(color: Color(0xffD02090), fontSize: 20.0, fontStyle: FontStyle.italic, fontFamily: 'Raleway'),
       pathImage: "images/photo_museum.png",
       colorBegin: Color(0xffFFFACD),
       colorEnd: Color(0xffFF6347),
       directionColorBegin: Alignment.topRight,
       directionColorEnd: Alignment.bottomLeft,
     ),
   );
   slides.add(
     new Slide(
       title: "COFFEE",
       styleTitle:
           TextStyle(color: Color(0xffD02090), fontSize: 30.0, fontWeight: FontWeight.bold, fontFamily: 'RobotoMono'),
       description:
           "Much evil soon high in hope do view. Out may few northward believing attempted. Yet timed being songs marry one defer men our. Although finished blessing do of",
       styleDescription:
           TextStyle(color: Color(0xffD02090), fontSize: 20.0, fontStyle: FontStyle.italic, fontFamily: 'Raleway'),
       pathImage: "images/photo_coffee_shop.png",
       colorBegin: Color(0xffFFA500),
       colorEnd: Color(0xff7FFFD4),
       directionColorBegin: Alignment.topCenter,
       directionColorEnd: Alignment.bottomCenter,
       maxLineTextDescription: 3,
     ),
   );
 }

 void onDonePress() {
   // Do what you want
   // Navigator.push(
   //   context,
   //   MaterialPageRoute(builder: (context) => HomeScreen()),
   // );
 }

 Widget renderNextBtn() {
   return Icon(
     Icons.navigate_next,
     color: Color(0xffD02090),
     size: 35.0,
   );
 }

 Widget renderDoneBtn() {
   return Icon(
     Icons.done,
     color: Color(0xffD02090),
   );
 }

 Widget renderSkipBtn() {
   return Icon(
     Icons.skip_next,
     color: Color(0xffD02090),
   );
 }

 @override
 Widget build(BuildContext context) {
   return new IntroSlider(
     // List slides
     slides: this.slides,

     // Skip button
     renderSkipBtn: this.renderSkipBtn(),
     colorSkipBtn: Color(0x33000000),
     highlightColorSkipBtn: Color(0xff000000),

     // Next button
     renderNextBtn: this.renderNextBtn(),

     // Done button
     renderDoneBtn: this.renderDoneBtn(),
     onDonePress: this.onDonePress,
     colorDoneBtn: Color(0x33000000),
     highlightColorDoneBtn: Color(0xff000000),

     // Dot indicator
     colorDot: Color(0x33D02090),
     colorActiveDot: Color(0xffD02090),
     sizeDot: 13.0,

     // Show or hide status bar
     hideStatusBar: true,
     backgroundColorAllSlides: Colors.grey,

     // Scrollbar
     verticalScrollbarBehavior: scrollbarBehavior.SHOW_ALWAYS,
   );
 }
}

Custom your own tabs

custom config image

Code example (click to expand)
class IntroScreenState extends State<IntroScreen> {
  List<Slide> slides = [];

  Function goToTab;

  @override
  void initState() {
    super.initState();

    slides.add(
      new Slide(
        title: "SCHOOL",
        styleTitle: TextStyle(
          color: Color(0xff3da4ab),
          fontSize: 30.0,
          fontWeight: FontWeight.bold,
          fontFamily: 'RobotoMono',
        ),
        description:
            "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.",
        styleDescription:
            TextStyle(color: Color(0xfffe9c8f), fontSize: 20.0, fontStyle: FontStyle.italic, fontFamily: 'Raleway'),
        pathImage: "images/photo_school.png",
      ),
    );
    slides.add(
      new Slide(
        title: "MUSEUM",
        styleTitle:
            TextStyle(color: Color(0xff3da4ab), fontSize: 30.0, fontWeight: FontWeight.bold, fontFamily: 'RobotoMono'),
        description: "Ye indulgence unreserved connection alteration appearance",
        styleDescription:
            TextStyle(color: Color(0xfffe9c8f), fontSize: 20.0, fontStyle: FontStyle.italic, fontFamily: 'Raleway'),
        pathImage: "images/photo_museum.png",
      ),
    );
    slides.add(
      new Slide(
        title: "COFFEE SHOP",
        styleTitle:
            TextStyle(color: Color(0xff3da4ab), fontSize: 30.0, fontWeight: FontWeight.bold, fontFamily: 'RobotoMono'),
        description:
            "Much evil soon high in hope do view. Out may few northward believing attempted. Yet timed being songs marry one defer men our. Although finished blessing do of",
        styleDescription:
            TextStyle(color: Color(0xfffe9c8f), fontSize: 20.0, fontStyle: FontStyle.italic, fontFamily: 'Raleway'),
        pathImage: "images/photo_coffee_shop.png",
      ),
    );
  }

  void onDonePress() {
    // Back to the first tab
    this.goToTab(0);
  }

  void onTabChangeCompleted(index) {
    // Index of current tab is focused
  }

  Widget renderNextBtn() {
    return Icon(
      Icons.navigate_next,
      color: Color(0xffffcc5c),
      size: 35.0,
    );
  }

  Widget renderDoneBtn() {
    return Icon(
      Icons.done,
      color: Color(0xffffcc5c),
    );
  }

  Widget renderSkipBtn() {
    return Icon(
      Icons.skip_next,
      color: Color(0xffffcc5c),
    );
  }

  List<Widget> renderListCustomTabs() {
    List<Widget> tabs = [];
    for (int i = 0; i < slides.length; i++) {
      Slide currentSlide = slides[i];
      tabs.add(Container(
        width: double.infinity,
        height: double.infinity,
        child: Container(
          margin: EdgeInsets.only(bottom: 60.0, top: 60.0),
          child: ListView(
            children: <Widget>[
              GestureDetector(
                  child: Image.asset(
                currentSlide.pathImage,
                width: 200.0,
                height: 200.0,
                fit: BoxFit.contain,
              )),
              Container(
                child: Text(
                  currentSlide.title,
                  style: currentSlide.styleTitle,
                  textAlign: TextAlign.center,
                ),
                margin: EdgeInsets.only(top: 20.0),
              ),
              Container(
                child: Text(
                  currentSlide.description,
                  style: currentSlide.styleDescription,
                  textAlign: TextAlign.center,
                  maxLines: 5,
                  overflow: TextOverflow.ellipsis,
                ),
                margin: EdgeInsets.only(top: 20.0),
              ),
            ],
          ),
        ),
      ));
    }
    return tabs;
  }

  @override
  Widget build(BuildContext context) {
    return new IntroSlider(

      // Skip button
      renderSkipBtn: this.renderSkipBtn(),
      colorSkipBtn: Color(0x33ffcc5c),
      highlightColorSkipBtn: Color(0xffffcc5c),

      // Next button
      renderNextBtn: this.renderNextBtn(),

      // Done button
      renderDoneBtn: this.renderDoneBtn(),
      onDonePress: this.onDonePress,
      colorDoneBtn: Color(0x33ffcc5c),
      highlightColorDoneBtn: Color(0xffffcc5c),

      // Dot indicator
      colorDot: Color(0xffffcc5c),
      sizeDot: 13.0,
      typeDotAnimation: dotSliderAnimation.SIZE_TRANSITION,

      // Tabs
      listCustomTabs: this.renderListCustomTabs(),
      backgroundColorAllSlides: Colors.white,
      refFuncGoToTab: (refFunc) {
        this.goToTab = refFunc;
      },

      // Behavior
      scrollPhysics: BouncingScrollPhysics(),

      // Show or hide status bar
      hideStatusBar: true,

      // On tab change completed
      onTabChangeCompleted: this.onTabChangeCompleted,
    );
  }
}

Slide object properties

NameTypeDefaultDescription
Title
titleString""Change text title at top
widgetTitleWidgetnullSet a custom widget as the title (ignore title if define both)
maxLineTitleint1Change max number of lines title at top
styleTitleTextStyleWhite color, bold and font size is 30.0Style for text title
marginTitleEdgeInsetstop: 70.0, bottom: 50.0Margin for text title
Image
pathImageString""Path to your local image
widthImagedouble250.0Width of image
heightImagedouble250.0Height of image
foregroundImageFitBoxFitBoxFit.containForeground image fit
Center widget
centerWidgetWidgetnullYour custom's widget
onCenterItemPressFunctionDo nothingFire when press center image/widget
Description
descriptionString""Change text description at bottom
widgetDescriptionWidgetnullSet a custom widget as the description (ignore description if define both)
maxLineTextDescriptionString100Maximum line of text description
styleDescriptionTextStyleWhite and font size is 18.0Style for text description
marginDescriptionEdgeInsetsleft, right = 20.0, top, bottom = 50.0Margin for text description
Background Color
backgroundColorColorColors.amberAccentBackground tab color
colorBeginColorColors.amberAccentGradient tab color begin
colorEndColorColors.amberAccentGradient tab color end
directionColorBeginAlignmentGeometryAlignment.topLeftDirection color begin
directionColorEndAlignmentGeometryAlignment.bottomRightDirection color end
Background Image
backgroundImageStringnullBackground tab image
backgroundImageFitBoxFitBoxFit.coverBackground tab image fit
backgroundOpacitydouble0.5Background tab image filter opacity
backgroundOpacityColorColorColors.blackBackground tab image filter color
backgroundBlendModeBlendModeBlendMode.darkenBackground tab image filter blend mode

IntroSlider widget properties

NameTypeDefaultDescription
Slide
slidesSlideNo default, require if listCustomTabs not definedAn array of Slide object
Skip Button
renderSkipBtnWidgetButton with text SKIPRender your own SKIP button
widthSkipBtndouble1/4 screen widthWidth of view wrapper SKIP button
onSkipPressFunctionGo to last pageFire when press SKIP button
nameSkipBtnString"SKIP"Change SKIP to any text you want
styleSkipBtnTextStyleWhite colorStyle for text at SKIP button
colorSkipBtnColortransparentColor for SKIP button
highlightColorSkipBtnColorColor(0x4dffffff)Color for SKIP button when press
showSkipBtnbooltrueShow or hide SKIP button
borderRadiusSkipBtndouble30.0Rounded SKIP button
Prev Button
renderPrevBtnWidgetButton with text PREVRender your own PREV button
widthPrevBtndouble1/4 screen widthWidth of view wrapper PREV button
namePrevBtnString"PREV"Change PREV to any text you want
stylePrevBtnTextStyleWhite colorStyle for text at PREV button
colorPrevBtnColortransparentColor for PREV button
highlightColorPrevBtnColorColor(0x4dffffff)Color for PREV button when press
showPrevBtnboolfalseShow or hide PREV button
borderRadiusPrevBtndouble30.0Rounded PREV button
Done Button
renderDoneBtnWidgetButton with text DONERender your own DONE button
widthDoneBtndouble1/4 screen widthWidth of view wrapper DONE button
onDonePressFunctionDo nothingFire when press DONE button
nameDoneBtnString"DONE"Change DONE to any text you want
styleDoneBtnTextStyleWhite colorStyle for text at DONE button
colorDoneBtnColortransparentColor for DONE button
highlightColorDoneBtnColorColor(0x4dffffff)Color for DONE button when press
borderRadiusDoneBtndouble30.0Rounded DONE button
showDoneBtnbooltrueShow or hide DONE button
Next Button (other attributes will have the same<br/>Done button since they are one)
renderNextBtnWidgetButton with text NEXTRender your own NEXT button
nameNextBtnString"NEXT"Change NEXT to any text you want
showNextBtnbooltrueShow or hide NEXT button
Dot Indicator
showDotIndicatorbooltrueShow or hide dot indicator
colorDotColorColor(0x80000000)Color for dot when passive
colorActiveDotColorColor(0xffffffff)Color for dot when active
sizeDotdouble8.0Size of each dot
typeDotAnimation (inactive dots auto have opacity 50%,<br/>dot active has size bigger than 1.5 times )enum dotSliderAnimationDOT_MOVEMENTType dots animation
Tabs
listCustomTabsList<Widget>nullRender your own list tabs (use default tab UI if not defined)
refFuncGoToTabFunctionDo nothingSend the reference of change tab's function,<br/>then we can move to any tab index programmatically
onTabChangeCompletedFunctionDo nothingCallback when tab change comleted, return the current tab's index
backgroundColorAllSlidesColorTransparentBackground color for all slides
Behavior
isScrollablebooltrueForce button-only scrolling
scrollPhysicsScrollPhysicsScrollPhysics()Determines the physics horizontal scroll for the slide
verticalScrollbarBehaviorenum scrollbarBehaviorHIDEAllow to specify how the vertical scrollbar should behave
hideStatusBarboolfalseShow or hide the status bar

Pull request and feedback are always appreciated

Libraries

dot_animation_enum
intro_slider
list_rtl_language
scrollbar_behavior_enum
slide_object