Skip to content

feat(description-list): components theming with CSS-vars (#DS-2846) #274

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.

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 5 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/guides/theming-2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
- [checkbox,pseudo-checkbox](/packages/components/checkbox/checkbox-tokens.scss)
- [code-block](/packages/components/code-block/code-block-tokens.scss)
- [datepicker](/packages/components/datepicker/datepicker-tokens.scss)
- [description-list](/packages/components/dl/dl-tokens.scss)
- [divider](/packages/components/divider/divider-tokens.scss)
- [dropdown](/packages/components/dropdown/dropdown-tokens.scss)
- [empty-state](/packages/components/empty-state/empty-state-tokens.scss)
Expand Down
3 changes: 0 additions & 3 deletions packages/components/core/styles/_koobiq-theme.scss
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,10 @@
@use '../option/optgroup-theme' as *;
@use '../option/option-action-theme' as *;
@use '../highlight/highlight-theme' as *;
@use '../../dl/dl-theme' as *;

@mixin koobiq-theme($theme) {
@include kbq-core-theme($theme);

@include kbq-dl-theme($theme);
@include kbq-file-upload-theme($theme);
@include kbq-forms-theme($theme);
@include kbq-highlight-theme();
Expand Down Expand Up @@ -82,7 +80,6 @@
@include kbq-base-typography();
@include kbq-markdown-base-typography();

@include kbq-dl-typography($config);
@include kbq-file-upload-typography($config);
@include kbq-forms-typography($config);
@include kbq-list-typography($config);
Expand Down
10 changes: 4 additions & 6 deletions packages/components/dl/_dl-theme.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,17 @@
@use '../core/styles/typography/typography-utils' as *;
@use '../core/styles/common/tokens' as *;

@mixin kbq-dl-theme($theme) {
$dl: map.get(map.get($theme, components), dl);

@mixin kbq-dl-theme() {
.kbq-dt {
color: kbq-css-variable(description-list-term-color, map.get($dl, dt));
color: kbq-css-variable(description-list-term-color);
}

.kbq-dd {
color: kbq-css-variable(description-list-description-color, map.get($dl, dd));
color: kbq-css-variable(description-list-description-color);
}
}

@mixin kbq-dl-typography($config) {
@mixin kbq-dl-typography() {
.kbq-dl {
& .kbq-dt {
@include kbq-typography-css-variables(description-list, term);
Expand Down
32 changes: 32 additions & 0 deletions packages/components/dl/dl-tokens.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.kbq-dl {
--kbq-description-list-size-horizontal-content-gap-horizontal: 16px;
--kbq-description-list-size-horizontal-gap-vertical: 16px;
--kbq-description-list-size-vertical-content-gap-vertical: 2px;
--kbq-description-list-size-vertical-gap-vertical: 12px;
--kbq-description-list-font-term-font-size: 14px;
--kbq-description-list-font-term-line-height: 20px;
--kbq-description-list-font-term-letter-spacing: -0.006em;
--kbq-description-list-font-term-font-weight: normal;
--kbq-description-list-font-term-font-family: Inter, -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Helvetica Neue',
Arial, sans-serif;
--kbq-description-list-font-term-text-transform: null;
--kbq-description-list-font-term-font-feature-settings: 'calt', 'kern', 'liga', 'ss01', 'ss04';
--kbq-description-list-font-description-font-size: 14px;
--kbq-description-list-font-description-line-height: 20px;
--kbq-description-list-font-description-letter-spacing: -0.006em;
--kbq-description-list-font-description-font-weight: normal;
--kbq-description-list-font-description-font-family: Inter, -apple-system, BlinkMacSystemFont, 'Segoe UI',
'Helvetica Neue', Arial, sans-serif;
--kbq-description-list-font-description-text-transform: null;
--kbq-description-list-font-description-font-feature-settings: 'calt', 'kern', 'liga', 'ss01', 'ss04';
}

:where(.kbq-light, .theme-light, .kbq-theme-light) {
--kbq-description-list-term-color: hsla(229, 15%, 50%, 100%);
--kbq-description-list-description-color: hsla(229, 15%, 15%, 100%);
}

:where(.kbq-dark, .theme-dark, .kbq-theme-dark) {
--kbq-description-list-term-color: hsla(229, 15%, 50%, 100%);
--kbq-description-list-description-color: hsla(229, 15%, 80%, 100%);
}
2 changes: 1 addition & 1 deletion packages/components/dl/dl.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { debounceTime } from 'rxjs/operators';
@Component({
selector: 'kbq-dl',
template: '<ng-content />',
styleUrls: ['dl.scss'],
styleUrls: ['dl.scss', 'dl-tokens.scss'],
host: {
class: 'kbq-dl',
'[class.kbq-dl_vertical]': 'vertical',
Expand Down
5 changes: 5 additions & 0 deletions packages/components/dl/dl.scss
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

@use '../core/styles/common/tokens' as *;

@use './dl-theme' as *;

.kbq-dl {
display: grid;
column-gap: kbq-css-variable(description-list-size-horizontal-content-gap-horizontal);
Expand Down Expand Up @@ -45,3 +47,6 @@
}
}
}

@include kbq-dl-theme();
@include kbq-dl-typography();
1 change: 1 addition & 0 deletions tools/tokens/build-each-component.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const componentsWithCss = [
'checkbox',
'code-block',
'datepicker',
'description-list',
'divider',
'dropdown',
'empty-state',
Expand Down
4 changes: 3 additions & 1 deletion tools/tokens/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ const componentNameMapping = {
autocomplete: 'autocomplete-panel',
'button-toggle': 'button-toggle-group',
datepicker: 'datepicker__content',
dropdown: 'dropdown__panel'
dropdown: 'dropdown__panel',
'description-list': 'dl'
};

const applyCustomTransformations = (dictionary) => {
Expand All @@ -38,6 +39,7 @@ const componentAliases = {
{ path: 'checkbox/checkbox-tokens.scss', aliasName: 'checkbox' },
{ path: 'core/selection/pseudo-checkbox/pseudo-checkbox-tokens.scss', aliasName: 'pseudo-checkbox' }
],
'description-list': 'dl/dl-tokens.scss',
hint: 'form-field/hint-tokens.scss',
'icon-button': 'icon/icon-button-tokens.scss',
'icon-item': 'icon/icon-item-tokens.scss'
Expand Down