router-store - GitLite

KO | EN

gitlite — search

#react #typescript #llm #android #linux #docker #macos #nodejs #java #cli #kubernetes #vue #security #ios

router-store

(★ 182)

Bindings to connect the Angular Router to @ngrx/store

파일 탐색기

최종 버전 다운로드 (.zip)

- actions.spec.ts
- connect.spec.ts
- index.spec.ts
- reducer.spec.ts
- actions.ts
- connect.ts
- reducer.ts
- router-store-module.ts
.gitignore
CHANGELOG.md
circle.yml
index.ts
karma.conf.js
LICENSE
package.json
README.md
rollup.config.js
tests.bundle.ts
tsconfig.dist.json
tsconfig.json
tslint.json
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ngrx/router-store

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd router-store

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install @ngrx/router-store@1.2.6 --save

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

---
# This repository is for version 1.x of of @ngrx/router-store.
# [Click here for the latest version (4.x)](https://github.com/ngrx/platform)
---

# @ngrx/router-store
Bindings to connect angular/router to ngrx/store

[![Join the chat at https://gitter.im/ngrx/store](https://badges.gitter.im/ngrx/store.svg)](https://gitter.im/ngrx/store?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

### Installation

```
  npm install @ngrx/router-store@1.2.6 --save
  ```

### Setup

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

```ts
  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:

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

export interface AppState {
    router: RouterState;
  };
  ```

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

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

### Dispatching Actions

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

#### Navigation with a new state into history

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

#### Navigation with replacing the current state in history

```ts
  store.dispatch(replace(['/path'], { query: 'string' }));
  ```
#### Navigation without pushing a new state into history

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

#### Navigation with only changing query parameters

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

#### Navigating back

```ts
  store.dispatch(back());
  ```

#### Navigating forward

```ts
  store.dispatch(forward());
  ```

### Navigation Extras

The [Angular Router Navigation Extras](https://angular.io/docs/ts/latest/api/router/index/NavigationExtras-interface.html) are supported with each router action.

```ts
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));
```