Skip to content

Commit f6b4166

Browse files
committed
doc: added migration guide for Checkbox
1 parent 4b05d07 commit f6b4166

File tree

4 files changed

+48
-25
lines changed

4 files changed

+48
-25
lines changed

scss/forms/_checkbox.scss

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
border-bottom: 1px solid $ouds-color-border-default; // TODO: Introduce design token once created
2020
}
2121

22-
%control-item-reverse {
22+
%control-item-inverse {
2323
flex-direction: row-reverse;
2424
}
2525

@@ -120,8 +120,8 @@
120120
@extend %control-item-border;
121121
}
122122

123-
.checkbox-item-reverse {
124-
@extend %control-item-reverse;
123+
.checkbox-item-inverse {
124+
@extend %control-item-inverse;
125125
}
126126

127127
.checkbox-item-divider {
@@ -259,6 +259,6 @@
259259
}
260260

261261
.form-check-reverse {
262-
@extend .checkbox-item-reverse;
262+
@extend .checkbox-item-inverse;
263263
}
264264
}

site/assets/js/tac.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
})
4949
const allowConsentButton = document.querySelector('#tarteaucitronAllAllowed')
5050
const denyConsentButton = document.querySelector('#tarteaucitronAllDenied')
51-
const checkboxes = document.querySelectorAll('.form-check-input')
51+
const checkboxes = document.querySelectorAll('.checkbox-indicator')
5252

