Widgets 16 | Stepper
In this tutorial, you will learn how to use the Stepper in the flutter.
Before Start
We should create a page to contain our code.
1
import "package:flutter/material.dart";
2
import 'package:flutter_widgets/const/_const.dart';
3
​
4
class StepperPage extends StatefulWidget {
5
@override
6
_StepperState createState() => _StepperState();
7
}
8
​
9
class _StepperState extends State<StepperPage> {
10
@override
11
Widget build(BuildContext context) {
12
return Scaffold(
13
appBar: AppBar(
14
title: Text(PageName.STEPPER),
15
),
16
body: SingleChildScrollView(
17
child: Column(
18
children: <Widget>[
19
//our code.
20
SizedBox(height: 600)
21
],
22
),
23
),
24
);
25
}
26
}
Copied!
It shows an empty page with a title.
Simple Use
When I write this article, I have used some steps to describe our tutorials. In this situation, we can use a stepper to implement this.
1
Container(
2
color: RED,
3
child: Stepper(
4
steps: [
5
Step(
6
title: Text("Start"),
7
content: Text("Before starting, we should create a page."),
8
),
9
Step(
10
title: Text("Constructor"),
11
content: Text("Let's look at its construtor."),
12
),
13
],
14
),
15
),
Copied!
It will show as follows.
Constructor
Let's look at its constructor. The
steps is a list, onStepTapped, onStepContinue, onStepCancel，controlsBuilder are functions. The currentStep is the int. The type is the enum. I will tell the detail of them one by one.1
Stepper({
2
Key key,
3
@required this.steps,
4
this.type = StepperType.vertical,
5
this.currentStep = 0,
6
this.onStepTapped,
7
this.onStepContinue,
8
this.onStepCancel,
9
this.controlsBuilder,
10
})
Copied!
steps
Let's look at the definition of the
steps.1
final List<Step> steps;
Copied!
Its constructor is below.
1
Step({
2
@required this.title,
3
this.subtitle,
4
@required this.content,
5
this.state = StepState.indexed,
6
this.isActive = false,
7
})
Copied!
The
title, subtitle, content are the widgets, the state is an enum.So let's see an example.
1
Widget _steps() => Container(
2
margin: EdgeInsets.only(top: 10),
3
color: GREEN,
4
child: Stepper(
5
steps: [
6
Step(
7
title: Text("First"),
8
subtitle: Text("This is our first article"),
9
content: Text(
10
"In this article, I will tell you how to create a page."),
11
),
12
Step(
13
title: Text("Second"),
14
subtitle: Text("Constructor"),
15
content: Text("Let's look at its construtor."),
16
state: StepState.editing,
17
isActive: true),
18
Step(
19
title: Text("Third"),
20
subtitle: Text("Constructor"),
21
content: Text("Let's look at its construtor."),
22
state: StepState.error),
23
],
24
),
25
);
Copied!
It will show you like this.
type
It has two types, the default value is the
vertical. We use the horizontal in this example.1
Widget _typeStep() => Container(
2
margin: EdgeInsets.only(top: 10),
3
constraints: BoxConstraints.expand(height: 200),
4
color: BLUE_LIGHT,
5
child: Stepper(
6
type: StepperType.horizontal,
7
steps: [
8
Step(
9
title: Text("First"),
10
content: Text("This is our first example."),
11
),
12
Step(
13
title: Text("Second"),
14
content: Text("This is our second example."),
15
),
16
],
17
),
18
);
Copied!
It shows as follows.
onStepTapped¤tStep
In the fore example, when we click the second title, it doesn't show the content of the second. We need some handle.
1
Widget _tabStep() => Container(
2
margin: EdgeInsets.only(top: 10),
3
color: PURPLE,
4
child: Stepper(
5
steps: [
6
Step(
7
title: Text("First"),
8
content: Text("This is our first example."),
9
),
10
Step(
11
title: Text("Second"),
12
content: Text("This is our second example."),
13
),
14
Step(
15
title: Text("Third"),
16
content: Text("This is our third example."),
17
),
18
Step(
19
title: Text("Forth"),
20
content: Text("This is our forth example."),
21
),
22
],
23
currentStep: _index,
24
onStepTapped: (index) {
25
setState(() {
26
_index = index;
27
});
28
},
29
onStepCancel: () {
30
print("You are clicking the cancel button.");
31
},
32
onStepContinue: () {
33
print("You are clicking the continue button.");
34
},
35
),
36
);
Copied!
When you click the third title, it will show as follows.
When you click the
continue or cancel, it will print as follows.1
I/flutter ( 6888): You are clicking the continue button.
2
I/flutter ( 6888): You are clicking the cancel button.
Copied!
controlsBuilder
If you want to custom your own
continue, cancel button, you can use the controlsBuilder to define them. The function is the same as the above. But this time, I will hide these two buttons.1
Widget _builderStep() => Container(
2
margin: EdgeInsets.only(top: 10),
3
color: PURPLE,
4
child: Stepper(
5
steps: [
6
Step(
7
title: Text("First"),
8
content: Text("This is our first example."),
9
),
10
Step(
11
title: Text("Second"),
12
content: Text("This is our second example."),
13
),
14
Step(
15
title: Text("Third"),
16
content: Text("This is our third example."),
17
),
18
Step(
19
title: Text("Forth"),
20
content: Text("This is our forth example."),
21
),
22
],
23
currentStep: _index,
24
onStepTapped: (index) {
25
setState(() {
26
_index = index;
27
});
28
},
29
controlsBuilder: (BuildContext context,
30
{VoidCallback onStepContinue, VoidCallback onStepCancel}) =>
31
Container(),
32
),
33
);
Copied!
It will hide these two buttons.
Conclusion
Today, we have learned the
Stepper. It has many parameters, the most thing you should know that this widget is very special widget. You can learn it when you need time.Thanks for your reading!
The end.
Facebook Page
Twitter
GitHub
Medium
​
​
​
​
​
​
​
​
Last modified 2yr ago