@public-ui/components 1.5.0-rc.11 → 1.5.0-rc.12
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/cheat-sheet.html +66 -92
- package/custom-elements.json +145 -144
- package/dist/cjs/kol-accordion.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-alert.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-badge.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-breadcrumb.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-button-link.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-button-wc_3.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-button.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-card.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-form.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-icon.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-image.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-checkbox.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-color.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-date.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-email.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-file.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-number.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-password.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-radio-group.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-radio.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-range.cjs.entry.js +1 -1
- package/dist/cjs/kol-input-range.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-input-text.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-link-button.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-link-group.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-link-wc.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-link.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-modal.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-nav.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-pagination.cjs.entry.js +1 -1
- package/dist/cjs/kol-pagination.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-progress.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-quote.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-select.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-skip-nav.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-span-wc.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-span.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-tabs.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-textarea.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-toast.cjs.entry.js.map +1 -1
- package/dist/cjs/kol-tooltip.cjs.entry.js.map +1 -1
- package/dist/components/component.js.map +1 -1
- package/dist/components/component11.js.map +1 -1
- package/dist/components/component12.js.map +1 -1
- package/dist/components/component13.js.map +1 -1
- package/dist/components/component14.js +1 -1
- package/dist/components/component14.js.map +1 -1
- package/dist/components/component15.js.map +1 -1
- package/dist/components/component2.js.map +1 -1
- package/dist/components/component3.js.map +1 -1
- package/dist/components/component4.js.map +1 -1
- package/dist/components/component5.js.map +1 -1
- package/dist/components/component6.js.map +1 -1
- package/dist/components/component7.js.map +1 -1
- package/dist/components/component8.js.map +1 -1
- package/dist/components/kol-accordion.js.map +1 -1
- package/dist/components/kol-breadcrumb.js.map +1 -1
- package/dist/components/kol-button-link.js.map +1 -1
- package/dist/components/kol-card.js.map +1 -1
- package/dist/components/kol-form.js.map +1 -1
- package/dist/components/kol-image.js.map +1 -1
- package/dist/components/kol-input-checkbox.js.map +1 -1
- package/dist/components/kol-input-color.js.map +1 -1
- package/dist/components/kol-input-date.js.map +1 -1
- package/dist/components/kol-input-email.js.map +1 -1
- package/dist/components/kol-input-file.js.map +1 -1
- package/dist/components/kol-input-password.js.map +1 -1
- package/dist/components/kol-input-radio-group.js.map +1 -1
- package/dist/components/kol-input-range.js +1 -1
- package/dist/components/kol-input-range.js.map +1 -1
- package/dist/components/kol-input-text.js.map +1 -1
- package/dist/components/kol-link-button.js.map +1 -1
- package/dist/components/kol-link-group.js.map +1 -1
- package/dist/components/kol-modal.js.map +1 -1
- package/dist/components/kol-nav.js.map +1 -1
- package/dist/components/kol-progress.js.map +1 -1
- package/dist/components/kol-quote.js.map +1 -1
- package/dist/components/kol-skip-nav.js.map +1 -1
- package/dist/components/kol-span.js.map +1 -1
- package/dist/components/kol-tabs.js.map +1 -1
- package/dist/components/kol-textarea.js.map +1 -1
- package/dist/components/kol-toast.js.map +1 -1
- package/dist/components/shadow.js.map +1 -1
- package/dist/components/shadow2.js.map +1 -1
- package/dist/esm/kol-accordion.entry.js.map +1 -1
- package/dist/esm/kol-alert.entry.js.map +1 -1
- package/dist/esm/kol-badge.entry.js.map +1 -1
- package/dist/esm/kol-breadcrumb.entry.js.map +1 -1
- package/dist/esm/kol-button-link.entry.js.map +1 -1
- package/dist/esm/kol-button-wc_3.entry.js.map +1 -1
- package/dist/esm/kol-button.entry.js.map +1 -1
- package/dist/esm/kol-card.entry.js.map +1 -1
- package/dist/esm/kol-form.entry.js.map +1 -1
- package/dist/esm/kol-icon.entry.js.map +1 -1
- package/dist/esm/kol-image.entry.js.map +1 -1
- package/dist/esm/kol-input-checkbox.entry.js.map +1 -1
- package/dist/esm/kol-input-color.entry.js.map +1 -1
- package/dist/esm/kol-input-date.entry.js.map +1 -1
- package/dist/esm/kol-input-email.entry.js.map +1 -1
- package/dist/esm/kol-input-file.entry.js.map +1 -1
- package/dist/esm/kol-input-number.entry.js.map +1 -1
- package/dist/esm/kol-input-password.entry.js.map +1 -1
- package/dist/esm/kol-input-radio-group.entry.js.map +1 -1
- package/dist/esm/kol-input-radio.entry.js.map +1 -1
- package/dist/esm/kol-input-range.entry.js +1 -1
- package/dist/esm/kol-input-range.entry.js.map +1 -1
- package/dist/esm/kol-input-text.entry.js.map +1 -1
- package/dist/esm/kol-link-button.entry.js.map +1 -1
- package/dist/esm/kol-link-group.entry.js.map +1 -1
- package/dist/esm/kol-link-wc.entry.js.map +1 -1
- package/dist/esm/kol-link.entry.js.map +1 -1
- package/dist/esm/kol-modal.entry.js.map +1 -1
- package/dist/esm/kol-nav.entry.js.map +1 -1
- package/dist/esm/kol-pagination.entry.js +1 -1
- package/dist/esm/kol-pagination.entry.js.map +1 -1
- package/dist/esm/kol-progress.entry.js.map +1 -1
- package/dist/esm/kol-quote.entry.js.map +1 -1
- package/dist/esm/kol-select.entry.js.map +1 -1
- package/dist/esm/kol-skip-nav.entry.js.map +1 -1
- package/dist/esm/kol-span-wc.entry.js.map +1 -1
- package/dist/esm/kol-span.entry.js.map +1 -1
- package/dist/esm/kol-tabs.entry.js.map +1 -1
- package/dist/esm/kol-textarea.entry.js.map +1 -1
- package/dist/esm/kol-toast.entry.js.map +1 -1
- package/dist/esm/kol-tooltip.entry.js.map +1 -1
- package/dist/kolibri/kol-accordion.entry.js.map +1 -1
- package/dist/kolibri/kol-alert.entry.js.map +1 -1
- package/dist/kolibri/kol-badge.entry.js.map +1 -1
- package/dist/kolibri/kol-breadcrumb.entry.js.map +1 -1
- package/dist/kolibri/kol-button-link.entry.js.map +1 -1
- package/dist/kolibri/kol-button-wc_3.entry.js.map +1 -1
- package/dist/kolibri/kol-button.entry.js.map +1 -1
- package/dist/kolibri/kol-card.entry.js.map +1 -1
- package/dist/kolibri/kol-form.entry.js.map +1 -1
- package/dist/kolibri/kol-icon.entry.js.map +1 -1
- package/dist/kolibri/kol-image.entry.js.map +1 -1
- package/dist/kolibri/kol-input-checkbox.entry.js.map +1 -1
- package/dist/kolibri/kol-input-color.entry.js.map +1 -1
- package/dist/kolibri/kol-input-date.entry.js.map +1 -1
- package/dist/kolibri/kol-input-email.entry.js.map +1 -1
- package/dist/kolibri/kol-input-file.entry.js.map +1 -1
- package/dist/kolibri/kol-input-number.entry.js.map +1 -1
- package/dist/kolibri/kol-input-password.entry.js.map +1 -1
- package/dist/kolibri/kol-input-radio-group.entry.js.map +1 -1
- package/dist/kolibri/kol-input-radio.entry.js.map +1 -1
- package/dist/kolibri/kol-input-range.entry.js +1 -1
- package/dist/kolibri/kol-input-range.entry.js.map +1 -1
- package/dist/kolibri/kol-input-text.entry.js.map +1 -1
- package/dist/kolibri/kol-link-button.entry.js.map +1 -1
- package/dist/kolibri/kol-link-group.entry.js.map +1 -1
- package/dist/kolibri/kol-link-wc.entry.js.map +1 -1
- package/dist/kolibri/kol-link.entry.js.map +1 -1
- package/dist/kolibri/kol-modal.entry.js.map +1 -1
- package/dist/kolibri/kol-nav.entry.js.map +1 -1
- package/dist/kolibri/kol-pagination.entry.js +1 -1
- package/dist/kolibri/kol-pagination.entry.js.map +1 -1
- package/dist/kolibri/kol-progress.entry.js.map +1 -1
- package/dist/kolibri/kol-quote.entry.js.map +1 -1
- package/dist/kolibri/kol-select.entry.js.map +1 -1
- package/dist/kolibri/kol-skip-nav.entry.js.map +1 -1
- package/dist/kolibri/kol-span-wc.entry.js.map +1 -1
- package/dist/kolibri/kol-span.entry.js.map +1 -1
- package/dist/kolibri/kol-tabs.entry.js.map +1 -1
- package/dist/kolibri/kol-textarea.entry.js.map +1 -1
- package/dist/kolibri/kol-toast.entry.js.map +1 -1
- package/dist/kolibri/kol-tooltip.entry.js.map +1 -1
- package/dist/types/components.d.ts +290 -288
- package/doc/abbr.md +7 -3
- package/doc/accordion.md +50 -24
- package/doc/alert.md +7 -5
- package/doc/badge.md +16 -24
- package/doc/breadcrumb.md +10 -8
- package/doc/button-link.md +2 -2
- package/doc/button.md +39 -68
- package/doc/card.md +17 -61
- package/doc/details.md +12 -9
- package/doc/form.md +4 -4
- package/doc/heading.md +18 -11
- package/doc/icon.md +10 -14
- package/doc/image.md +27 -20
- package/doc/indented-text.md +1 -7
- package/doc/input-checkbox.md +14 -10
- package/doc/input-color.md +9 -12
- package/doc/input-date.md +10 -13
- package/doc/input-email.md +11 -10
- package/doc/input-file.md +9 -7
- package/doc/input-number.md +10 -39
- package/doc/input-password.md +8 -8
- package/doc/input-radio-group.md +4 -4
- package/doc/input-radio.md +26 -8
- package/doc/input-range.md +6 -9
- package/doc/input-text.md +15 -17
- package/doc/kolibri.md +10 -5
- package/doc/link-button.md +6 -11
- package/doc/link-group.md +20 -18
- package/doc/link.md +18 -39
- package/doc/logo.md +4 -8
- package/doc/modal.md +36 -54
- package/doc/nav.md +49 -37
- package/doc/pagination.md +17 -22
- package/doc/progress.md +7 -7
- package/doc/quote.md +11 -8
- package/doc/select.md +27 -18
- package/doc/skip-nav.md +10 -5
- package/doc/span.md +5 -5
- package/doc/spin.md +4 -5
- package/doc/table.md +7 -59
- package/doc/tabs.md +27 -39
- package/doc/textarea.md +28 -29
- package/doc/toast.md +15 -8
- package/doc/tooltip.md +7 -7
- package/doc/version.md +5 -8
- package/jest-test-results.json +1 -1
- package/package.json +1 -1
- package/vscode-custom-data.json +143 -143
package/doc/link.md
CHANGED
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
# Link
|
|
2
2
|
|
|
3
3
|
Die **Link**-Komponente rendert einen auf Barrierefreiheit optimierten Link, der als Text, als Icon oder auch in Kombination ausgegeben werden kann.
|
|
4
|
-
Möglich ist auch die Ausgabe eines versteckten Links.
|
|
5
|
-
|
|
6
|
-
Der Link wird standardmäßig in klassischer Form mit Unterstrich ausgegeben, der jedoch über ein Attribut auch ohne CSS entfernt werden kann. Weitere Informationen zu Custom Styles finden Sie weiter unten.
|
|
7
4
|
|
|
8
5
|
Beachten Sie, dass die Komponente automatisch ein Padding links und rechts zum umgebenden Text erzeugt. Sie kann daher im Fließtext ohne
|
|
9
6
|
Eingabe von Leerzeichen eingefügt werden. Zusätzliche Leerzeichen vergrößern den Abstand zum umgebenden Text.
|
|
@@ -13,62 +10,44 @@ Eingabe von Leerzeichen eingefügt werden. Zusätzliche Leerzeichen vergrößern
|
|
|
13
10
|
### Code
|
|
14
11
|
|
|
15
12
|
```html
|
|
16
|
-
<
|
|
13
|
+
<p>
|
|
14
|
+
In diesem Absatz wird ein Link gesetzt, der keine weiteren Attribute enthält.
|
|
15
|
+
<kol-link _href="https://www.w3.org">Hier steht ein Link</kol-link>Er wird standardmäßig als
|
|
16
|
+
<i>
|
|
17
|
+
<b>inline-Element</b>
|
|
18
|
+
</i>
|
|
19
|
+
ausgegeben.
|
|
20
|
+
</p>
|
|
17
21
|
```
|
|
18
22
|
|
|
19
23
|
### Beispiel
|
|
20
24
|
|
|
21
25
|
<p>
|
|
22
26
|
In diesem Absatz wird ein Link gesetzt, der keine weiteren Attribute enthält.
|
|
23
|
-
<kol-link _href="https://www.w3.org">Hier steht ein Link</kol-link>
|
|
27
|
+
<kol-link _href="https://www.w3.org">Hier steht ein Link</kol-link>Er wird standardmäßig als <i>
|
|
24
28
|
<b>inline-Element</b>
|
|
25
29
|
</i> ausgegeben.
|
|
26
30
|
</p>
|
|
27
31
|
|
|
28
32
|
## Verwendung
|
|
29
33
|
|
|
30
|
-
### Link innerhalb eines Fließtextes, mit unterschiedlichen **\_display**-Werten
|
|
31
|
-
|
|
32
|
-
<p>
|
|
33
|
-
In diesem Absatz wird ein Link gesetzt, der einmal als inline-block-Element ausgegeben wird.
|
|
34
|
-
<kol-link _display="inline-block">
|
|
35
|
-
Ich bin ein Link als <b>inline-block-Element</b>
|
|
36
|
-
</kol-link>, damit kann man mir per CSS-Styles eine Breite, eine Höhe und andere Eigenschaften zuweisen.
|
|
37
|
-
Danach folgt ein Link, der als block-Element ausgegeben wird.
|
|
38
|
-
<kol-link _display="block">
|
|
39
|
-
Ich bin ein Link als <b>block-Element</b>
|
|
40
|
-
</kol-link>,
|
|
41
|
-
daher gehe ich über die ganze Breite des Eltern-Elements erzeuge so einen Zeilenumbruch.
|
|
42
|
-
</p>
|
|
43
|
-
|
|
44
34
|
### Link innerhalb eines Fließtextes mit Icon und Text
|
|
45
35
|
|
|
46
36
|
<p>
|
|
47
|
-
<kol-link _icon="home">Ich bin ein Link mit Icon links</kol-link><br/>
|
|
48
|
-
<kol-link _icon="home" _icon-align="right">
|
|
37
|
+
<kol-link _icon="codicon codicon-home">Ich bin ein Link mit Icon links</kol-link><br/>
|
|
38
|
+
<kol-link _icon="codicon codicon-home" _icon-align="right">
|
|
49
39
|
Ich bin ein Link mit Icon rechts
|
|
50
40
|
</kol-link>
|
|
51
41
|
Lorem, ipsum dolor sit amet consectetur adipisicing elit. Ea optio deleniti fuga quos molestias, voluptate nobis
|
|
52
42
|
nemo, incidunt excepturi facilis, amet ducimus minus quae corporis eligendi cum distinctio. Fugit, repellendus.
|
|
53
|
-
<kol-link _icon="home">Ich bin ein Link mit Icon links</kol-link>. Lorem, ipsum dolor sit amet consectetur adipisicing
|
|
54
|
-
elit. Ea optio deleniti fuga quos molestias, voluptate nobis nemo, incidunt excepturi
|
|
55
|
-
_icon="home"
|
|
43
|
+
<kol-link _icon="codicon codicon-home">Ich bin ein Link mit Icon links</kol-link>. Lorem, ipsum dolor sit amet consectetur adipisicing
|
|
44
|
+
elit. Ea optio deleniti fuga quos molestias, voluptate nobis nemo, incidunt excepturi<kol-link
|
|
45
|
+
_icon="codicon codicon-home"
|
|
56
46
|
_icon-align="right"
|
|
57
47
|
>
|
|
58
48
|
Ich bin ein Link mit Icon rechts
|
|
59
49
|
</kol-link>
|
|
60
50
|
facilis, amet ducimus minus quae corporis eligendi cum distinctio. Fugit, repellendus.
|
|
61
|
-
|
|
62
|
-
</p>
|
|
63
|
-
|
|
64
|
-
### Link mit und ohne Unterstrich
|
|
65
|
-
|
|
66
|
-
<p>
|
|
67
|
-
<kol-link _icon="home">Ich bin ein Link in Standardausgabe mit Unterstrich</kol-link><br/>
|
|
68
|
-
<kol-link _icon="home" _underline="false">
|
|
69
|
-
Ich bin ein Link in Standardausgabe ohne Unterstrich
|
|
70
|
-
</kol-link>
|
|
71
|
-
|
|
72
51
|
</p>
|
|
73
52
|
|
|
74
53
|
<!--### Best practices
|
|
@@ -100,16 +79,16 @@ Eingabe von Leerzeichen eingefügt werden. Zusätzliche Leerzeichen vergrößern
|
|
|
100
79
|
| `_ariaSelected` | `_aria-selected` | Gibt an, ob der Link gerade ausgewählt ist. (https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-selected) | `boolean \| undefined` | `undefined` |
|
|
101
80
|
| `_disabled` | `_disabled` | Gibt an, ob der Link deaktiviert ist. | `boolean \| undefined` | `false` |
|
|
102
81
|
| `_href` _(required)_ | `_href` | Gibt die Ziel-Url des Links an. | `string` | `undefined` |
|
|
103
|
-
| `_icon` | `_icon` |
|
|
82
|
+
| `_icon` | `_icon` | Iconklasse (z.B.: "codicon codicon-home") | `KoliBriHorizontalIcon & KoliBriVerticalIcon \| string \| undefined` | `undefined` |
|
|
104
83
|
| `_iconAlign` | `_icon-align` | <span class="text-red-500">**[DEPRECATED]**</span> Wird durch das neue flexibleren Icon-Typ abgedeckt.<br/><br/>Gibt an, ob das Icon entweder links oder rechts dargestellt werden soll. | `"bottom" \| "left" \| "right" \| "top" \| undefined` | `undefined` |
|
|
105
84
|
| `_iconOnly` | `_icon-only` | Gibt an, ob nur das Icon angezeigt wird. | `boolean \| undefined` | `false` |
|
|
106
|
-
| `_label` _(required)_ | `_label` |
|
|
85
|
+
| `_label` _(required)_ | `_label` | Setzt den sichtbaren Text des Elements. | `string` | `undefined` |
|
|
107
86
|
| `_on` | -- | <span style="color:red">**[DEPRECATED]**</span> <br/><br/>Gibt die EventCallback-Funktionen für den Link an. | `undefined \| { onClick?: EventValueOrEventCallback<Event, string> \| undefined; }` | `undefined` |
|
|
108
|
-
| `_role` | `_role` | Gibt an, welche
|
|
87
|
+
| `_role` | `_role` | Gibt an, welche Rolle das Element hat. | `"button" \| "link" \| "tab" \| undefined` | `undefined` |
|
|
109
88
|
| `_selector` | `_selector` | <span style="color:red">**[DEPRECATED]**</span> Das Styling sollte stets über CSS erfolgen.<br/><br/>Gibt die ID eines DOM-Elements, zu dem gesprungen werden soll, aus. | `string \| undefined` | `undefined` |
|
|
110
89
|
| `_stealth` | `_stealth` | <span style="color:red">**[DEPRECATED]**</span> Das Styling sollte stets über CSS erfolgen.<br/><br/>Gibt an, ob der Link nur beim Fokus sichtbar ist. | `boolean \| undefined` | `false` |
|
|
111
90
|
| `_tabIndex` | `_tab-index` | Gibt an, welchen Tab-Index der Button hat. (https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) | `number \| undefined` | `undefined` |
|
|
112
|
-
| `_target` | `_target` |
|
|
91
|
+
| `_target` | `_target` | Gibt an wo der Link geöffnet werden soll. | `string \| undefined` | `undefined` |
|
|
113
92
|
| `_targetDescription` | `_target-description` | Gibt die Beschreibung an, wenn der Link in einem anderen Programm geöffnet wird. | `string \| undefined` | `'Der Link wird in einem neuen Tab geöffnet.'` |
|
|
114
93
|
| `_tooltipAlign` | `_tooltip-align` | Gibt an, ob der Tooltip entweder oben, rechts, unten oder links angezeigt werden soll. | `"bottom" \| "left" \| "right" \| "top" \| undefined` | `'right'` |
|
|
115
94
|
| `_useCase` | `_use-case` | <span style="color:red">**[DEPRECATED]**</span> Das Styling sollte stets über CSS erfolgen.<br/><br/>Gibt den Verwendungsfall des Links an. | `"image" \| "nav" \| "text" \| undefined` | `'text'` |
|
package/doc/logo.md
CHANGED
|
@@ -1,26 +1,22 @@
|
|
|
1
1
|
# Logo
|
|
2
2
|
|
|
3
|
-
Mit Hilfe der **Logo**-Komponente können an beliebigen Positionen Logos ausgegeben werden.
|
|
4
|
-
der Bundesinstitutionen. Die **Logo**-Komponente rendert an beliebiger Position auf der Webseite ein Logo, das über ein Attribut definiert wird. Das Logo wird dabei aus einer
|
|
5
|
-
Sammlung von SVG-Grafiken zusammengesetzt, die fertig konstruiert vorliegen. Die Ausgabe des Logos kann über das Attribut **style** definiert werden.
|
|
3
|
+
Mit Hilfe der **Logo**-Komponente können an beliebigen Positionen die Logos verschiedener Bundesinstitutionen ausgegeben werden. Das Logo wird dabei aus einer Sammlung von SVG-Grafiken zusammengesetzt, die fertig konstruiert vorliegen.
|
|
6
4
|
|
|
7
5
|
## Konstruktion
|
|
8
6
|
|
|
9
7
|
### Code
|
|
10
8
|
|
|
11
9
|
```html
|
|
12
|
-
<
|
|
13
|
-
<kol-logo _abbr="BReg"></kol-logo>
|
|
14
|
-
</div>
|
|
10
|
+
<kol-logo _org_="BReg"></kol-logo>
|
|
15
11
|
```
|
|
16
12
|
|
|
17
13
|
### Beispiel
|
|
18
14
|
|
|
19
|
-
<kol-logo
|
|
15
|
+
<kol-logo _org_="BReg"></kol-logo>
|
|
20
16
|
|
|
21
17
|
## Verwendung
|
|
22
18
|
|
|
23
|
-
Das Attribut
|
|
19
|
+
Das Attribut **`_org`** wird für die Definition des gewünschten Logos verwendet. Es sind folgende Parameter möglich:
|
|
24
20
|
|
|
25
21
|
**BReg** = **_Die Bundesregierung_**
|
|
26
22
|
|
package/doc/modal.md
CHANGED
|
@@ -1,11 +1,7 @@
|
|
|
1
1
|
# Modal
|
|
2
2
|
|
|
3
|
-
Mit Hilfe der **Modal**-Komponente können zusätzliche Informationen oder auch Eingabeformulare in einem
|
|
4
|
-
|
|
5
|
-
Close-Icon wieder geschlossen. Die **Modal**-Komponente basiert auf der **Card**-Komponente und ist standardmäßig versteckt. Sie wird i.d.R.
|
|
6
|
-
erst nach Klick auf einen Button oder sonstigem Trigger angezeigt. Dabei wird der Hintergrund des Fensters deaktiviert und allein der Inhalt
|
|
7
|
-
des Modal-Fensters ist aktiv. Das **Modal**-Fenster wird über ein **Close-Icon** oben rechts im Kopfbereich wieder
|
|
8
|
-
geschlossen.
|
|
3
|
+
Mit Hilfe der **Modal**-Komponente können zusätzliche Informationen oder auch Eingabeformulare in einem Dialogfenster angezeigt werden. Ein offenes **Modal** kann via **ESC** geschlossen werden.
|
|
4
|
+
Die **Modal**-Komponente ist standardmäßig versteckt. Sie wird i.d.R. erst nach Klick auf einen Button oder sonstigem Trigger angezeigt. Dabei wird der Hintergrund des Fensters deaktiviert und allein der Inhalt des Modal-Fensters ist aktiv.
|
|
9
5
|
|
|
10
6
|
## Funktionsweise
|
|
11
7
|
|
|
@@ -13,54 +9,45 @@ Das **Modal** realisiert die Basis für barrierefreie Overlays und ermöglicht e
|
|
|
13
9
|
|
|
14
10
|
Sobald ein **Modal** geöffnet wird, werden alle selektierbaren Elemente in der Webseite deaktiviert, außer die innerhalb des aktiven Modals.
|
|
15
11
|
|
|
16
|
-
Werden mehrere **Modale** nach einander geöffnet, dann wird immer nur das letzte geöffnete angezeigt. Die **Modale** werden nach dem _Last In – First Out_ -Prinzip (LIFO) angezeigt, wobei die einzelnen **Modale** in beliebiger Reihenfolge wieder geschlossen werden können.
|
|
17
|
-
|
|
18
12
|
## Konstruktion
|
|
19
13
|
|
|
20
14
|
### Code
|
|
21
15
|
|
|
22
|
-
> Um das Zusammenspiel von Komponenten (HTML) und Controller (TypeScript) gemeinsam darzustellen, wurden alle Code-Beispiele auf dieser Seite mit den Web Components im TSX geschrieben.
|
|
23
|
-
|
|
24
16
|
```html
|
|
25
|
-
<kol-modal
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
}
|
|
34
|
-
}}
|
|
35
|
-
_width="400px"
|
|
36
|
-
>
|
|
37
|
-
<kol-card _heading="Vorgang löschen" _has-footer>
|
|
38
|
-
<p slot="content">Wollen Sie den Vorgang wirklich löschen?</p>
|
|
39
|
-
<div slot="footer">
|
|
40
|
-
<kol-button _label="Ok" _variant="primary"></kol-button>
|
|
41
|
-
<kol-button _label="Abbrechen"></kol-button>
|
|
42
|
-
</div>
|
|
43
|
-
</kol-card>
|
|
17
|
+
<kol-modal id="test-modal" _aria-label="Beschreibung zur Modalbox">
|
|
18
|
+
<kol-card _heading="Vorgang löschen" _has-footer style="background-color: bisque">
|
|
19
|
+
<p slot="content">Wollen Sie den Vorgang wirklich löschen?</p>
|
|
20
|
+
<div slot="footer">
|
|
21
|
+
<kol-button class="close-modal" _label="Ok" _variant="primary"></kol-button>
|
|
22
|
+
<kol-button class="close-modal" _label="Abbrechen"></kol-button>
|
|
23
|
+
</div>
|
|
24
|
+
</kol-card>
|
|
44
25
|
</kol-modal>
|
|
45
|
-
<kol-button
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
26
|
+
<kol-button id="modal-open-button" _label="Modal öffnen"></kol-button>
|
|
27
|
+
<script>
|
|
28
|
+
const modal = document.querySelector('#test-modal');
|
|
29
|
+
const modalOpenButton = document.querySelector('#modal-open-button');
|
|
30
|
+
function openModal() {
|
|
31
|
+
modal._activeElement = modalOpenButton;
|
|
32
|
+
modal._open = true;
|
|
33
|
+
}
|
|
34
|
+
function closeModal() {
|
|
35
|
+
modal._activeElement = null;
|
|
36
|
+
}
|
|
37
|
+
document.querySelectorAll('.close-modal').forEach((b) => (b._on = { onClick: closeModal }));
|
|
38
|
+
modalOpenButton._on = { onClick: openModal };
|
|
39
|
+
</script>
|
|
55
40
|
```
|
|
56
41
|
|
|
57
42
|
## Verwendung
|
|
58
43
|
|
|
59
|
-
Über das Attribut
|
|
44
|
+
Über das Attribut **`_width`** geben Sie die gewünschte Breite der Modalbox an. Sie wird in der gewählten Größe immer mittig auf dem Bildschirm angezeigt.
|
|
45
|
+
|
|
46
|
+
Da das Modal vom eigentlichen Modal entkoppelt ist, aber für eine teilweisen Sperrung der Inhalte sorgt. Muss es auch eine Möglichkeit bieten, das Schließen (Sperrung aufheben) aus dem Modal-Kontext zu ermöglichen.
|
|
60
47
|
|
|
61
|
-
|
|
48
|
+
<kol-alert _type="info">Es wird empfohlen einen Close-Button oben rechts einzubauen.</kol-alert>
|
|
62
49
|
|
|
63
|
-
|
|
50
|
+
Das **Modal** hat einen `z-index` von `100`.
|
|
64
51
|
|
|
65
52
|
### Best practices
|
|
66
53
|
|
|
@@ -80,25 +67,20 @@ Da das Modal vom eigentlichen Modal entkoppelt ist, aber für eine teilweisen Sp
|
|
|
80
67
|
|
|
81
68
|
Das **Modal** ist so realisiert, dass der Fokus darauf liegt, wenn es geöffnet wird. Elemente außerhalb des Modals sind dann nicht mehr fokussierbar.
|
|
82
69
|
|
|
83
|
-
Wird das **Modal** geschlossen, liegt der Fokus wieder auf dem Element, welches
|
|
70
|
+
Wird das **Modal** geschlossen, liegt der Fokus wieder auf dem Element, welches unter **`_activeElement`** angegeben wurde.
|
|
84
71
|
|
|
85
|
-
Bei der Realisierung dieser Funktionalität haben wir auf die Verwendung der CSS-Properties
|
|
72
|
+
Bei der Realisierung dieser Funktionalität haben wir auf die Verwendung der CSS-Properties **`user-select`** und **`pointer-events`** verzichtet, um das Navigieren aus der Webseite in die Browser-Menü's weiterhin zu ermöglichen. Ebenfalls haben wir darauf verzichtet die _Event-Propagation_ zu manipulieren.
|
|
86
73
|
|
|
87
74
|
Achten Sie für eine optimale Ausgabe der **Modal**-Komponente in Screenreadern darauf, das Attribut **`aria-label`** korrekt zu setzen.
|
|
88
75
|
|
|
89
|
-
Beim Öffnen eines Modals, muss der Entwickler:in das aktive Element übergeben, zu dem nach dem Schließen des Modals automatisch der Fokus gesetzt werden soll.
|
|
90
|
-
|
|
91
76
|
Des Weiteren gibt es immer nur maximal ein aktives Modal, welches alle selektierbaren Elemente deaktiviert außer die innerhalb des eigenen Modals. Hierbei ist zu beachten, dass KoliBri nur Elemente deaktiviert die sich im Browser-Seitenbereich befinden. Das Fokussieren den Browser-Menü's ist weiterhin möglich.
|
|
92
77
|
|
|
93
|
-
Zusätzlich stellt die Komponente sicher, dass die Darstellung beliebiger Inhalte bei beliebiger Zoomstufe barrierefrei bleibt. Hierzu wird ein vertikaler Scroll-Balken bei bedarf verwendet.
|
|
94
|
-
|
|
95
78
|
### Tastatursteuerung
|
|
96
79
|
|
|
97
|
-
| Taste
|
|
98
|
-
|
|
|
99
|
-
| `Tab`
|
|
100
|
-
| `
|
|
101
|
-
| `Leer` | Öffnet das Modal. |
|
|
80
|
+
| Taste | Funktion |
|
|
81
|
+
| ----- | ------------------------------------------------------------------------------------------- |
|
|
82
|
+
| `Tab` | Bei geöffnetem Modal werden alle fokussierbaren Elemente der Reihenfolge nach angesprungen. |
|
|
83
|
+
| `ESC` | Schließt das Modal. |
|
|
102
84
|
|
|
103
85
|
## Links und Referenzen
|
|
104
86
|
|
|
@@ -115,7 +97,7 @@ Zusätzlich stellt die Komponente sicher, dass die Darstellung beliebiger Inhalt
|
|
|
115
97
|
| `_activeElement` | -- | Gibt die Referenz auf das auslösende HTML-Element an, wodurch das Modal geöffnet wurde. | `HTMLElement \| null \| undefined` | `undefined` |
|
|
116
98
|
| `_ariaLabel` _(required)_ | `_aria-label` | Gibt den Text an, der die Navigation von anderen Navigationen differenziert. | `string` | `undefined` |
|
|
117
99
|
| `_on` | -- | Gibt die EventCallback-Function für das Schließen des Modals an. | `undefined \| { onClose?: EventCallback<Event> \| undefined; }` | `undefined` |
|
|
118
|
-
| `_width` | `_width` |
|
|
100
|
+
| `_width` | `_width` | Setzt die Breite des Modals. (max-width: 100%). | `string \| undefined` | `'100%'` |
|
|
119
101
|
|
|
120
102
|
|
|
121
103
|
----------------------------------------------
|
package/doc/nav.md
CHANGED
|
@@ -1,17 +1,13 @@
|
|
|
1
1
|
# Nav
|
|
2
2
|
|
|
3
|
-
Eine **Navigationsleiste** ist eine Gruppe von verwandten Links oder
|
|
4
|
-
|
|
5
|
-
Die **Nav**-Komponente stellt eine vollwertige vertikale , bzw. horizontale **Navigationsleiste** bereit. Sie kann mehrere Ebenen enthalten und in verschiedenen Breiten ausgegeben werden. Die **Nav**-Komponente repräsentiert die Struktur der Webseite und hat so eine fundamentale Bedeutung sowohl für Nutzer:innen, als auch für Suchmaschinen.
|
|
3
|
+
Eine **Navigationsleiste** ist eine Gruppe von verwandten Links oder Navigationselementen, die durch Anklicken eine Aktion ausführen oder Inhalte anzeigen. Sie navigiert Nutzer:innen direkt zu bestimmten Inhalten der aktuellen Seite oder zu externen Seiten. Außerdem dient sie Nutzer:innen (ähnlich wie Registerkarten) als Steuerelement, um Inhalte anzuzeigen, auszublenden und zwischen ihnen zu wechseln.
|
|
6
4
|
|
|
7
5
|
**KoliBri** stellt eine umfangreich konfigurierbare, vertikale oder horizontale **Navigationsleiste** zur Verfügung, die mehrere Ebenen darstellen und in der Breite variiert werden kann.
|
|
8
|
-
Menüpunkte
|
|
9
|
-
etwas eingerückt ausgegeben. Übergeordnete Menüpunkte die Untermenüpunkte enthalten, werden mit einem **Plus-Icon** am linken Rand angezeigt. Wird der übergeordnete Menüpunkt mit dem Plus-Icon geöffnet, ändert sich
|
|
10
|
-
das Plus-Icon automatisch zu einem **Minus-Icon**, mit dem der Menüpunkt wieder geschlossen werden kann.
|
|
6
|
+
Übergeordnete Menüpunkte die Untermenüpunkte enthalten, werden mit einem **Plus-Icon** am rechten Rand angezeigt. Wird der übergeordnete Menüpunkt mit dem Plus-Icon geöffnet, ändert sich das Plus-Icon automatisch zu einem **Minus-Icon**, mit dem der Menüpunkt wieder geschlossen werden kann.
|
|
11
7
|
|
|
12
8
|
Aktive Menüpunkte werden mit einer farbigen Markierung dargestellt.
|
|
13
9
|
|
|
14
|
-
Über
|
|
10
|
+
Über eine optionale Schaltfläche unterhalb der Navigation kann die Breite der **Nav**-Komponente verändert werden. In der kleinsten Breite werden die Menütitel ausgeblendet und nur
|
|
15
11
|
noch die Icons ausgegeben.
|
|
16
12
|
|
|
17
13
|
## Konstruktion
|
|
@@ -20,44 +16,61 @@ noch die Icons ausgegeben.
|
|
|
20
16
|
|
|
21
17
|
```html
|
|
22
18
|
<kol-nav
|
|
23
|
-
|
|
24
|
-
|
|
19
|
+
_ariaLabel="Navigation"
|
|
20
|
+
_links="[
|
|
21
|
+
{
|
|
22
|
+
_href: 'startseite',
|
|
23
|
+
_icon: 'codicon codicon-home',
|
|
24
|
+
_label: 'Startseite',
|
|
25
|
+
_children: [
|
|
26
|
+
{ _href: 'startseite/1-untermenuepunkt', _icon: 'codicon codicon-home', _label: '1. Untermenüpunkt' },
|
|
27
|
+
{ _href: 'startseite/2-untermenuepunkt', _icon: 'codicon codicon-home', _label: '2. Untermenüpunkt' },
|
|
28
|
+
],
|
|
29
|
+
},
|
|
30
|
+
{ _href: 'unterseite', _icon: 'codicon codicon-home', _label: '2. Menüpunkt' },
|
|
31
|
+
]"
|
|
32
|
+
_has-compact-button
|
|
25
33
|
></kol-nav>
|
|
26
34
|
```
|
|
27
35
|
|
|
28
36
|
### Beispiel
|
|
29
37
|
|
|
30
|
-
<kol-nav _ariaLabel="Navigation" _links=
|
|
38
|
+
<kol-nav _ariaLabel="Navigation" _links="[{_href: 'startseite',_icon: 'codicon codicon-home',_label: 'Startseite',_children: [{ _href: 'startseite/1-untermenuepunkt', _icon: 'codicon codicon-home', _label: '1. Untermenüpunkt' },{ _href: 'startseite/2-untermenuepunkt', _icon: 'codicon codicon-home', _label: '2. Untermenüpunkt' },],},{ _href: 'unterseite', _icon: 'codicon codicon-home', _label: '2. Menüpunkt' }]" _has-compact-button></kol-nav>
|
|
31
39
|
|
|
32
40
|
## Verwendung
|
|
33
41
|
|
|
34
42
|
### Links in der Navigationsleiste definieren
|
|
35
43
|
|
|
36
|
-
Die Navigationsstruktur wird als JSON-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
44
|
+
Die Navigationsstruktur wird als Objekt oder JSON-String an das Attribut **`_links`** übergeben. Die Struktur ist als Wert/Parameter-Paar aufgebaut:
|
|
45
|
+
Um Untermenüpunkte zu erzeugen, erweitern Sie die JSON-Struktur um das zusätzliche Attribut **`_children`** im übergeordneten Element.
|
|
46
|
+
|
|
47
|
+
```js
|
|
48
|
+
[
|
|
49
|
+
{
|
|
50
|
+
_href: 'startseite',
|
|
51
|
+
_icon: 'codicon codicon-home',
|
|
52
|
+
_label: 'Startseite',
|
|
53
|
+
_children: [
|
|
54
|
+
{ _href: 'startseite/1-untermenuepunkt', _icon: 'codicon codicon-home', _label: '1. Untermenüpunkt' },
|
|
55
|
+
{ _href: 'startseite/2-untermenuepunkt', _icon: 'codicon codicon-home', _label: '2. Untermenüpunkt' },
|
|
56
|
+
],
|
|
57
|
+
},
|
|
58
|
+
{ _href: 'unterseite', _icon: 'codicon codicon-home', _label: '2. Menüpunkt' },
|
|
59
|
+
];
|
|
47
60
|
```
|
|
48
61
|
|
|
49
62
|
### Kompakte Navigationsleiste anzeigen
|
|
50
63
|
|
|
51
|
-
Um die Navigationsleiste in der kompakten Darstellung auszugeben, setzen Sie das Attribut
|
|
64
|
+
Um die Navigationsleiste in der kompakten Darstellung auszugeben, setzen Sie das Attribut **`_compact`**.
|
|
52
65
|
|
|
53
66
|
### Umschalter normale/kompakte Darstellung
|
|
54
67
|
|
|
55
|
-
Um
|
|
56
|
-
|
|
68
|
+
Um eine Schaltfläche einzublenden, die die kompakte Darstellung an/aus schaltet, setzen Sie das Attribut **`_hasCompact-button`**.
|
|
69
|
+
Diese Schaltfläche erscheint unterhalb der Navigation und wird nur bei vertikaler Ausrichtung angezeigt.
|
|
57
70
|
|
|
58
71
|
### Umschaltung horizontale/vertikale Ausrichtung
|
|
59
72
|
|
|
60
|
-
Die Navigationsleiste kann mit dem Attribut
|
|
73
|
+
Die Ausrichtung der Navigationsleiste kann mit dem Attribut **`_orientation`** umgeschaltet werden. Mögliche Werte sind:
|
|
61
74
|
|
|
62
75
|
- `horizontal`
|
|
63
76
|
- `vertical`
|
|
@@ -70,7 +83,6 @@ Die Navigationsleiste kann mit dem Attribut `_orientation` zwischen horizontaler
|
|
|
70
83
|
- Stapeln Sie nicht mehrere **Navigationsleisten** direkt nebeneinander.
|
|
71
84
|
- Verwenden Sie keine **Navigationsleisten** zum Vergleichen von Inhalten (z. B. unterschiedliche Leistungen).
|
|
72
85
|
- Berücksichtigen Sie die Anzahl der Navigationselemente, die Sie in die **Navigationsleiste** einfügen. Wenn Sie das Gefühl haben, dass die Zahl zu groß wird, ziehen Sie alternative Ansätze zur Präsentation des Inhalts in Betracht oder verwenden Sie ein anderes Navigationsmuster/eine andere Komponente.
|
|
73
|
-
- Wenn ein Menüpunkt Kindelemente besitzt, bewirkt die Enter-Taste das Öffnen des nächsten Kindelements. Es ist in diesem Fall nicht möglich den Link im Elternelement mit der Enter-Taste auszuführen.
|
|
74
86
|
|
|
75
87
|
### Anwendungsfälle
|
|
76
88
|
|
|
@@ -86,7 +98,7 @@ Die Navigationsleiste kann mit dem Attribut `_orientation` zwischen horizontaler
|
|
|
86
98
|
| Taste | Funktion |
|
|
87
99
|
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
88
100
|
| `Tab` | Fokussiert den ersten Menüpunkt in der Navigation. Nachfolgend kann mit der Tab-Taste jeder Menüpunkt angesprungen werden. Wenn der Has-compact-Button aktiviert wurde, ist dieser ebenfalls mit der Tab-Taste erreichbar. |
|
|
89
|
-
| `Enter` |
|
|
101
|
+
| `Enter` | Klappt Unterpunkte auf/zu, sofern eine Ausklappschaltfläche fokussiert ist, aktiviert die Schaltfläche oder öffnet den Link anderenfalls. |
|
|
90
102
|
|
|
91
103
|
<!--## Links und Referenzen
|
|
92
104
|
|
|
@@ -95,16 +107,16 @@ Die Navigationsleiste kann mit dem Attribut `_orientation` zwischen horizontaler
|
|
|
95
107
|
|
|
96
108
|
## Properties
|
|
97
109
|
|
|
98
|
-
| Property | Attribute | Description
|
|
99
|
-
| ------------------------- | --------------------- |
|
|
100
|
-
| `_ariaCurrentValue` | `_aria-current-value` | Gibt den Wert von aria-current an, der bei dem aktuellen Kontext innerhalb der Navigation verwendet werden soll.
|
|
101
|
-
| `_ariaLabel` _(required)_ | `_aria-label` | Gibt den Text an, der die Navigation von anderen Navigationen differenziert.
|
|
102
|
-
| `_collapsible` | `_collapsible` | Gibt an, ob Knoten in der Navigation zusammengeklappt werden können. Ist standardmäßig aktiv.
|
|
103
|
-
| `_compact` | `_compact` | Gibt an, ob die Navigation kompakt angezeigt wird.
|
|
104
|
-
| `_hasCompactButton` | `_has-compact-button` | <span class="text-red-500">**[DEPRECATED]**</span> Version 2<br/><br/>Gibt an, ob die Navigation eine zusätzliche Schaltfläche zum Aus- und Einklappen der Navigation anzeigen soll.
|
|
105
|
-
| `_links` _(required)_ | `_links` | Gibt die geordnete Liste der Seitenhierarchie an.
|
|
106
|
-
| `_orientation` | `_orientation` | Gibt die Ausrichtung der Navigation an.
|
|
107
|
-
| `_variant` | `_variant` | <span style="color:red">**[DEPRECATED]**</span> This property is deprecated and will be removed in the next major version.<br/><br/>
|
|
110
|
+
| Property | Attribute | Description | Type | Default |
|
|
111
|
+
| ------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------------ |
|
|
112
|
+
| `_ariaCurrentValue` | `_aria-current-value` | Gibt den Wert von aria-current an, der bei dem aktuellen Kontext innerhalb der Navigation verwendet werden soll. | `"date" \| "location" \| "page" \| "step" \| "time" \| boolean` | `false` |
|
|
113
|
+
| `_ariaLabel` _(required)_ | `_aria-label` | Gibt den Text an, der die Navigation von anderen Navigationen differenziert. | `string` | `undefined` |
|
|
114
|
+
| `_collapsible` | `_collapsible` | Gibt an, ob Knoten in der Navigation zusammengeklappt werden können. Ist standardmäßig aktiv. | `boolean \| undefined` | `true` |
|
|
115
|
+
| `_compact` | `_compact` | Gibt an, ob die Navigation kompakt angezeigt wird. | `boolean \| undefined` | `false` |
|
|
116
|
+
| `_hasCompactButton` | `_has-compact-button` | <span class="text-red-500">**[DEPRECATED]**</span> Version 2<br/><br/>Gibt an, ob die Navigation eine zusätzliche Schaltfläche zum Aus- und Einklappen der Navigation anzeigen soll. | `boolean \| undefined` | `false` |
|
|
117
|
+
| `_links` _(required)_ | `_links` | Gibt die geordnete Liste der Seitenhierarchie an. | `ButtonOrLinkOrTextWithChildrenProps[] \| string` | `undefined` |
|
|
118
|
+
| `_orientation` | `_orientation` | Gibt die Ausrichtung der Navigation an. | `"horizontal" \| "vertical" \| undefined` | `'vertical'` |
|
|
119
|
+
| `_variant` | `_variant` | <span style="color:red">**[DEPRECATED]**</span> This property is deprecated and will be removed in the next major version.<br/><br/>Setzt zusätzliche Klassen an das das <nav> umschließende <div>. (müssen im Theme existieren) | `"primary" \| "secondary" \| undefined` | `'primary'` |
|
|
108
120
|
|
|
109
121
|
|
|
110
122
|
## Dependencies
|
package/doc/pagination.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# Pagination
|
|
2
2
|
|
|
3
|
-
Mit Hilfe der
|
|
4
|
-
in handliche Abschnitte unterteilen. Diese können dann über die Paginierung der Reihe nach
|
|
5
|
-
durchlaufen werden.
|
|
3
|
+
Mit Hilfe der **Paginierung**-Komponente lassen sich umfangreiche, aufgeteilte Inhalte, wie zum Beispiel Suchergebnisse, der Reihe nach durchlaufen.
|
|
6
4
|
|
|
7
5
|
## Konstruktion
|
|
8
6
|
|
|
@@ -19,34 +17,31 @@ durchlaufen werden.
|
|
|
19
17
|
### Beispiel
|
|
20
18
|
|
|
21
19
|
<div class="grid gap-2">
|
|
22
|
-
<kol-heading _level="3"
|
|
23
|
-
<kol-pagination _total="100" _page="6"></kol-pagination>
|
|
24
|
-
<kol-heading _level="3"
|
|
20
|
+
<kol-heading _level="3" _label="Standardausgabe nur mit aktuellem Element"></kol-heading>
|
|
21
|
+
<kol-pagination _total="100" _page="6" _has-buttons="false"></kol-pagination>
|
|
22
|
+
<kol-heading _level="3" _label="Ausgabe 2 Elemente links und rechts dem aktuellen Element (_sibling)"></kol-heading>
|
|
25
23
|
<kol-pagination _total="100" _page="6" _sibling-count="2"></kol-pagination>
|
|
26
|
-
<kol-heading _level="3"
|
|
24
|
+
<kol-heading _level="3" _label="Ausgabe 2 Elemente links und rechts (_boundary-count)"></kol-heading>
|
|
27
25
|
<kol-pagination _total="100" _page="6" _sibling-count="0" _boundary-count="2"></kol-pagination>
|
|
28
26
|
</div>
|
|
29
27
|
|
|
30
28
|
## Verwendung
|
|
31
29
|
|
|
32
|
-
Die
|
|
30
|
+
Die **Paginierung**-Komponente kann über Ihre Properties konfiguriert werden.
|
|
33
31
|
|
|
34
|
-
-
|
|
35
|
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
- Über die Property `_sibling-count` kann festgelegt werden, wie viele Elemente links und rechts des aktuellen Elements angezeigt werden sollen. Der Wert 2 hätte also zur Folge, daß zwei Elemente links und rechts des
|
|
39
|
-
aktuellen Elements angezeigt werden.
|
|
32
|
+
- Das Attribut **`_total`** bestimmt die Gesamtanzahl der Elemente.
|
|
33
|
+
- Über das Attribut **`boundary-count`** wird die Anzahl von Elementen bestimmt, die in der **Paginierung**-Komponente rechts und links angezeigt werden, während die übrigen Elemente
|
|
34
|
+
- Das Attribut **`_page`** legt das gerade aktive Element fest. Dieses wird farblich hervorgehoben dargestellt.
|
|
35
|
+
- Über das Attribut **`_sibling-count`** kann festgelegt werden, wie viele Elemente jeweils links und rechts des Aktuellen angezeigt werden sollen.
|
|
40
36
|
|
|
41
37
|
<!-- ### Best practices -->
|
|
42
38
|
|
|
43
39
|
### Anwendungsfälle
|
|
44
40
|
|
|
45
|
-
Die **
|
|
46
|
-
|
|
47
|
-
Klassische Anwendungsbereiche einer Paginierung sind z.B. Blog-ähnliche Inhalte oder auch listenartige Layouts, wie z.B. Tabellen. Auch für bestimmte Navigationsaufgaben innerhalb einer Seite kann die Paginierung gut verwendet werden.
|
|
41
|
+
Die **Paginierung**-Komponente kann auf vielfältige Art eingesetzt werden. Insbesondere dort, wo auf einer Inhaltsseite umfangreiche Inhalte dargestellt werden sollen, trägt sie zur Verbesserung der Struktur und Übersichtlichkeit bei.
|
|
42
|
+
Klassische Anwendungsbereiche einer Paginierung sind z.B. Blog-ähnliche Inhalte, Listen und Tabellen. Auch für bestimmte Navigationsaufgaben innerhalb einer Seite kann die Paginierung gut verwendet werden.
|
|
48
43
|
|
|
49
|
-
## Barrierefreiheit
|
|
44
|
+
<!-- ## Barrierefreiheit -->
|
|
50
45
|
|
|
51
46
|
<!-- ## Links und Referenzen -->
|
|
52
47
|
|
|
@@ -59,14 +54,14 @@ Klassische Anwendungsbereiche einer Paginierung sind z.B. Blog-ähnliche Inhalte
|
|
|
59
54
|
| --------------------- | -------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|
|
60
55
|
| `_boundaryCount` | `_boundary-count` | Gibt an, wie viele Seiten neben den am Rand liegenden Pfeil-Schaltern angezeigt werden sollen. | `number \| undefined` | `1` |
|
|
61
56
|
| `_customClass` | `_custom-class` | Gibt an, welche Custom-Class übergeben werden soll, wenn _variant="custom" gesetzt ist. | `string \| undefined` | `undefined` |
|
|
62
|
-
| `_hasButtons` | `_has-buttons` |
|
|
57
|
+
| `_hasButtons` | `_has-buttons` | Setzt die Sichtbarkeit der Anfang/zurück/weiter/Ende-Schaltflächen. | `boolean \| string \| undefined \| { first: boolean; last: boolean; next: boolean; previous: boolean; }` | `true` |
|
|
63
58
|
| `_on` _(required)_ | -- | Gibt an, auf welche Callback-Events reagiert werden. | `{ onChangePage?: EventValueOrEventCallback<Event, number> \| undefined; onChangePageSize?: EventValueOrEventCallback<Event, number> \| undefined; onClick?: EventValueOrEventCallback<Event, number> \| undefined; }` | `undefined` |
|
|
64
59
|
| `_page` _(required)_ | `_page` | Gibt an, welche Seite aktuell ausgewählt ist. | `number` | `undefined` |
|
|
65
60
|
| `_pageSize` | `_page-size` | Gibt an, wie viele Einträge pro Seite angezeigt werden. | `number` | `1` |
|
|
66
|
-
| `_pageSizeOptions` | `_page-size-options` |
|
|
67
|
-
| `_siblingCount` | `_sibling-count` | Gibt an, wie viele Seiten neben
|
|
61
|
+
| `_pageSizeOptions` | `_page-size-options` | Setzt die Optionen für das Seitenlängenselect. | `number[] \| string` | `[]` |
|
|
62
|
+
| `_siblingCount` | `_sibling-count` | Gibt an, wie viele Seiten neben der aktuell Ausgewählten angezeigt werden. | `number \| undefined` | `1` |
|
|
68
63
|
| `_tooltipAlign` | `_tooltip-align` | Gibt an, ob der Tooltip oben, rechts, unten oder links angezeigt werden. | `"bottom" \| "left" \| "right" \| "top" \| undefined` | `'top'` |
|
|
69
|
-
| `_total` _(required)_ | `_total` |
|
|
64
|
+
| `_total` _(required)_ | `_total` | Setzt die Gesamtanzahl der Seiten. | `number` | `undefined` |
|
|
70
65
|
| `_variant` | `_variant` | Gibt an, welche Button-Variante verwendet werden soll. | `"custom" \| "danger" \| "ghost" \| "normal" \| "primary" \| "secondary" \| undefined` | `'normal'` |
|
|
71
66
|
|
|
72
67
|
|
package/doc/progress.md
CHANGED
|
@@ -18,20 +18,20 @@ Die **Progress**-Komponente erzeugt einen Fortschrittsbalken, über den eine opt
|
|
|
18
18
|
|
|
19
19
|
## Verwendung
|
|
20
20
|
|
|
21
|
-
Verwenden Sie das Attribut
|
|
21
|
+
Verwenden Sie das Attribut **`_type`**, um die optische Ausgabe der Komponente zu steuern. Mögliche Werte sind:
|
|
22
22
|
|
|
23
|
-
-
|
|
24
|
-
-
|
|
23
|
+
- `bar`: für eine Ausgabe als horizontaler Fortschrittsbalken
|
|
24
|
+
- `cycle`: für eine Ausgabe als kreisförmiger Fortschrittsbalken
|
|
25
25
|
|
|
26
|
-
Verwenden Sie das Attribut
|
|
26
|
+
Verwenden Sie das Attribut **`_max`**, um den maximalen Wert der Komponente zu bestimmen, das Minimum ist immer 0.
|
|
27
27
|
|
|
28
|
-
Verwenden Sie das Attribut
|
|
28
|
+
Verwenden Sie das Attribut **`_value`**, um den aktuellen Wert der Komponente zu bestimmen.
|
|
29
29
|
|
|
30
30
|
<!--### Best practices
|
|
31
31
|
|
|
32
32
|
### Anwendungsfälle-->
|
|
33
33
|
|
|
34
|
-
## Barrierefreiheit
|
|
34
|
+
<!-- ## Barrierefreiheit -->
|
|
35
35
|
|
|
36
36
|
## Links und Referenzen
|
|
37
37
|
|
|
@@ -47,7 +47,7 @@ Verwenden Sie das Attribut `_value`, um den aktuellen Wert der Komponente zu bes
|
|
|
47
47
|
| --------------------- | --------- | -------------------------------------------------------------------- | ------------------------------- | ----------- |
|
|
48
48
|
| `_max` _(required)_ | `_max` | Gibt an, bei welchem Wert die Fortschrittsanzeige abgeschlossen ist. | `number` | `undefined` |
|
|
49
49
|
| `_type` | `_type` | Gibt an, ob der Prozess als Balken oder Kreis dargestellt wird. | `"bar" \| "cycle" \| undefined` | `undefined` |
|
|
50
|
-
| `_unit` | `_unit` |
|
|
50
|
+
| `_unit` | `_unit` | Setzt die Einheit der Fortschrittswerte. (wird nicht angezeigt) | `string \| undefined` | `'%'` |
|
|
51
51
|
| `_value` _(required)_ | `_value` | Gibt an, wie weit die Anzeige fortgeschritten ist. | `number` | `undefined` |
|
|
52
52
|
|
|
53
53
|
|
package/doc/quote.md
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
# Quote
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Die **Quote**-Komponente verfügt über zwei Varianten, eine kurze Fließtext-(`inline`) und eine eingerückte(`block`) Variante. Beide Varianten enthalten einen Link auf die Quelle des Zitates.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Verwendung
|
|
6
|
+
|
|
7
|
+
Mittels **`_caption`** kann eine Überschrift gesetzt werden, während **`_quote`** das eigentliche Zitat enthält. Der Ursprung wird über **`_href`** gesetzt.
|
|
8
|
+
Die `inline`-Variante ist Standard, sofern die Eingerückte gewünscht ist, kann **`_variant`** auf `block` gesetzt werden.
|
|
6
9
|
|
|
7
10
|
## References
|
|
8
11
|
|
|
@@ -17,12 +20,12 @@ Both variants can be extended with a `cite` element. The `cite` element is used
|
|
|
17
20
|
|
|
18
21
|
## Properties
|
|
19
22
|
|
|
20
|
-
| Property | Attribute | Description
|
|
21
|
-
| --------------------- | ---------- |
|
|
22
|
-
| `_caption` | `_caption` |
|
|
23
|
-
| `_href` _(required)_ | `_href` |
|
|
24
|
-
| `_quote` _(required)_ | `_quote` |
|
|
25
|
-
| `_variant` | `_variant` |
|
|
23
|
+
| Property | Attribute | Description | Type | Default |
|
|
24
|
+
| --------------------- | ---------- | -------------------------------------- | ---------------------------------- | ----------- |
|
|
25
|
+
| `_caption` | `_caption` | Setzt die Überschrift. | `string \| undefined` | `undefined` |
|
|
26
|
+
| `_href` _(required)_ | `_href` | Link auf die Quelle des Zitates. | `string` | `undefined` |
|
|
27
|
+
| `_quote` _(required)_ | `_quote` | Setzt den Text, also das Zitat selbst. | `string` | `undefined` |
|
|
28
|
+
| `_variant` | `_variant` | Setzt die Variante des Zitats. | `"block" \| "inline" \| undefined` | `'inline'` |
|
|
26
29
|
|
|
27
30
|
|
|
28
31
|
## Dependencies
|