Skip to content

Commit

Permalink
Merge pull request #105 from trimble-oss/dev/coliff/docs-update
Browse files Browse the repository at this point in the history
Docs: updates
  • Loading branch information
coliff authored Feb 14, 2025
2 parents 276369e + 5e68a6a commit c89b3bd
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 32 deletions.
1 change: 1 addition & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
"fusv",
"Fwww",
"getenv",
"getbootstrap",
"Giraudel",
"goldmark",
"gotemplates",
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ jobs:
files: "**/*.md"
inline: warning
incremental_files_only: true
strict: false
2 changes: 1 addition & 1 deletion site/content/docs/v2/components/modal.md
Original file line number Diff line number Diff line change
Expand Up @@ -910,7 +910,7 @@ Bootstrap's modal class exposes a few events for hooking into modal functionalit
{{< bs-table >}}
| Event | Description |
| --- | --- |
| `hide.bs.modal` | This event is fired immediately when the `hide` instance method has been called. |
| `hide.bs.modal` | This event is fired immediately when the `hide` instance method has been called. Can be prevented by calling `event.preventDefault()`. See [JavaScript events documentation]({{< docsref "/getting-started/javascript#events" >}}) for more details on event prevention. |
| `hidden.bs.modal` | This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete). |
| `hidePrevented.bs.modal` | This event is fired when the modal is shown, its backdrop is `static` and a click outside of the modal is performed. The event is also fired when the escape key is pressed and the `keyboard` option is set to `false`. |
| `show.bs.modal` | This event fires immediately when the `show` instance method is called. If caused by a click, the clicked element is available as the `relatedTarget` property of the event. |
Expand Down
62 changes: 31 additions & 31 deletions site/content/docs/v2/forms/checks-radios.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: docs
title: Checks and radios
description: Create consistent cross-browser and cross-device checkboxes and radios with our completely rewritten checks component.
description: Create consistent cross-browser and cross-device checkboxes, radios and switches with our completely rewritten checks component.
group: forms
aliases:
- "/components/checkboxes/"
Expand All @@ -23,14 +23,14 @@ Our checks use custom Bootstrap icons to indicate checked or indeterminate state

{{< example >}}
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="flexCheckDefault">
<label class="form-check-label" for="flexCheckDefault">
<input class="form-check-input" type="checkbox" value="" id="CheckDefault">
<label class="form-check-label" for="CheckDefault">
Default checkbox
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="flexCheckChecked" checked>
<label class="form-check-label" for="flexCheckChecked">
<input class="form-check-input" type="checkbox" value="" id="CheckChecked" checked>
<label class="form-check-label" for="CheckChecked">
Checked checkbox
</label>
</div>
Expand All @@ -42,8 +42,8 @@ Checkboxes can utilize the `:indeterminate` pseudo class when manually set via J

{{< example class="bd-example-indeterminate" stackblitz_add_js="true" >}}
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="flexCheckIndeterminate">
<label class="form-check-label" for="flexCheckIndeterminate">
<input class="form-check-input" type="checkbox" value="" id="CheckIndeterminate">
<label class="form-check-label" for="CheckIndeterminate">
Indeterminate checkbox
</label>
</div>
Expand All @@ -55,20 +55,20 @@ Add the `disabled` attribute and the associated `<label>`s are automatically sty

{{< example class="bd-example-indeterminate" stackblitz_add_js="true" >}}
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="flexCheckIndeterminateDisabled" disabled>
<label class="form-check-label" for="flexCheckIndeterminateDisabled">
<input class="form-check-input" type="checkbox" value="" id="CheckIndeterminateDisabled" disabled>
<label class="form-check-label" for="CheckIndeterminateDisabled">
Disabled indeterminate checkbox
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="flexCheckDisabled" disabled>
<label class="form-check-label" for="flexCheckDisabled">
<input class="form-check-input" type="checkbox" value="" id="CheckDisabled" disabled>
<label class="form-check-label" for="CheckDisabled">
Disabled checkbox
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="flexCheckCheckedDisabled" checked disabled>
<label class="form-check-label" for="flexCheckCheckedDisabled">
<input class="form-check-input" type="checkbox" value="" id="CheckCheckedDisabled" checked disabled>
<label class="form-check-label" for="CheckCheckedDisabled">
Disabled checked checkbox
</label>
</div>
Expand All @@ -78,14 +78,14 @@ Add the `disabled` attribute and the associated `<label>`s are automatically sty

