Skip to content

Commit 14f4268

Browse files
domrichmadoar
authored andcommitted
Fixed module import in readme (#51)
* fixed module import * fixed further flaws in the readme
1 parent 0c04eac commit 14f4268

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ $ npm install --save ng2-archwizard
2727

2828
Afterwards you can import `ng2-archwizard` in your angular project by adding the `ArchwizardModule` to your Module declaration as followed:
2929
```typescript
30-
import { WizardModule } from 'ng2-archwizard';
30+
import { ArchwizardModule } from 'ng2-archwizard';
3131

3232
@NgModule({
3333
imports: [
@@ -106,7 +106,7 @@ for each step of your wizard, in the navigation bar, if such a symbol has been d
106106
#### \[defaultStepIndex\]
107107
Per default the wizard always starts with the first wizard step, after initialisation. The same applies for a reset, where the wizard normally resets to the first step.
108108
Sometimes this needs to be changed. If another default wizard step needs to be used, you can set it, by using the `[defaultStepIndex]` input of the wizard component.
109-
For example, to start the wizard in the second step, `defaultStepIndex="2"` can to be set.
109+
For example, to start the wizard in the second step, `defaultStepIndex="2"` needs to be set.
110110

111111
#### \[disableNavigationBar\]
112112
Sometimes it may be necessary to disable navigation via the navigation bar.
@@ -172,7 +172,7 @@ It then returns true, when the step change should succeed and false otherwise.
172172
If you have an additional check or validation you need to perform to decide, if the step can be exited (both to the next step and to the previous step),
173173
you can either pass a boolean or a function, taking a `MovingDirection` enum and returning a boolean or a `Promise<boolean>`, to the `[canExit]` attribute of the wizard step.
174174
This boolean, or function, is taken into account, when an operation has been performed, which leads to a transition of the current step.
175-
If `[canExit]` has been bound to a boolean, it needs to be true to leave the step either in both a forwards and backwards direction.
175+
If `[canExit]` has been bound to a boolean, it needs to be true to leave the step in either direction (foreward AND backward).
176176
If only exiting in one direction should be covered, you can pass a function, taking a `MovingDirection` and returning a boolean, to `[canExit]`.
177177
This function will then be called whenever an operation has been performed, that leads to a change of the current step.
178178

@@ -185,9 +185,9 @@ If you need to call a function to do some initialisation work before entering a
185185

186186
This leads to the calling of the `enterSecondStep` function when the wizard moves to this step.
187187
When the first step of the wizard contains a `stepEnter` function, it not only gets called
188-
when the used moves back from a later step to the first step, but also after the wizard is initialized.
188+
when the user moves back from a later step to the first step, but also after the wizard is initialized.
189189
The event emitter will call the given function with a parameter that contains the `MovingDirection` of the user.
190-
If the user went backwards, like from the third step to the second or first step, then `MovingDirection.Backwards` will be passed to the function.
190+
If the user went backwards, for example from the third step to the second or first step, then `MovingDirection.Backwards` will be passed to the function.
191191
If the user went forwards `MovingDirection.Forwards` will be passed to the function.
192192

193193
#### \(stepExit\)
@@ -252,7 +252,7 @@ Possible `enableBackLinks` parameters:
252252
### \[wizardStepTitle\]
253253
Sometimes it's not enough to define a title with the `stepTitle` attribute in `<wizard-step>` and `<wizard-completion-step>`.
254254
One example for such a case is, if the title should be written in another font.
255-
Another example would be if it's desired that the title should be choosen depending on the available width of your screen or window.
255+
Another example would be if it's desired that the title should be chosen depending on the available width of your screen or window.
256256
In such cases you may want to specify the html for the title of a wizard step yourself.
257257
This can be achieved by using the `[wizardStepTitle]` directive inside a wizard step on a `ng-template` component.
258258

@@ -362,7 +362,7 @@ This listener will automatically change the currently selected wizard step to th
362362
```
363363

364364
#### \(finalize\)
365-
Like both the `goToStep` and `nextStep` directives the `previousStep` directives too provides a `preFinalize`, `postFinalize` and `finalize` output, which are called every time
365+
Like both the `goToStep` and `nextStep` directives the `previousStep` directives provides a `preFinalize`, `postFinalize` and `finalize` output, which are called every time
366366
the current step is successfully exited, by clicking on the element containing the `previousStep` directive.
367367

368368
#### Parameter overview

0 commit comments

Comments
 (0)