Skip to content

Commit d265c01

Browse files
authored
Updated Link to "Modularisierung" in Theming (#240)
Ref #6828
2 parents de1fce9 + 43d0228 commit d265c01

File tree

3 files changed

+48
-31
lines changed

3 files changed

+48
-31
lines changed

docs/20-concepts/05-styling/34-theming.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import {KolAlert, KolDetails, KolIndentedText, KolLink,} from '@public-ui/react';
2-
import {KoliBri} from '@site/src/components/KoliBri';
3-
import {Mermaid} from '@site/src/components/Mermaid';
1+
import { KolAlert, KolDetails, KolIndentedText, KolLink, } from '@public-ui/react';
2+
import { KoliBri } from '@site/src/components/KoliBri';
3+
import { Mermaid } from '@site/src/components/Mermaid';
44

55
# Theming
66

@@ -9,13 +9,13 @@ import {Mermaid} from '@site/src/components/Mermaid';
99
</KolAlert>
1010

1111
<p>
12-
Das Einzigartige an <KoliBri /> ist die <strong>Referenzimplementierung</strong> von Komponenten, die von Grund auf
12+
Das Einzigartige an <KoliBri/> ist die <strong>Referenzimplementierung</strong> von Komponenten, die von Grund auf
1313
<strong>semantisch W3C- und WCAG-konform</strong> und damit <strong>vollständig barrierefrei</strong> bezüglich der assistiven
1414
Unterstützung sind. Alle Komponenten werden dabei als <KolLink
15-
_label="Web Components"
16-
_href="https://developer.mozilla.org/en-US/docs/Web/Web_Components?retiredLocale=de"
17-
_target="_blank"
18-
/> umgesetzt und sind somit in allen webbasierten Projekten wiederverwendbar. In der folgenden Abbildung werden diese Komponenten
15+
_label="Web Components"
16+
_href="https://developer.mozilla.org/en-US/docs/Web/Web_Components?retiredLocale=de"
17+
_target="_blank"
18+
/> umgesetzt und sind somit in allen webbasierten Projekten wiederverwendbar. In der folgenden Abbildung werden diese Komponenten
1919
durch die grau-gestrichelten Formen in der Mitte dargestellt.
2020
</p>
2121
<p>
@@ -33,7 +33,7 @@ import {Mermaid} from '@site/src/components/Mermaid';
3333
/>
3434

3535
<p>
36-
Im ersten Release (v1.0) hatte <KoliBri /> noch direkt das Individualisieren des Standard-Designs mittels sogenannter{' '}
36+
Im ersten Release (v1.0) hatte <KoliBri/> noch direkt das Individualisieren des Standard-Designs mittels sogenannter{' '}
3737
<strong>
3838
<KolLink
3939
_label="CSS-Properties"
@@ -48,10 +48,10 @@ import {Mermaid} from '@site/src/components/Mermaid';
4848
_target="_blank"
4949
/>
5050
, <KolLink
51-
_label="Tailwind CSS"
52-
_href="https://tailwindcss.com"
53-
_target="_blank"
54-
/>) umgesetzt. Mit der
51+
_label="Tailwind CSS"
52+
_href="https://tailwindcss.com"
53+
_target="_blank"
54+
/>) umgesetzt. Mit der
5555
Umsetzung weiterer Themes haben wir jedoch festgestellt, dass wir immer mehr CSS-Properties einführen müssten, um die
5656
Flexiblität für das gewünschte Design/UX (Corporate Design/Styleguide) umsetzen zu können. Im Zweifel müsste für jede
5757
Anpassbarkeit ein separates Property vorgesehen werden. Am Beispiel des{' '}
@@ -66,10 +66,10 @@ import {Mermaid} from '@site/src/components/Mermaid';
6666
<KolIndentedText>
6767
<strong>
6868
2. Wir haben das ganze CSS vollständig von den Components entkoppelt (wie <KolLink
69-
_label="Styled-Components"
70-
_href="https://styled-components.com"
71-
_target="_blank"
72-
/>).
69+
_label="Styled-Components"
70+
_href="https://styled-components.com"
71+
_target="_blank"
72+
/>).
7373
</strong>
7474
</KolIndentedText>
7575
</p>
@@ -132,7 +132,7 @@ stateDiagram-v2
132132
<p>
133133
Das UI/UX-Team spezifiziert beispielsweise mit Figma die Komponenten ihres Design-Systems. Bei der Überführung der
134134
Spezifikation in die Realisierung wird das Design in Form von reinem CSS mittels des{' '}
135-
<KolLink _label="KoliBri-Designers" _href="/docs/concepts/styling/designer" /> auf die Basis-Komponenten
135+
<KolLink _label="KoliBri-Designers" _href="/docs/concepts/styling/designer"/> auf die Basis-Komponenten
136136
„übertragen“. Wenn im eigenen Design-System eine Individualisierbarkeit gewünscht ist, können im Designer dafür
137137
CSS-Properties oder Design-Tokens definiert werden. Damit das eigene Theme über Projekte hinweg geteilt werden kann,
138138
wird das Theme in ein NPM-Paket paketiert und kann über eine beliebige Registry bereitgestellt werden.
@@ -159,7 +159,7 @@ stateDiagram-v2
159159
Hierfür bieten wir die sogenannte <strong>KoliBri-Factory</strong> (Stack) an (siehe{' '}
160160
<KolLink
161161
_label="Modularisierung"
162-
_href="https://github.com/public-ui/kolibri/blob/main/docs/ARCHITECTURE.md#erweitert"
162+
_href="/docs/concepts/architecture#erweitert"
163163
_target="_blank"
164164
/>
165165
).

