Skip to content

Commit

Permalink
Update docs json
Browse files Browse the repository at this point in the history
  • Loading branch information
matteason committed Sep 2, 2024
1 parent e5b713c commit 2fa11d9
Show file tree
Hide file tree
Showing 24 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .docs/GvAccordionSection.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"props":[{"name":"id","description":"The ID for this section. If you don't provide an ID, one will be generated automatically.","type":{"name":"string"}},{"name":"heading","description":"The title of the section.","type":{"name":"string"}},{"name":"summary","description":"Text content for the summary line. If content is provided in the `summary` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"content","description":"Text content of this section, which is hidden when the section is closed. If content is provided in the default\nslot, this prop will be ignored.","type":{"name":"string"}},{"name":"modelValue","description":"Sets whether the section is expanded. If set, the model value will override any stored expansion state if\n`rememberExpanded` has been set on the parent `GvAccordion`. In most cases you should use `v-model` instead of setting this prop directly.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"null"}}],"slots":[{"name":"summary","description":"The content of the summary. If content is provided in this slot, the `summary` prop will be ignored."},{"name":"default","description":"The content of the accordion section. If content is provided in this slot, the `content` prop will be ignored."}]}
{"props":[{"name":"id","description":"The ID for this section. If you don't provide an ID, one will be generated automatically.","type":{"name":"string"}},{"name":"heading","description":"The title of the section.","type":{"name":"string"}},{"name":"summary","description":"Text content for the summary line. If content is provided in the `summary` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"content","description":"Text content of this section, which is hidden when the section is closed. If content is provided in the default\nslot, this prop will be ignored.","type":{"name":"string"}},{"name":"expanded","description":"Sets whether the section is expanded. If set, the model value will override any stored expansion state if\n`rememberExpanded` has been set on the parent `GvAccordion`. Use `v-model:expanded` to keep track of the expansion state.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"null"}}],"slots":[{"name":"summary","description":"The content of the summary. If content is provided in this slot, the `summary` prop will be ignored."},{"name":"default","description":"The content of the accordion section. If content is provided in this slot, the `content` prop will be ignored."}]}
2 changes: 1 addition & 1 deletion .docs/GvBreadcrumbs.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"props":[{"name":"collapseOnMobile","description":"When true, the breadcrumbs will collapse to the first and last item only on tablet breakpoint and below.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}}],"slots":[{"name":"default","description":"A list of `gv-breadcrumb-item`s"}]}
{"props":[{"name":"collapseOnMobile","description":"When true, the breadcrumbs will collapse to the first and last item only on tablet breakpoint and below.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"ariaLabel","description":"The text for the `aria-label` on the `<nav>` element around the breadcrumbs.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Breadcrumb'"}}],"slots":[{"name":"default","description":"A list of `gv-breadcrumb-item`s"}]}
2 changes: 1 addition & 1 deletion .docs/GvCharacterCount.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"props":[{"name":"modelValue","type":{"name":"string"}},{"name":"id","type":{"name":"string"}},{"name":"name","type":{"name":"string"}},{"name":"rows","type":{"name":"number"},"defaultValue":{"func":false,"value":"5"}},{"name":"describedBy","type":{"name":"string"}},{"name":"autocomplete","type":{"name":"string"}},{"name":"spellcheck","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"null"}},{"name":"disabled","type":{"name":"boolean"}},{"name":"formGroupClass","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"label","type":{"name":"string"}},{"name":"labelIsPageHeading","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"labelClass","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"hint","type":{"name":"string"}},{"name":"hintClass","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"errorMessage","type":{"name":"string"}},{"name":"errorMessageClass","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"errorMessageVisuallyHiddenText","type":{"name":"string"}},{"name":"maxChars","type":{"name":"number"}},{"name":"maxWords","type":{"name":"number"}},{"name":"threshold","type":{"name":"number"},"defaultValue":{"func":false,"value":"0"}},{"name":"messageClass","type":{"name":"string|array|object"},"defaultValue":{"func":false,"value":"''"}},{"name":"textareaDescription","type":{"name":"string"}},{"name":"charactersUnderLimitText","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} characters remaining'"}},{"name":"charactersUnderLimitTextOne","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} character remaining'"}},{"name":"charactersAtLimitText","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} characters remaining'"}},{"name":"charactersOverLimitText","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} characters too many'"}},{"name":"charactersOverLimitTextOne","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} character too many'"}},{"name":"wordsUnderLimitText","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} words remaining'"}},{"name":"wordsUnderLimitTextOne","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} word remaining'"}},{"name":"wordsAtLimitText","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} words remaining'"}},{"name":"wordsOverLimitText","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} words too many'"}},{"name":"wordsOverLimitTextOne","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} word too many'"}}],"slots":[{"name":"default"}]}
{"props":[{"name":"modelValue","description":"The value of the textarea. In most cases you should use `v-model` instead of setting this prop directly.","type":{"name":"string"}},{"name":"id","description":"The ID for this textarea.\n\nIf you don't provide an ID, one will be generated automatically.","type":{"name":"string"}},{"name":"name","description":"The name of the textarea, which is submitted with the form data.","type":{"name":"string"}},{"name":"rows","description":"Number of textarea rows","type":{"name":"number"},"defaultValue":{"func":false,"value":"5"}},{"name":"describedBy","description":"One or more element IDs to add to the `aria-describedby` attribute, used to provide additional descriptive\n\tinformation 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 `street-address`. 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"}},{"name":"spellcheck","description":"Sets the `spellcheck` attribute on the textarea","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"null"}},{"name":"disabled","description":"If `true`, textarea will be disabled.","type":{"name":"boolean"}},{"name":"formGroupClass","description":"Classes to add to the form group. You can bind a string, an array or an object, as with normal\n[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\n[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\n[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\n[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":"maxChars","description":"The maximum number of characters. If `maxWords` is provided, the `maxChars` option will be ignored.","type":{"name":"number"}},{"name":"maxWords","description":"The maximum number of words. If `maxWords` is provided, the `maxChars` option will be ignored.","type":{"name":"number"}},{"name":"threshold","description":"The percentage value of the limit at which point the count message is displayed. If this prop is set, the count\nmessage will be hidden by default.","type":{"name":"number"},"defaultValue":{"func":false,"value":"0"}},{"name":"messageClass","description":"Classes to add to the count message. You can bind a string, an array or an object, as with normal\n[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":"textareaDescription","description":"Message made available to assistive technologies to describe that the component accepts only a limited amount of\ncontent. The component will replace the `%{count}` placeholder with the value of the maxChars or maxWords param.","type":{"name":"string"}},{"name":"charactersUnderLimitText","description":"Message displayed when the number of characters is under the configured maximum, `maxChars`. This message is\ndisplayed visually and through assistive technologies. The component will replace the `%{count}` placeholder\nwith the number of remaining characters.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} characters remaining'"}},{"name":"charactersUnderLimitTextOne","description":"Message used instead of `charactersUnderLimitText` when there is only one character remaining.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have 1 character remaining'"}},{"name":"charactersAtLimitText","description":"Message displayed when the number of characters reaches the configured maximum, `maxChars`. This message is\ndisplayed visually and through assistive technologies.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have 0 characters remaining'"}},{"name":"charactersOverLimitText","description":"Message displayed when the number of characters is over the configured maximum, `maxChars`. This message is\ndisplayed visually and through assistive technologies. The component will replace the `${count}`placeholder\nwith the number of remaining characters.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} characters too many'"}},{"name":"charactersOverLimitTextOne","description":"Message used instead of`charactersOverLimitText`when the text is one character over.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have 1 character too many'"}},{"name":"wordsUnderLimitText","description":"Message displayed when the number of words is under the configured maximum,`maxWords`. This message is\ndisplayed visually and through assistive technologies. The component will replace the `${count}` placeholder\nwith the number of remaining characters.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} words remaining'"}},{"name":"wordsUnderLimitTextOne","description":"Message used instead of `wordsUnderLimitText` when there is only one word remaining.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have 1 word remaining'"}},{"name":"wordsAtLimitText","description":"Message displayed when the number of words reaches the configured maximum, `maxWords`. This message is\ndisplayed visually and through assistive technologies.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have 0 words remaining'"}},{"name":"wordsOverLimitText","description":"Message displayed when the number of words is over the configured maximum, `maxWords`. This message is\ndisplayed visually and through assistive technologies. The component will replace the `${count}`placeholder\nwith the number of remaining characters.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have ${count} words too many'"}},{"name":"wordsOverLimitTextOne","description":"Message used instead of`wordsOverLimitText`when the text is one word over.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'You have 1 word too many'"}},{"name":"beforeInput","description":"Text to add before the textarea. 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 textarea. 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 textarea. If content is provided in this slot, the`beforeInput`prop will be ignored."},{"name":"after-input","description":"Content to add after the textarea. If content is provided in this slot, the`afterInput` prop will be ignored."}]}
Loading

0 comments on commit 2fa11d9

Please sign in to comment.