https://github.com/nuxt-community/router-extras-module
Extra Add-ons For Nuxt 2 Router
https://github.com/nuxt-community/router-extras-module
nuxt-module nuxtjs vue-router
Last synced: 5 months ago
JSON representation
Extra Add-ons For Nuxt 2 Router
- Host: GitHub
- URL: https://github.com/nuxt-community/router-extras-module
- Owner: nuxt-community
- License: mit
- Archived: true
- Created: 2018-08-26T17:21:01.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T21:34:19.000Z (over 1 year ago)
- Last Synced: 2025-01-12T07:06:39.217Z (6 months ago)
- Topics: nuxt-module, nuxtjs, vue-router
- Language: JavaScript
- Homepage: https://codesandbox.io/s/github/nuxt-community/router-extras-module
- Size: 1.3 MB
- Stars: 279
- Watchers: 7
- Forks: 12
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @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 2 router
**Demo**:
[📖 **Release Notes**](./CHANGELOG.md)
## Nuxt 3
Looking for a Nuxt 3 alternative? Use the core composable [definePageMeta](https://nuxt.com/docs/api/utils/define-page-meta#definepagemeta).
Example:
```vue
definePageMeta({
path: '/posts',
alias: ['/articles', '/blog']
})
```
## 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 */ }]
]
}
```
### Using top level options
```js
{
buildModules: [
'@nuxtjs/router-extras'
],
routerExtras: {
/* module options */
}
}
```
## Options
### `routerNativeAlias`
- Default: `true`
Simple aliases will be added as router alias, see [vue-router](https://router.vuejs.org/guide/essentials/redirect-and-alias.html#alias)
## Usage
### Define custom paths for a page
Simply add a block inside Vue file and define a path in JavaScript or [Yaml](https://en.wikipedia.org/wiki/YAML)
JavaScript
```xml
{
path: '/posts'
}
```
Yaml
```xml
path: /posts
```
### Define multiple aliases for single page
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
```
### Define multiple params regardless of pages directory structure
JavaScript
```xml
{
path: '/post/:id/:title?'
}
```
Yaml
```xml
path: /post/:id/:title?
```
### Define named views for the page
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](https://router.vuejs.org/guide/essentials/redirect-and-alias.html#alias)
- **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](https://router.vuejs.org/guide/advanced/navigation-guards.html#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) |
## Named views support
There is support for [named views in nuxt](https://nuxtjs.org/guide/routing#named-views), 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
### Visual Studio Code
Install [Vetur](https://vuejs.github.io/vetur/) extension and define [custom block](https://vuejs.github.io/vetur/highlighting.html#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
### PhpStorm/WebStorm
- Place cursor right after tag
- Right click on cursor and choose "Show context actions"
- Select Inject language or reference
- Select "JSON5" for JavaScript or "Yaml" for YAML
## Development
- Clone this repository
- Install dependencies using `yarn install` or `npm install`
- Start development server using `npm run dev`
## License
[MIT License](./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