Skip to content
Permalink
Browse files

feat(docs): add prop descriptions to component reference tables (closes

  • Loading branch information...
tmorehouse committed Sep 27, 2019
1 parent 22268aa commit fdd2a837de3173f28b96ad4c92cf458fc0f39816
Showing with 4,716 additions and 235 deletions.
  1. +11 −5 docs/assets/scss/styles.scss
  2. +236 −0 docs/common-props.json
  3. +194 −61 docs/components/componentdoc.vue
  4. +8 −7 docs/components/importdoc.vue
  5. +0 −1 docs/markdown/intro/README.md
  6. +5 −4 docs/pages/docs/components/_slug.js
  7. +1 −0 package.json
  8. +29 −0 src/components/alert/package.json
  9. +9 −1 src/components/badge/package.json
  10. +25 −2 src/components/breadcrumb/package.json
  11. +7 −0 src/components/button-group/package.json
  12. +11 −0 src/components/button-toolbar/package.json
  13. +24 −0 src/components/button/package.json
  14. +6 −6 src/components/card/card-img-lazy.js
  15. +8 −8 src/components/card/card-img.js
  16. +174 −4 src/components/card/package.json
  17. +128 −0 src/components/carousel/package.json
  18. +41 −2 src/components/collapse/package.json
  19. +131 −1 src/components/dropdown/package.json
  20. +13 −1 src/components/embed/package.json
  21. +1 −1 src/components/form-checkbox/form-checkbox-group.js
  22. +4 −4 src/components/form-checkbox/form-checkbox.js
  23. +80 −0 src/components/form-checkbox/package.json
  24. +2 −1 src/components/form-file/form-file.js
  25. +69 −3 src/components/form-file/package.json
  26. +98 −0 src/components/form-group/package.json
  27. +63 −0 src/components/form-input/package.json
  28. +1 −1 src/components/form-radio/form-radio-group.js
  29. +1 −1 src/components/form-radio/form-radio.js
  30. +72 −0 src/components/form-radio/package.json
  31. +32 −2 src/components/form-select/package.json
  32. +51 −1 src/components/form-textarea/package.json
  33. +60 −4 src/components/form/package.json
  34. +122 −2 src/components/image/package.json
  35. +53 −4 src/components/input-group/package.json
  36. +26 −0 src/components/jumbotron/package.json
  37. +106 −4 src/components/layout/package.json
  38. +9 −1 src/components/link/package.json
  39. +26 −2 src/components/list-group/package.json
  40. +23 −1 src/components/media/package.json
  41. +3 −1 src/components/modal/modal.js
  42. +297 −5 src/components/modal/package.json
  43. +142 −4 src/components/nav/package.json
  44. +60 −3 src/components/navbar/package.json
  45. +1 −1 src/components/pagination-nav/README.md
  46. +195 −6 src/components/pagination-nav/package.json
  47. +180 −5 src/components/pagination/package.json
  48. +2 −2 src/components/popover/index.js
  49. +92 −10 src/components/popover/package.json
  50. +78 −2 src/components/progress/package.json
  51. +14 −0 src/components/spinner/package.json
  52. +1 −1 src/components/table/README.md
  53. +1,168 −37 src/components/table/package.json
  54. +100 −0 src/components/tabs/package.json
  55. +0 −5 src/components/tabs/tab.js
  56. +1 −1 src/components/tabs/tabs.js
  57. +86 −3 src/components/toast/package.json
  58. +2 −2 src/components/tooltip/index.js
  59. +86 −8 src/components/tooltip/package.json
  60. +101 −1 src/directives/popover/package.json
  61. +29 −1 src/directives/scrollspy/package.json
  62. +101 −1 src/directives/tooltip/package.json
  63. +3 −1 src/utils/safe-types.js
  64. +14 −0 yarn.lock
@@ -204,17 +204,23 @@ pre.editable {
.bv-docs-table {
font-size: 90%;

th,
td {
padding: 0.5rem;
> thead,
> tbody,
> tfoot {
> tr {
> th,
> td {
padding: 0.5rem;
}
}
}

thead > tr > th {
> thead > tr > th {
min-width: 80px;
}

code {
white-space: nowrap !important;
white-space: nowrap;
}
}

@@ -0,0 +1,236 @@
{
"id": {
"description": "Used to set the 'id' attribute on the rendered content, and used as the base to generate any additional element IDs as needed"
},
"variant": {
"description": "Applies one of the Bootstrap theme color variants to the component"
},
"textVariant": {
"description": "Applies one of the Bootstrap theme color variants to the text"
},
"bgVariant": {
"description": "Applies one of the Bootstrap theme color variants to the background"
},
"borderVariant": {
"description": "Applies one of the Bootstrap theme color variants to the border"
},
"headerVariant": {
"description": "Applies one of the Bootstrap theme color variants to the header"
},
"headerTextVariant": {
"description": "Applies one of the Bootstrap theme color variants to the header text"
},
"titleTextVariant": {
"description": "Applies one of the Bootstrap theme color variants to the title text"
},
"subTitleTextVariant": {
"description": "Applies one of the Bootstrap theme color variants to the sub title text"
},
"headerBgVariant": {
"description": "Applies one of the Bootstrap theme color variants to the header background"
},
"headerBorderVariant": {
"description": "Applies one of the Bootstrap theme color variants to the header border"
},
"footerVariant": {
"description": "Applies one of the Bootstrap theme color variants to the footer"
},
"footerTextVariant": {
"description": "Applies one of the Bootstrap theme color variants to the footer text"
},
"footerBgVariant": {
"description": "Applies one of the Bootstrap theme color variants to the footer background"
},
"footerBorderVariant": {
"description": "Applies one of the Bootstrap theme color variants to the footer border"
},
"bodyVariant": {
"description": "Applies one of the Bootstrap theme color variants to the body"
},
"bodyTextVariant": {
"description": "Applies one of the Bootstrap theme color variants to the body text"
},
"bodyBgVariant": {
"description": "Applies one of the Bootstrap theme color variants to the body background"
},
"bodyBorderVariant": {
"description": "Applies one of the Bootstrap theme color variants to the body border"
},
"tag": {
"description": "Specify the HTML tag to render instead of the default tag"
},
"headerTag": {
"description": "Specify the HTML tag to render instead of the default tag for the header"
},
"footerTag": {
"description": "Specify the HTML tag to render instead of the default tag for the footer"
},
"bodyTag": {
"description": "Specify the HTML tag to render instead of the default tag for the body"
},
"titleTag": {
"description": "Specify the HTML tag to render instead of the default tag for the title"
},
"subTitleTag": {
"description": "Specify the HTML tag to render instead of the default tag for the sub title"
},
"textTag": {
"description": "Specify the HTML tag to render instead of the default tag for the text content"
},
"headerClass": {
"description": "CSS class (or classes) to apply to the header"
},
"footerClass": {
"description": "CSS class (or classes) to apply to the footer"
},
"bodyClass": {
"description": "CSS class (or classes) to apply to the body"
},
"titleClass": {
"description": "CSS class (or classes) to apply to the title"
},
"header": {
"description": "Text content to place in the header"
},
"headerHtml": {
"description": "HTML string content to place in the header. Use with caution"
},
"footer": {
"description": "Text content to place in the footer"
},
"footerHtml": {
"description": "HTML string content to place in the footer. Use with caution"
},
"title": {
"description": "Text content to place in the title"
},
"titleHtml": {
"description": "HTML string content to place in the title. Use with caution"
},
"subTitle": {
"description": "Text content to place in the sub title"
},
"size": {
"description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'"
},
"required": {
"description": "Adds the 'required' attribute to the form control"
},
"form": {
"description": "ID of the form that the form control belongs to. Sets the 'form' attribute on the control"
},
"name": {
"description": "Sets the value of the 'name' attribute on the form control"
},
"placeholder": {
"description": "Sets the 'placeholder' attribute value on the form control"
},
"readonly": {
"description": "Sets the 'readonly' attribute on hte form control"
},
"plaintext": {
"description": "Set the form control as readonly and renders the control to look like plain text (no borders)"
},
"autocomplete": {
"description": "Sets the 'autocomplete' attribute value on the form control"
},
"autofocus": {
"description": "When set to 'true', attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the 'autofocus' attribute on the control"
},
"state": {
"description": "Controls the validation state appearance of the component. 'true' for valid, 'false' for invalid', or 'null' for no validation state"
},
"options": {
"description": "Array of items to render in the component"
},
"valueField": {
"description": "Field name in the 'options' array that should be used for the value"
},
"textField": {
"description": "Field name in the 'options' array that should be used for the text label"
},
"htmlField": {
"description": "Field name in the 'options' array that should be used for the html label instead of text field. Use with caution."
},
"disabledField": {
"description": "Field name in the 'options' array that should be used for the disabled state"
},
"plain": {
"description": "Render the form control in plain mode, rather than custom styled mode"
},
"static": {
"description": "Renders the content of the component in-place in the DOM, rather than portalling it to be appended to the body element"
},
"src": {
"description": "URL to set for the 'src' attribute"
},
"alt": {
"description": "Value to set for the 'alt' attribute"
},
"role": {
"description": "Sets the ARIA attribute 'role' to a specific value"
},
"ariaRole": {
"description": "Sets the ARIA attribute 'role' to a specific value"
},
"ariaLabel": {
"description": "Sets the value of 'aria-label' attribute on the rendered element"
},
"ariaLabelledby": {
"description": "The ID of the element that provides a label for this component. Used as the value for the 'aria-labelledby' attribute"
},
"ariaDescribedby": {
"description": "The ID of the element that provides additional context for this component. Used as the value for the 'aria-describedby' attribute"
},
"ariaLive": {
"description": "When the rendered element is an aria-live region (for screen reader users), set to either 'polite' or 'assertive'"
},
"fade": {
"description": "When set to 'true', enables the fade animation/transition on the component"
},
"noFade": {
"description": "When set to 'true', disables the fade animation/transition on the component"
},
"disabled": {
"description": "When set to 'true', disables the component's functionality and places it in a disabled state"
},
"active": {
"description": "When set to 'true', places the component in the active state with active styling"
},
"rel": {
"description": "Sets the 'rel' attribute on the rendered link"
},
"target": {
"description": "Sets the 'target' attribute on the rendered link"
},
"href": {
"description": "Denotes the target URL of the link for standard a links"
},
"to": {
"description": "router-link prop: Denotes the target route of the link. When clicked, the value of the to prop will be passed to router.push() internally, so the value can be either a string or a Location descriptor object"
},
"replace": {
"description": "router-link prop: Setting the replace prop will call 'router.replace()' instead of 'router.push()' when clicked, so the navigation will not leave a history record"
},
"append": {
"description": "router-link prop: Setting append prop always appends the relative path to the current path"
},
"exact": {
"description": "router-link prop: The default active class matching behavior is inclusive match. Setting this prop forces the mode to exactly match the route"
},
"activeClass": {
"description": "router-link prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'"
},
"exactActiveClass": {
"description": "router-link prop: Configure the active CSS class applied when the link is active with exact match. Typically you will want to set this to class name 'active'"
},
"routerTag": {
"description": "router-link prop: Specify which tag to render, and it will still listen to click events for navigation. 'router-tag' translates to the tag prop on the final rendered router-link. Typically you should use the default value"
},
"event": {
"description": "router-link prop: Specify the event that triggers the link. In most cases you should leave this as the default"
},
"noPrefetch": {
"description": "nuxt-link prop: To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting 'no-prefetch' will disabled this feature for the specific link"
}
}

0 comments on commit fdd2a83

Please sign in to comment.
You can’t perform that action at this time.