Skip to content

chore(docs): minor adjustments to the form docs #5228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 23, 2020
Merged

chore(docs): minor adjustments to the form docs #5228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bb759b
chore(docs): minor adjustments to the form docs
tmorehouse Apr 23, 2020
525f016
Update README.md
tmorehouse Apr 23, 2020
f00907a
Update README.md
tmorehouse Apr 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/components/form/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,11 +187,12 @@ See also:
- [`<b-form-select>`](/docs/components/form-select) Select input
- [`<b-form-radio>`](/docs/components/form-radio) Radio Inputs
- [`<b-form-checkbox>`](/docs/components/form-checkbox) Checkbox Inputs
- [`b-form-datepicker`](/docs/components/form-datepicker) Date picker input
- [`b-form-spinbutton`](/docs/components/form-spinbutton) Numerical range spinbutton input
- [`b-form-tags`](/docs/components/form-tags) Customizable tag input
- [`<b-form-timepicker>`](/docs/components/form-timepicker) Time picker custom form input
- [`<b-form-file>`](/docs/components/form-file) File Input
- [`<b-form-datepicker>`](/docs/components/form-datepicker) Date picker input
- [`<b-form-spinbutton>`](/docs/components/form-spinbutton) Numerical range spinbutton input
- [`<b-form-tags>`](/docs/components/form-tags) Customizable tag input
- [`<b-form-timepicker>`](/docs/components/form-timepicker) Time picker custom form input
- [`<b-form-rating>`](/docs/components/form-rating) Star rating custom form input and display
- [`<b-button>`](/docs/components/button) Buttons
- [`<b-form-group>`](/docs/components/form-group) Form input wrapper to generate form-groups that
support labels, help text and feedback
Expand Down
13 changes: 9 additions & 4 deletions src/components/input-group/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,22 @@ subcomponent inside of the `<b-input-group-prepend>` or `<b-input-group-append>`

The following are the form controls supported as the input-group's _main_ input element:

- `<b-form-input>`
- `<b-form-textarea>`
- `<b-form-select>`
- `<b-form-file>`
- [`<b-form-input>`](/docs/components/form-input)
- [`<b-form-textarea>`](/docs/components/form-textarea)
- [`<b-form-select>`](/docs/components/form-select)
- [`<b-form-file>`](/docs/components/form-file)
- [`<b-form-rating>`](/docs/components/form-rating)
- [`<b-form-tags>`](/docs/components/form-tags)
- [`<b-form-spinbutton>`](/docs/components/form-splinbutton)

**Notes:**

- BootstrapVue uses custom SCSS/CSS to handling sizing the `<b-form-file>` input when it is placed
in a `<b-input-group>` which has a [`size`](#control-sizing) specified.
- BootstrapVue uses custom SCSS/CSS when `<b-form-input type="range">` is placed in a
`<b-input-group>`.
- BootstrapVue's custom components (i.e. `<b-form-spinbutton>`, `<b-form-rating>`, `<b-form-tags>`,
etc.) require BootstrapVue's custom SCSS/CSS.

## Checkbox and radio addons

Expand Down