Skip to content

Auto Update from main #117

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

Merged
merged 5 commits into from
Oct 26, 2022
Merged

Auto Update from main #117

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
f269407
docs: update docs for create-react-app (#111)
annsch Oct 25, 2022
e734ee3
fix: icon rendering in DB UI Elements (#115)
mfranzke Oct 25, 2022
a2859b5
chore: aligned header background-colors (#110)
mfranzke Oct 25, 2022
7a8b712
build(deps-dev): bump html-validate from 7.7.0 to 7.7.1
dependabot[bot] Oct 25, 2022
640dab4
Merge pull request #116 from db-ui/dependabot-npm_and_yarn-html-valid…
github-actions[bot] Oct 25, 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
20 changes: 19 additions & 1 deletion docs/getStarted.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This should add a new entry to your `package.json` file:
@import "@db-ui/core/sources/css/enterprise/db-ui-core";
----

### SCSS: `node_modules include path / load path
### SCSS: node_modules include path / load path

Please keep in mind, that you would need to set your `include path` also known as `load path` depending on your setup for the sass compiler to find the correct `node_modules` folder, e.g. like the following (this is similar to how other frameworks and libraries like link:https://github.com/twbs/bootstrap-npm-starter/blob/main/package.json#L18[Bootstrap] are handling this):

Expand Down Expand Up @@ -172,6 +172,24 @@ If you want to use the compiled CSS directly, you can refence the css files in y
<link rel="stylesheet" href="css/enterprise/db-ui-core.css" type="text/css">
----

## Example 2: how to use DB UI Core in Create React app

Create React App offers only limited access to the configuration of the production build. While it uses webpack under the hood, the webpack configuration is not exposed to the user.
To manage your CRA to work with SASS include Path you have to update or create your _.env_ file:

----
SASS_PATH=node_modules
----

In addition to get the asset paths working you have to load them separately. Further description is written above within the section _webpack based bundlers_.

[source,scss]
----
@import "@db-ui/core/sources/css/webpack.assets-paths";
@import "@db-ui/core/sources/css/enterprise/db-ui-core";
----


## Documentation

Please find our Architectural Decision Records within the link:adr/[adr subfolder].
Expand Down
14 changes: 7 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"dialog-polyfill": "^0.5.6",
"dotenv": "^16.0.3",
"find-versions-cli": "^4.0.0",
"html-validate": "^7.7.0",
"html-validate": "^7.7.1",
"html5-boilerplate": "^8.0.0",
"husky": "^8.0.1",
"iframe-resizer": "^4.3.2",
Expand Down
1 change: 1 addition & 0 deletions source/_patterns/00-base/icons/_icons.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// @import "icons.variables";

@import "icons.variables";
@import "icons.attributes-mappings";
@import "icons.helpers";
@import "icons.custom-properties";
@import "icons.font-faces";
Expand Down
1 change: 0 additions & 1 deletion source/_patterns/00-base/icons/enterprise/icons.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
@import "icons.variables";

@import "../icons.attributes-mappings";
@import "icons.custom-properties";
@import "icons.font-faces";
@import "../icons";
1 change: 1 addition & 0 deletions source/_patterns/02-components/mainnavigation/_mainnavigation.variables.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
@import "../../00-base/icons/icons.helpers";

$header-big-link-paddingTop: 32 * 0.0625 !default;
$header---backgroundColor: #fdfdfd !default; // TODO: This would need to get replaced by the correct (semantic) color

// * reduced height
// $header-big-link-paddingTop: 19*0.0625 !default;
Expand Down
4 changes: 2 additions & 2 deletions source/_patterns/02-components/mainnavigation/mainnavigation.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
@include icon(glyph(menu), 24, "outline", $partial: $partial);
@include icon(glyph(close), 24, "outline", "after", $partial: $partial);

background-color: #fdfdfd; // TODO: This would need to get replaced by the correct (semantic) color
background-color: $header---backgroundColor; // TODO: This would need to get replaced by the correct (semantic) color

border-bottom: 1px solid $db-color-warm-gray-100;

Expand Down Expand Up @@ -79,7 +79,7 @@
}

ul {
background-color: #fff;
background-color: $header---backgroundColor;
}

// Multiple level navigation
Expand Down
2 changes: 0 additions & 2 deletions source/_patterns/03-areas/00-header/_header.variables.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,3 @@ $header---borderBottom: #{to-rem(
$header---marginBottom: to-rem(
$pxValue: 16
) !default;

$header---backgroundColor: #fdfdfd !default; // TODO: This would need to get replaced by the correct (semantic) color