You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Prerenderer notwendig sein werden und wird daher unsererseits als experimentell eingestuft (<KolLink_label="https://web.dev"_href="https://web.dev/declarative-shadow-dom/"_target="_blank" />).
185
169
</small>
186
-
</KolIndentedText>
170
+
</KolAlert>
187
171
</p>
188
172
189
173
## Versionierung
@@ -192,7 +176,7 @@ import { translate } from '@docusaurus/Translate';
192
176
<KoliBri /> folgt den Prinzipien der semantischen Versionierung.
193
177
</p>
194
178
<pclassName="col-12">
195
-
Aufbau einer Version:
179
+
<strong>Aufbau</strong> einer Version:
196
180
<ul>
197
181
<li>
198
182
Sie besteht in der Regel aus 3 Teilen (z. B. 1.0.2)
@@ -219,7 +203,7 @@ import { translate } from '@docusaurus/Translate';
219
203
</ul>
220
204
</p>
221
205
<pclassName="col-12">
222
-
Folgende Hauptprinzipien kommen dabei zur Anwendung:
206
+
Folgende <strong>Hauptprinzipien</strong> kommen dabei zur Anwendung:
223
207
<ul>
224
208
<li>
225
209
<b>Patch</b>: Beinhaltet Änderungen, die den aktuellen Funktionsumfang verbessern und in seiner Verwendung nicht
@@ -234,8 +218,8 @@ import { translate } from '@docusaurus/Translate';
234
218
Funktionsumfang in seiner Verwendung ändern dürfen.
235
219
</li>
236
220
</ul>
237
-
Die komplette Beschreibubng der SemVer finden Sie hier:{''}
Copy file name to clipboardExpand all lines: docs/03-faq.mdx
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ import { KolLink } from '@public-ui/react';
31
31
-**Was besagt die Lizenzierung?**<br/>
32
32
Die EUPL erlaubt die uneingeschränkte Nutzung der Artefakt, die auf konfigurative Weise an die eigenen Bedürfnisse angepasst werden können.
33
33
Andererseits erzwingt sie die Offenlegung von Änderungen, die beim Kopieren von Quellcode aus KoliBri hervorgegangen sind (Copy-Left).
34
-
Mehr hierzu finden Sie in der <KolLink_href="/docs/license"_label="Lizenz" />.
34
+
Mehr hierzu finden Sie in der <KolLink_label="Lizenz"_href="/docs/project/license" />.
35
35
36
36
## Theming und Styling
37
37
@@ -40,20 +40,20 @@ import { KolLink } from '@public-ui/react';
40
40
-**Wie funktioniert das Theming?**<br/>
41
41
In der Regel werden Web Components mit festem Styling erstellt. KoliBri trennt die semantisch barrierefreien Komponenten vom Styling und stellt dafür eine Register-Methode zum Kombinieren zur Verfügung. Da die Web Components im Browser grundsätzlich registriert (define) werden müssen, besteht hier die Möglichkeit, die Komponenten mit einem definierten Theme zu laden.
42
42
-**Wie kann man ein eigenes Theme erstellen?**<br/>
43
-
Wir arbeiten stets daran, das Erstellen und Pflegen von Themes weiter zu vereinfachen. Hierzu dienen z.B. das Basis-Styling (reines Layout) der Komponenten ab Version 1.5. Aufsetzen kann man einfach durch die Erstellung einer Theme-Definition, z.B. mit einem eigenen Theme-Projekt (NPM-Paket) mittels der <KolLink_href="https://github.com/public-ui/kolibri/blob/45726c50d7f28c9c595442b2241582816eca5670/packages/create-kolibri/templates/kolibri-library/packages/components/src/global/script.ts#L8"_label="TS-Datei"_target="github"/>. Hilfreich um Erstellen und Pflegen von Themes ist auch unser<KolLink_href="/designer/"_label="Theme-Designer"_target="designer"/>.
44
-
-**Warum muss CSS in JavaScript verwalten werden?**<br/>
43
+
Wir arbeiten stets daran, das Erstellen und Pflegen von Themes weiter zu vereinfachen. Hierzu dienen z.B. das Basis-Styling (reines Layout) der Komponenten ab Version 1.5. Aufsetzen kann man einfach durch die Erstellung einer Theme-Definition, z.B. mit einem eigenen Theme-Projekt (NPM-Paket) mittels der <KolLink_label="TS-Datei"_href="https://github.com/public-ui/kolibri/blob/45726c50d7f28c9c595442b2241582816eca5670/packages/create-kolibri/templates/kolibri-library/packages/components/src/global/script.ts#L8"_target="_blank"/>. Hilfreich um Erstellen und Pflegen von Themes ist auch unser<KolLink_label="Theme-Designer"_href="/designer/"_target="_blank"/>.
44
+
-**Warum muss CSS in JavaScript verwaltet werden?**<br/>
45
45
Das Stylen von KoliBri-Komponenten erfolgt nicht allein eingebundenes CSS oder die Verwendung von CSS-Frameworks (wie z.B. Bootstrap, Material-UI, Tailwind CSS, etc.), sondern
46
-
über das technische Setzen von CSS an der Komponente. Das hat den Vorteil, dass die Komponenten vom äußeren CSS unabhängig sind. Die Robustheit ist ein architektonischen Qualitätsziel. Sie spiegelt sich darin wieder, das nur die Komponente selbst über ihr Styling entscheidet.
46
+
über das technische Setzen von CSS an der Komponente. Das hat den Vorteil, dass die Komponenten vom äußeren CSS unabhängig sind. Die Robustheit ist ein architektonisches Qualitätsziel. Sie spiegelt sich darin wider, dass nur die Komponente selbst über ihr Styling entscheidet.
47
47
-**Wozu braucht man das Schema?**<br/>
48
-
KoliBri basiert auf einer ausgeklügelten <KolLink_href="/docs/concepts/architecture"_label="Architektur" />. Beispielsweise dient das kleine Schema-Paket (@public-ui/schema) dazu, die Tag-Namen und Sprach-Keys der KoliBri-Komponenten unabhängig von der konkreten Implementierung zu definieren. Dies ermöglicht bei der Theme-Erstellung ein komplett losgelöstes Arbeiten mit Autovervollständigung, ohne aber die Komponenten und deren Abhängigkeiten zu benötigen. Das hat Vorteile bei manchen Integrationsszenarien, wie z.B. bei statischen Seiten oder Content-Management-Systemen (CMS).
48
+
KoliBri basiert auf einer ausgeklügelten <KolLink_label="Architektur"_href="/docs/concepts/architecture" />. Beispielsweise dient das kleine Schema-Paket (@public-ui/schema) dazu, die Tag-Namen und Sprach-Keys der KoliBri-Komponenten unabhängig von der konkreten Implementierung zu definieren. Dies ermöglicht bei der Theme-Erstellung ein komplett losgelöstes Arbeiten mit Autovervollständigung, ohne aber die Komponenten und deren Abhängigkeiten zu benötigen. Das hat Vorteile bei manchen Integrationsszenarien, wie z.B. bei statischen Seiten oder Content-Management-Systemen (CMS).
49
49
50
50
## Technisches
51
51
52
52
-**Wieso können KoliBri-Komponenten wirklich barrierefrei sein?**<br/>
53
53
Die KoliBri-Komponenten sind softwarearchitektonisch so designed, dass sie sich nur über Properties instrumentieren lassen und nicht über eignenes reingebbares HTML. Das bedeutet, dass die Komponenten nur über die API (Properties) gesteuert werden können. Das ist ein Qualitätsmerkmal, da die Komponenten so nicht von außen manipuliert werden können. Die Komponenten sind sehr restriktiv und können somit in sich immer barrierefrei sein.<br/>
54
-
Um aus dieser Restriktivität ausbrechen zu können, gibt es den <KolLink_href="/docs/concepts/expert-slot"_label="Expert-Slot" />, der es ermöglicht, eigenes HTML in die Komponente einzubetten. Die Barrierefreiheit über den Expert-Slot liegt in den Händen des Experten (Developers) und sollte nur in Ausnahmefällen verwendet werden.
54
+
Um aus dieser Restriktivität ausbrechen zu können, gibt es den <KolLink_label="Expert-Slot"_href="/docs/concepts/expert-slot" />, der es ermöglicht, eigenes HTML in die Komponente einzubetten. Die Barrierefreiheit über den Expert-Slot liegt in den Händen des Experten (Developers) und sollte nur in Ausnahmefällen verwendet werden.
55
55
-**Warum werden die Eigenschaften von Komponenten manchmal abweichend vom HTML-Naming benannt?**<br/>
56
-
Um die Erlernbarkeit von KoliBri zu einfach zu halten, wird in der Regel immer das Naming des HTML verwenden. Doch auch der HTML-Standard ist in seinem Naming über mehrerer Element (Komponenten) nicht einheitlich. Und daher kommt es dazu, dass wir in KoliBri für gleichartige Eigenschaften übergreifend einheitliche Namen gewählt haben. Mehr dazu finden Sie im Konzept <KolLink_href="/docs/concepts/properties"_label="Eigenschaften" />.
56
+
Um die Erlernbarkeit von KoliBri einfach zu halten, wird in der Regel die Benennung aus dem HTML übernommen. Doch auch der HTML-Standard ist in seinem Naming über mehrere Elemente (Komponenten) nicht einheitlich. Und daher kommt es dazu, dass wir in KoliBri für gleichartige Eigenschaften übergreifend einheitliche Namen gewählt haben. Mehr dazu finden Sie im Konzept <KolLink_label="Eigenschaften"_href="/docs/concepts/properties" />.
57
57
58
58
## Barrierefreiheit
59
59
@@ -62,4 +62,4 @@ import { KolLink } from '@public-ui/react';
62
62
63
63
## Noch Fragen offen?
64
64
65
-
Wenn noch Fragen offen sind, dann schreiben Sie uns gerne eine E-Mail an <KolLink_href="mailto:kolibri@itzbund.de"_label="kolibri@itzbund.de"_target="email"_icons="codicon codicon-mail" />.
65
+
Wenn noch Fragen offen sind, dann schreiben Sie uns gerne eine E-Mail an <KolLink_href="mailto:kolibri@itzbund.de"_label="kolibri@itzbund.de"_icons="codicon codicon-mail" />.
0 commit comments