@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/select.md
CHANGED
|
@@ -7,39 +7,48 @@ Die **Select**-Komponente erzeugt eine Auswahlliste, aus der eine oder mehrere v
|
|
|
7
7
|
### Code
|
|
8
8
|
|
|
9
9
|
```html
|
|
10
|
-
<kol-select _list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'}
|
|
10
|
+
<kol-select _list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'}" _value="['1']"> Auswahlfeld </kol-select>
|
|
11
11
|
<kol-select _list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'}]" _multiple _value="['0','2']">
|
|
12
12
|
Auswahlfeld (Mehrfachauswahl)
|
|
13
13
|
</kol-select>
|
|
14
|
+
<kol-select
|
|
15
|
+
_list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'},{'label':'Herr','value':'3'},{'label':'Frau','value':'4'},{'label':'Firma','value':'5'}]"
|
|
16
|
+
_size="4"
|
|
17
|
+
_value="['1']"
|
|
18
|
+
>
|
|
19
|
+
Auswahlfeld mit _size
|
|
20
|
+
</kol-select>
|
|
14
21
|
```
|
|
15
22
|
|
|
16
23
|
### Beispiel
|
|
17
24
|
|
|
18
|
-
<kol-select _list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'}
|
|
19
|
-
|
|
20
|
-
|
|
25
|
+
<kol-select _list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'}" _value="['1']"> Auswahlfeld </kol-select>
|
|
26
|
+
<kol-select _list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'}]" _multiple _value="['0','2']">
|
|
27
|
+
Auswahlfeld (Mehrfachauswahl)
|
|
28
|
+
</kol-select>
|
|
29
|
+
<kol-select _list="[{'label':'Herr','value':'0'},{'label':'Frau','value':'1'},{'label':'Firma','value':'2'},{'label':'Herr','value':'3'},{'label':'Frau','value':'4'},{'label':'Firma','value':'5'}]" _size="4" _value="['1']">Auswahlfeld mit size</kol-select>
|
|
21
30
|
|
|
22
31
|
## Verwendung
|
|
23
32
|
|
|
24
|
-
Die Auswahlmöglichkeiten
|
|
33
|
+
Die Auswahlmöglichkeiten werden über das Attribut **`_list`** als Objekt oder JSON-String an die Komponente übergeben. Je Option müssen die Werte **`label`** und **`value`** angegeben werden.
|
|
25
34
|
|
|
26
35
|
Beispiel für die Konstruktion des JSON-Objektes:
|
|
27
36
|
|
|
28
|
-
```
|
|
29
|
-
[
|
|
37
|
+
```js
|
|
38
|
+
[
|
|
39
|
+
{ label: 'Herr', value: '0' },
|
|
40
|
+
{ label: 'Frau', value: '1' },
|
|
41
|
+
{ label: 'Firma', value: '2' },
|
|
42
|
+
];
|
|
30
43
|
```
|
|
31
44
|
|
|
32
45
|
### Individuelle Höhe angeben
|
|
33
46
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
```html
|
|
37
|
-
<kol-select _height="85px"></kol-select>
|
|
38
|
-
```
|
|
47
|
+
Über das Attribut **`_size`** kann von einem Auswahlmenü auf ein Auswahlfeld (wie bei **`_multiple`**) gewechselt werden und dessen Höhe gesetzt werden.
|
|
39
48
|
|
|
40
49
|
<!--### Best practices-->
|
|
41
50
|
|
|
42
|
-
## Barrierefreiheit
|
|
51
|
+
<!-- ## Barrierefreiheit -->
|
|
43
52
|
|
|
44
53
|
### Tastatursteuerung
|
|
45
54
|
|
|
@@ -85,19 +94,19 @@ import { xxx..., xxx..., FormatHandler, } from '@leanup/form';
|
|
|
85
94
|
| -------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------- |
|
|
86
95
|
| `_accessKey` | `_access-key` | Gibt an, mit welcher Tastenkombination man das Input auslösen oder fokussieren kann. | `string \| undefined` | `undefined` |
|
|
87
96
|
| `_alert` | `_alert` | Gibt an, ob die Fehlermeldung vorgelesen werden soll, wenn es eine gibt. | `boolean \| undefined` | `true` |
|
|
88
|
-
| `_disabled` | `_disabled` |
|
|
97
|
+
| `_disabled` | `_disabled` | Setzt das Feld in einen inaktiven Zustand, in dem es keine Interaktion erlaubt. | `boolean \| undefined` | `undefined` |
|
|
89
98
|
| `_error` | `_error` | Gibt den Text für eine Fehlermeldung an. | `string \| undefined` | `undefined` |
|
|
90
99
|
| `_height` | `_height` | <span class="text-red-500">**[DEPRECATED]**</span> Use _size instead.<br/><br/>Gibt an, ob eine individuelle Höhe übergeben werden soll. | `string \| undefined` | `undefined` |
|
|
91
|
-
| `_hideLabel` | `_hide-label` |
|
|
92
|
-
| `_hint` | `_hint` | Gibt den
|
|
100
|
+
| `_hideLabel` | `_hide-label` | Versteckt das sichtbare Label des Elements. | `boolean \| undefined` | `undefined` |
|
|
101
|
+
| `_hint` | `_hint` | Gibt den Hinweistext an. | `string \| undefined` | `''` |
|
|
93
102
|
| `_icon` | `_icon` | Ermöglicht das Anzeigen von Icons links und/oder rechts am Rand des Eingabefeldes. | `string \| undefined \| { right?: IconOrIconClass \| undefined; left?: IconOrIconClass \| undefined; }` | `undefined` |
|
|
94
103
|
| `_id` | `_id` | Gibt die technische ID des Eingabefeldes an. | `string \| undefined` | `undefined` |
|
|
95
104
|
| `_list` _(required)_ | `_list` | Gibt den technischen Namen des Eingabefeldes an. | `SelectOption<W3CInputValue>[] \| string` | `undefined` |
|
|
96
105
|
| `_multiple` | `_multiple` | Gibt an, ob mehrere Werte eingegeben werden können. | `boolean \| undefined` | `false` |
|
|
97
106
|
| `_name` | `_name` | Gibt den technischen Namen des Eingabefeldes an. | `string \| undefined` | `undefined` |
|
|
98
107
|
| `_on` | -- | Gibt die EventCallback-Funktionen für das Input-Event an. | `InputTypeOnBlur & InputTypeOnClick & InputTypeOnChange & InputTypeOnFocus \| undefined` | `undefined` |
|
|
99
|
-
| `_required` | `_required` |
|
|
100
|
-
| `_size` | `_size` |
|
|
108
|
+
| `_required` | `_required` | Macht das Eingabeelement zu einem Pflichtfeld. | `boolean \| undefined` | `undefined` |
|
|
109
|
+
| `_size` | `_size` | Wechselt das Eingabeelement in den Auswahlfeld modus und setzt die Höhe des Feldes. | `number \| undefined` | `undefined` |
|
|
101
110
|
| `_tabIndex` | `_tab-index` | Gibt an, welchen Tab-Index dieses Input hat. | `number \| undefined` | `undefined` |
|
|
102
111
|
| `_touched` | `_touched` | Gibt an, ob dieses Eingabefeld von Nutzer:innen einmal besucht/berührt wurde. | `boolean \| undefined` | `false` |
|
|
103
112
|
| `_value` | `_value` | Gibt den Wert des Eingabefeldes an. | `W3CInputValue[] \| string \| undefined` | `undefined` |
|
package/doc/skip-nav.md
CHANGED
|
@@ -15,7 +15,7 @@ Mit Hilfe der **SkipNav**-Komponente kann eine versteckte Navigation erzeugt wer
|
|
|
15
15
|
|
|
16
16
|
### Beispiel
|
|
17
17
|
|
|
18
|
-
Um die **SkipNav** sehen zu können, klicken Sie auf
|
|
18
|
+
Um die **SkipNav** sehen zu können, klicken Sie auf diesen Text und gehen dann mit der Tab-Taste einen Schritt weiter.
|
|
19
19
|
|
|
20
20
|
<kol-skip-nav _aria-label="Ein versteckter Link" _links="[{'_label':'Navigation','_href':'#nav'},{'_label':'Inhalt','_href':'#main'},{'_label':'Kontakt','_href':'#kontakt'},{'_label':'Links','_href':'#links'}]"></kol-skip-nav>
|
|
21
21
|
|
|
@@ -23,15 +23,20 @@ Um die **SkipNav** sehen zu können, klicken Sie auf den Text **_Beispiel_** und
|
|
|
23
23
|
|
|
24
24
|
Die **SkipNav** wird durch Übergabe eines JSON-Objekts erzeugt, das für das Rendern der versteckten Links zuständig ist.
|
|
25
25
|
|
|
26
|
-
```
|
|
27
|
-
[
|
|
26
|
+
```js
|
|
27
|
+
[
|
|
28
|
+
{ _label: 'Navigation', _href: '#nav' },
|
|
29
|
+
{ _label: 'Inhalt', _href: '#main' },
|
|
30
|
+
{ _label: 'Kontakt', _href: '#kontakt' },
|
|
31
|
+
{ _label: 'Links', _href: '#links' },
|
|
32
|
+
];
|
|
28
33
|
```
|
|
29
34
|
|
|
30
35
|
<!--### Best practices
|
|
31
36
|
|
|
32
37
|
### Anwendungsfälle-->
|
|
33
38
|
|
|
34
|
-
## Barrierefreiheit
|
|
39
|
+
<!-- ## Barrierefreiheit -->
|
|
35
40
|
|
|
36
41
|
### Tastatursteuerung
|
|
37
42
|
|
|
@@ -52,7 +57,7 @@ Die **SkipNav** wird durch Übergabe eines JSON-Objekts erzeugt, das für das Re
|
|
|
52
57
|
| Property | Attribute | Description | Type | Default |
|
|
53
58
|
| ------------------------- | ------------- | ---------------------------------------------------------------------------- | ----------------------- | ----------- |
|
|
54
59
|
| `_ariaLabel` _(required)_ | `_aria-label` | Gibt den Text an, der die Navigation von anderen Navigationen differenziert. | `string` | `undefined` |
|
|
55
|
-
| `_links` _(required)_ | `_links` |
|
|
60
|
+
| `_links` _(required)_ | `_links` | Setzt die Liste der darzustellenden Links. | `LinkProps[] \| string` | `undefined` |
|
|
56
61
|
|
|
57
62
|
|
|
58
63
|
## Dependencies
|
package/doc/span.md
CHANGED
|
@@ -21,11 +21,11 @@ Die **Span**-Komponente dient dazu innerhalb zahlreicher KoliBri-Komponenten die
|
|
|
21
21
|
|
|
22
22
|
## Properties
|
|
23
23
|
|
|
24
|
-
| Property | Attribute | Description
|
|
25
|
-
| --------------------- | ------------ |
|
|
26
|
-
| `_icon` | `_icon` |
|
|
27
|
-
| `_iconOnly` | `_icon-only` | Gibt an, ob nur das Icon angezeigt wird.
|
|
28
|
-
| `_label` _(required)_ | `_label` |
|
|
24
|
+
| Property | Attribute | Description | Type | Default |
|
|
25
|
+
| --------------------- | ------------ | ----------------------------------------- | -------------------------------------------------------------------- | ----------- |
|
|
26
|
+
| `_icon` | `_icon` | Iconklasse (z.B.: "codicon codicon-home") | `KoliBriHorizontalIcon & KoliBriVerticalIcon \| string \| undefined` | `undefined` |
|
|
27
|
+
| `_iconOnly` | `_icon-only` | Gibt an, ob nur das Icon angezeigt wird. | `boolean \| undefined` | `false` |
|
|
28
|
+
| `_label` _(required)_ | `_label` | Setzt den sichtbaren Text des Elements. | `string` | `undefined` |
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
## Dependencies
|
package/doc/spin.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Spin
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ladeanzeigen, wie die **Spin**-Komponente, informieren die Nutzer:innen über Lade- oder Rechenvorgänge, die vom System ausgeführt werden. Der Fortschritt kann durch eine wiederholte Animation kommuniziert werden.
|
|
4
4
|
|
|
5
5
|
## Konstruktion
|
|
6
6
|
|
|
@@ -22,9 +22,8 @@ Verwenden Sie das Attribut `_show` um festzulegen, ob der Spin angezeigt wird.
|
|
|
22
22
|
|
|
23
23
|
### Best practices
|
|
24
24
|
|
|
25
|
-
- Verwenden Sie
|
|
26
|
-
- Verwenden Sie
|
|
27
|
-
- Verwenden Sie einen Lader, um anzuzeigen, wie viel Arbeit noch übrig ist, bevor das Ergebnis angezeigt werden kann.
|
|
25
|
+
- Verwenden Sie Ladeanzeigen, um die Nutzer:innen über einen Ladezustand oder einen laufenden Prozess zu informieren.
|
|
26
|
+
- Verwenden Sie Ladeanzeigen an konsistenten Stellen in der Benutzeroberfläche, um die Benutzererfahrung zu verbessern.
|
|
28
27
|
|
|
29
28
|
### Anwendungsfälle
|
|
30
29
|
|
|
@@ -33,7 +32,7 @@ Verwenden Sie das Attribut `_show` um festzulegen, ob der Spin angezeigt wird.
|
|
|
33
32
|
- Download von Inhalten.
|
|
34
33
|
- Laden von umfangreichen Inhalten, z.B. Videos.
|
|
35
34
|
|
|
36
|
-
## Barrierefreiheit
|
|
35
|
+
<!-- ## Barrierefreiheit -->
|
|
37
36
|
|
|
38
37
|
<!--## Links und Referenzen
|
|
39
38
|
|
package/doc/table.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Table
|
|
1
|
+
k# Table
|
|
2
2
|
|
|
3
3
|
Die **Table**-Komponente dient primär der übersichtlichen Darstellung von Datenmengen. Dabei ist sie so ausgelegt, dass sie alle von den Daten abhängige Werte automatisch ermittelt und die Tabelle entsprechend darstellt. Hierzu gehören beispielsweise die optionalen Funktionalitäten Spaltensortierung oder Pagination.
|
|
4
4
|
|
|
@@ -10,33 +10,13 @@ Die **Table**-Komponente dient primär der übersichtlichen Darstellung von Date
|
|
|
10
10
|
|
|
11
11
|
Die Table-Komponente ist so konstruiert, dass nicht der gesamte Tabellenaufbau im Markup selbst beschrieben werden muss. Wie genau die Tabelle Markup-spezifisch aufgebaut werden muss, um barrierefrei zu sein, übernimmt die Komponente selbst.
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
```html
|
|
16
|
-
<kol-table>
|
|
17
|
-
<kol-tr>
|
|
18
|
-
<kol-th>…</kol-th>
|
|
19
|
-
…
|
|
20
|
-
</kol-tr>
|
|
21
|
-
…
|
|
22
|
-
</kol-table>
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
**Beispiel**, wie es gedacht ist:
|
|
26
|
-
|
|
27
|
-
```html
|
|
28
|
-
<div>
|
|
29
|
-
<kol-table _caption="…" _headers="…" _data="…" _pagination="…"></kol-table>
|
|
30
|
-
</div>
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Dadurch, dass die Table-Komponente das valide und barrierefreie Markup dynamisch "zusammenbaut", kann die komplexe Auszeichnung für die assistive Systeme dem/der Entwickler:in abgenommen werden.
|
|
13
|
+
Dadurch, dass die Table-Komponente das valide und barrierefreie Markup dynamisch zusammenbaut, kann die komplexe Auszeichnung für die assistive Systeme dem/der Entwickler:in abgenommen werden.
|
|
34
14
|
|
|
35
15
|
### Funktionalitäten
|
|
36
16
|
|
|
37
17
|
Die Table-Komponente unterstützt folgende Funktionalitäten:
|
|
38
18
|
|
|
39
|
-
- Tabellenbeschreibung durch ein
|
|
19
|
+
- Tabellenbeschreibung durch ein **`caption`**-Attribut.
|
|
40
20
|
- Mehrzeilige Spaltenüberschriften in horizontaler oder vertikaler Richtung.
|
|
41
21
|
- Sortierfunktion für entweder horizontale und vertikale Ausrichtung.
|
|
42
22
|
- Unterschiedliche Render-Funktion für die Zellen.
|
|
@@ -49,11 +29,9 @@ Die Table-Komponente unterstützt folgende Funktionalitäten **nicht**:
|
|
|
49
29
|
|
|
50
30
|
> Beides könnte jedoch mittels der Render-Funktion umgesetzt werden.
|
|
51
31
|
|
|
52
|
-
### Typen
|
|
53
|
-
|
|
54
32
|
### Pagination
|
|
55
33
|
|
|
56
|
-
Über
|
|
34
|
+
Über das Attribut **`_pagination`** kann optional eine Vielzahl zusätzlicher Properties zur Steuerung der Pagination übergeben werden. Die genaue Beschreibung der Optionen ist auf der Seite <kol-link _href="/docs/components/pagination" _label="Pagination"></kol-link> zu finden.
|
|
57
35
|
|
|
58
36
|
#### KoliBriTableHeaders
|
|
59
37
|
|
|
@@ -92,10 +70,6 @@ Die Table-Komponente unterstützt folgende Funktionalitäten **nicht**:
|
|
|
92
70
|
};
|
|
93
71
|
```
|
|
94
72
|
|
|
95
|
-
#### KoliBriTablePaginationStates
|
|
96
|
-
|
|
97
|
-
Die Tabellen-Komponente verwendet intern die Pagination-Komponente die sich mit den gleichen Properties steuern lässt. Die Steuerung wird in der Beschreibung der Pagination-Komponente erläutert.
|
|
98
|
-
|
|
99
73
|
### Code
|
|
100
74
|
|
|
101
75
|
```html
|
|
@@ -111,9 +85,8 @@ Die Tabellen-Komponente verwendet intern die Pagination-Komponente die sich mit
|
|
|
111
85
|
### Sortierung
|
|
112
86
|
|
|
113
87
|
- Zu jedem Header kann man eine Sortierfunktion definieren.
|
|
114
|
-
- Es ist
|
|
115
|
-
-
|
|
116
|
-
- Aktuell wird nicht unterstützt, dass bei zweidimensionalen Headern, die Header der jeweils anderen Header-Seite mitsortiert werden. Bei der Anforderung der Sortierung empfehlen wir die Verwendung nur einer Header-Dimension (entweder horizontal oder vertikal).
|
|
88
|
+
- Es ist exakt eine oder keine Sortierfunktion aktiviert.
|
|
89
|
+
- Aktuell wird nicht unterstützt, dass bei zweidimensionalen Headern, die Header der jeweils anderen Header-Seite mit sortiert werden. Bei der Anforderung der Sortierung empfehlen wir die Verwendung nur einer Header-Dimension (entweder horizontal oder vertikal).
|
|
117
90
|
|
|
118
91
|
<!--### Best practices
|
|
119
92
|
|
|
@@ -123,37 +96,12 @@ Die Tabellen-Komponente verwendet intern die Pagination-Komponente die sich mit
|
|
|
123
96
|
|
|
124
97
|
Bei der Table-Komponente werden zahlreiche Attribut-Definitionen dem Tabellen-Markup hinzugefügt, um die Screenreader bestmöglich zu unterstützen.
|
|
125
98
|
|
|
126
|
-
Aktuell werden folgende Attribute von der Komponente
|
|
99
|
+
Aktuell werden folgende Attribute von der Komponente verwaltet: `role`, `scope` und `aria-\*`.
|
|
127
100
|
|
|
128
101
|
Das heißt beispielsweise, dass bei den Spaltenüberschriften automatisch entweder die Rolle `colheader` oder `rowheader` gesetzt wird. Darüber hinaus wird der Scope entweder auf `col`/`colgroup` oder `row`/`rowgroup` gesetzt. Ähnlich dieser Automatismen werden auch die `aria-\*`-Attribute je nach Relevanz gesetzt.
|
|
129
102
|
|
|
130
103
|
Warum die Tabelle einen **Tabindex** hat, wird auf der folgenden Webseite beschrieben: https://dequeuniversity.com/rules/axe/3.5/scrollable-region-focusable
|
|
131
104
|
|
|
132
|
-
### Pagination ohne/mit Label
|
|
133
|
-
|
|
134
|
-
Bei der Tabelle kann die Pagination optional hinzugefügt werden. Die Steuerelemente der Pagination haben hierbei keine sichtbaren Labels, weil das eine übliche Darstellung ist (State-of-the-art). Für den Screenreader-Nutzenden werden alle Steuerelemente genauso vorgelesen, als würde es ein sichtbares Label geben (KoliBri-Inputs).
|
|
135
|
-
Nun bleibt aus Sicht der Barrierefreiheit nur noch zu beurteilen, ob für sehende Nutzende die Steuerung auch barrierefrei ist.
|
|
136
|
-
|
|
137
|
-
Sichtweisen:
|
|
138
|
-
|
|
139
|
-
<ol type="a">
|
|
140
|
-
<li>Dem sehenden Nutzenden erschließt sich durch die aussagekräftigen Beschriftungen der Optionen das Verhalten der Steuerelement, auch ohne zusätzliches Label. Die Steuerelemente der Pagination können optisch kompakter dargestellt werden.</li>
|
|
141
|
-
<li>Dem sehenden Nutzenden werden Labels angezeigt, um auf das Verhalten der Steuerelement schließen zu können. Dadurch können die Beschriftungen der Optionen kürzer erfolgen. Die Steuerelemente der Pagination werden tendenziell durch das zusätzliche Label optisch mehr Platz benötigen.
|
|
142
|
-
Wenn die Select-Auswahl ein Label bekommt, dann muss konsequenterweise auch die Seitenauswahl ein Label erhalten.</li>
|
|
143
|
-
</ol>
|
|
144
|
-
|
|
145
|
-
**Betrachtung:** Der informelle Teil (Label) für das Verständnis muss in der Sichtweise **a** durch die Optionsbeschriftung und bei Sichtweise **b** durch das explizite Label abgebildet werden.
|
|
146
|
-
|
|
147
|
-
> **Aus Sicht der Barrierefreiheit sind beide Sichtweise barrierefrei.** (?!)
|
|
148
|
-
|
|
149
|
-
**Lösungsentscheidung:** Es wäre möglich, die Pagination mit um einen `_labelled`-Modus zu erweitern, um somit den Projekten beide Sichtweisen anbieten zu können.
|
|
150
|
-
|
|
151
|
-
### Verwendung von Role
|
|
152
|
-
|
|
153
|
-
Die Auszeichnung der Rolle (`role`) führt bei manchen Screenreadern zu Problemen. Da der Fokus der Table-Komponente auf der Darstellung von Daten liegt und somit der semantische Aufbau auf der HTML-Table beruht, sollte das Vorlesen auch ohne zusätzliche Rollenauszeichnung gut funktionieren (Retest).
|
|
154
|
-
|
|
155
|
-
_Lediglich die Rollen `columnheader` und `rowheader` wird beibehalten, da die Tabellenköpfe (`th`) in entweder Spalten- oder Zeilen-orientiert sind._
|
|
156
|
-
|
|
157
105
|
## Links und Referenzen
|
|
158
106
|
|
|
159
107
|
- https://www.w3.org/WAI/tutorials/tables/
|
package/doc/tabs.md
CHANGED
|
@@ -4,18 +4,15 @@ Die **Tabs**-Komponente wird verwendet, um verwandte Inhalte auf derselben Seite
|
|
|
4
4
|
|
|
5
5
|
## Konstruktion
|
|
6
6
|
|
|
7
|
-
Nach dem Laden der Komponente wird die erste Registerkarte links automatisch optisch als **_aktiv_** hervorgehoben. Jede Registerkarte übernimmt den Status **_aktiv_** nach dem Anklicken. Der Status **_aktiv_** kann mit dem Attribut
|
|
8
|
-
um z.B. die dritte anstelle der ersten Registerkarte aktiv zu setzen.
|
|
7
|
+
Nach dem Laden der Komponente wird die erste Registerkarte links automatisch optisch als **_aktiv_** hervorgehoben. Jede Registerkarte übernimmt den Status **_aktiv_** nach dem Anklicken. Der Status **_aktiv_** kann mit dem Attribut **`_selected`** auch manuell auf den Index der Registrierkarte gesetzt werden.
|
|
9
8
|
Die einzelnen Inhalte der Registerkarte werden in einem eigenen `HTMLDivElement` als `<div>Inhalt der Registerkarte</div>` innerhalb von `<kol-tabs></kol-tabs>` notiert.
|
|
10
9
|
|
|
11
|
-
Die Zuordnung der
|
|
12
|
-
|
|
13
|
-
Typischer Aufbau einer **Tab**-Komponente:
|
|
10
|
+
Die Zuordnung der Daten im Attribut **`_tabs`** zu den Div-Elementen erfolgt automatisch.
|
|
14
11
|
|
|
15
12
|
### Code
|
|
16
13
|
|
|
17
14
|
```html
|
|
18
|
-
<kol-tabs _selected="0" _tabs='[{"_label":"Tab 1"},{"_label":"Tab 2", "_on": {"onClose": true}},{"_label":"Tab 3"}]'>
|
|
15
|
+
<kol-tabs _selected="0" _tabs='[{"_label":"Tab 1","_icon":"codicon codicon-home"},{"_label":"Tab 2", "_on": {"onClose": true}},{"_label":"Tab 3"}]'>
|
|
19
16
|
<div>Inhalt von Tab 1</div>
|
|
20
17
|
<div>Inhalt von Tab 2</div>
|
|
21
18
|
<div>Inhalt von Tab 3</div>
|
|
@@ -24,7 +21,7 @@ Typischer Aufbau einer **Tab**-Komponente:
|
|
|
24
21
|
|
|
25
22
|
### Beispiel
|
|
26
23
|
|
|
27
|
-
<kol-tabs _selected="0" _tabs='[{"_label":"Tab 1","_icon":"home"},{"_label":"Tab 2", "_on": {"onClose": true}},{"_label":"Tab 3"}]'>
|
|
24
|
+
<kol-tabs _selected="0" _tabs='[{"_label":"Tab 1","_icon":"codicon codicon-home"},{"_label":"Tab 2", "_on": {"onClose": true}},{"_label":"Tab 3"}]'>
|
|
28
25
|
<div>Inhalt von Tab 1</div>
|
|
29
26
|
<div>Inhalt von Tab 2</div>
|
|
30
27
|
<div>Inhalt von Tab 3</div>
|
|
@@ -34,82 +31,73 @@ Typischer Aufbau einer **Tab**-Komponente:
|
|
|
34
31
|
|
|
35
32
|
### Definition der Registerkarten
|
|
36
33
|
|
|
37
|
-
Die Registerkarten
|
|
34
|
+
Die Daten für die Registerkarten können als Objekte oder JSON-String an das Attribut **`_tabs`** übergeben werden.
|
|
38
35
|
|
|
39
|
-
```
|
|
40
|
-
[
|
|
36
|
+
```json
|
|
37
|
+
[{ "_label": "Tab 1", "_icon": "codicon codicon-home" }, { "_label": "Tab 2", "_on": { "onClose": true } }, { "_label": "Tab 3" }]
|
|
41
38
|
```
|
|
42
39
|
|
|
43
|
-
### Registerkarte auswählen
|
|
44
|
-
|
|
45
|
-
Standardmäßig wird die erste Registerkarte von links aus als **_ausgewählt_** angezeigt. Verwenden Sie das Attribut `_selected` und als Wert die **interne ID**, um eine andere Registerkarte als ausgewählt zu setzen. Besitzt die **Tabs**-Komponente beispielsweise drei Tabs und soll das zweite Tab ausgewählt werden, setzen Sie **1** als Wert für `_selected` ein, da die ID immer von 0 aus hochgezählt wird.
|
|
46
|
-
|
|
47
40
|
### Registerkarte deaktivieren
|
|
48
41
|
|
|
49
|
-
Um eine Registerkarte zu deaktivieren, verwenden Sie das Attribut
|
|
42
|
+
Um eine Registerkarte zu deaktivieren, verwenden Sie das Attribut **`_disabled`**.
|
|
50
43
|
|
|
51
44
|
### Close-Icon im Registekartenheader
|
|
52
45
|
|
|
53
|
-
Wenn Sie eine schließbare Registerkarte benötigen, können Sie dies über das Attribut
|
|
46
|
+
Wenn Sie eine schließbare Registerkarte benötigen, können Sie dies über das Attribut **`_on`** und den Wert **"onClose":true** realisieren.
|
|
54
47
|
|
|
55
48
|
### Best practices
|
|
56
49
|
|
|
57
|
-
- Verwenden Sie Registerkarten, um verwandte Inhalte so zu organisieren und zu gruppieren, dass
|
|
50
|
+
- Verwenden Sie Registerkarten, um verwandte Inhalte so zu organisieren und zu gruppieren, dass Nutzer:innen die Seite nicht verlassen müssen.
|
|
58
51
|
- Registerkarten sollten in einer einzelnen, scrollbaren (falls erforderlich) Zeile über dem Inhalt positioniert werden, auf den sie sich beziehen.
|
|
59
52
|
- Verwenden Sie die Registerkartenbezeichnung, um den Inhalt dieser Registerkarte klar und prägnant zu beschreiben und zwischen den verschiedenen Abschnitten zu unterscheiden.
|
|
60
|
-
-
|
|
61
|
-
- Verwenden Sie
|
|
62
|
-
- Verwenden Sie keine Registerkarten zum Vergleichen von Inhalten (z. B. unterschiedliche Spezifikationen).
|
|
63
|
-
- Verwenden Sie keine Registerkarten, um Benutzer zu einer anderen Seite zu navigieren.
|
|
53
|
+
- Verwenden Sie Registerkarten nicht, um eine Sequenz oder einen Verlauf von Inhalten zu erstellen, die der Benutzer in einer bestimmten Reihenfolge lesen soll.
|
|
54
|
+
- Verwenden Sie Registerkarten nicht zum Vergleichen von Inhalten (z. B. unterschiedliche Spezifikationen).
|
|
64
55
|
- Berücksichtigen Sie die Anzahl der Registerkarten, die Sie in die Registerkartengruppe aufnehmen. Wenn Sie das Gefühl haben, dass die Zahl zu groß wird, sollten Sie den Inhalt weiter aufteilen oder ein anderes Navigationsmuster/eine andere Komponente verwenden.
|
|
65
56
|
|
|
66
57
|
### Anwendungsfälle
|
|
67
58
|
|
|
68
|
-
- Verwenden Sie Registerkarten, um verwandte Informationen auf einer Landingpage zu organisieren.
|
|
69
59
|
- Über Registerkarten können Sie z.B. Dienstleistungen oder Vorteile in verschiedene Kategorien einteilen.
|
|
70
60
|
- Verwenden Sie Registerkarten, um Benutzerprofile in verschiedene Abschnitte zu gliedern (z. B. persönliche Informationen, Termine, aktive Services).
|
|
71
61
|
- Verwenden Sie Registerkarten, um FAQs in verschiedene Kategorien zu unterteilen.
|
|
72
62
|
|
|
73
63
|
## Barrierefreiheit
|
|
74
64
|
|
|
65
|
+
### Tastatursteuerung
|
|
66
|
+
|
|
75
67
|
Ausgewählte Tabs werden beim Anspringen mit der **Tab-Taste** mit einem deutlichen Focus-Rahmen umgeben. Die einzelnen Tabs können mit den Pfeiltasten **links** und **rechts** durchlaufen werden.
|
|
76
68
|
|
|
77
69
|
Nach Anspringen eines Tabs kann mit Hilfe der **Tab-Taste** vom Header in den Inhaltsbereich der Registerkarte gewechselt werden.
|
|
78
70
|
|
|
79
71
|
Unabhängig davon ob die Tab-Schalter oben, rechts, unten oder links angeordnet sind, bleibt die Tastatursteuerung gleich. Hintergrund ist, dass das Layout bei der Nutzung eines Screenreaders keine Rolle spielt. Eine unterschiedliche Pfeil-Tastensteuerung aufgrund der Layout-Anordnung würde daher nicht dem üblichen Bedienkonzept des W3C entsprechen.
|
|
80
72
|
|
|
81
|
-
### Tastatursteuerung
|
|
82
|
-
|
|
83
73
|
Bei der Umsetzung der Tastatursteuerung wurde sich an den Beispielen des W3C's orientiert.
|
|
84
74
|
|
|
85
75
|
Hier steht immer der beeinträchtige Nutzende im Vordergrund. Um möglichst effizient über die gesamte Seite/Anwendung zu navigieren, ist nur 1 Schalter aus der Tab-Serie fokussierbar. Sobald der Nutzende auf der Tab-Navigation selbst ist, werden die Pfeiltasten verwendet, um zwischen den Tabs selbst wechseln.
|
|
86
76
|
|
|
87
|
-
|
|
77
|
+
| Taste | Funktion |
|
|
78
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
|
79
|
+
| `Tab` | Fokussiert den ersten aktiven Tab. Auf vorhandene Close-Icons können mit der Tab-Taste erreicht werden. |
|
|
80
|
+
| `Pfeil-Tasten (links \| rechts)` | Wechselt zwischen den Tabs. |
|
|
81
|
+
|
|
82
|
+
## Links und Referenzen
|
|
88
83
|
|
|
89
84
|
- https://www.w3.org/WAI/ARIA/apg/example-index/tabs/tabs-manual.html
|
|
90
85
|
- https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/tab_role
|
|
91
86
|
- https://dequeuniversity.com/library/aria/tabpanel
|
|
92
87
|
- https://design-system.service.gov.uk/components/tabs/
|
|
93
88
|
|
|
94
|
-
| Taste | Funktion |
|
|
95
|
-
| -------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------- | --- |
|
|
96
|
-
| `Tab` | Fokussiert den ersten aktiven Tab. Auf vorhandene Close-Icons können mit der Tab-Taste erreicht werden. |
|
|
97
|
-
| `Pfeil-Tasten (links | rechts)` | Wechselt zwischen den Tabs. | |
|
|
98
|
-
|
|
99
|
-
<!--## Links und Referenzen
|
|
100
|
-
|
|
101
89
|
<!-- Auto Generated Below -->
|
|
102
90
|
|
|
103
91
|
|
|
104
92
|
## Properties
|
|
105
93
|
|
|
106
|
-
| Property | Attribute | Description
|
|
107
|
-
| ------------------------- | ------------- |
|
|
108
|
-
| `_ariaLabel` _(required)_ | `_aria-label` | Gibt den Text an, der die Navigation von anderen Navigationen differenziert.
|
|
109
|
-
| `_on` | -- | Gibt die Liste der Callback-Funktionen an, die auf Events aufgerufen werden sollen.
|
|
110
|
-
| `_selected` | `_selected` | Gibt an, welches Tab selektiert sein soll.
|
|
111
|
-
| `_tabs` _(required)_ | `_tabs` |
|
|
112
|
-
| `_tabsAlign` | `_tabs-align` |
|
|
94
|
+
| Property | Attribute | Description | Type | Default |
|
|
95
|
+
| ------------------------- | ------------- | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|
|
96
|
+
| `_ariaLabel` _(required)_ | `_aria-label` | Gibt den Text an, der die Navigation von anderen Navigationen differenziert. | `string` | `undefined` |
|
|
97
|
+
| `_on` | -- | Gibt die Liste der Callback-Funktionen an, die auf Events aufgerufen werden sollen. | `undefined \| { onCreate?: EventCallback<Event> \| { label: string; callback: EventCallback<Event>; } \| undefined; } & { onSelect?: EventValueOrEventCallback<MouseEvent \| CustomEvent<any> \| KeyboardEvent \| PointerEvent, number> \| undefined; }` | `undefined` |
|
|
98
|
+
| `_selected` | `_selected` | Gibt an, welches Tab selektiert sein soll. | `number \| undefined` | `0` |
|
|
99
|
+
| `_tabs` _(required)_ | `_tabs` | Setzt die Daten für die Registrierkarten. | `TabButtonProps[] \| string` | `undefined` |
|
|
100
|
+
| `_tabsAlign` | `_tabs-align` | Setzt die Position der Registrierkarten. | `"bottom" \| "left" \| "right" \| "top" \| undefined` | `'top'` |
|
|
113
101
|
|
|
114
102
|
|
|
115
103
|
## Dependencies
|
package/doc/textarea.md
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
# Textarea
|
|
2
2
|
|
|
3
|
-
Die Komponente **Textarea** stellt ein größeres Eingabefeld für Inhalte zur Verfügung. Im Gegensatz zum
|
|
4
|
-
InputText können hier auch umfangreiche Inhalte eingegeben werden, die auch mit Zeilenumbrüchen versehen sein können.
|
|
3
|
+
Die Komponente **Textarea** stellt ein größeres Eingabefeld für Inhalte zur Verfügung. Im Gegensatz zum <kol-link _href="/docs/components/input-text" _label="InputText"></kol-link> können hier auch umfangreiche Inhalte eingegeben werden, die auch mit Zeilenumbrüchen versehen sein können.
|
|
5
4
|
|
|
6
5
|
## Konstruktion
|
|
7
6
|
|
|
@@ -28,9 +27,9 @@ InputText können hier auch umfangreiche Inhalte eingegeben werden, die auch mit
|
|
|
28
27
|
|
|
29
28
|
## Verwendung
|
|
30
29
|
|
|
31
|
-
Verwenden Sie die **Textarea**-Komponente wenn die Eingabe von größeren Textmengen erforderlich ist, z.B. bei der Erfassung eines Anliegens innerhalb eines Formulars
|
|
32
|
-
Mit Hilfe
|
|
33
|
-
Über
|
|
30
|
+
Verwenden Sie die **Textarea**-Komponente wenn die Eingabe von größeren Textmengen erforderlich ist, z.B. bei der Erfassung eines Anliegens innerhalb eines Formulars.
|
|
31
|
+
Mit Hilfe des Attributs **`_rows`** kann die Höhe der Textarea in Zeilen bestimmt werden.
|
|
32
|
+
Über das Attribut **`_resize`** kann zusätzlich festgelegt werden ob und in welche Richtung die Textarea vergrößert werden kann. Der Wert **`none`** sperrt die Textarea gegen Größenänderungen.
|
|
34
33
|
|
|
35
34
|
<!--### Best practices
|
|
36
35
|
|
|
@@ -41,9 +40,9 @@ Mit Hilfe der Property **`_rows`** kann die Höhe der Textarea in Zeilen bestimm
|
|
|
41
40
|
### Tastatursteuerung
|
|
42
41
|
|
|
43
42
|
| Taste | Funktion |
|
|
44
|
-
| -------------- | ------------------------------------------------------------------------------- |
|
|
43
|
+
| -------------- | ------------------------------------------------------------------------------- |
|
|
45
44
|
| `Tab` | Fokussiert die Textarea. |
|
|
46
|
-
| `Pfeil-Tasten` | Können für die Navigation im Inhalt der fokussierten Textarea verwendet werden. |
|
|
45
|
+
| `Pfeil-Tasten` | Können für die Navigation im Inhalt der fokussierten Textarea verwendet werden. |
|
|
47
46
|
|
|
48
47
|
## Links und Referenzen
|
|
49
48
|
|
|
@@ -54,28 +53,28 @@ Mit Hilfe der Property **`_rows`** kann die Höhe der Textarea in Zeilen bestimm
|
|
|
54
53
|
|
|
55
54
|
## Properties
|
|
56
55
|
|
|
57
|
-
| Property | Attribute | Description
|
|
58
|
-
| --------------- | ---------------- |
|
|
59
|
-
| `_accessKey` | `_access-key` | Gibt an, mit welcher Tastenkombination man das Input auslösen oder fokussieren kann.
|
|
60
|
-
| `_adjustHeight` | `_adjust-height` | Passt die Höhe des Eingabefeldes automatisch an den Füllstand an.
|
|
61
|
-
| `_alert` | `_alert` | Gibt an, ob die Fehlermeldung vorgelesen werden soll, wenn es eine gibt.
|
|
62
|
-
| `_disabled` | `_disabled` |
|
|
63
|
-
| `_error` | `_error` | Gibt den Text für eine Fehlermeldung an.
|
|
64
|
-
| `_hasCounter` | `_has-counter` |
|
|
65
|
-
| `_hideLabel` | `_hide-label` |
|
|
66
|
-
| `_hint` | `_hint` | Gibt den
|
|
67
|
-
| `_id` | `_id` | Gibt die technische ID des Eingabefeldes an.
|
|
68
|
-
| `_maxLength` | `_max-length` |
|
|
69
|
-
| `_name` | `_name` | Gibt den technischen Namen des Eingabefeldes an.
|
|
70
|
-
| `_on` | -- | Gibt die EventCallback-Funktionen für das Input-Event an.
|
|
71
|
-
| `_placeholder` | `_placeholder` | Gibt den Platzhalter des Eingabefeldes an, wenn es leer ist.
|
|
72
|
-
| `_readOnly` | `_read-only` |
|
|
73
|
-
| `_required` | `_required` |
|
|
74
|
-
| `_resize` | `_resize` | Gibt an, ob die Größe des Eingabefeldes geändert werden kann. (https://developer.mozilla.org/de/docs/Web/CSS/resize) | `"both" \| "horizontal" \| "none" \| "vertical" \| undefined` | `'vertical'` |
|
|
75
|
-
| `_rows` | `_rows` | Gibt die Anzahl der anzuzeigenden Zeilen des Eingabefeldes an.
|
|
76
|
-
| `_tabIndex` | `_tab-index` | Gibt an, welchen Tab-Index dieses Input hat.
|
|
77
|
-
| `_touched` | `_touched` | Gibt an, ob dieses Eingabefeld von Nutzer:innen einmal besucht/berührt wurde.
|
|
78
|
-
| `_value` | `_value` | Gibt den Wert des Eingabefeldes an.
|
|
56
|
+
| Property | Attribute | Description | Type | Default |
|
|
57
|
+
| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------ |
|
|
58
|
+
| `_accessKey` | `_access-key` | Gibt an, mit welcher Tastenkombination man das Input auslösen oder fokussieren kann. | `string \| undefined` | `undefined` |
|
|
59
|
+
| `_adjustHeight` | `_adjust-height` | Passt die Höhe des Eingabefeldes automatisch an den Füllstand an. | `boolean \| undefined` | `false` |
|
|
60
|
+
| `_alert` | `_alert` | Gibt an, ob die Fehlermeldung vorgelesen werden soll, wenn es eine gibt. | `boolean \| undefined` | `true` |
|
|
61
|
+
| `_disabled` | `_disabled` | Setzt das Feld in einen inaktiven Zustand, in dem es keine Interaktion erlaubt. | `boolean \| undefined` | `undefined` |
|
|
62
|
+
| `_error` | `_error` | Gibt den Text für eine Fehlermeldung an. | `string \| undefined` | `undefined` |
|
|
63
|
+
| `_hasCounter` | `_has-counter` | Aktiviert den Zeichenanzahlzähler am unteren Rand des Eingabefeldes. | `boolean \| undefined` | `undefined` |
|
|
64
|
+
| `_hideLabel` | `_hide-label` | Versteckt das sichtbare Label des Elements. | `boolean \| undefined` | `undefined` |
|
|
65
|
+
| `_hint` | `_hint` | Gibt den Hinweistext an. | `string \| undefined` | `''` |
|
|
66
|
+
| `_id` | `_id` | Gibt die technische ID des Eingabefeldes an. | `string \| undefined` | `undefined` |
|
|
67
|
+
| `_maxLength` | `_max-length` | Setzt die maximale Zeichenanzahl. | `number \| undefined` | `undefined` |
|
|
68
|
+
| `_name` | `_name` | Gibt den technischen Namen des Eingabefeldes an. | `string \| undefined` | `undefined` |
|
|
69
|
+
| `_on` | -- | Gibt die EventCallback-Funktionen für das Input-Event an. | `InputTypeOnBlur & InputTypeOnClick & InputTypeOnChange & InputTypeOnFocus \| undefined` | `undefined` |
|
|
70
|
+
| `_placeholder` | `_placeholder` | Gibt den Platzhalter des Eingabefeldes an, wenn es leer ist. | `string \| undefined` | `undefined` |
|
|
71
|
+
| `_readOnly` | `_read-only` | Setzt das Eingabefeld in den schreibgeschützten Modus. | `boolean \| undefined` | `undefined` |
|
|
72
|
+
| `_required` | `_required` | Macht das Eingabeelement zu einem Pflichtfeld. | `boolean \| undefined` | `undefined` |
|
|
73
|
+
| `_resize` | `_resize` | Gibt an, ob die Größe des Eingabefeldes von Nutzer:innen geändert werden kann. (https://developer.mozilla.org/de/docs/Web/CSS/resize) | `"both" \| "horizontal" \| "none" \| "vertical" \| undefined` | `'vertical'` |
|
|
74
|
+
| `_rows` | `_rows` | Gibt die Anzahl der anzuzeigenden Zeilen des Eingabefeldes an. | `number \| undefined` | `undefined` |
|
|
75
|
+
| `_tabIndex` | `_tab-index` | Gibt an, welchen Tab-Index dieses Input hat. | `number \| undefined` | `undefined` |
|
|
76
|
+
| `_touched` | `_touched` | Gibt an, ob dieses Eingabefeld von Nutzer:innen einmal besucht/berührt wurde. | `boolean \| undefined` | `false` |
|
|
77
|
+
| `_value` | `_value` | Gibt den Wert des Eingabefeldes an. | `string \| undefined` | `undefined` |
|
|
79
78
|
|
|
80
79
|
|
|
81
80
|
## Dependencies
|