Skip to content

Commit

Permalink
docs(router): clean up formatting and verbiage of existing documentat…
Browse files Browse the repository at this point in the history
…ion (#3099)
  • Loading branch information
xelaint authored Sep 19, 2024
1 parent c7e8ced commit e39d98d
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions libs/router/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
# @daffodil/router
`@daffodil/router` contains utilities useful for dealing with and adding features to the Angular router.

Contains utilities useful for dealing with and adding features to the Angular router.
## Installation
To install `@daffodil/router`, use the following commands in your terminal.

Install with npm:
```bash
npm install @daffodil/router --save
```

Install with yarn:

```bash
yarn add @daffodil/router
```

## Features

### Route Named Views
Adds the ability to define additional components in a `Route` config:
### Route named views
Route named views adds the ability to define additional components in a `Route` config:

```ts
const routes = [
<DaffRouteWithNamedViews>{
Expand All @@ -20,6 +34,7 @@ const routes = [
```

Each component is associated with a key and can be rendered like so:

```html
<ng-container daffRouterNamedViewOutlet="key"></ng-container>
```

0 comments on commit e39d98d

Please sign in to comment.