@public-ui/themes 2.0.0-rc.12 → 2.0.0-rc.13

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.
package/README.md CHANGED
@@ -1,10 +1,43 @@
1
- # Themes
1
+ # KoliBri - Themes
2
2
 
3
- Das **Themes**-Modul beinhaltet zahlreiche Themes (Styleguides) zur Komponenten-Bibliothek. Sie können in Kombination mit dem Components-Modul geladen werden.
3
+ The **Themes** module contains numerous themes (style guides) for the component library. They can be loaded in combination with the Components module.
4
4
 
5
- Mehr zur **Modularisierung** kann im [Architekturkonzept](https://public-ui.github.io/docs/concepts/architecture) nachgelesen werden.
5
+ You can read more about **modularization** in the [architecture concept](https://public-ui.github.io/docs/concepts/architecture).
6
6
 
7
- Mehr zum **Projekt** kann in der [README](https://public-ui.github.io/docs) nachgelesen werden.
7
+ More about the **project** can be found in the [documentation](https://public-ui.github.io/docs).
8
+
9
+ ## Installation
10
+
11
+ You can install the KoliBri themes with `npm`, `pnpm` or `yarn`:
12
+
13
+ ```bash
14
+ npm i -g @public-ui/themes
15
+ pnpm i -g @public-ui/themes
16
+ yarn add -g @public-ui/themes
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ Register the themes like this:
22
+
23
+ ```tsx
24
+ import { register } from '@public-ui/components';
25
+ import { defineCustomElements } from '@public-ui/components/dist/loader';
26
+ import { BAMF, BMF, BZStv1, DEFAULT, DESYv1, DESYv2, ECL_EC, ECL_EU, ITZBund, MAPZ, ZOLLv2, ZOLLv3 } from '@public-ui/themes';
27
+
28
+ register(
29
+ DEFAULT,
30
+ // or provide an array to register multiple themes:
31
+ // [BAMF, BMF, DEFAULT, BZStv1, DESYv1, DESYv2, ECL_EC, ECL_EU, ITZBund, MAPZ, ZOLLv2, ZOLLv3, TH]
32
+ defineCustomElements,
33
+ )
34
+ .then(() => {
35
+ /* KoliBri ready */
36
+ })
37
+ .catch((error) => {
38
+ /* Handle errors */
39
+ });
40
+ ```
8
41
 
9
42
  ## Important settings
10
43