@ihk-gfi/lux-components-theme 19.3.0 → 21.1.0

package/README.md

@@ -3,16 +3,22 @@
 - [Theme](#theme)
   - [Installation](#installation)
   - [LUX-Theme](#lux-theme)
-    - [Allgemeine Css-Variablen](#allgemeine-css-variablen)
-    - [Allgemeine Css-Klassen](#allgemeine-css-klassen)
-    - [Beispiel einer Farbpalette](#beispiel-einer-farbpalette)
-      - [Css-Variablen](#css-variablen)
-      - [Css-Klassen](#css-klassen)
+    - [Allgemeine CSS-Variablen](#allgemeine-css-variablen)
+      - [CSS-Variablen-Beispiele](#css-variablen-beispiele)
+    - [Allgemeine CSS-Klassen](#allgemeine-css-klassen)
+      - [CSS-Klassen](#css-klassen)
     - [Code-Beispiele](#code-beispiele)
-      - [Css-Variable](#css-variable)
-      - [Css-Klasse](#css-klasse)
-- [Lizenzhinweis - Icons](#lizenzhinweis---icons)
-- [Lizenzhinweis - Fonts](#lizenzhinweis---fonts)
+      - [CSS-Variable nutzen](#css-variable-nutzen)
+      - [LUX-Card umstylen](#lux-card-umstylen)
+      - [LUX-Button (rund) umstylen](#lux-button-rund-umstylen)
+      - [LUX-Button (stroked) umstylen](#lux-button-stroked-umstylen)
+      - [CSS-Klasse](#css-klasse)
+  - [Lizenztext - Icons](#lizenztext---icons)
+  - [Lizenztext - Fonts](#lizenztext---fonts)
+
+Dieses Projekt enthält alle Themes der [LUX-Components](https://www.npmjs.com/package/@ihk-gfi/lux-components).
+
+> **Hinweis:** Seit Version 20 basiert das Theme auf [Material Theme 3 (MDC)](https://m3.material.io/) und verwendet Design Tokens für eine moderne, flexible und konsistente Gestaltung. Die Farbpaletten und Variablen wurden überarbeitet. Migrationstipps siehe unten.
 
 ## Installation
 
@@ -22,67 +28,34 @@ npm install @ihk-gfi/lux-components-theme
 
 ## LUX-Theme
 
-Ein LUX-Theme besteht immer aus den drei Farbpaletten:
+Ein LUX-Theme besteht immer aus unterschiedlichen Farbpaletten:
 
 - `lux-palette_primary`
 - `lux-palette_accent`
 - `lux-palette_warn`
+- `lux-palette_neutral`
+
+Aus den Farbpaletten werden zahlreiche CSS-Variablen und CSS-Klassen abgeleitet.
+Zusätzlich gibt es viele allgemeine CSS-Variablen und CSS-Klassen.
+Alles zusammen bildet die Grundlage für das Theming eigener Komponenten auf Basis eines LUX-Themes.
+
+### Allgemeine CSS-Variablen
+
+Die verfügbaren CSS-Variablen stehen im jeweiligen Theme:
 
-Aus den Farbpaletten werden eine Menge von Css-Variablen und Css-Klassen abgeleitet.
-Zusätzlich gibt es eine Menge von allgemeinen Css-Variablen und Css-Klassen.
-Alles zusammen bildet die Grundlage für das Theming der eigenen Komponenten auf Basis eines LUX-Themes.
-
-### Allgemeine Css-Variablen
-
-- `--lux-theme-app-header-bg`
-- `--lux-theme-app-content-bg`
-- `--lux-theme-app-footer-bg`
-- `--lux-theme-app-data-bg`
-- `--lux-theme-dark-primary-text`
-- `--lux-theme-dark-secondary-text`
-- `--lux-theme-dark-disabled-text`
-- `--lux-theme-dark-dividers`
-- `--lux-theme-dark-focused`
-- `--lux-theme-light-primary-text`
-- `--lux-theme-light-secondary-text`
-- `--lux-theme-light-disabled-text`
-- `--lux-theme-light-dividers`
-- `--lux-theme-light-focused`
-- `--lux-theme-form-border-color`
-- `--lux-theme-form-control-font-size`
-- `--lux-theme-form-control-buffer`
-- `--lux-theme-button-height`
-- `--lux-theme-button-fav-height`
-- `--lux-theme-outline-color-bright`
-- `--lux-theme-outline-color-dark`
-- `--lux-theme-hover-color`
-- `--lux-theme-hover-color-for-dark-background`
-- `--lux-theme-selected-border-color`
-- `--lux-theme-selected-bg-color`
-- `--lux-theme-primary-color`
-- `--lux-theme-accent-color`
-- `--lux-theme-warn-color`
-- `--lux-theme-component-bg-red`
-- `--lux-theme-component-bg-green`
-- `--lux-theme-component-bg-purple`
-- `--lux-theme-component-bg-blue`
-- `--lux-theme-component-bg-gray`
-- `--lux-theme-component-bg-orange`
-- `--lux-theme-component-bg-brown`
-- `--lux-theme-component-bg-black`
-- `--lux-theme-component-bg-white`
-- `--lux-theme-component-bg-dark-red`
-- `--lux-theme-component-bg-dark-green`
-- `--lux-theme-component-bg-dark-purple`
-- `--lux-theme-component-bg-dark-blue`
-- `--lux-theme-component-bg-dark-gray`
-- `--lux-theme-component-bg-dark-orange`
-- `--lux-theme-component-bg-dark-brown`
-- `--lux-theme-component-bg-dark-white`
-- `--lux-theme-component-font-color-black`
-- `--lux-theme-component-font-color-white`
-
-### Allgemeine Css-Klassen
+- `projects\lux-components-theme\src\${themeName}\_variables.scss`
+- `projects\lux-components-theme\src\${themeName}\_variablesPreferContrast.scss`
+
+#### CSS-Variablen-Beispiele
+
+- --lux-theme-app-font-family (Schriftart)
+- --lux-theme-custom-red (Hintergrundfarbe)
+- --lux-theme-custom-on-red (Textfarbe)
+- --lux-theme-accordion-header-color-neutral (Hintergrundfarbe)
+- --lux-theme-accordion-header-color-on-neutral (Textfarbe)
+- ...
+
+### Allgemeine CSS-Klassen
 
 - `lux-app-header-bg`
 - `lux-app-content-bg`
@@ -110,156 +83,134 @@ Alles zusammen bildet die Grundlage für das Theming der eigenen Komponenten auf
 - `lux-outline-light`
 - `lux-outline-dark`
 
-### Beispiel einer Farbpalette
+#### CSS-Klassen
 
-```
-$lux-palette_primary: (
-50 : #e7ebf0,
-100 : #c6d1dc,
-200 : #99aec2,
-300 : #708daa,
-400 : #527497,
-500 : #335c85,
-600 : #2e547d,
-700 : #274a72,
-800 : #204168,
-900 : #143055,
-A100 : #b5d5e8,
-A200 : #4d9dca,
-A400 : #0073b3,
-A700 : #00569a,
-contrast: (
-50 : #000000,
-100 : #000000,
-200 : #000000,
-300 : #000000,
-400 : #000000,
-500 : #ffffff,
-600 : #ffffff,
-700 : #ffffff,
-800 : #ffffff,
-900 : #ffffff,
-A100 : #000000,
-A200 : #000000,
-A400 : #000000,
-A700 : #000000,
-)
-);
-```
+Zu jedem Eintrag (z.B. 0, 10, 20,...) der Farbpalette gibt es im LUX-Theme entsprechende CSS-Klassen.
+Hier im Beispiel werden nur die CSS-Klassen des Eintrags 20 aufgeführt. Die Klassen der anderen Einträge
+(0, 10, 20,...) sind analog aufgebaut.
 
-#### Css-Variablen
-
-- `--lux-theme-primary-50`
-- `--lux-theme-primary-50-contrast`
-- `--lux-theme-primary-100`
-- `--lux-theme-primary-100-contrast`
-- `--lux-theme-primary-200`
-- `--lux-theme-primary-200-contrast`
-- `--lux-theme-primary-300`
-- `--lux-theme-primary-300-contrast`
-- `--lux-theme-primary-400`
-- `--lux-theme-primary-400-contrast`
-- `--lux-theme-primary-500`
-- `--lux-theme-primary-500-contrast`
-- `--lux-theme-primary-600`
-- `--lux-theme-primary-600-contrast`
-- `--lux-theme-primary-700`
-- `--lux-theme-primary-700-contrast`
-- `--lux-theme-primary-800`
-- `--lux-theme-primary-800-contrast`
-- `--lux-theme-primary-900`
-- `--lux-theme-primary-900-contrast`
-- `--lux-theme-primary-a100`
-- `--lux-theme-primary-a100-contrast`
-- `--lux-theme-primary-a200`
-- `--lux-theme-primary-a200-contrast`
-- `--lux-theme-primary-a400`
-- `--lux-theme-primary-a400-contrast`
-- `--lux-theme-primary-a700`
-- `--lux-theme-primary-a700-contrast`
-
-#### Css-Klassen
-
-Zu jedem Eintrag (z.B. 50, 100, 200,..., A100, A200,...) der Farbpalette gibt es im LUX-Theme entsprechende Css-Klassen.
-Hier im Beispiel werden nur die Css-Klassen des Eintrags 50 aufgeführt. Die Klassen der anderen Einträge
-(50, 100, 200,...) sind analog aufgebaut.
-
-- `lux-color-primary-50`
-- `lux-color-primary-50-contrast`
-- `lux-bg-color-primary-50`
-- `lux-bg-color-primary-50-contrast`
-- `lux-border-color-primary-50`
-- `lux-border-color-primary-50-contrast`
-- `lux-outline-color-primary-50`
-- `lux-outline-color-primary-50-contrast`
-- `lux-text-decoration-primary-color-50`
-- `lux-text-decoration-primary-color-50-contrast`
-- `lux-column-rule-color-primary-50`
-- `lux-column-rule-color-primary-50-contrast`
-- `lux-color-accent-50`
-- `lux-color-accent-50-contrast`
+- `lux-color-primary-20`
+- `lux-bg-color-primary-20`
+- `lux-border-color-primary-20`
+- `lux-outline-color-primary-20`
+- `lux-text-decoration-primary-color-20`
+- `lux-column-rule-color-primary-20`
+- `lux-color-accent-20`
 - `lux-bg-color-accent`
-- `lux-bg-color-accent-50-contrast`
-- `lux-border-color-accent-50`
-- `lux-border-color-accent-50-contrast`
-- `lux-outline-color-accent-50`
-- `lux-outline-color-accent-50-contrast`
-- `lux-text-decoration-accent-color-50`
-- `lux-text-decoration-accent-color-50-contrast`
-- `lux-column-rule-color-accent-50`
-- `lux-column-rule-color-accent-50-contrast`
-- `lux-color-warn-50`
-- `lux-color-warn-50-contrast`
-- `lux-bg-color-warn-50`
-- `lux-bg-color-warn-50-contrast`
-- `lux-border-color-warn-50`
-- `lux-border-color-warn-50-contrast`
-- `lux-outline-color-warn-50`
-- `lux-outline-color-warn-50-contrast`
-- `lux-text-decoration-warn-color-50`
-- `lux-text-decoration-warn-color-50-contrast`
-- `lux-column-rule-color-warn-50`
-- `lux-column-rule-color-warn-50-contrast`
+- `lux-border-color-accent-20`
+- `lux-outline-color-accent-20`
+- `lux-text-decoration-accent-color-20`
+- `lux-column-rule-color-accent-20`
+- `lux-color-warn-20`
+- `lux-bg-color-warn-20`
+- `lux-border-color-warn-20`
+- `lux-outline-color-warn-20`
+- `lux-text-decoration-warn-color-20`
+- `lux-column-rule-color-warn-20`
+- ...
 
 ### Code-Beispiele
 
-#### Css-Variable
+#### CSS-Variable nutzen
+
+Beispiel:
 
-Bespiel:
+HTML-Datei:
+
+```html
+<span class="highlight">Lorem ipsum</span>
+```
 
-Html-Datei:
+SCSS-Datei:
 
+```scss
+span.highlight {
+  background-color: var(--lux-theme-selected-bg-color);
+}
 ```
+
+#### LUX-Card umstylen
+
+Beispiel:
+
+HTML-Datei:
+
+```html
 <lux-card class="highlight" luxTitle="Lorem ipsum"></lux-card>
 ```
 
-Scss-Datei:
+SCSS-Datei:
+
+```scss
+lux-card.highlight {
+  --lux-theme-card-background-color: rgb(207, 211, 212);
+  --lux-theme-card-padding: 4px;
+  --lux-theme-card-shape: 16px;
+  --lux-theme-card-title-text-size: 1rem;
+  --lux-theme-card-title-text-weight: normal;
+  --lux-theme-card-subtitle-text-size: 1rem;
+  --lux-theme-card-subtitle-text-weight: normal;
+  --lux-theme-card-subtitle-text-color: red;
+}
+```
+
+#### LUX-Button (rund) umstylen
 
+Beispiel:
+
+HTML-Datei:
+
+```html
+<lux-button class="my-button" luxIconName="lux-save" [luxRounded]="true" [luxStroked]="true" luxLabel="Lorem ipsum"></lux-button>
 ```
-lux-card.highlight ::ng-deep .mat-mdc-card {
-  color: var(--lux-theme-accent-400-contrast);
-  background-color: var(--lux-theme-accent-400);
+
+SCSS-Datei:
+
+```scss
+lux-button.my-button {
+  --lux-theme-button-rounded-stroked-container-height: 2rem;
+  --lux-theme-button-rounded-stroked-text-size: 1rem;
 }
 ```
 
-#### Css-Klasse
+#### LUX-Button (stroked) umstylen
 
-Html-Datei:
+Beispiel:
 
+HTML-Datei:
+
+```html
+<lux-button class="my-button" luxLabel="Lorem ipsum" [luxStroked]="true" luxLabel="Lorem ipsum"></lux-button>
+```
+
+SCSS-Datei:
+
+```scss
+lux-button.my-button {
+  --lux-theme-button-stroked-text-size: 1rem;
+  --lux-theme-button-stroked-text-weight: normal;
+  --lux-theme-button-stroked-container-height: 1.5rem;
+  --lux-theme-button-stroked-container-shape: 4px;
+}
 ```
-<div class="lux-color-accent-500-contrast lux-bg-color-accent-500">Lorem ipsum</div>
+
+#### CSS-Klasse
+
+HTML-Datei:
+
+```html
+<div class="lux-color-accent-50 lux-bg-color-accent-30">Lorem ipsum</div>
 ```
 
-# Lizenzhinweis - Icons
+## Lizenztext - Icons
 
-Über das Github-Projekt https://github.com/IHK-GfI/lux-components-icons-and-fonts können statt der bisherigen Material- oder Font Awesome-Icons nun auch die "neuen" Streamline-Icons mit eingebunden werden, welche speziell für die Nutzung mit dem Theme-authentic ausgewählt wurden.
-Die Streamline Icons laufen unter der Lizenz CC-BY 4.0 und der Urheber ist „streamlinehq.com“ ("Streamline Icons Core Line free Copyright © by streamlinehq.com“).
-Bezugsquelle: „[Free Core Line – Free Icons Set - 1000 customizable PNGs, SVGs, PDFs (streamlinehq.com)](https://www.streamlinehq.com/icons/streamline-mini-line)“.
-Die Lizenz „[CC BY 4.0“ ist zu finden unter „[Streamline Free License | Streamline Help center (intercom.help)](https://intercom.help/streamlinehq/en/articles/5354376-streamline-free-license)“.
+In dieser Anwendung werden Streamline-Icons über das Github-Projekt "lux-components-icons-and-fonts" (https://github.com/IHK-GfI/lux-components-icons-and-fonts) der IHK-GfI mbH eingebunden. Die verwendeten Icons laufen unter der Lizenz CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/) und der Urheber ist „streamlinehq.com“ ("Streamline Icons Core Line free Copyright © by streamlinehq.com“).
+Bezugsquelle: „[Core Line - Free – Free Icons Set - 1000 customizable PNGs, SVGs, PDFs (streamlinehq.com)](https://www.streamlinehq.com/icons/core-line-free)".
+Die Lizensierungsinformationen „[CC BY 4.0“ sind zu finden unter „[Streamline Free License | Streamline Help center (intercom.help)](https://intercom.help/streamlinehq/en/articles/5354376-streamline-free-license)“.
 Die Icons aus dem o.a. Iconset wurden durch die IHK-GfI mbH nicht verändert. Es wurden jedoch eigene Icons im selben Stil erstellt und unserer Sammlung unter gleicher Lizenz hinzugefügt.
 
-# Lizenzhinweis - Fonts
+## Lizenztext - Fonts
 
-Über das Github-Projekt https://github.com/IHK-GfI/lux-components-icons-and-fonts können statt der bisher vorgeschlagenen Fontfamilien wie z.B. Korb, Roboo, etc.) nun auch die Schriftarten "Source Sans Pro" designed by Paul D. Hunt (Lizensiert unter SIL 1.1 Open Font License) sowie "BloggerSans" created by Sergiy Tkachenko (Lizensiert unter Creative Commons 4.0) verwendet werden, welche speziell für die Nutzung mit dem Theme-authentic ausgewählt wurden.
+Diese Anwendung verwendet die Schriftarten "Source Sans Pro" designed by Paul D. Hunt (Lizensiert unter SIL 1.1 Open Font License / https://github.com/IHK-GfI/lux-components-icons-and-fonts/blob/master/assets/fonts/Source%20Sans%20Pro/SIL%20Open%20Font%20License%20V1.1.md) sowie "BloggerSans" (Lizenz: https://www.fontsquirrel.com/license/blogger-sans) created by Sergiy Tkachenko (Lizensiert unter Creative Commons 4.0 / https://creativecommons.org/licenses/by/4.0/).
 
 > **Note:** Bei der Entwicklung einer Applikation auf Basis der LUX-Components sowie unter Nutzung der Schriftart "Source Sans Pro" ist zwingend die Lizenzdatei "SIL Open Font License V1.1.md" in die GUI der Applikation einzubinden. Bei Nutzung der Schriftart "BloggerSans" ist ein Verweis auf die Lizenz unter https://www.fontsquirrel.com/license/blogger-sans erforderlich.

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "@ihk-gfi/lux-components-theme",
-  "version": "19.3.0",
+  "version": "21.1.0",
   "description": "",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build-authentic": "del-cli --force ./../../dist/theme/*authentic*.* && sass --style=compressed --load-path=../../node_modules src/authentic/luxtheme.scss:./../../dist/theme/prebuilt-themes/luxtheme-authentic-min.css && sass --load-path=../../node_modules src/authentic/luxtheme.scss:./../../dist/theme/prebuilt-themes/luxtheme-authentic.css",
-    "build-green": "del-cli --force ./../../dist/theme/*green*.* && sass --style=compressed --load-path=../../node_modules src/green/luxtheme.scss:./../../dist/theme/prebuilt-themes/luxtheme-green-min.css && sass --load-path=../../node_modules src/green/luxtheme.scss:./../../dist/theme/prebuilt-themes/luxtheme-green.css",
+    "build-authentic": "del-cli --force ./../../dist/theme/*authentic*.* && sass --style=compressed --load-path=../../node_modules src/theme-authentic/lux-authentic.scss:./../../dist/theme/prebuilt-themes/luxtheme-authentic-min.css && sass --load-path=../../node_modules src/theme-authentic/lux-authentic.scss:./../../dist/theme/prebuilt-themes/luxtheme-authentic.css",
+    "build-green": "del-cli --force ./../../dist/theme/*green*.* && sass --style=compressed --load-path=../../node_modules src/theme-green/lux-green.scss:./../../dist/theme/prebuilt-themes/luxtheme-green-min.css && sass --load-path=../../node_modules src/theme-green/lux-green.scss:./../../dist/theme/prebuilt-themes/luxtheme-green.css",
     "build": "node ./scripts/check-font-size.js && npm run clean && npm run build-authentic && npm run build-green",
     "clean": "del-cli --force ./../../dist/theme/*.* && del-cli --force ../../dist/theme/",
-    "pack-copy-base-files": "copyfiles -f package.json README.md ../../LICENSE ./../../dist/theme",
-    "pack-copy-src-dirs": "copyfiles \"./src/**\" ./../../dist/theme",
-    "pack-copy-prebuilt-themes": "copyfiles \"./../../dist/theme/**\" ./../../dist/theme",
-    "pack": "npm run build && npm run pack-copy-base-files && npm run pack-copy-src-dirs && npm run pack-copy-prebuilt-themes",
+    "pack-copy-base-files": "node ./scripts/copy-base-files.js",
+    "pack-copy-src-dirs": "node ./scripts/copy-src-dirs.js",
+    "pack": "npm run build && npm run pack-copy-base-files && npm run pack-copy-src-dirs",
     "smoketest": "npm run test && npm run pack",
     "test": "npm run build",
     "watch": "npm-watch"
@@ -26,23 +25,24 @@
   },
   "license": "IHK-GfI Open-Source-Lizenz",
   "peerDependencies": {
-    "@angular/material": "^19.0.0"
+    "@angular/material": "^21.0.0"
   },
   "watch": {
     "build-authentic": {
       "patterns": [
-        "src/authentic"
+        "src/theme-authentic"
       ],
       "extensions": "scss"
     },
     "build-green": {
       "patterns": [
-        "src/green"
+        "src/theme-green"
       ],
       "extensions": "scss"
     },
     "build": {
       "patterns": [
+        "src/base-templates",
         "src/base",
         "src/public"
       ],