-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
65 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
{ | ||
"name": { | ||
"type": "string", | ||
"description": "When a `<router-view>` has a `name` prop, it will render the component with the corresponding name in the matched route record's components option." | ||
}, | ||
"to": { | ||
"description": "Denotes the target route of the link. When clicked, the value of the `to` prop will be internally passed to `router.push()`, so the value can be either a string or a location descriptor object." | ||
}, | ||
"append": { | ||
"type": "boolean", | ||
"description": "Setting the 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." | ||
}, | ||
"tag": { | ||
"description": "Specify which tag to render to, and it will still listen to click events for navigation. By default, an `a` tag is rendered." | ||
}, | ||
"event": { | ||
"description": "Specify the event(s) that can trigger the link navigation. By default, the `click` event triggers a navigation." | ||
}, | ||
"replace": { | ||
"type": "boolean", | ||
"description": "Call `router.replace()` instead of `router.push()` when the link is clicked, so the navigation replaces the current history entry." | ||
}, | ||
"exact": { | ||
"description": "The default active class matching behavior is inclusive match. For example, `<router-link to=\"/a\">` will get this class applied as long as the current path starts with /a/ or is /a.\nOne consequence of this is that `<router-link to=\"/\">` will be active for every route! To force the link into \"exact match mode\", use the exact prop: `<router-link to=\"/\" exact>`" | ||
}, | ||
"active-class": { | ||
"type": "string", | ||
"description": "Configure the active CSS class applied when the link is active. Note the default value can also be configured globally via the `linkActiveClass` router constructor option." | ||
}, | ||
"exact-active-class": { | ||
"type": "string", | ||
"description": "Configure the active CSS class applied when the link is exactly active. Note the default value can also be configured globally via the `linkExactActiveClass` router constructor option." | ||
}, | ||
"aria-current-value": { | ||
"options": ["page", "step", "location", "date", "time", "true", "false"], | ||
"description": "Configure the value of `aria-current` when the link is active with exact match. It must be one of the [allowed values for `aria-current`](https://www.w3.org/TR/wai-aria-1.2/#aria-current) in the ARIA spec. In most cases, the default of `page` should be the best fit." | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"router-view": { | ||
"attributes": ["name"], | ||
"description": "Component that renders the matched component for the current location. Components rendered by `<router-view>` can also contain their own `<router-view>` to render nested routes." | ||
}, | ||
"router-link": { | ||
"attributes": [ | ||
"to", | ||
"replace", | ||
"append", | ||
"tag", | ||
"active-class", | ||
"exact", | ||
"event", | ||
"exact-active-class", | ||
"aria-current-value" | ||
], | ||
"description": "Component that renders an `<a>` with the correct `href` attribute and click listeners to trigger a local navigation when clicked. Can also customize its rendering by providing the `custom` prop and using its `v-slot` API." | ||
} | ||
} |