Skip to content

refactor: guidelines 3.0 checkbox style #62

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

Closed
wants to merge 5 commits into from
Closed

refactor: guidelines 3.0 checkbox style #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
754ef21
refactor: added sizes and restyling
mfranzke Sep 30, 2022
24c247e
docs(checkbox): added sizes documentation
mfranzke Sep 30, 2022
b4cc4b6
feat(checkbox): added required states styles
mfranzke Oct 3, 2022
57a74ec
chore: further styling adaptions
mfranzke Oct 3, 2022
4cc9fbe
chore: adapted to (and reduced) test URL list
mfranzke Oct 3, 2022
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
7 changes: 5 additions & 2 deletions .pa11yci
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,16 @@
"http://127.0.0.1:8080/patterns/elements-buttons-06-button-tertiary-plain/elements-buttons-06-button-tertiary-plain.rendered.html",
"http://127.0.0.1:8080/patterns/elements-buttons-09-button-sizes/elements-buttons-09-button-sizes.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-checked/elements-checkbox-checkbox-checked.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-disabled-checked/elements-checkbox-checkbox-disabled-checked.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-disabled/elements-checkbox-checkbox-disabled.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-disabled-checked/elements-checkbox-checkbox-disabled-checked.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-indeterminate/elements-checkbox-checkbox-indeterminate.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background/elements-checkbox-checkbox-on-dark-background.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-checked/elements-checkbox-checkbox-on-dark-background-checked.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-disabled-checked/elements-checkbox-checkbox-on-dark-background-disabled-checked.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-disabled/elements-checkbox-checkbox-on-dark-background-disabled.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-disabled-checked/elements-checkbox-checkbox-on-dark-background-disabled-checked.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-indeterminate/elements-checkbox-checkbox-on-dark-background-indeterminate.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-required/elements-checkbox-checkbox-required.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-sizes/elements-checkbox-checkbox-sizes.rendered.html",
"http://127.0.0.1:8080/patterns/elements-checkbox-checkbox/elements-checkbox-checkbox.rendered.html",
"http://127.0.0.1:8080/patterns/elements-image-image-avif/elements-image-image-avif.rendered.html",
"http://127.0.0.1:8080/patterns/elements-image-image-lazy-loading/elements-image-image-lazy-loading.rendered.html",
Expand Down
18 changes: 18 additions & 0 deletions source/_patterns/01-elements/checkbox/_checkbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Checkbox
state: inevaluation
---

## Variations/configurability

### Size

#### SCSS (recommended)

Extend one of the size SCSS placeholders in case that you don't want the default (medium): `%size-Small` or `%size-Large`

#### HTML attribute

You could set the different button sizes via the `data-size` attribute, the default is "medium" and in that case is optional.

