@ngrx/router-store

WebJar for @ngrx/router-store

License	MIT
GroupId	org.webjars.npm
ArtifactId	ngrx__router-store
Last Version	1.2.5
Release Date	Feb 20, 2017
Type	jar
Description	@ngrx/router-store WebJar for @ngrx/router-store
Project URL	http://webjars.org
Source Code Management	https://github.com/ngrx/router-store

Download ngrx__router-store

Filename	Size
ngrx__router-store-1.2.5.pom
ngrx__router-store-1.2.5.jar	21 KB
ngrx__router-store-1.2.5-sources.jar	22 bytes
ngrx__router-store-1.2.5-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/ngrx__router-store/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>ngrx__router-store</artifactId>
    <version>1.2.5</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/ngrx__router-store/
implementation 'org.webjars.npm:ngrx__router-store:1.2.5'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/ngrx__router-store/
implementation ("org.webjars.npm:ngrx__router-store:1.2.5")

Apache Buildr

'org.webjars.npm:ngrx__router-store:jar:1.2.5'

Apache Ivy

<dependency org="org.webjars.npm" name="ngrx__router-store" rev="1.2.5">
  <artifact name="ngrx__router-store" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='ngrx__router-store', version='1.2.5')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "ngrx__router-store" % "1.2.5"

Leiningen

[org.webjars.npm/ngrx__router-store "1.2.5"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

---

This repository is for version 1.x of of @ngrx/router-store.

Click here for the latest version (4.x)

---

@ngrx/router-store

Bindings to connect angular/router to ngrx/store

Installation

npm install @ngrx/[email protected] --save

Setup

1. Use the routerReducer when providing the StoreModule.provideStore and add the RouterStoreModule.connectRouter to the @NgModule.imports:

import { StoreModule } from '@ngrx/store';
import { routerReducer, RouterStoreModule } from '@ngrx/router-store';

@NgModule({
  imports: [
    BrowserModule,
    StoreModule.provideStore({ router: routerReducer }),
    RouterStoreModule.connectRouter()
  ],
  bootstrap: [ AppComponent ]
})
export class AppModule {
}

2. Add RouterState to main application state:

import { RouterState } from '@ngrx/router-store';

export interface AppState {
  router: RouterState;
};

3. (Optional) Set the initial value for the router state:

StoreModule.provideStore({ router: routerReducer }, {
  router: {
    path: window.location.pathname + window.location.search
  }
})

Dispatching Actions

import { go, replace, search, show, back, forward } from '@ngrx/router-store';

Navigation with a new state into history

store.dispatch(go(['/path', { routeParam: 1 }], { query: 'string' }));

Navigation with replacing the current state in history

store.dispatch(replace(['/path'], { query: 'string' }));

Navigation without pushing a new state into history

store.dispatch(show(['/path'], { query: 'string' }));

Navigation with only changing query parameters

store.dispatch(search({ query: 'string' }));

Navigating back

store.dispatch(back());

Navigating forward

store.dispatch(forward());

Navigation Extras

The Angular Router Navigation Extras are supported with each router action.

import { NavigationExtras } from '@angular/router';

let extras: NavigationExtras = {
  relativeTo: ActivatedRoute,
  fragment: string,
  preserveQueryParams: boolean,
  preserveFragment: boolean,
  skipLocationChange: boolean,
  replaceUrl: boolean
};

store.dispatch(go(['path', { routeParam: 1 }], { query: 'string' }, extras));

ngrx

Reactive Extensions for Angular

Versions

Version
1.2.5 Feb 20, 2017