i18n/en/docusaurus-plugin-content-docs/version-2.1/20-concepts/05-styling/34-theming.mdx

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import {KolAlert, KolDetails, KolIndentedText, KolLink,} from '@public-ui/react';
2-
import {KoliBri} from '@site/src/components/KoliBri';
3-
import {Mermaid} from '@site/src/components/Mermaid';
1+
import { KolAlert, KolDetails, KolIndentedText, KolLink, } from '@public-ui/react';
2+
import { KoliBri } from '@site/src/components/KoliBri';
3+
import { Mermaid } from '@site/src/components/Mermaid';
44

55
# Theming
66

@@ -9,7 +9,9 @@ import {Mermaid} from '@site/src/components/Mermaid';
99
</KolAlert>
1010

1111
<p>
12-
The unique feature of <KoliBri /> is the <strong>reference implementation</strong> of components that are <strong>semantically W3C- and WCAG-compliant</strong> from the ground up and thus <strong>completely accessible</strong> regarding assistive support. All components are implemented as <KolLink _label="Web Components" _href="https://developer.mozilla.org/en-US/docs/Web/Web_Components" _target="_blank" />
12+
The unique feature of <KoliBri/> is the <strong>reference implementation</strong> of components that are <strong>semantically W3C- and
13+
WCAG-compliant</strong> from the ground up and thus <strong>completely accessible</strong> regarding assistive support. All components are implemented
14+
as <KolLink _label="Web Components" _href="https://developer.mozilla.org/en-US/docs/Web/Web_Components" _target="_blank"/>
1315
and are therefore reusable in all web-based projects. In the following figure, these components are represented by the gray-dashed shapes in the center.
1416
</p>
1517
<p>
@@ -24,15 +26,24 @@ import {Mermaid} from '@site/src/components/Mermaid';
2426
/>
2527

