Skip to content

Commit 82aaa99

Browse files
committed
Add missing docs json files
1 parent 2fa11d9 commit 82aaa99

8 files changed

+7
-2
lines changed

.docs/GvErrorLink.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"text","description":"Text for the error link item. If content is provided in the default slot, this prop will be ignored.","type":{"name":"string"}},{"name":"targetId","description":"ID of the component on the page that the error link should jump to.","type":{"name":"string"}},{"name":"href","description":"Href attribute for the error link item. Only use this if you're linking to another page. If you're linking to an element on this page, use `targetId` instead.","type":{"name":"string"}},{"name":"component","description":"The component used to render the link, for example `RouterLink`. Will default to `a` if an `href` or `targetId` is provided or no link otherwise.","type":{"name":"string|object"}}],"slots":[{"name":"default","description":"The content of the error link. If content is provided in this slot, the `text` prop will be ignored."}]}

.docs/GvErrorSummary.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"title","description":"Text to use for the heading of the error summary block. If content is provided in the `title` slot, this prop will be ignored.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'There is a problem'"}},{"name":"description","description":"Text to use for the description of the errors. If content is provided in the `description` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"disableAutoFocus","description":"If `true`, keyboard focus will not be moved to the error summary when it's mounted.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}}],"slots":[{"name":"title","description":"The heading of the error summary block. If content is provided in this slot, the `title` prop will be ignored."},{"name":"description","description":"The description of the errors. If content is provided in this slot, the `description` prop will be ignored."},{"name":"default","description":"A list of `gv-error-link`s"}]}

.docs/GvPasswordInput.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"modelValue","description":"The value of the input. In most cases you should use `v-model` instead of setting this prop directly.","type":{"name":"string"}},{"name":"id","description":"The ID of the input.\n\nIf you don't provide an ID, one will be generated automatically.","type":{"name":"string"}},{"name":"name","description":"The name of the input, which is submitted with the form data.","type":{"name":"string"}},{"name":"describedBy","description":"One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive information for screenreader users.","type":{"name":"string"}},{"name":"autocomplete","description":"Attribute to [identify input purpose](https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html),\nfor example `new-password`. See [autofill](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill)\nfor full list of values that can be used.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'current-password'"}},{"name":"disabled","description":"If `true`, input will be disabled.","type":{"name":"boolean"}},{"name":"showPasswordText","description":"Button text when the password is hidden.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Show'"}},{"name":"hidePasswordText","description":"Button text when the password is visible.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Hide'"}},{"name":"showPasswordAriaLabel","description":"Button text exposed to assistive technologies, like screen readers, when the password is hidden.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Show password'"}},{"name":"hidePasswordAriaLabel","description":"Button text exposed to assistive technologies, like screen readers, when the password is visible.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Hide password'"}},{"name":"passwordShownAnnouncementText","description":"Announcement made to screen reader users when their password has become visible in plain text.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Your password is visible'"}},{"name":"passwordHiddenAnnouncementText","description":"Announcement made to screen reader users when their password has been obscured and is not visible.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Your password is hidden'"}},{"name":"passwordVisible","description":"Sets whether the password is visible. Use `v-model:password-visible` to keep track of the visibility.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"formGroupClass","description":"Classes to add to the form group. You can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"label","description":"Text to use within the label. If content is provided in the default slot, this prop will be ignored.","type":{"name":"string"}},{"name":"labelIsPageHeading","description":"Whether the label also acts as the heading for the page.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"labelClass","description":"Classes to add to the label tag. You can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"hint","description":"Text to use within the hint. If content is provided in the `hint` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"hintClass","description":"Classes to add to the hint span tag. You can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"buttonClass","description":"Classes to add to the button. You can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"errorMessage","description":"Text to use within the error message. If content is provided in the `error-message` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"errorMessageClass","description":"Classes to add to the error message `<p>` tag. You can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"errorMessageVisuallyHiddenText","description":"A visually hidden prefix used before the error message.\n\nDefaults to `'Error'`.","type":{"name":"string"}},{"name":"beforeInput","description":"Text to add before the input. If content is provided in the `before-input` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"afterInput","description":"Text to add after the input. If content is provided in the `after-input` slot, this prop will be ignored.","type":{"name":"string"}}],"slots":[{"name":"label","description":"The content of the label. If content is provided in this slot, the `label` prop will be ignored."},{"name":"hint","description":"The content of the hint. If content is provided in this slot, the `hint` prop will be ignored."},{"name":"error-message","description":"The content of the error message. If content is provided in this slot, the `errorMessage` prop will be ignored."},{"name":"before-input","description":"Content to add before the input. If content is provided in this slot, the `beforeInput` prop will be ignored."},{"name":"after-input","description":"Content to add after the input. If content is provided in this slot, the `aftereInput` prop will be ignored."}]}

