Skip to content

Commit ccad2de

Browse files
authored
Fix some Issues in the README file (#273)
- mark string values by adding ' around them - fix some indentation issues - fix some issues that were found by Codacy in the README.md file - add new lines between list items
1 parent a3ad9a1 commit ccad2de

File tree

1 file changed

+44
-43
lines changed

1 file changed

+44
-43
lines changed

README.md

Lines changed: 44 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,13 @@ Disabling the navigation bar doesn't restrict the use of elements (buttons or li
136136
#### Parameter overview
137137
Possible `<aw-wizard>` parameters:
138138

139-
| Parameter name | Possible Values | Default Value |
140-
| ------------------------ | ----------------------------------------------------------------------------------------------------- | ------------- |
141-
| `[navBarLocation]` | `top` \| `bottom` \| `left` \| `right` | top |
142-
| `[navBarLayout]` | `small` \| `large-filled` \| `large-empty` \| `large-filled-symbols` \| `large-empty-symbols` | small |
143-
| `[navBarDirection]` | `left-to-right` \| `right-to-left` | left-to-right |
144-
| `[defaultStepIndex]` | `number` | 0 |
145-
| `[disableNavigationBar]` | `boolean` | false |
139+
| Parameter name | Possible Values | Default Value |
140+
| ------------------------ | ------------------------------------------------------------------------------------------------------- | ----------------- |
141+
| `[navBarLocation]` | `'top'` \| `'bottom'` \| `'left'` \| `'right'` | `'top'` |
142+
| `[navBarLayout]` | `'small'` \| `'large-filled'` \| `'large-empty'` \| `'large-filled-symbols'` \| `'large-empty-symbols'` | `'small'` |
143+
| `[navBarDirection]` | `'left-to-right'` \| `'right-to-left'` | `'left-to-right'` |
144+
| `[defaultStepIndex]` | `number` | `0` |
145+
| `[disableNavigationBar]` | `boolean` | `false` |
146146

147147
### \<aw-wizard-step\>
148148
`angular-archwizard` contains two ways to define a wizard step.
@@ -319,9 +319,10 @@ my.component.html:
319319

320320
Instead of implementing the `NavigationMode` interface from scratch, you can extend one of the classes provided by `angular-archwizard`:
321321

322-
- `BaseNavigationMode`. This class contains an abstract method called `isNavigable`, which you will have to override to define wizard's behavior towards navigation using the navigation bar.
322+
- `BaseNavigationMode`: This class contains an abstract method called `isNavigable`, which you will have to override to define wizard's behavior towards navigation using the navigation bar.
323323

324-
- `ConfigurableNavigationMode`. This class defines the default navigation mode used by `angular-archwizard`. In some cases, it might be more convenient to base your custom implementation on it.
324+
- `ConfigurableNavigationMode`: This class defines the default navigation mode used by `angular-archwizard`.
325+
In some cases, it might be more convenient to base your custom implementation on it.
325326

326327
This way of customizing the wizard is advanced, so be prepared to refer to documentation comments and source code for help.
327328

@@ -351,7 +352,6 @@ Possible `awEnableBackLinks` parameters:
351352
| ----------------------------- | ---------------------------------------------------------------------------------------------------- | ------------- |
352353
| `(stepExit)` | `function(MovingDirection): void` | `null` |
353354

354-
355355
### \[awWizardStepTitle\]
356356
Sometimes it's not enough to define a title with the `stepTitle` attribute in `<aw-wizard-step>` and `<aw-wizard-completion-step>`.
357357
One example for such a case is, if the title should be written in another font.
@@ -387,7 +387,7 @@ In such a case, the the navigation symbol can be specified using the `[awWizardS
387387
```html
388388
<aw-wizard-step (stepEnter)="enterStep($event)">
389389
<ng-template awWizardStepSymbol>
390-
// use <i class="fa fa-file"></i> for fontawesome version 4
390+
<!-- use <i class="fa fa-file"></i> for fontawesome version 4 -->
391391
<i class="far fa-file"></i>
392392
</ng-template>
393393
</aw-wizard-step>
@@ -399,9 +399,9 @@ This for example allows customization of the navigation symbol depending on the
399399
```html
400400
<aw-wizard-step (stepEnter)="enterStep($event)">
401401
<ng-template awWizardStepSymbol let-wizardStep="wizardStep">
402-
// use <i *ngIf="!wizardStep.completed" class="fa fa-file"></i> for fontawesome version 4
402+
<!-- use <i *ngIf="!wizardStep.completed" class="fa fa-file"></i> for fontawesome version 4 -->
403403
<i *ngIf="!wizardStep.completed" class="far fa-file"></i>
404-
// use <i *ngIf="wizardStep.completed" class="fa fa-check"></i> for fontawesome version 4
404+
<!-- use <i *ngIf="wizardStep.completed" class="fa fa-check"></i> for fontawesome version 4 -->
405405
<i *ngIf="wizardStep.completed" class="far fa-check"></i>
406406
</ng-template>
407407
</aw-wizard-step>
@@ -468,34 +468,35 @@ when the element with the `awGoToStep` directive has been clicked.
468468

469469
This input accepts different arguments:
470470

471-
- a destination **step index**:
472-
One possible argument for the input is a destination step index.
473-
A destination step index is always zero-based, i.e. the index of the first step inside the wizard
474-
is always zero.
471+
- a destination **step index**:
472+
One possible argument for the input is a destination step index.
473+
A destination step index is always zero-based, i.e. the index of the first step inside the wizard is always zero.
474+
475+
To pass a destination step index to an `awGoToStep` directive,
476+
you need to pass the following json object to the directive:
477+
478+
```html
479+
<button [awGoToStep]="{ stepIndex: 2 }" (finalize)="finalizeStep()">Go directly to the third Step</button>
480+
```
475481

476-
To pass a destination step index to an `awGoToStep` directive,
477-
you need to pass the following json object to the directive:
482+
- a destination **step id**:
483+
Another possible argument for the input is a the unique step id of the destination step.
484+
This step id can be set for all wizard steps through their input `[stepId]`.
478485

479-
```html
480-
<button [awGoToStep]="{ stepIndex: 2 }" (finalize)="finalizeStep()">Go directly to the third Step</button>
481-
```
482-
- a destination **step id**:
483-
Another possible argument for the input is a the unique step id of the destination step.
484-
This step id can be set for all wizard steps through their input `[stepId]`.
486+
To pass a unique destination step id to an `awGoToStep` directive,
487+
you need to pass the following json object to the directive:
485488

486-
To pass a unique destination step id to an `awGoToStep` directive,
487-
you need to pass the following json object to the directive:
489+
```html
490+
<button [awGoToStep]="{ stepId: 'unique id of the third step' }" (finalize)="finalizeStep()">Go directly to the third Step</button>
491+
```
488492

489-
```html
490-
<button [awGoToStep]="{ stepId: 'unique id of the third step' }" (finalize)="finalizeStep()">Go directly to the third Step</button>
491-
```
492-
- a **step offset** between the current step and the destination step:
493-
Alternatively to an absolute step index or an unique step id,
494-
it's also possible to set the destination wizard step as an offset to the source step:
493+
- a **step offset** between the current step and the destination step:
494+
Alternatively to an absolute step index or an unique step id,
495+
it's also possible to set the destination wizard step as an offset to the source step:
495496

496-
```html
497-
<button [awGoToStep]="{ stepOffset: 1 }" (finalize)="finalizeStep()">Go to the third Step</button>
498-
```
497+
```html
498+
<button [awGoToStep]="{ stepOffset: 1 }" (finalize)="finalizeStep()">Go to the third Step</button>
499+
```
499500

500501
In all above examples a click on the "Go to the third Step" button will move
501502
the user to the next step (the third step) compared to the step the button belongs to (the second step).
@@ -675,7 +676,7 @@ Sometimes you like to use your own custom CSS for some parts of the wizard like
675676
This is quite easy to do.
676677
Different ways are possible:
677678

678-
1. Either use a wrapper around the wizard:
679+
1. Either use a wrapper around the wizard:
679680
```html
680681
<div class="my-custom-css-wrapper">
681682
<aw-wizard>
@@ -684,7 +685,7 @@ Different ways are possible:
684685
</div>
685686
```
686687

687-
2. Or add your css wrapper class directly to the wizard element:
688+
2. Or add your css wrapper class directly to the wizard element:
688689
```html
689690
<aw-wizard class="my-custom-css-wrapper">
690691
...
@@ -693,9 +694,8 @@ Different ways are possible:
693694

694695
When overriding css properties already defined in the existing navigation bar layouts, it is required to use `!important`.
695696
In addition it is required to add `encapsulation: ViewEncapsulation.None` to the component, that defines the wizard and overrides its layout.
696-
For additional information about how to write your own navigation bar please take a look at the existing navigation bar layouts, which can be found at
697-
https://github.com/madoar/angular-archwizard/blob/master/src/components/wizard-navigation-bar.component.horizontal.less and
698-
https://github.com/madoar/angular-archwizard/blob/master/src/components/wizard-navigation-bar.component.vertical.less.
697+
For additional information about how to write your own navigation bar please take a look at the existing navigation bar layouts, which can be found in the
698+
[https://github.com/madoar/angular-archwizard/blob/develop/src/css/wizard-navigation-bar.scss](wizard-navigation-bar.scss) file.
699699

700700
### Working with dynamically inserted and removed steps
701701
In some cases it may be required to remove or insert one or multiple steps after the wizard initialization,
@@ -724,8 +724,9 @@ invalid state, which may lead to strange and unexpected behavior.
724724

725725
If you are using SCSS, you can customize the wizard's global styles and color theme using SCSS variables:
726726

727-
1. Import `node_modules/angular-archwizard/archwizard.scss` into your `styles.scss` file as described in the [Installation](#installation) section.
728-
2. Re-define any of the variables you can find at the top of `node_modules/angular-archwizard/variables.scss`.
727+
1. Import `node_modules/angular-archwizard/archwizard.scss` into your `styles.scss` file as described in the [Installation](#installation) section.
728+
729+
2. Re-define any of the variables you can find at the top of `node_modules/angular-archwizard/variables.scss`.
729730

730731
In the following example, we configure a simple color theme which only defines styles for two step states: 'default' and 'current'.
731732

0 commit comments

Comments
 (0)