You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,23 +32,23 @@ Using [npm](https://www.npmjs.com/):
32
32
33
33
This is the wrapper component. You must define every step component under `<Steps />` component. It takes `total` as a prop which must match the number of `Step` components inside.
34
34
35
-
#### `<Steps />`Properties
35
+
#### Properties
36
36
37
-
|`total`_integer_ - is the number of steps you want to create.
37
+
-`total`_integer_ - is the number of steps you want to create.
38
38
39
39
<br />
40
40
41
41
### `<Step />`
42
42
43
43
This is the component you create for each `step` in your application. It takes `order` prop for ordering the steps in the flow. `Step` that has `order={1}` prop renders default. The `component` prop takes the component that you would like to show in that step.
44
44
45
-
-If you would like to create a persistent component that appears in every `Step`, you must remove the `order` prop and pass `persist` as a prop to a `Step` component. It is recommended to have that persistent step either in the beginning of the steps or at the end depending on where would you like to render that component (top or bottom).
45
+
If you would like to create a persistent component that appears in every `Step`, you must remove the `order` prop and pass `persist` as a prop to a `Step` component. It is recommended to have that persistent step either in the beginning of the steps or at the end depending on where would you like to render that component (top or bottom).
46
46
47
47
```js
48
48
<Step persist component={PersistentComponent} />
49
49
```
50
50
51
-
#### `<Step />`Properties
51
+
#### Properties
52
52
53
53
-`order`_integer_ - defines the order of the `Step`. Order numbers must start with `1` and be consecutive.
54
54
@@ -106,7 +106,7 @@ Example usage:
106
106
<Button prev text="Previous Step">
107
107
```
108
108
109
-
#### `<Button />`Properties
109
+
#### Properties
110
110
111
111
-`text`_String_ - is the text that will button render.
112
112
-`prev`_Boolean_ - gives the button 'Go to Previous Step' functionality. Disabled in the first step.
0 commit comments