.docs/GvServiceNavigation.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"ariaLabel","description":"The text for the `aria-label` which labels the service navigation container when a service name is included.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Service information'"}},{"name":"menuButtonText","description":"The text of the mobile navigation menu toggle.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Menu'"}},{"name":"menuButtonLabel","description":"The screen reader label for the mobile navigation menu toggle. Defaults to the same value as `menuButtonText` if not specified.","type":{"name":"string"}},{"name":"navigationLabel","description":"The screen reader label for the mobile navigation menu. Defaults to the same value as `menuButtonText` if not specified.","type":{"name":"string"}},{"name":"navigationId","description":"The ID used to associate the mobile navigation toggle with the navigation menu.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'navigation'"}},{"name":"navigationClass","description":"Classes to add to the navigation menu container.\nYou can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"serviceName","description":"The name of your service.","type":{"name":"string"}},{"name":"serviceUrl","description":"The homepage of your service.","type":{"name":"string"}},{"name":"serviceNameLinkComponent","description":"The component used to render the service name link, for example `RouterLink`. Will default to `a` if a `serviceUrl` is provided or no link otherwise.","type":{"name":"string|object"}}],"slots":[{"name":"start","description":"Content injected at the start of the service header container"},{"name":"default","description":"A list of `gv-service-navigation-item`s"},{"name":"end","description":"Content injected at the end of the service header container"}]}

.docs/GvServiceNavigationItem.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"current","description":"If `true`, indicates that the user is currently on this page. This takes precedence over `active`.","type":{"name":"boolean"}},{"name":"active","description":"If `true`, indicates that the user is within this group of pages in the navigation hierarchy.","type":{"name":"boolean"}},{"name":"text","description":"Text for the navigation item. If content is provided in the default slot, this prop will be ignored.","type":{"name":"string"}},{"name":"href","description":"URL of the navigation item anchor.","type":{"name":"string"}},{"name":"component","description":"The component used to render the link, for example `RouterLink`. Will default to `a` if an `href` is provided or no link otherwise.","type":{"name":"string|object"}}],"slots":[{"name":"default","description":"The content of the navigation item. If content is provided in this slot, the `text` prop will be ignored."}]}

.docs/GvTaskList.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":"","slots":[{"name":"default","description":"A list of `GvTaskListItem`s"}]}

.docs/GvTaskListItem.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"title","description":"The main title for the task within the task list component. If content is provided in the default slot, this prop will be ignored.","type":{"name":"string"}},{"name":"titleClass","description":"Classes to add to the title wrapper.\nYou can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"href","description":"The value of the link's `href` attribute for the task list item.","type":{"name":"string"}},{"name":"titleComponent","description":"The component used to render the link, for example `RouterLink`.","type":{"name":"string|object"},"defaultValue":{"func":false,"value":"'a'"}},{"name":"hint","description":"Can be used to add a hint to each task within the task list component. If content is provided in the `hint` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"status","description":"Text to use for the status, as an alternative to using a tag. If content is provided in the `status` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"statusClass","description":"Classes to add to the status container.\nYou can bind a string, an array or an object, as with normal [Vue class bindings](https://vuejs.org/guide/essentials/class-and-style.html#binding-html-classes).","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"cannotStartYet","description":"Set to `true` if the task cannot be started yet. This will make the status text grey.","type":{"name":"boolean"}}],"slots":[{"name":"default","description":"The main title for the task within the task list component. If content is provided in this slot, the `title` prop will be ignored."},{"name":"hint","description":"The content of the hint. If content is provided in this slot, the `hint` prop will be ignored."},{"name":"status","description":"The content of the status, usually a `GvTag`. If content is provided in this slot, the `hint` prop will be ignored."}]}

.gitignore

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
/.idea
22
/.nuxt
33
/.output
4-
/.docs
5-
/.generated-examples
64
/node_modules
75
/dist

0 commit comments

Comments
 (0)