Getting started with Flutter Range Slider (SfRangeSlider)

4 May 202121 minutes to read

This section explains the steps required to add the range slider widget and its elements such as numeric and date values, ticks, labels and tooltips. This section covers only basic features needed to know to get started with Syncfusion range slider.

Add Flutter range slider to an application

Create a simple project using the instructions given in the Getting Started with your first Flutter app documentation.

Add dependency

Add the Syncfusion Flutter range slider dependency to your pubspec.yaml file.

  • dart
  • dependencies:
    
    syncfusion_flutter_sliders: ^xx.x.xx

    NOTE

    Here xx.x.xx denotes the current version of Syncfusion Flutter Sliders package.

    Get packages

    Run the following command to get the required packages.

  • dart
  • $ flutter pub get

    Import package

    Import the following package in your Dart code.

    import 'package:syncfusion_flutter_sliders/sliders.dart';

    Initialize range slider

    After importing the package, initialize the range slider widget as a child of any widget. Here, the range slider widget is added as a child of the Container widget. The default value of the min and max properties of the SfRangeSlider is 0.0 and 1.0 respectively. So, the values property must be given within the range.

    NOTE

    The range slider passes the new values to the onChanged callback but does not change its state until the parent widget rebuilds the range slider with new values.

    Horizontal

    SfRangeValues _values = const SfRangeValues(0.3, 0.7);
    
    @override
    Widget build(BuildContext context) {
      return MaterialApp(
          home: Scaffold(
              body: Center(
                  child: Container(
                      child: SfRangeSlider(
                        values: _values,
                        onChanged: (dynamic values){
                          setState(() {
                            _values = values;
                          });
                        },
                      )
                  )
              )
          )
      );
    }

    Default range slider

    Vertical

    SfRangeValues _values = const SfRangeValues(0.3, 0.7);
    
    @override
    Widget build(BuildContext context) {
      return MaterialApp(
          home: Scaffold(
              body: Center(
                  child: Container(
                      child: SfRangeSlider.vertical(
                        values: _values,
                        onChanged: (dynamic values){
                          setState(() {
                            _values = values;
                          });
                        },
                      )
                  )
              )
          )
      );
    }

    Default range slider

    Handle range change

    The onChanged callback is used to get the current value of the range slider when the user selects a value through interaction.

    NOTE

    The range slider passes the new values to the callback but does not change its state until the parent widget rebuilds the range slider with new values.

    Horizontal

    SfRangeValues _values = SfRangeValues(3.0, 7.0);
    
    @override
    Widget build(BuildContext context) {
      return MaterialApp(
          home: Scaffold(
              body: Center(
                  child: SfRangeSlider(
                        min: 0.0,
                        max: 10.0,
                        values: _values,
                        onChanged: (SfRangeValues newValues) {
                           setState(() {
                               _values = newValues;
                            });
                       },
                  )
              )
          )
      );
    }

    Handle range slider

    Vertical

    SfRangeValues _values = SfRangeValues(3.0, 7.0);
    
    @override
    Widget build(BuildContext context) {
      return MaterialApp(
          home: Scaffold(
              body: Center(
                  child: SfRangeSlider.vertical(
                        min: 0.0,
                        max: 10.0,
                        values: _values,
                        onChanged: (SfRangeValues newValues) {
                           setState(() {
                               _values = newValues;
                            });
                       },
                  )
              )
          )
      );
    }

    Handle range slider

    Set numeric range

    You can show numeric values in the range slider by setting double values to the min, max and values properties.

    Horizontal

    final double _min = 0;
    final double _max = 100;
    SfRangeValues _values = const SfRangeValues(40.0, 60.0);
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
            child: SfRangeSlider(
              min: _min,
              max: _max,
              values: _values,
              interval: 20,
              showLabels: true,
              onChanged: (SfRangeValues value) {
                setState(() {
                  _values = value;
                });
              },
            ),
          ),
        ),
      );
    }

    Numeric range slider

    Vertical

    final double _min = 0;
    final double _max = 100;
    SfRangeValues _values = const SfRangeValues(40.0, 60.0);
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
           child: SfRangeSlider.vertical(
                     min: _min,
                     max: _max,
                     values: _values,
                     interval: 20,
                     showLabels: true,
                     onChanged: (SfRangeValues value) {
                       setState(() {
                         _values = value;
                       });
              },
            ),
          ),
        ),
      );
    }

    Numeric range slider

    Set date range

    You can show date values in the range slider by setting DateTime values to the min, max and values properties.

    NOTE

    You must import intl package for formatting date range slider using the DateFormat class.

    Horizontal

    DateTime _min = DateTime(2008, 01, 01);
    DateTime _max = DateTime(2018, 01, 01);
    SfRangeValues _values = SfRangeValues(DateTime(2012, 01, 01), DateTime(2014, 01, 01));
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
            child: SfRangeSlider(
              min: _min,
              max: _max,
              values: _values,
              interval: 2,
              showLabels: true,
              dateIntervalType: DateIntervalType.years,
              dateFormat: DateFormat.y(),
              onChanged: (SfRangeValues value) {
                setState(() {
                  _values = value;
                });
              },
            ),
          ),
        ),
      );
    }

    DateTime range slider

    Vertical

    DateTime _min = DateTime(2008, 01, 01);
    DateTime _max = DateTime(2018, 01, 01);
    SfRangeValues _values = SfRangeValues(DateTime(2012, 01, 01), DateTime(2014, 01, 01));
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
            child: SfRangeSlider.vertical(
              min: _min,
              max: _max,
              values: _values,
              interval: 2,
              showLabels: true,
              dateIntervalType: DateIntervalType.years,
              dateFormat: DateFormat.y(),
              onChanged: (SfRangeValues value) {
                setState(() {
                  _values = value;
                });
              },
            ),
          ),
        ),
      );
    }

    DateTime range slider

    Enable ticks

    You can enable ticks in the range slider using the showTicks property.

    Horizontal

    final double _min = 0;
    final double _max = 100;
    SfRangeValues _values = const SfRangeValues(40.0, 60.0);
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
            child: SfRangeSlider(
              min: _min,
              max: _max,
              values: _values,
              interval: 20,
              showTicks: true,
              showLabels: true,
              onChanged: (SfRangeValues value) {
                setState(() {
                  _values = value;
                });
              },
            ),
          ),
        ),
      );
    }

    Numeric range slider

    Vertical

    final double _min = 0;
    final double _max = 100;
    SfRangeValues _values = const SfRangeValues(40.0, 60.0);
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
            child: SfRangeSlider.vertical(
              min: _min,
              max: _max,
              values: _values,
              interval: 20,
              showTicks: true,
              showLabels: true,
              onChanged: (SfRangeValues value) {
                setState(() {
                  _values = value;
                });
              },
            ),
          ),
        ),
      );
    }

    Numeric range slider

    Add prefix/suffix to labels

    You can add prefix or suffix to the labels using the numberFormat or dateFormat properties.

    NOTE

    The format type (numeric or date) of the range slider is determined based on the values specified in min, max and values properties.

    IMPORTANT

    You must import intl package for formatting date range slider using the DateFormat class and for formatting numeric range slider using the NumberFormat class.

    Horizontal

    final double _min = 0;
    final double _max = 100;
    SfRangeValues _values = const SfRangeValues(40.0, 60.0);
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
            child: SfRangeSlider(
              min: _min,
              max: _max,
              values: _values,
              interval: 20,
              showTicks: true,
              showLabels: true,
              numberFormat: NumberFormat("\$"),
              onChanged: (SfRangeValues value) {
                setState(() {
                  _values = value;
                });
              },
            ),
          ),
        ),
      );
    }

    Format label

    Vertical

    final double _min = 0;
    final double _max = 100;
    SfRangeValues _values = const SfRangeValues(40.0, 60.0);
    
    @override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: Container(
            child: SfRangeSlider.vertical(
              min: _min,
              max: _max,
              values: _values,
              interval: 20,
              showTicks: true,
              showLabels: true,
              numberFormat: NumberFormat("\$"),
              onChanged: (SfRangeValues value) {
                setState(() {
                  _values = value;
                });
              },
            ),
          ),
        ),
      );
    }

    Format label