{{< example >}}
<div class="form-check">
<input class="form-check-input" type="radio" name="flexRadioDefault" id="flexRadioDefault1">
<label class="form-check-label" for="flexRadioDefault1">
<input class="form-check-input" type="radio" name="RadioDefault" id="RadioDefault1">
<label class="form-check-label" for="RadioDefault1">
Default radio
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="radio" name="flexRadioDefault" id="flexRadioDefault2" checked>
<label class="form-check-label" for="flexRadioDefault2">
<input class="form-check-input" type="radio" name="RadioDefault" id="RadioDefault2" checked>
<label class="form-check-label" for="RadioDefault2">
Default checked radio
</label>
</div>
Expand All @@ -97,14 +97,14 @@ Add the `disabled` attribute and the associated `<label>`s are automatically sty

{{< example >}}
<div class="form-check">
<input class="form-check-input" type="radio" name="flexRadioDisabled" id="flexRadioDisabled" disabled>
<label class="form-check-label" for="flexRadioDisabled">
<input class="form-check-input" type="radio" name="RadioDisabled" id="RadioDisabled" disabled>
<label class="form-check-label" for="RadioDisabled">
Disabled radio
</label>
</div>
<div class="form-check">
<input class="form-check-input" type="radio" name="flexRadioDisabled" id="flexRadioCheckedDisabled" checked disabled>
<label class="form-check-label" for="flexRadioCheckedDisabled">
<input class="form-check-input" type="radio" name="RadioDisabled" id="RadioCheckedDisabled" checked disabled>
<label class="form-check-label" for="RadioCheckedDisabled">
Disabled checked radio
</label>
</div>
Expand All @@ -116,20 +116,20 @@ A switch has the markup of a custom checkbox but uses the `.form-switch` class t

{{< example >}}
<div class="form-check form-switch">
<input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckDefault">
<label class="form-check-label" for="flexSwitchCheckDefault">Default switch checkbox input</label>
<input class="form-check-input" type="checkbox" role="switch" id="SwitchCheckDefault">
<label class="form-check-label" for="SwitchCheckDefault">Default switch checkbox input</label>
</div>
<div class="form-check form-switch">
<input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckChecked" checked>
<label class="form-check-label" for="flexSwitchCheckChecked">Checked switch checkbox input</label>
<input class="form-check-input" type="checkbox" role="switch" id="SwitchCheckChecked" checked>
<label class="form-check-label" for="SwitchCheckChecked">Checked switch checkbox input</label>
</div>
<div class="form-check form-switch">
<input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckDisabled" disabled>
<label class="form-check-label" for="flexSwitchCheckDisabled">Disabled switch checkbox input</label>
<input class="form-check-input" type="checkbox" role="switch" id="SwitchCheckDisabled" disabled>
<label class="form-check-label" for="SwitchCheckDisabled">Disabled switch checkbox input</label>
</div>
<div class="form-check form-switch">
<input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckCheckedDisabled" checked disabled>
<label class="form-check-label" for="flexSwitchCheckCheckedDisabled">Disabled checked switch checkbox input</label>
<input class="form-check-input" type="checkbox" role="switch" id="SwitchCheckCheckedDisabled" checked disabled>
<label class="form-check-label" for="SwitchCheckCheckedDisabled">Disabled checked switch checkbox input</label>
</div>
{{< /example >}}

Expand Down Expand Up @@ -202,7 +202,7 @@ Smaller variants of checks, radio buttons and switches are available with the `
<td></td>
<td></td>
<td><div class="form-check form-check-sm form-switch">
<input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckDefaultSm" aria-label="Example Small Switch">
<input class="form-check-input" type="checkbox" role="switch" id="SwitchCheckDefaultSm" aria-label="Example Small Switch">
</div></td>
</tr>
<tr>
Expand All @@ -212,7 +212,7 @@ Smaller variants of checks, radio buttons and switches are available with the `
<td></td>
<td></td>
<td><div class="form-check form-switch">
<input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckDefaultP" aria-label="Example Default Switch">
<input class="form-check-input" type="checkbox" role="switch" id="SwitchCheckDefaultP" aria-label="Example Default Switch">
</div></td>
</tr>
<tr>
Expand Down

0 comments on commit c89b3bd

Please sign in to comment.