@nuxtjs/router-extras

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Circle CI][circle-ci-src]][circle-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]

> Extra add-ons for Nuxt router

Demo:

📖 Release Notes

Features

- Define custom paths for a page
- Define multiple aliases for a single page
- Define multiple params regardless of pages directory structure

Setup

1. Add @nuxtjs/router-extras dependency to your project

``bash
yarn add --dev @nuxtjs/router-extras # or npm install --save-dev @nuxtjs/router-extras
`

2. Add @nuxtjs/router-extras to the buildModules section of nuxt.config.js

:warning: If you are using Nuxt < 2.9.0, use modules instead.

`js
{
buildModules: [
// Simple usage
'@nuxtjs/router-extras',

// With options
['@nuxtjs/router-extras', { / module options / }]
]
}
`

$3

`js
{
buildModules: [
'@nuxtjs/router-extras'
],
routerExtras: {
/ module options /
}
}
`

Options

$3

- Default: true

Simple aliases will be added as router alias, see vue-router

Usage

$3

Simply add a block inside Vue file and define a path in JavaScript or Yaml

JavaScript

`xml

{
path: '/posts'
}

`

Yaml

`xml

path: /posts

`

$3

If you want more paths for a single page, define them with aliases

JavaScript

`xml

{
path: '/posts',
alias: [
'/articles',
'/blog'
]
}

`

Yaml

`xml

path: /posts
alias:
- /articles
- /blog

`

Aliases can have their own props

JavaScript

`xml

{
path: '/posts',
alias: [
'/articles',
{
path: '/blog',
props: {
section: 'top-posts'
}
}
]
}

`

Yaml

`xml

path: /posts
alias:
- /articles
-
path: /blog
props:
section: top-posts

`

$3

JavaScript

`xml

{
path: '/post/:id/:title?'
}

`

Yaml

`xml

path: /post/:id/:title?

`




$3

JavaScript

`xml

{
namedViews: {
currentView: 'main',
views: {
side: '~/components/side.vue'
},
chunkNames: {
side: 'components/side'
}
}
}

`

Yaml

`xml

namedViews:
currentView: "main"
views:
side: "~/components/side.vue"
chunkNames:
side: "~/components/side.vue"

`

Valid Extras


| Extras | Support | Description |
| ----- | ------- | ----------- |
| path | JS & YAML | Change page URL |
| alias | JS & YAML | Add single or multiple aliases to page, Module supports two types of aliases
- Simple Alias: These aliases are defined as simple strings. If routerNativeAlias is true, simple aliases will be added as router alias, see vue-router docs
- Clone Alias: These aliases are in form of object and they can have their own extras. These aliases will be added as an individual route. They can have their own props and they can have different number of url params |
| meta | JS & YAML | Add Meta information to the page, meta can be used by middlewares |
| name | JS & YAML | Define custom name for route |
| props | JS & YAML | Pass predefined props to page |
| beforeEnter | JS | Define beforeEnter guard for this route, see: Global Before Guards |
| caseSensitive | JS & YAML | Use case sensitive route match (default: false) |
| redirect | JS & YAML | Redirect current page to new location|
| namedViews | JS & YAML | Add named view to the path, see Named Views Support |

Named views support

There is support for named views in nuxt, but it requires the user to write a lot of boilerplate code in the config. The namedViews property in the block allows for a more streamlined configuration

Named views key is a bit different from all other settings. It expects an object with following properties:
- currentView: actual view name for the current component. Defaults to "default", to be rendered in plain
- views: object, where keys are view names and values are component paths. It supports all expected path resolution (~/ and others)
- chunkNames: object, where keys are view names and values are webpack chunks for them. Object structure is expected to be equal to views - all the same keys must be present.

For usage example see example/pages/namedParent.vue and example/pages/namedParent/namedChild.vue.

Syntax Highlighting

$3

Install Vetur extension and define custom block

- Add to vetur.grammar.customBlocks in VSCode settings

`json
"vetur.grammar.customBlocks": {
"docs": "md",
"i18n": "json",
"router": "js"
}
`

- Execute command > Vetur: Generate grammar from vetur.grammar.customBlocks in VSCode
- Restart VSCode and enjoy awesome

$3

- Use Yaml syntax
- Place cursor right after tag
- Right click on cursor and choose "Show context actions"
- Select Inject language or reference
- Select Yaml

Development

- Clone this repository
- Install dependencies using yarn install or npm install
- Start development server using npm run dev`

License

MIT License

Copyright (c) Nuxt Community

[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/router-extras/latest.svg?style=flat-square
[npm-version-href]: https://npmjs.com/package/@nuxtjs/router-extras

[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/router-extras.svg?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/router-extras

[circle-ci-src]: https://img.shields.io/circleci/project/github/nuxt-community/router-extras-module.svg?style=flat-square
[circle-ci-href]: https://circleci.com/gh/nuxt-community/router-extras-module

[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/router-extras-module.svg?style=flat-square
[codecov-href]: https://codecov.io/gh/nuxt-community/router-extras-module

[license-src]: https://img.shields.io/npm/l/@nuxtjs/router-extras.svg?style=flat-square
[license-href]: https://npmjs.com/package/@nuxtjs/router-extras