Skip to content

Commit f08a3ac

Browse files
authored
Stepper component docs (#362)
* docs(stepper):docs sceleton and draft overview * docs(stepper):added orientation, indicators, labels articles * docs(stepper):template and linear flow articles * docs(stepper):validation, state and events articles * docs(stepper):fixes * docs(stepper):final touches * docs(stepper):minor fix * docs(stepper):improvements as per feedback * docs(stepper);minor fix
1 parent 6a490e4 commit f08a3ac

36 files changed

+889
-0
lines changed

_config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,9 @@ navigation:
169169
"*components/panelbar/templates":
170170
title: "Templates"
171171
position: 10
172+
"*components/stepper/steps":
173+
title: "Steps"
174+
position: 3
172175

173176
## List helpers directory names and order here, like this:
174177
"*appearance":
@@ -332,6 +335,8 @@ navigation:
332335
title: "Splitter"
333336
"*stacklayout":
334337
title: "Stack Layout"
338+
"*stepper":
339+
title: "Stepper"
335340
"*stockchart":
336341
title: "Stock Chart"
337342
"*switch":
@@ -394,6 +399,7 @@ intro_columns:
394399
"Pager": "pager-overview"
395400
"ToolBar": "toolbar-overview"
396401
"PanelBar": "panelbar-overview"
402+
"Stepper" : "stepper-overview"
397403

398404
-
399405
title: "Interactivity and UX"

accessibility/keyboard-navigation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ The following list shows the Telerik components that support specific keyboard c
9090

9191
* StackLayout - not applicable, it is a layout container.
9292

93+
* [Stepper](https://demos.telerik.com/blazor-ui/stepper/keyboard-navigation)
94+
9395
* [Switch](https://demos.telerik.com/blazor-ui/switch/keyboard-navigation)
9496

9597
* [TabStrip](https://demos.telerik.com/blazor-ui/tabstrip/keyboard-navigation)
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Display Modes
3+
page_title: Display Modes
4+
description: Display Modes of the Stepper for Blazor.
5+
slug: stepper-display-modes
6+
tags: telerik,blazor,stepper,display,modes
7+
published: True
8+
position: 17
9+
---
10+
11+
# Display Modes
12+
13+
This article explains the Display modes that the Stepper for Blazor provides.
14+
15+
You can configure the desired display mode through the `StepType` parameter of the Stepper. It takes a member of the `StepperStepType` enum:
16+
17+
* [Steps](#steps) (the default)
18+
* [Labels](#labels)
19+
20+
21+
## Steps
22+
23+
The default Display mode of the Stepper is `Steps`. If labels are defined, with this setup the Stepper will render both indicators and labels.
24+
25+
>caption Display mode: Steps, customize the Stepper to render indicators and labels.The result from the snippet.
26+
27+
![Indicators and labels](images/labels-and-indicators-example.png)
28+
29+
````CSHTML
30+
@* Stepper with both labels and indicators. *@
31+
32+
<div style="width:500px">
33+
<TelerikStepper StepType="StepperStepType.Steps">
34+
<StepperSteps>
35+
<StepperStep Label="Personal Info" Icon="user"></StepperStep>
36+
<StepperStep Label="Education" Icon="dictionary-add"></StepperStep>
37+
<StepperStep Label="Experience" Icon="flip-vertical"></StepperStep>
38+
<StepperStep Label="Attachments" Icon="attachment"></StepperStep>
39+
</StepperSteps>
40+
</TelerikStepper>
41+
</div>
42+
````
43+
44+
## Labels
45+
46+
If you want to display only labels for the steps, set the `StepType` parameter of the Stepper to `Labels`.
47+
48+
>caption Display mode: Labels, customize the Stepper to render only labels. The result from the snippet.
49+
50+
![Labels only](images/labels-only-example.png)
51+
52+
````CSHTML
53+
@* Stepper with only labels. *@
54+
55+
<div style="width:500px">
56+
<TelerikStepper StepType="StepperStepType.Labels">
57+
<StepperSteps>
58+
<StepperStep Label="Personal Info" Icon="user"></StepperStep>
59+
<StepperStep Label="Education" Icon="dictionary-add"></StepperStep>
60+
<StepperStep Label="Experience" Icon="flip-vertical"></StepperStep>
61+
<StepperStep Label="Attachments" Icon="attachment"></StepperStep>
62+
</StepperSteps>
63+
</TelerikStepper>
64+
</div>
65+
````
66+
67+
## See Also
68+
69+
* [Live Demo: Stepper Template](https://demos.telerik.com/blazor-ui/stepper/configuration)

components/stepper/events.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Events
3+
page_title: Events
4+
description: Events of the Stepper for Blazor.
5+
slug: stepper-events
6+
tags: telerik,blazor,stepper,events
7+
published: True
8+
position: 25
9+
---
10+
11+
# Stepper Events
12+
13+
This article explains the events available in the Telerik Stepper for Blazor
14+
15+
16+
## ValueChanged
17+
18+
The Telerik Stepper for Blazor supports ValueChanged event. It fires upon every change of the CurrentStepIndex.
19+
20+
<br/>
21+
22+
>caption Handle the ValueChanged event. The result from the snippet.
23+
24+
![ValueChanged example](images/value-changed-example.gif)
25+
26+
````CSHTML
27+
@* Handle ValueChanged event of the Stepper *@
28+
29+
@Result
30+
31+
<TelerikStepper ValueChanged="@ValueChangeHandler">
32+
<StepperSteps>
33+
<StepperStep Text="1" Label="Step 1"></StepperStep>
34+
<StepperStep Text="2" Label="Step 2"></StepperStep>
35+
<StepperStep Text="3" Label="Step 3"></StepperStep>
36+
</StepperSteps>
37+
</TelerikStepper>
38+
39+
@code{
40+
public string Result { get; set; }
41+
42+
public void ValueChangeHandler(int index)
43+
{
44+
Result = "Step index changed. Current step index is: " + index;
45+
}
46+
}
47+
````
48+
49+
## See Also
50+
51+
* [Live Demo: Stepper Events](https://demos.telerik.com/blazor-ui/stepper/events)
5.52 KB
Loading
2.36 KB
Loading
2.02 KB
Loading
4.4 KB
Loading
2.04 KB
Loading
268 KB
Loading

0 commit comments

Comments
 (0)