Skip to content

Commit dd4e144

Browse files
authored
Add switch attribute to docs for switch checkbox (#41396)
* Add switch attribute to docs for switch checkbox * tweak * AI says this is the way * fix
1 parent ed36faa commit dd4e144

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

Diff for: build/vnu-jar.mjs

+3-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ execFile('java', ['-version'], (error, stdout, stderr) => {
3535
'Attribute “is:raw” is not serializable as XML 1.0.',
3636
'Attribute “is:raw” not allowed on element “code” at this point.',
3737
// Astro's expecting trailing slashes on HTML tags such as <br />
38-
'Trailing slash on void elements has no effect and interacts badly with unquoted attribute values.'
38+
'Trailing slash on void elements has no effect and interacts badly with unquoted attribute values.',
39+
// Allow `switch` attribute.
40+
'Attribute “switch” not allowed on element “input” at this point.'
3941
].join('|')
4042

4143
const args = [

Diff for: site/src/content/docs/forms/checks-radios.mdx

+17-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc: true
99

1010
Browser default checkboxes and radios are replaced with the help of `.form-check`, a series of classes for both input types that improves the layout and behavior of their HTML elements, that provide greater customization and cross browser consistency. Checkboxes are for selecting one or several options in a list, while radios are for selecting one option from many.
1111

12-
Structurally, our `<input>`s and `<label>`s are sibling elements as opposed to an `<input>` within a `<label>`. This is slightly more verbose as you must specify `id` and `for` attributes to relate the `<input>` and `<label>`. We use the sibling selector (`~`) for all our `<input>` states, like `:checked` or `:disabled`. When combined with the `.form-check-label` class, we can easily style the text for each item based on the `<input>`s state.
12+
Structurally, our `<input>`s and `<label>`s are sibling elements as opposed to an `<input>` within a `<label>`. This is slightly more verbose as you must specify `id` and `for` attributes to relate the `<input>` and `<label>`. We use the sibling selector (`~`) for all our `<input>` states, like `:checked` or `:disabled`. When combined with the `.form-check-label` class, we can easily style the text for each item based on the `<input>`'s state.
1313

1414
Our checks use custom Bootstrap icons to indicate checked or indeterminate states.
1515

@@ -41,7 +41,7 @@ Checkboxes can utilize the `:indeterminate` pseudo class when manually set via J
4141

4242
### Disabled
4343

44-
Add the `disabled` attribute and the associated `<label>`s are automatically styled to match with a lighter color to help indicate the inputs state.
44+
Add the `disabled` attribute and the associated `<label>`s are automatically styled to match with a lighter color to help indicate the input's state.
4545

4646
<Example addStackblitzJs class="bd-example-indeterminate" code={`<div class="form-check">
4747
<input class="form-check-input" type="checkbox" value="" id="checkIndeterminateDisabled" disabled>
@@ -79,7 +79,7 @@ Add the `disabled` attribute and the associated `<label>`s are automatically sty
7979

8080
### Disabled
8181

82-
Add the `disabled` attribute and the associated `<label>`s are automatically styled to match with a lighter color to help indicate the inputs state.
82+
Add the `disabled` attribute and the associated `<label>`s are automatically styled to match with a lighter color to help indicate the input's state.
8383

8484
<Example code={`<div class="form-check">
8585
<input class="form-check-input" type="radio" name="radioDisabled" id="radioDisabled" disabled>
@@ -115,6 +115,19 @@ A switch has the markup of a custom checkbox but uses the `.form-switch` class t
115115
<label class="form-check-label" for="switchCheckCheckedDisabled">Disabled checked switch checkbox input</label>
116116
</div>`} />
117117

118+
### Native switches
119+
120+
Progressively enhance your switches for mobile Safari (iOS 17.4+) by adding a `switch` attribute to your input to enable haptic feedback when toggling switches, just like native iOS switches. There are no style changes attached to using this attribute in Bootstrap as all our switches use custom styles.
121+
122+
<Example code={`<div class="form-check form-switch">
123+
<input class="form-check-input" type="checkbox" value="" id="checkNativeSwitch" switch>
124+
<label class="form-check-label" for="checkNativeSwitch">
125+
Native switch haptics
126+
</label>
127+
</div>`} />
128+
129+
Be sure to read more about [the switch attribute on the WebKit blog](https://webkit.org/blog/15054/an-html-switch-control/). Safari 17.4+ on macOS and iOS both have native-style switches in HTML while other browsers simply fall back to the standard checkbox appearance. Applying the attribute to a non-Bootstrap checkbox in more recent versions of Safari will render a native switch.
130+
118131
## Default (stacked)
119132

120133
By default, any number of checkboxes and radios that are immediate sibling will be vertically stacked and appropriately spaced with `.form-check`.
@@ -240,7 +253,7 @@ Create button-like checkboxes and radio buttons by using `.btn` styles rather th
240253
<label class="btn" for="btn-check-6">Disabled</label>`} />
241254

242255
<Callout>
243-
Visually, these checkbox toggle buttons are identical to the [button plugin toggle buttons]([[docsref:/components/buttons#button-plugin]]). However, they are conveyed differently by assistive technologies: the checkbox toggles will be announced by screen readers as checked”/“not checked (since, despite their appearance, they are fundamentally still checkboxes), whereas the button plugin toggle buttons will be announced as button”/“button pressed. The choice between these two approaches will depend on the type of toggle you are creating, and whether or not the toggle will make sense to users when announced as a checkbox or as an actual button.
256+
Visually, these checkbox toggle buttons are identical to the [button plugin toggle buttons]([[docsref:/components/buttons#button-plugin]]). However, they are conveyed differently by assistive technologies: the checkbox toggles will be announced by screen readers as "checked"/"not checked" (since, despite their appearance, they are fundamentally still checkboxes), whereas the button plugin toggle buttons will be announced as "button"/"button pressed". The choice between these two approaches will depend on the type of toggle you are creating, and whether or not the toggle will make sense to users when announced as a checkbox or as an actual button.
244257
</Callout>
245258

246259
### Radio toggle buttons

0 commit comments

Comments
 (0)