attributes.json 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. {
  2. "name": {
  3. "type": "string",
  4. "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."
  5. },
  6. "to": {
  7. "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."
  8. },
  9. "append": {
  10. "type": "boolean",
  11. "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."
  12. },
  13. "tag": {
  14. "description": "Specify which tag to render to, and it will still listen to click events for navigation. By default, an `a` tag is rendered."
  15. },
  16. "event": {
  17. "description": "Specify the event(s) that can trigger the link navigation. By default, the `click` event triggers a navigation."
  18. },
  19. "replace": {
  20. "type": "boolean",
  21. "description": "Call `router.replace()` instead of `router.push()` when the link is clicked, so the navigation replaces the current history entry."
  22. },
  23. "exact": {
  24. "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>`"
  25. },
  26. "active-class": {
  27. "type": "string",
  28. "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."
  29. },
  30. "exact-active-class": {
  31. "type": "string",
  32. "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."
  33. },
  34. "aria-current-value": {
  35. "options": ["page", "step", "location", "date", "time", "true", "false"],
  36. "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."
  37. }
  38. }