@public-ui/theme-default 1.7.2-rc.0 → 1.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +51 -0
  2. package/package.json +77 -78
package/README.md CHANGED
@@ -21,3 +21,54 @@ register(DEFAULT, defineCustomElements).then(() => {
21
21
  ## Full documentation
22
22
 
23
23
  👉 [https://public-ui.github.io](https://public-ui.github.io)
24
+
25
+ ## Usage (DE)
26
+
27
+ Das Default-Theme ist ein _Token-Based_ Theme, das mit minimalen Anpassungen sofort verwendet werden kann. Es bringt bereits alle notwendigen Stylings mit und kann
28
+ über Design Tokens, in Form von _CSS Custom Properties_ an das eigene Design angepasst werden.
29
+
30
+ ### Variablen
31
+
32
+ | Variable | Standard-Wert | Bedeutung |
33
+ | --------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------- |
34
+ | `--kolibri-border-radius` | `5px` | Border-Radius für abgerundete Elemente |
35
+ | `--kolibri-font-family` | `BundesSans Web, Calibri, Verdana, Arial, Helvetica, sans-serif` | Allgemeine Schriftart |
36
+ | `--kolibri-font-size` | `16px` | Allgemeine Schriftgröße |
37
+ | `--kolibri-spacing` | `0.25rem` | Allgemeiner Abstand zwischen Elementen |
38
+ | `--kolibri-border-width` | `1px` | Allgemeine Rahmen-Breite |
39
+ | `--kolibri-color-primary` | `#004b76` | Primärfarbe |
40
+ | `--kolibri-color-primary-variant` | `#0077b6` | Alternative Variante der Primärfarbe |
41
+ | `--kolibri-color-danger` | `#c0003c` | Farbe für Fehlermeldungen und gefährliche Aktionen |
42
+ | `--kolibri-color-warning` | `#c44931` | Farbe für Warnungen |
43
+ | `--kolibri-color-success` | `#005c45` | Farbe für Erfolgsmeldungen |
44
+ | `--kolibri-color-subtle` | `#576164` | Farbe für feine Akzente wie z.B. Rahmen |
45
+ | `--kolibri-color-light` | `#ffffff` | Helle Farbe für z.B. Hintergründe |
46
+ | `--kolibri-color-text` | `#202020` | Textfarbe |
47
+ | `--kolibri-color-mute` | `#f2f3f4` | Farbe für deaktivierte Elemente |
48
+ | `--kolibri-color-mute-variant` | `#bec5c9` | Alternative Farbe für deaktivierte Elemente |
49
+
50
+ ### Verwendung
51
+
52
+ Theme importieren und registrieren:
53
+
54
+ ```js
55
+ import { register } from '@public-ui/components';
56
+ import { defineCustomElements } from '@public-ui/components/dist/loader';
57
+ import { DEFAULT } from '@public-ui/themes';
58
+
59
+ register(DEFAULT, defineCustomElements);
60
+ ```
61
+
62
+ Für mehr Details und weitere Optionen siehe [Erste Schritte](https://public-ui.github.io/docs/get-started/first-steps#einbinden-in-ein-bestehendes-projekt).
63
+
64
+ Um die _Design Tokens_ anzupassen, reicht ein einfaches Stylesheet, das die gewünschten Custom Properties überschreibt. Es ist dabei nicht notwendig, alle Properties zu setzen, sondern nur solche, die auch überschrieben werden sollen. Beispiel:
65
+
66
+ ```css
67
+ :root {
68
+ --kolibri-border-radius: 3px;
69
+ --kolibri-font-size: 18px;
70
+ --kolibri-spacing: 0.3rem;
71
+ --kolibri-color-primary: #cc006e;
72
+ --kolibri-color-primary-variant: #ff64b9;
73
+ }
74
+ ```
package/package.json CHANGED
@@ -1,79 +1,78 @@
1
1
  {
2
- "name": "@public-ui/theme-default",
3
- "version": "1.7.2-rc.0",
4
- "license": "EUPL-1.2",
5
- "homepage": "https://public-ui.github.io",
6
- "repository": "https://github.com/public-ui/kolibri",
7
- "bugs": {
8
- "url": "https://github.com/public-ui/kolibri/issues",
9
- "email": "kolibri@itzbund.de"
10
- },
11
- "author": {
12
- "name": "Informationstechnikzentrum Bund",
13
- "email": "kolibri@itzbund.de"
14
- },
15
- "description": "Contains the default theme for KoliBri - The accessible HTML-Standard.",
16
- "keywords": [
17
- "accessibility",
18
- "accessible",
19
- "bitv",
20
- "designsystem",
21
- "design",
22
- "web components",
23
- "webcomponents",
24
- "aria",
25
- "wai",
26
- "axe",
27
- "custom elements",
28
- "styleguide",
29
- "style",
30
- "guide",
31
- "ui",
32
- "html",
33
- "css",
34
- "web",
35
- "a11y",
36
- "w3c",
37
- "webstandard",
38
- "wcag"
39
- ],
40
- "scripts": {
41
- "build": "unbuild",
42
- "depcheck": "depcheck --ignore-bin-package --skip-missing --ignores=@types/*",
43
- "format": "prettier --check src",
44
- "lint": "eslint src && tsc --noemit",
45
- "prepack": "unbuild",
46
- "-test": "THEME_MODULE=src/index THEME_EXPORT=DEFAULT kolibri-visual-test",
47
- "test-update": "THEME_MODULE=src/index THEME_EXPORT=DEFAULT kolibri-visual-test --update-snapshots"
48
- },
49
- "devDependencies": {
50
- "@public-ui/schema": "1.7.2-rc.0",
51
- "@public-ui/visual-tests": "1.7.2-rc.0",
52
- "@types/node": "ts5.2",
53
- "@typescript-eslint/eslint-plugin": "6.7.3",
54
- "@typescript-eslint/parser": "6.7.3",
55
- "eslint": "8.50.0",
56
- "eslint-plugin-no-loops": "0.3.0",
57
- "typescript": "5.2.2",
58
- "unbuild": "1.2.1"
59
- },
60
- "peerDependencies": {
61
- "@public-ui/components": "1.7.2-rc.0"
62
- },
63
- "sideEffects": false,
64
- "type": "module",
65
- "exports": {
66
- ".": {
67
- "types": "./dist/index.d.ts",
68
- "import": "./dist/index.mjs",
69
- "require": "./dist/index.cjs"
70
- }
71
- },
72
- "main": "./dist/index.cjs",
73
- "module": "./dist/index.mjs",
74
- "types": "./dist/index.d.ts",
75
- "files": [
76
- "assets",
77
- "dist"
78
- ]
79
- }
2
+ "name": "@public-ui/theme-default",
3
+ "version": "1.7.2",
4
+ "license": "EUPL-1.2",
5
+ "homepage": "https://public-ui.github.io",
6
+ "repository": "https://github.com/public-ui/kolibri",
7
+ "bugs": {
8
+ "url": "https://github.com/public-ui/kolibri/issues",
9
+ "email": "kolibri@itzbund.de"
10
+ },
11
+ "author": {
12
+ "name": "Informationstechnikzentrum Bund",
13
+ "email": "kolibri@itzbund.de"
14
+ },
15
+ "description": "Contains the default theme for KoliBri - The accessible HTML-Standard.",
16
+ "keywords": [
17
+ "accessibility",
18
+ "accessible",
19
+ "bitv",
20
+ "designsystem",
21
+ "design",
22
+ "web components",
23
+ "webcomponents",
24
+ "aria",
25
+ "wai",
26
+ "axe",
27
+ "custom elements",
28
+ "styleguide",
29
+ "style",
30
+ "guide",
31
+ "ui",
32
+ "html",
33
+ "css",
34
+ "web",
35
+ "a11y",
36
+ "w3c",
37
+ "webstandard",
38
+ "wcag"
39
+ ],
40
+ "devDependencies": {
41
+ "@public-ui/schema": "1.7.2",
42
+ "@public-ui/visual-tests": "1.7.2",
43
+ "@types/node": "ts5.2",
44
+ "@typescript-eslint/eslint-plugin": "6.7.3",
45
+ "@typescript-eslint/parser": "6.7.3",
46
+ "eslint": "8.50.0",
47
+ "eslint-plugin-no-loops": "0.3.0",
48
+ "typescript": "5.2.2",
49
+ "unbuild": "1.2.1"
50
+ },
51
+ "peerDependencies": {
52
+ "@public-ui/components": "1.7.2"
53
+ },
54
+ "sideEffects": false,
55
+ "type": "module",
56
+ "exports": {
57
+ ".": {
58
+ "types": "./dist/index.d.ts",
59
+ "import": "./dist/index.mjs",
60
+ "require": "./dist/index.cjs"
61
+ }
62
+ },
63
+ "main": "./dist/index.cjs",
64
+ "module": "./dist/index.mjs",
65
+ "types": "./dist/index.d.ts",
66
+ "files": [
67
+ "assets",
68
+ "dist"
69
+ ],
70
+ "scripts": {
71
+ "build": "unbuild",
72
+ "depcheck": "depcheck --ignore-bin-package --skip-missing --ignores=@types/*",
73
+ "format": "prettier --check src",
74
+ "lint": "eslint src && tsc --noemit",
75
+ "-test": "THEME_MODULE=src/index THEME_EXPORT=DEFAULT kolibri-visual-test",
76
+ "test-update": "THEME_MODULE=src/index THEME_EXPORT=DEFAULT kolibri-visual-test --update-snapshots"
77
+ }
78
+ }