2628
<p>
27-
In the first release (v1.0) <KoliBri /> had directly implemented the individualization of the standard design using
28-
so-called <strong><KolLink _label="CSS-Properties" _href="https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties" _target="_blank" /></strong>
29-
(<KolLink _label="Design-Tokens" _href="https://uxdesign.cc/design-tokens-for-dummies-8acebf010d71" _target="_blank" />, <KolLink _label="Tailwind CSS" _href="https://tailwindcss.com" _target="_blank" />). With the implementation of further themes, however, we have found that we would have to introduce more and more CSS-Properties to be able to implement the flexibility for the desired design/UX (Corporate Design/Style guide). In
30-
case of doubt, a separate property would have to be provided for each customizability. The example of the <KolLink _label="MUI-Button CSS" _href="https://mui.com/material-ui/api/button/#css" _target="_blank" /> shows well how the CSS properties (design tokens) become more and more.
29+
In the first release (v1.0) <KoliBri/> had directly implemented the individualization of the standard design using
30+
so-called <strong><KolLink _label="CSS-Properties" _href="https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties"
31+
_target="_blank"/></strong>
32+
(<KolLink _label="Design-Tokens" _href="https://uxdesign.cc/design-tokens-for-dummies-8acebf010d71" _target="_blank"/>, <KolLink _label="Tailwind CSS"
33+
_href="https://tailwindcss.com"
34+
_target="_blank"/>). With the
35+
implementation of further themes, however, we have found that we would have to introduce more and more CSS-Properties to be able to implement the flexibility
36+
for the desired design/UX (Corporate Design/Style guide). In
37+
case of doubt, a separate property would have to be provided for each customizability. The example of the <KolLink _label="MUI-Button CSS"
38+
_href="https://mui.com/material-ui/api/button/#css"
39+
_target="_blank"/> shows well how the CSS
40+
properties (design tokens) become more and more.
3141
</p>
3242
<p>
3343
<KolIndentedText>
3444
<strong>
35-
2. We have completely decoupled the whole CSS from the components (like <KolLink _label="Styled-Components" _href="https://styled-components.com" _target="_blank" />).
45+
2. We have completely decoupled the whole CSS from the components (like <KolLink _label="Styled-Components" _href="https://styled-components.com"
46+
_target="_blank"/>).
3647
</strong>
3748
</KolIndentedText>
3849
</p>
@@ -93,7 +104,7 @@ stateDiagram-v2
93104
<p>
94105
For example, the UI/UX team specifies the components of their design system with Figma. When the specification is
95106
transferred to implementation, the design is “transferred” to the basic components in the form of pure CSS using the
96-
<KolLink _label="KoliBri-Designer" _href="/en/docs/concepts/styling/designer" />. If customizability is desired in your
107+
<KolLink _label="KoliBri-Designer" _href="/en/docs/concepts/styling/designer"/>. If customizability is desired in your
97108
design system, CSS properties or design tokens can be defined in the Designer for this purpose. So that the own theme
98109
can be shared across projects, the theme is packaged in an NPM package and can be made available via any registry.
99110
</p>
@@ -115,6 +126,12 @@ stateDiagram-v2
115126
<p>
116127
Own specific components, which are not provided by KoliBri and unfortunately do not fit to the KoliBri component
117128
variety, can be built in own component libraries and maintained independently. For this purpose, we offer the
118-
so-called <strong>KoliBri-Factory</strong> (Stack) (see <KolLink _label="Modularization" _href="https://github.com/public-ui/kolibri/blob/main/docs/ARCHITECTURE.md#erweitert" _target="_blank" />).
129+
so-called <strong>KoliBri-Factory</strong> (Stack) (see{' '}
130+
<KolLink
131+
_label="Modularization"
132+
_href="/en/docs/concepts/architecture#advanced"
133+
_target="_blank"
134+
/>
135+
).
119136
</p>
120137
</KolAlert>

versioned_docs/version-2.1/20-concepts/05-styling/34-theming.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ stateDiagram-v2
159159
Hierfür bieten wir die sogenannte <strong>KoliBri-Factory</strong> (Stack) an (siehe{' '}
160160
<KolLink
161161
_label="Modularisierung"
162-
_href="https://github.com/public-ui/kolibri/blob/main/docs/ARCHITECTURE.md#erweitert"
162+
_href="/docs/concepts/architecture#erweitert"
163163
_target="_blank"
164164
/>
165165
).

0 commit comments

Comments
 (0)