Skip to content

Commit 75e9f85

Browse files
authored
chore(docs): added further comments for clarity (#144)
1 parent 5e6110f commit 75e9f85

File tree

4 files changed

+19
-0
lines changed

4 files changed

+19
-0
lines changed

source/css/_db-ui-core.variables.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/* *****
2+
This file summarizes the general variables relevant for using DB UI Core with SCSS.
3+
***** */
4+
15
// Define the path for both image and font folders
26
$icons-path: "../../icons/" !default;
37
$images-path: "../../images/" !default;

source/css/_fonts.general.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/* *****
2+
SCSS placeholder for general font declarations
3+
***** */
4+
15
@import "db-ui-core.variables";
26

37
%general-fonts {

source/css/db-ui-core.general.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/* *****
2+
This is mainly meant to get included within scoped components like e.g. within StencilJS Custom Components / DB UI Elements
3+
***** */
4+
15
@import "db-ui-core.variables";
26
@import "@csstools/normalize.css/normalize";
37
@import "../_patterns/00-base/init";

source/css/db-ui-core.vars.scss

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/* *****
2+
This file is meant to get included globally on a page with a standard set of variables and font references,
3+
if you're using only partials – either Web Components out of DB UI Elements or the partial CSS generated out
4+
of DB UI Core for each element and component.
5+
***** */
6+
17
// Define the path for both image and font folders
28
$icons-path: "../icons/" !default;
39
$images-path: "../images/" !default;
@@ -12,6 +18,7 @@ $fonts-path: "../fonts/" !default;
1218
@import "../_patterns/00-base/icons/icons.font-faces";
1319

1420
:root {
21+
// Overwriting the referenced SVG icons as this is going to get inlined and the path would be relative to the pages URL instead of the CSS, which would break
1522
--db-ic-search-24: url(#{$icons-path}functional/images/action/db_ic_search_24.svg);
1623
--db-ic-expand-more-20: url(#{$icons-path}functional/images/navigation/db_ic_expand_more_20.svg);
1724
}

0 commit comments

Comments
 (0)