[inspirational sources for this page]: # "https://www.uiguideline.com/components/checkbox"
6 changes: 6 additions & 0 deletions source/_patterns/01-elements/checkbox/checkbox-sizes.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{#each sizes }}
<h2>{{ label }}</h2>
<p>
{{> elements-checkbox id=../id }}
</p>
{{/each }}
18 changes: 18 additions & 0 deletions source/_patterns/01-elements/checkbox/checkbox-sizes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"sizes": [
{
"size": "small",
"label": "Small"
},
{
"size": "medium",
"label": "Medium (default, data-size attribute is optional)"
},
{
"size": "large",
"label": "Large"
}
],
"id": "checkbox05",
"label": "Checkbox"
}
10 changes: 6 additions & 4 deletions source/_patterns/01-elements/checkbox/checkbox.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<input type="checkbox"
class="elm-checkbox {{ styleModifier }}"
id="{{ id }}"{{#if checked}} checked{{/if }}
id="{{ id }}{{#if size }}-{{ size }}{{/if }}"{{#if checked}} checked{{/if }}
{{#if disabled}} disabled{{/if }}
value="{{ value }}"
{{#if describedbyid }} aria-describedby="{{ describedbyid }}"{{/if }}>
<label class="elm-label" for="{{ id }}">{{ label }}</label>
{{#if describedbyid }} aria-describedby="{{ describedbyid }}"{{/if }}
{{#if size }} data-size="{{ size }}"{{/if }}
{{#if required }} required{{/if }}>
<label class="elm-label" for="{{ id }}{{#if size }}-{{ size }}{{/if }}">{{ label }}</label>
{{#if indeterminate}}
<script>
document.querySelector('#{{ id }}').indeterminate = true;
document.querySelector('#{{ id }}{{#if size }}-{{ size }}{{/if }}').indeterminate = true;
</script>
{{/if }}
6 changes: 0 additions & 6 deletions source/_patterns/01-elements/checkbox/checkbox.md
View file
Open in desktop

This file was deleted.

69 changes: 61 additions & 8 deletions source/_patterns/01-elements/checkbox/checkbox.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,25 @@
@import "checkbox.variables";

.elm-checkbox {
@include icon("\00A0", 24, "outline", $partial: $partial);
// $checkbox-size: 16;
// TODO: Replace this ugly hack as soon as we've got this as an icon font as well
$checkbox-size: 20;
&:before {
font-size: 18px;
}

@include icon("\00A0", $checkbox-size, "outline", $partial: $partial);

appearance: none;
background-color: $checkbox---backgroundColor;
border: #{to-rem($pxValue: 1)} solid $checkbox---borderColor;
border-radius: 4px;
border: 1px solid $checkbox---borderColor;
border-radius: 3px;
color: $checkbox---color;
height: to-rem($pxValue: 24);
height: to-rem($pxValue: $checkbox-size);
&[type="checkbox"] {
vertical-align: top;
vertical-align: middle;
}
width: to-rem($pxValue: 24);
width: to-rem($pxValue: $checkbox-size);

display: inline-flex;
justify-content: center;
Expand Down Expand Up @@ -45,7 +52,7 @@
}
}
&:active {
background-color: rgba(40, 45, 55, 0.14);
background-color: rgba(0, 0, 0, 0.24);
}
}

Expand All @@ -58,11 +65,57 @@
&:disabled {
&,
& + label {
opacity: 0.5;
opacity: 0.25;
}
}

& + label {
margin-left: $db-spacing-xs;

font-size: to-rem($pxValue: 12);
}

// Sizes
&%size-Small {
$checkbox-size: 16;
// TODO: Replace this ugly hack as soon as we've got this as an icon font as well
&:before {
font-size: 14px;
}

height: to-rem($pxValue: $checkbox-size);
width: to-rem($pxValue: $checkbox-size);
// TODO: Replace this ugly hack as soon as we've got this as an icon font as well
// @include iconMeta($checkbox-size);
@include iconMeta(20);
}
&%size-Large {
$checkbox-size: 24;
&:before {
font-size: 24px;
}

height: to-rem($pxValue: $checkbox-size);
width: to-rem($pxValue: $checkbox-size);
@include iconMeta($checkbox-size);

& + label {
font-size: to-rem($pxValue: 16);
}
}

&[data-size="small"] {
@extend %size-Small;
}
&[data-size="large"] {
@extend %size-Large;
}

&:required {
& + label {
&::after {
content: " *";
}
}
}
}
4 changes: 4 additions & 0 deletions source/_patterns/01-elements/checkbox/checkbox~required.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"id": "checkbox06",
"required": true
}
50 changes: 10 additions & 40 deletions tests/backstop.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,48 +539,18 @@
},
{
"label": "Checkbox",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox/elements-checkbox-checkbox.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox/elements-checkbox-checkbox.rendered.html"
"url": "http://127.0.0.1:8080/patterns/elements-checkbox/index.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox/index.html"
},
{
"label": "Checkbox Checked",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-checked/elements-checkbox-checkbox-checked.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-checked/elements-checkbox-checkbox-checked.rendered.html"
},
{
"label": "Checkbox Disabled",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-disabled/elements-checkbox-checkbox-disabled.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-disabled/elements-checkbox-checkbox-disabled.rendered.html"
},
{
"label": "Checkbox Disabled Checked",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-disabled-checked/elements-checkbox-checkbox-disabled-checked.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-disabled-checked/elements-checkbox-checkbox-disabled-checked.rendered.html"
},
{
"label": "Checkbox Indeterminate",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-indeterminate/elements-checkbox-checkbox-indeterminate.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-indeterminate/elements-checkbox-checkbox-indeterminate.rendered.html"
},
{
"label": "Checkbox Indeterminate Checked",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-indeterminate/elements-checkbox-checkbox-on-dark-background-indeterminate.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-on-dark-background-indeterminate/elements-checkbox-checkbox-on-dark-background-indeterminate.rendered.html"
},
{
"label": "Checkbox On Dark Background Checked",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-checked/elements-checkbox-checkbox-on-dark-background-checked.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-on-dark-background-checked/elements-checkbox-checkbox-on-dark-background-checked.rendered.html"
},
{
"label": "Checkbox On Dark Background Disabled",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-disabled/elements-checkbox-checkbox-on-dark-background-disabled.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-on-dark-background-disabled/elements-checkbox-checkbox-on-dark-background-disabled.rendered.html"
},
{
"label": "Checkbox On Dark Background Disabled Checked",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox-checkbox-on-dark-background-disabled-checked/elements-checkbox-checkbox-on-dark-background-disabled-checked.rendered.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox-checkbox-on-dark-background-disabled-checked/elements-checkbox-checkbox-on-dark-background-disabled-checked.rendered.html"
"label": "Checkbox - hovered",
"url": "http://127.0.0.1:8080/patterns/elements-checkbox/index.html",
"referenceUrl": "https://db-ui.github.io/core/patterns/elements-checkbox/index.html",
"hoverSelectors": [
".elm-checkbox"
],
"postInteractionWait": 1000,
"onReadyScript": "puppet/clickAndHoverHelper.js"
},
{
"label": "Image",
Expand Down