5353
allowConsentButton.addEventListener('click', () => {
5454
for (let i = 0; i < checkboxes.length; i++) {
@@ -86,7 +86,7 @@
8686
'tarteaucitron.userInterface.respond(document.getElementById(\'googletagmanagerAllowed\'),document.getElementById(\'googletagmanagerAllowed\').checked);'
8787
const toggle = document
8888
.createRange()
89-
.createContextualFragment(
89+
.createContextualFragment( // TODO replace with a form-switch
9090
`<label class="checkbox-standalone ">
9191
<input class="checkbox-indicator" type="checkbox" value="" id="googletagmanagerAllowed" aria-labelledby="googletagmanagerLine" onchange="${choiceEvent}"${((document.cookie.match(/^(?:.*;)?\s*cookie-consent\s*=\s*([^;]+)(?:.*)?$/) || [null])[1].match('!googletagmanager=true') ? 'checked' : '')}>
9292
<span class="visually-hidden">Google Tag Manager</span>

site/content/docs/0.2/forms/checkbox.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,17 +145,17 @@ You can display an helper text by adding a `.checkbox-helper` as a sibling of a
145145
</div>
146146
{{< /example >}}
147147

148-
### Reverse
148+
### Inverse
149149

150-
You can reverse the component by adding `.checkbox-item-reverse` to a `.checkbox-item`.
150+
You can reverse the component by adding `.checkbox-item-inverse` to a `.checkbox-item`.
151151

152152
{{< example >}}
153-
<div class="checkbox-item checkbox-item-reverse">
153+
<div class="checkbox-item checkbox-item-inverse">
154154
<div class="checkbox-item-indicator-container">
155-
<input class="checkbox-indicator" type="checkbox" value="" id="checkboxReverse">
155+
<input class="checkbox-indicator" type="checkbox" value="" id="checkboxInverse">
156156
</div>
157157
<div class="checkbox-item-text">
158-
<label class="checkbox-label" for="checkboxReverse">Label</label>
158+
<label class="checkbox-label" for="checkboxInverse">Label</label>
159159
</div>
160160
</div>
161161
{{< /example >}}

site/content/docs/0.2/migration-from-boosted.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,46 @@ You will have to make some extra Javascript to change the styles and update the
132132

133133
### Checks & radios
134134

135-
- <span class="badge text-bg-status-warning-emphasized">Warning</span> `.form-check`, `.form-check-input` and `.form-check-label` have been changed. Please make sure that the rendering is still fine.
135+
- <span class="badge text-bg-status-negative-emphasized">Breaking</span> Switch and radio buttons and the corresponding class `.form-switch` have been removed.
136136

137137
- <span class="badge text-bg-status-warning-emphasized">Warning</span> `form-star-rating()` mixin has been removed as it was deprecated in Boosted v5.3.2.
138138

139+
140+
#### Checkbox
141+
142+
- <span class="badge text-bg-status-positive-emphasized">New</span> `.checkbox-item`, `.checkbox-item-icon-container`, `.checkbox-item-indicator-container`, `.checkbox-item-text`, `.checkbox-label`, `.checkbox-indicator`, `.checkbox-helper`, `.checkbox-item-divider`, `.checkbox-item-inverse` have been added.
143+
144+
- <span class="badge text-bg-status-negative-emphasized">Breaking</span> Checkbox is a new component compared to Boosted's Check, the DOM is therefore very different.
145+
<div class="ps-taller">
146+
For example, if you used to write:
147+
148+
```html
149+
<div class="form-check">
150+
<input class="form-check-input" type="checkbox" value="" id="checkboxDefault">
151+
<label class="form-check-label" for="checkboxDefault">
152+
Default checkbox
153+
</label>
154+
</div>
155+
```
156+
Now you should write:
157+
158+
```html
159+
<div class="checkbox-item">
160+
<div class="checkbox-item-indicator-container">
161+
<input class="checkbox-indicator" type="checkbox" value="" id="checkboxDefault">
162+
</div>
163+
<div class="checkbox-item-text">
164+
<label class="checkbox-label" for="checkboxDefault">Default checkbox</label>
165+
</div>
166+
</div>
167+
```
168+
See [our new Checkbox page]({{< docsref "/forms/checkbox" >}}) for more information.
169+
</div>
170+
171+
- <span class="badge text-bg-status-negative-emphasized">Breaking</span> `.form-check`, `.form-check-input`, `.form-check-label`, `.form-check-inline`, `.form-check-reverse` have been removed.
172+
173+
- <span class="badge text-bg-status-warning-emphasized">Warning</span> Links in Checkboxes labels are now forbidden (they won't be interactive anyway).
174+
139175
## Helpers
140176

141177
### Color background
@@ -651,19 +687,6 @@ You will have to make some extra Javascript to change the styles and update the
651687
<li><code>$ouds-button-space-padding-inline-icon-none</code></li>
652688
<li><code>$ouds-button-space-padding-inline-icon-start</code></li>
653689
<li><code>$ouds-button-space-padding-inline-start-icon-end</code></li>
654-
<li><code>$ouds-checkbox-border-radius</code></li>
655-
<li><code>$ouds-checkbox-border-width-selected-focus</code></li>
656-
<li><code>$ouds-checkbox-border-width-selected-hover</code></li>
657-
<li><code>$ouds-checkbox-border-width-selected-pressed</code></li>
658-
<li><code>$ouds-checkbox-border-width-selected</code></li>
659-
<li><code>$ouds-checkbox-border-width-unselected-focus</code></li>
660-
<li><code>$ouds-checkbox-border-width-unselected-hover</code></li>
661-
<li><code>$ouds-checkbox-border-width-unselected-pressed</code></li>
662-
<li><code>$ouds-checkbox-border-width-unselected</code></li>
663-
<li><code>$ouds-checkbox-size-indicator</code></li>
664-
<li><code>$ouds-checkbox-size-max-height</code></li>
665-
<li><code>$ouds-checkbox-size-min-height</code></li>
666-
<li><code>$ouds-checkbox-size-min-width</code></li>
667690
<li><code>$ouds-color-action-disabled-dark</code></li>
668691
<li><code>$ouds-color-action-disabled-light</code></li>
669692
<li><code>$ouds-color-action-enabled-dark</code></li>

0 commit comments

Comments
 (0)