├── README.md ├── package.json ├── nuxt-tags.json ├── LICENSE └── nuxt-attributes.json /README.md: -------------------------------------------------------------------------------- 1 | # nuxt-helper-json 2 | 3 | Information to enhance [Vetur](https://github.com/vuejs/vetur)'s auto completion. 4 | 5 | NPM: https://www.npmjs.com/package/nuxt-helper-json 6 | 7 | ## License 8 | 9 | MIT 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "nuxt-helper-json", 3 | "version": "1.0.0", 4 | "description": "Definitions of Nuxt components", 5 | "main": "nuxt-tags.json", 6 | "keywords": [ 7 | "nuxt", 8 | "nuxtjs", 9 | "vue", 10 | "plugin", 11 | "definition" 12 | ], 13 | "author": "octref@gmail.com", 14 | "license": "MIT" 15 | } -------------------------------------------------------------------------------- /nuxt-tags.json: -------------------------------------------------------------------------------- 1 | { 2 | "nuxt": { 3 | "attributes": ["nuxtChildKey"], 4 | "description": "The nuxt component." 5 | }, 6 | "nuxt-child": { 7 | "description": "Component for displaying the children components in a nested route." 8 | }, 9 | "nuxt-link": { 10 | "attributes": ["to", "replace", "append", "tag", "active-class", "exact", "event", "exact-active-class"], 11 | "description": "Component for routing. Same as now." 12 | }, 13 | "no-ssr": { 14 | "description": "Component for excluding a part of your app from server-side rendering." 15 | } 16 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 Pine 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /nuxt-attributes.json: -------------------------------------------------------------------------------- 1 | { 2 | "nuxtChildKey": { 3 | "description": "This prop will be set to , useful to make transitions inside a dynamic page and different route. Default: `$route.fullPath`" 4 | }, 5 | "to": { 6 | "description": "Denotes the target route of the link. When clicked, the value of the to prop will be passed to router.push() internally, so the value can be either a string or a location descriptor object." 7 | }, 8 | "replace": { 9 | "type": "boolean", 10 | "description": "Setting replace prop will call router.replace() instead of router.push() when clicked, so the navigation will not leave a history record." 11 | }, 12 | "append": { 13 | "type": "boolean", 14 | "description": "Setting append prop always appends the relative path to the current path. For example, assuming we are navigating from /a to a relative link b, without append we will end up at /b, but with append we will end up at /a/b." 15 | }, 16 | "tag": { 17 | "description": "Specify which tag to render to, and it will still listen to click events for navigation." 18 | }, 19 | "active-class": { 20 | "description": "Configure the active CSS class applied when the link is active." 21 | }, 22 | "exact": { 23 | "description": "The default active class matching behavior is inclusive match. For example, will get this class applied as long as the current path starts with /a/ or is /a.\nOne consequence of this is that will be active for every route! To force the link into \"exact match mode\", use the exact prop: " 24 | }, 25 | "event": { 26 | "description": "Specify the event(s) that can trigger the link navigation." 27 | }, 28 | "exact-active-class": { 29 | "description": "Configure the active CSS class applied when the link is active with exact match. Note the default value can also be configured globally via the linkExactActiveClass router constructor option." 30 | } 31 | } --------------------------------------------------------------------------------