Skip to content

Add documentation for table settings #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025
Merged

Add documentation for table settings #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/30-components/table-stateful.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@ Dadurch, dass die Table-Komponente das valide und barrierefreie Markup dynamisch

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

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

### Funktionalitäten

Expand Down Expand Up @@ -174,6 +175,10 @@ import { createReactRenderElement } from '@public-ui/react';
}
```

### Einstellungen

Tabellen-Einstellungen (`_table-settings`) werden an die Komponente kol-table-stateless durchgereicht. Siehe <kol-link _href="table-stateless#einstellungen" _label="kol-table-stateless Dokumentation" />.

<!--### Best practices

### Anwendungsfälle-->
Expand Down
38 changes: 34 additions & 4 deletions docs/30-components/table-stateless.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,44 @@ const selection: KoliBriTableSelection = {
};
```

## Einstellungen

Tabellen verfügen automatisch über ein Einstellungsmenü, mit dem Nutzende:

* Spalten ein- und ausblenden
* Spaltenbreiten anpassen
* Spaltenreihenfolge ändern

Standardmäßig werden alle horizontalen Tabellenspalten berücksichtigt.

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.

Beispiel:

```jsx
<KolTableStateful
_tableSettings={{
columns: [
{ key: 'columnA', visible: false, label: 'Column A', position: 2 },
{ key: 'columnB', visible: true, label: 'Column B', position: 1, width: 20 },
{ key: 'columnC', visible: true, label: 'Column C', position: 0, width: 45 },
],
}}
// ...
/>
```

Ändern Nutzende die Einstellungen, werden diese automatisch auf die Tabellenansicht übertragen und ein <nobr>`settingsChange`</nobr>-DOM-Event ausgelöst (siehe Events).

### Events

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

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

## Beispiel

Expand Down
Loading