Skip to content

Commit e796167

Browse files
committed
Readme
1 parent 9cfd3d4 commit e796167

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,23 @@ Using [npm](https://www.npmjs.com/):
3232

3333
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.
3434

35-
#### `<Steps />` Properties
35+
#### Properties
3636

37-
| `total` _integer_ - is the number of steps you want to create.
37+
- `total` _integer_ - is the number of steps you want to create.
3838

3939
<br />
4040

4141
### `<Step />`
4242

4343
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.
4444

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).
4646

4747
```js
4848
<Step persist component={PersistentComponent} />
4949
```
5050

51-
#### `<Step />` Properties
51+
#### Properties
5252

5353
- `order` _integer_ - defines the order of the `Step`. Order numbers must start with `1` and be consecutive.
5454

@@ -106,7 +106,7 @@ Example usage:
106106
<Button prev text="Previous Step">
107107
```
108108

109-
#### `<Button />` Properties
109+
#### Properties
110110

111111
- `text` _String_ - is the text that will button render.
112112
- `prev` _Boolean_ - gives the button 'Go to Previous Step' functionality. Disabled in the first step.
@@ -128,7 +128,7 @@ Example usages:
128128
<Navigation active="active-class-name" visited="visited-class-name" />
129129
```
130130

131-
#### `<Navigation />` Properties
131+
#### Properties
132132

133133
- `text` _String_ - is the text that each button will show, disables `before` and `after` props.
134134
- `before` _String_ - is the text that goes before the step number in the button.

0 commit comments

Comments
 (0)