Skip to content

Commit 62a9ec1

Browse files
authored
Replace ng2-archwizard with angular-archwizard (#112)
- replace ng2-archwizard with angular-archwizard - remove unneeded letter from readme
1 parent 63eddaa commit 62a9ec1

File tree

3 files changed

+26
-26
lines changed

3 files changed

+26
-26
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Overview ng2-archwizard
1+
# Overview angular-archwizard (previously known as ng2-archwizard)
22

3-
[![Build Status](https://travis-ci.org/madoar/ng2-archwizard.svg?branch=master)](https://travis-ci.org/madoar/ng2-archwizard)
4-
[![Dependency Status](https://david-dm.org/madoar/ng2-archwizard.svg)](https://david-dm.org/madoar/ng2-archwizard)
5-
[![Dev-Dependency Status](https://david-dm.org/madoar/ng2-archwizard/dev-status.svg)](https://david-dm.org/madoar/ng2-archwizard?type=dev)
6-
[![Dependency Licence Status](https://dependencyci.com/github/madoar/ng2-archwizard/badge)](https://dependencyci.com/github/madoar/ng2-archwizard)
7-
[![Code Climate](https://codeclimate.com/github/madoar/ng2-archwizard/badges/gpa.svg)](https://codeclimate.com/github/madoar/ng2-archwizard)
8-
[![Test Coverage](https://codeclimate.com/github/madoar/ng2-archwizard/badges/coverage.svg)](https://codeclimate.com/github/madoar/ng2-archwizard/coverage)
9-
[![NPM Version](https://img.shields.io/npm/v/ng2-archwizard.svg)](https://www.npmjs.com/package/ng2-archwizard)
3+
[![Build Status](https://travis-ci.org/madoar/angular-archwizard.svg?branch=master)](https://travis-ci.org/madoar/angular-archwizard)
4+
[![Dependency Status](https://david-dm.org/madoar/angular-archwizard.svg)](https://david-dm.org/madoar/angular-archwizard)
5+
[![Dev-Dependency Status](https://david-dm.org/madoar/angular-archwizard/dev-status.svg)](https://david-dm.org/madoar/angular-archwizard?type=dev)
6+
[![Dependency Licence Status](https://dependencyci.com/github/madoar/angular-archwizard/badge)](https://dependencyci.com/github/madoar/angular-archwizard)
7+
[![Code Climate](https://codeclimate.com/github/madoar/angular-archwizard/badges/gpa.svg)](https://codeclimate.com/github/madoar/angular-archwizard)
8+
[![Test Coverage](https://codeclimate.com/github/madoar/angular-archwizard/badges/coverage.svg)](https://codeclimate.com/github/madoar/angular-archwizard/coverage)
9+
[![NPM Version](https://img.shields.io/npm/v/angular-archwizard.svg)](https://www.npmjs.com/package/angular-archwizard)
1010

1111
This project contains a functional module with a wizard component and some supportive components and directives for [Angular](https://angular.io/).
1212

@@ -20,14 +20,14 @@ Run `npm test` to execute the unit tests via [Karma](https://karma-runner.github
2020

2121
## Installation
2222

23-
`ng2-archwizard` is available as an NPM package. To install `ng2-archwizard` in your project directory run:
23+
`angular-archwizard` is available as a NPM package. To install `angular-archwizard` in your project directory run:
2424
```
25-
$ npm install --save ng2-archwizard
25+
$ npm install --save angular-archwizard
2626
```
2727

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

3232
@NgModule({
3333
imports: [
@@ -64,7 +64,7 @@ To use this wizard component in an angular project simply add a `aw-wizard` comp
6464

6565
### \<aw-wizard\>
6666
The `<aw-wizard>` environment is the environment, in which you define the steps belonging to your wizard.
67-
In addition to the contained wizard steps, `ng2-archwizard` enables you to define the location and the layout of the navigation bar inside your wizard.
67+
In addition to the contained wizard steps, `angular-archwizard` enables you to define the location and the layout of the navigation bar inside your wizard.
6868
To set the location, the layout of the navigation bar and many other settings, you can pass the following parameters to the `aw-wizard` component:
6969

7070
#### \[navBarLocation\]
@@ -89,7 +89,7 @@ In some cases, like with languages that are written from right to left, it may b
8989
To layout the steps from right to left you can pass `right-to-left` to the `navBarDirection` input of the wizard component.
9090

9191
#### \[navigationMode\]
92-
`ng2-archwizard` supports three different navigation modes:
92+
`angular-archwizard` supports three different navigation modes:
9393
- **strict** navigation mode:
9494
The first navigation mode is strict navigation.
9595
This mode describes the status quo, i.e. the current navigation behavior of the wizard.
@@ -135,7 +135,7 @@ Possible `<aw-wizard>` parameters:
135135
| [disableNavigationBar] | `boolean` | false |
136136

137137
### \<aw-wizard-step\>
138-
`ng2-archwizard` contains two ways to define a wizard step.
138+
`angular-archwizard` contains two ways to define a wizard step.
139139
One of these two ways is by using the `<aw-wizard-step>` component.
140140

141141
#### \[stepId\]
@@ -148,7 +148,7 @@ To set the title of a step, add the `stepTitle` input attribute, with the choose
148148

149149
#### \[navigationSymbol\]
150150
Sometimes it's useful to add a symbol in the center of the circle in the navigation bar, which belongs to the step.
151-
`ng2-archwizard` supports this through the `[navigationSymbol]` input attribute of the wizard step.
151+
`angular-archwizard` supports this through the `[navigationSymbol]` input attribute of the wizard step.
152152

153153
Be aware, that not all layouts display the symbols.
154154
Only the layouts `large-filled-symbols` and `large-empty-symbols` display the symbols!
@@ -291,7 +291,7 @@ When attaching the `awSelectedStep` directive to an arbitrary wizard step, it wi
291291
which is shown directly after the wizard startup.
292292

293293
### \[awGoToStep\]
294-
`ng2-archwizard` has three directives, which allow moving between steps.
294+
`angular-archwizard` has three directives, which allow moving between steps.
295295
These directives are the `awPreviousStep`, `asNextStep` and `awGoToStep` directives.
296296

297297
The `awGoToStep` directive needs to receive an input, which tells the wizard, to which step it should navigate,
@@ -509,8 +509,8 @@ Different ways are possible:
509509
When overriding css properties already defined in the existing navigation bar layouts, it is required to use `!important`.
510510
In addition it is required to add `encapsulation: ViewEncapsulation.None` to the component, that defines the wizard and overrides its layout.
511511
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
512-
https://github.com/madoar/ng2-archwizard/blob/master/src/components/wizard-navigation-bar.component.horizontal.less and
513-
https://github.com/madoar/ng2-archwizard/blob/master/src/components/wizard-navigation-bar.component.vertical.less.
512+
https://github.com/madoar/angular-archwizard/blob/master/src/components/wizard-navigation-bar.component.horizontal.less and
513+
https://github.com/madoar/angular-archwizard/blob/master/src/components/wizard-navigation-bar.component.vertical.less.
514514

515515
### Working with dynamically inserted and removed steps
516516
In some cases it may be required to remove or insert one or multiple steps after the wizard initialization,
@@ -536,6 +536,6 @@ Please be also sure to not remove the step, the wizard is currently displaying,
536536
invalid state, which may lead to strange and unexpected behavior.
537537

538538
## Example
539-
You can find an basic example project using `ng2-archwizard` [here](https://madoar.github.io/ng2-archwizard-demo).
540-
The sources for the example can be found in the [ng2-archwizard-demo](https://github.com/madoar/ng2-archwizard-demo) repository.
539+
You can find an basic example project using `angular-archwizard` [here](https://madoar.github.io/angular-archwizard-demo).
540+
The sources for the example can be found in the [angular-archwizard-demo](https://github.com/madoar/angular-archwizard-demo) repository.
541541
It illustrates how the wizard looks like and how the different settings can change its layout and behavior.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
{
2-
"name": "ng2-archwizard",
2+
"name": "angular-archwizard",
33
"version": "3.0.0-develop",
44
"license": "MIT",
55
"description": "An angular 2+ module containing a wizard component and its supporting components and directives",
6-
"homepage": "https://github.com/madoar/ng2-archwizard",
6+
"homepage": "https://github.com/madoar/angular-archwizard",
77
"author": {
88
"name": "Marc Arndt",
99
"email": "[email protected]"
1010
},
1111
"repository": {
1212
"type": "git",
13-
"url": "https://github.com/madoar/ng2-archwizard"
13+
"url": "https://github.com/madoar/angular-archwizard"
1414
},
1515
"bugs": {
16-
"url": "https://github.com/madoar/ng2-archwizard/issues"
16+
"url": "https://github.com/madoar/angular-archwizard/issues"
1717
},
1818
"keywords": [
1919
"angular",

src/archwizard.module.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {SelectedStepDirective} from './directives/selected-step.directive';
1818
import {ResetWizardDirective} from './directives/reset-wizard.directive';
1919

2020
/**
21-
* The module defining all the content inside `ng2-archwizard`
21+
* The module defining all the content inside `angular-archwizard`
2222
*
2323
* @author Marc Arndt
2424
*/

0 commit comments

Comments
 (0)