Skip to content

Commit 0e597b0

Browse files
committed
Add first cut of documentation
1 parent 1ddab85 commit 0e597b0

File tree

238 files changed

+6306
-124
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

238 files changed

+6306
-124
lines changed

.docs/GvAccordion.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"id","description":"Must be unique across the domain of your service if `rememberExpanded` is `true`\n(as the expanded state of individual instances of the component persists across page loads using `sessionStorage`).\nUsed as an id in the HTML for the accordion as a whole, and also as a prefix for the ids of the section contents\nand the buttons that open them, so that those ids can be the target of aria-labelledby and aria-control attributes.\n\nIf you don't provide an ID, one will be generated automatically.","type":{"name":"string"}},{"name":"headingLevel","description":"Heading level of the section headings, from `1` to `6`.","type":{"name":"number"},"defaultValue":{"func":false,"value":"2"}},{"name":"rememberExpanded","description":"Whether the expanded/collapsed state of the accordion sections should be saved and\n\trestored each time the user sees the accordion. If this is enabled you must set static `id`s on\n\teach `GvAccordionSection` to ensure the correct sections are restored.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"hideAllSectionsText","description":"The text content of the 'Hide all sections' button at the top of the accordion when all\n\tsections are expanded.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Hide all sections'"}},{"name":"hideSectionText","description":"The text content of the 'Hide' button within each section of the accordion, which is visible\n\twhen the section is expanded.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Hide'"}},{"name":"hideSectionAriaLabel","description":"Text made available to assistive technologies, like screen readers, as the final part of the\n\ttoggle's accessible name when the section is expanded.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Hide this section'"}},{"name":"showAllSectionsText","description":"The text content of the 'Show all sections' button at the top of the accordion when at least\n\tone section is collapsed.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Show all sections'"}},{"name":"showSectionText","description":"The text content of the 'Show' button within each section of the accordion, which is visible\n\twhen the section is collapsed.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Show'"}},{"name":"showSectionAriaLabel","description":"Text made available to assistive technologies, like screen readers, as the final part of the\n\ttoggle's accessible name when the section is collapsed.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Show this section'"}}],"slots":[{"name":"default","description":"A list of `gv-accordion-section`s"}]}

.docs/GvAccordionSection.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +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."}]}

.docs/GvBackLink.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"text","description":"Text to use within the back link component. If content is provided in the default slot, this prop will be ignored.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'Back'"}},{"name":"href","description":"The value of the link's `href` attribute.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'#'"}},{"name":"component","description":"The component used to render the link, for example `RouterLink`.","type":{"name":"string|object"},"defaultValue":{"func":false,"value":"'a'"}}],"slots":[{"name":"default","description":"The content of the back link. If content is provided in this slot, the `text` prop will be ignored."}]}

.docs/GvBreadcrumbItem.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"text","description":"Text to use within the breadcrumbs item. If content is provided in the default slot, this prop will be ignored.","type":{"name":"string"}},{"name":"href","description":"Link for the breadcrumbs item. If not specified, breadcrumbs item is a normal list item.","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 breadcrumbs item. If content is provided in this slot, the `text` prop will be ignored."}]}

.docs/GvBreadcrumbs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +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"}]}

.docs/GvButton.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"text","description":"Text for the button or link. If content is provided in the default slot, or if `element` is set to `input`, this prop will be ignored.","type":{"name":"string"}},{"name":"name","description":"Name for the `input` or `button`. This has no effect if `element` is `a`.","type":{"name":"string"}},{"name":"type","description":"Type of `input` or `button` - `button`, `submit` or `reset`. This has no effect if `component` is not `input` or `button`.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'button'"}},{"name":"value","description":"Value for the `button` tag. This has no effect if `element` is not `button`","type":{"name":"string"}},{"name":"disabled","description":"Whether the button should be disabled. If `element` is `input` or `button`, `disabled` and `aria-disabled`\nattributes will be set automatically.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"href","description":"The URL that the button should link to. If this is set, `element` will be automatically set to `a` if it has not already been defined.","type":{"name":"string"}},{"name":"isStartButton","description":"Use for the main call to action on your service's start page.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"variant","description":"The prominence of the button.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'primary'"},"values":["primary","secondary","warning"]},{"name":"id","description":"The ID of the button.","type":{"name":"string"}},{"name":"component","description":"The component used to render the button, for example `RouterLink`. Will default to `a` if an `href` is provided or `button` otherwise.","type":{"name":"string|object"}}],"slots":[{"name":"default","description":"The content of the button. If content is provided in this slot, the `text` prop will be ignored."}]}

.docs/GvButtonGroup.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":"","slots":[{"name":"default","description":"A list of `gv-button`s"}]}

.docs/GvCharacterCount.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +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"}]}

.docs/GvCheckbox.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"modelValue","description":"True if the checkbox is checked, false otherwise (or the value of the `trueValue` or `falseValue` props if they have been set). In most cases you should use `v-model` instead of setting this prop directly.","type":{"name":"null","func":true}},{"name":"trueValue","description":"The value to set the `v-model` to if the checkbox is checked.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"true"}},{"name":"falseValue","description":"The value to set the `v-model` to if the checkbox is not checked.","type":{"name":"boolean"},"defaultValue":{"func":false,"value":"false"}},{"name":"id","description":"The ID for this checkbox.\n\nIf you don't provide an ID, one will be generated automatically.","type":{"name":"string"}},{"name":"name","description":"The value of the `name` attribute for this checkbox.\n\nIf you don't provide a name, one will be generated automatically.","type":{"name":"string"}},{"name":"value","description":"If the parent checkbox group has a `v-model` array, this value will be added to the array if the checkbox is checked.","type":{"name":"null","func":true}},{"name":"divider","description":"The divider text to show above the checkbox if this checkbox is exclusive. This should usually be 'or'.","type":{"name":"string"}},{"name":"exclusive","description":"Whether checking this checkbox should deselect all other checkboxes in this group.","type":{"name":"boolean"}},{"name":"disabled","description":"If `true`, checkbox will be disabled.","type":{"name":"boolean"}},{"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":"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":"''"}}],"slots":[{"name":"default","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":"conditional","description":"Content to show if the checkbox is checked."}]}

.docs/GvCheckboxes.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"props":[{"name":"modelValue","description":"The array of selected checkbox values. In most cases you should use `v-model` instead of setting this prop directly.","type":{"name":"array"}},{"name":"name","description":"The value of the `name` attribute to apply to all checkboxes in this group.\n\nIf you don't provide a name, one will be generated automatically.","type":{"name":"string"}},{"name":"size","description":"The size of the checkboxes in this group.","type":{"name":"string"},"defaultValue":{"func":false,"value":"'normal'"},"values":["normal","small"]},{"name":"fieldsetDescribedBy","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":"fieldsetClass","description":"Classes to add to the fieldset container. 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":"fieldsetRole","description":"Optional ARIA role attribute to add to the fieldset container.","type":{"name":"string"}},{"name":"legend","description":"Text to use within the legend. If content is provided in the `legend` slot, this prop will be ignored.","type":{"name":"string"}},{"name":"legendClass","description":"Classes to add to the legend. 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":"legendIsPageHeading","description":"Whether the legend also acts as the heading for the page.","type":{"name":"boolean"}},{"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":"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":"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":"''"}}],"slots":[{"name":"legend","description":"The content of the legend. If content is provided in this slot, the `legend` 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":"default","description":"A list of `gv-checkbox`es"}]}

0 commit comments

Comments
 (0)