Skip to content

Commit 3889ce4

Browse files
authored
Add documentation for table settings (#315)
2 parents 647e734 + cb87197 commit 3889ce4

File tree

2 files changed

+42
-7
lines changed

2 files changed

+42
-7
lines changed

docs/30-components/table-stateful.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ Dadurch, dass die Table-Komponente das valide und barrierefreie Markup dynamisch
3030

3131
Zur Behandlung von Events bzw. Callbacks siehe <kol-link _label="Events" _href="../concepts/events" />.
3232

33-
| Event | Auslöser | Value |
34-
|-------------------|-------------------------------------------------|-------------------------------------------------------------------------------|
35-
| `selectionChange` | Die Auswahl von Tabellenzeilen hat sich geändert | Array von ausgewählten Zeilen-Objekten bzw. Zeilen-Objekt bei Einfachauswahl |
33+
| Event | Auslöser | Value |
34+
|-------------------|-----------------------------------------------------------|------------------------------------------------------------------------------|
35+
| `selectionChange` | Die Auswahl von Tabellenzeilen hat sich geändert | Array von ausgewählten Zeilen-Objekten bzw. Zeilen-Objekt bei Einfachauswahl |
36+
| `settingsChange` | Die Tabelleneinstellungen wurden durch den User geändert. | Objekt vom Typ `TableSettings` |
3637

3738
### Funktionalitäten
3839

@@ -174,6 +175,10 @@ import { createReactRenderElement } from '@public-ui/react';
174175
}
175176
```
176177

178+
### Einstellungen
179+
180+
Tabellen-Einstellungen (`_table-settings`) werden an die Komponente kol-table-stateless durchgereicht. Siehe <kol-link _href="table-stateless#einstellungen" _label="kol-table-stateless Dokumentation" />.
181+
177182
<!--### Best practices
178183

179184
### Anwendungsfälle-->

docs/30-components/table-stateless.mdx

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,44 @@ const selection: KoliBriTableSelection = {
5454
};
5555
```
5656

57+
## Einstellungen
58+
59+
Tabellen verfügen automatisch über ein Einstellungsmenü, mit dem Nutzende:
60+
61+
* Spalten ein- und ausblenden
62+
* Spaltenbreiten anpassen
63+
* Spaltenreihenfolge ändern
64+
65+
Standardmäßig werden alle horizontalen Tabellenspalten berücksichtigt.
66+
67+
Mithilfe der Property _tableSettings lassen sich vordefinierte oder bereits gespeicherte Tabellenkonfigurationen laden. Diese überschreiben die Standardwerte, und im Menü werden dann nur noch die dort aufgeführten Spalten angezeigt.
68+
69+
Beispiel:
70+
71+
```jsx
72+
<KolTableStateful
73+
_tableSettings={{
74+
columns: [
75+
{ key: 'columnA', visible: false, label: 'Column A', position: 2 },
76+
{ key: 'columnB', visible: true, label: 'Column B', position: 1, width: 20 },
77+
{ key: 'columnC', visible: true, label: 'Column C', position: 0, width: 45 },
78+
],
79+
}}
80+
// ...
81+
/>
82+
```
83+
84+
Ändern Nutzende die Einstellungen, werden diese automatisch auf die Tabellenansicht übertragen und ein <nobr>`settingsChange`</nobr>-DOM-Event ausgelöst (siehe Events).
85+
5786
### Events
5887

5988
Zur Behandlung von Events bzw. Callbacks siehe <kol-link _label="Events" _href="../concepts/events" />.
6089

61-
| Event | Auslöser | Value |
62-
|-------------------|--------------------------------------------------|-------------------------------------------------------------------------|
63-
| `sort` | Die Sortierung hat sich geändert | Objekt vom Typ `SortEventPayload` mit `key` und `currentSortDirection` |
64-
| `selectionChange` | Die Auswahl von Tabellenzeilen hat sich geändert | Array von ausgewählten IDs bzw. ausgewählt ID bei Einfachauswahl |
90+
| Event | Auslöser | Value |
91+
|-------------------|-----------------------------------------------------------|------------------------------------------------------------------------|
92+
| `sort` | Die Sortierung hat sich geändert | Objekt vom Typ `SortEventPayload` mit `key` und `currentSortDirection` |
93+
| `selectionChange` | Die Auswahl von Tabellenzeilen hat sich geändert | Array von ausgewählten IDs bzw. ausgewählt ID bei Einfachauswahl |
94+
| `settingsChange` | Die Tabelleneinstellungen wurden durch den User geändert. | Objekt vom Typ `TableSettings` |
6595

6696
## Beispiel
6797

0 commit comments

Comments
 (0)