|
| 1 | +# AvalynxTable |
| 2 | + |
| 3 | +[](https://www.npmjs.com/package/avalynx-table) |
| 4 | +[](https://www.npmjs.com/package/avalynx-table) |
| 5 | +[](https://www.jsdelivr.com/package/npm/avalynx-table) |
| 6 | +[](LICENSE) |
| 7 | +[](https://github.com/avalynx/avalynx-table/actions/workflows/tests.yml) |
| 8 | +[](https://codecov.io/gh/avalynx/avalynx-table) |
| 9 | +[](https://github.com/avalynx/avalynx-table) |
| 10 | + |
| 11 | +AvalynxTable ist ein leichtgewichtiges, abhängigkeitsfreies Tabellensystem, das für responsive Webanwendungen entwickelt wurde. Es nutzt Bootstrap (Version 5.3 oder höher), um eine nahtlose Integration in Ihr Projekt zu ermöglichen. Wenn der Breakpoint der Tabelle erreicht wird, werden die Zeilen und Spalten übereinander gestapelt, um eine leicht lesbare Ansicht zu erstellen. |
| 12 | + |
| 13 | +## Funktionen |
| 14 | + |
| 15 | +- **Automatische Tabellenerweiterung**: Erweitert Tabellen durch Hinzufügen von Datenattributen zu Tabellenzellen basierend auf der entsprechenden Kopfzeile. Dies ist besonders nützlich für responsive Designs, bei denen Tabellenzellen ihre Header auf kleineren Bildschirmen inline anzeigen müssen. |
| 16 | +- **Flexible Selector-Unterstützung**: Unterstützt benutzerdefinierte Selektoren für das Ansprechen von Tabellen innerhalb des DOM. Dies ermöglicht eine feingranulare Kontrolle darüber, welche Tabellen erweitert werden. |
| 17 | +- **Benutzerdefinierte Breakpoints**: Ermöglicht die Angabe benutzerdefinierter Breakpoints für den Zeitpunkt, an dem Tabellen übereinander gestapelt werden sollen. Dies ist nützlich, um eine konsistente Benutzererfahrung über verschiedene Bildschirmgrößen hinweg zu schaffen. |
| 18 | + |
| 19 | +## Beispiel |
| 20 | + |
| 21 | +Hier ist ein einfaches Beispiel für die Verwendung von AvalynxTable in Ihrem Projekt: |
| 22 | + |
| 23 | +* [Übersicht](https://avalynx-table.jbs-newmedia.de/examples/index.html) |
| 24 | +* [Tabelle](https://avalynx-table.jbs-newmedia.de/examples/table.html) |
| 25 | +* [Tabelle mit benutzerdefinierten CSS-Variablen](https://avalynx-table.jbs-newmedia.de/examples/table-custom-css.html) |
| 26 | + |
| 27 | +## Installation |
| 28 | + |
| 29 | +Um AvalynxTable in Ihrem Projekt zu verwenden, können Sie es direkt in Ihre HTML-Datei einbinden. Stellen Sie sicher, dass Sie Bootstrap 5.3 oder höher in Ihrem Projekt eingebunden haben, damit AvalynxTable korrekt funktioniert. |
| 30 | + |
| 31 | +Zuerst Bootstrap einbinden: |
| 32 | + |
| 33 | +```html |
| 34 | +<!-- Bootstrap --> |
| 35 | +<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3/dist/css/bootstrap.min.css" rel="stylesheet"> |
| 36 | +<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3/dist/js/bootstrap.bundle.min.js"></script> |
| 37 | +``` |
| 38 | + |
| 39 | +Dann AvalynxTable einbinden: |
| 40 | + |
| 41 | +```html |
| 42 | +<link href="path/to/avalynx-table.css" rel="stylesheet"> |
| 43 | +<script src="path/to/avalynx-table.js"></script> |
| 44 | +``` |
| 45 | + |
| 46 | +Ersetzen Sie `path/to/avalynx-table.js` und `path/to/avalynx-table.css` durch den tatsächlichen Pfad zu den Dateien in Ihrem Projekt. |
| 47 | + |
| 48 | +## Installation über jsDelivr ([Link](https://cdn.jsdelivr.net/npm/avalynx-table/)) |
| 49 | + |
| 50 | +AvalynxTable ist auch über [jsDelivr](https://www.jsdelivr.com/) verfügbar. Sie können es wie folgt in Ihr Projekt einbinden: |
| 51 | + |
| 52 | +```html |
| 53 | +<link href="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.2/dist/css/avalynx-table.min.css" rel="stylesheet"> |
| 54 | +<script src="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.2/dist/js/avalynx-table.min.js"></script> |
| 55 | +``` |
| 56 | + |
| 57 | +Stellen Sie sicher, dass Sie auch das JS/CSS von Bootstrap in Ihr Projekt einbinden, um eine korrekte Anzeige von AvalynxTable zu gewährleisten. |
| 58 | + |
| 59 | +## Installation über NPM ([Link](https://www.npmjs.com/package/avalynx-table)) |
| 60 | + |
| 61 | +AvalynxTable ist auch als npm-Paket verfügbar. Sie können es mit dem folgenden Befehl zu Ihrem Projekt hinzufügen: |
| 62 | + |
| 63 | +```bash |
| 64 | +npm install avalynx-table |
| 65 | +``` |
| 66 | + |
| 67 | +Nach der Installation können Sie AvalynxTable wie folgt in Ihre JavaScript-Datei importieren: |
| 68 | + |
| 69 | +```javascript |
| 70 | +import { AvalynxTable } from 'avalynx-table'; |
| 71 | +import 'avalynx-table/dist/css/avalynx-table.min.css'; |
| 72 | +``` |
| 73 | + |
| 74 | +Stellen Sie sicher, dass Sie auch das JS/CSS von Bootstrap in Ihr Projekt einbinden, um eine korrekte Anzeige von AvalynxTable zu gewährleisten. |
| 75 | + |
| 76 | +## Installation über Symfony AssetMapper |
| 77 | + |
| 78 | +```bash |
| 79 | +php bin/console importmap:require avalynx-table |
| 80 | +``` |
| 81 | + |
| 82 | +Nach der Installation können Sie AvalynxTable wie folgt in Ihre JavaScript-Datei importieren: |
| 83 | + |
| 84 | +```javascript |
| 85 | +import { AvalynxTable } from 'avalynx-table'; |
| 86 | +import 'avalynx-table/dist/css/avalynx-table.min.css'; |
| 87 | +``` |
| 88 | + |
| 89 | +Stellen Sie sicher, dass Sie auch das JS/CSS von Bootstrap in Ihr Projekt einbinden, um eine korrekte Anzeige von AvalynxTable zu gewährleisten. |
| 90 | + |
| 91 | +## Installation über Symfony AssetComposer |
| 92 | + |
| 93 | +Weitere Informationen zum Symfony AssetComposer Bundle finden Sie [hier](https://github.com/jbsnewmedia/asset-composer-bundle). |
| 94 | + |
| 95 | +```twig |
| 96 | +{% do addAssetComposer('avalynx/avalynx-table/dist/css/avalynx-table.css') %} |
| 97 | +{% do addAssetComposer('avalynx/avalynx-table/dist/js/avalynx-table.js') %} |
| 98 | +``` |
| 99 | + |
| 100 | +Stellen Sie sicher, dass Sie auch das JS/CSS von Bootstrap in Ihr Projekt einbinden, um eine korrekte Anzeige von AvalynxTable zu gewährleisten. |
| 101 | + |
| 102 | +## Installation über Composer ([Link](https://packagist.org/packages/avalynx/avalynx-table)) |
| 103 | + |
| 104 | +AvalynxTable ist auch als Composer-Paket verfügbar. Sie können es mit dem folgenden Befehl zu Ihrem Projekt hinzufügen: |
| 105 | + |
| 106 | +```bash |
| 107 | +composer require avalynx/avalynx-table |
| 108 | +``` |
| 109 | + |
| 110 | +Nach der Installation können Sie AvalynxTable wie folgt in Ihre HTML-Datei einbinden: |
| 111 | + |
| 112 | +```html |
| 113 | +<link href="vendor/avalynx/avalynx-table/dist/css/avalynx-table.css" rel="stylesheet"> |
| 114 | +<script src="vendor/avalynx/avalynx-table/dist/js/avalynx-table.js"></script> |
| 115 | +``` |
| 116 | + |
| 117 | +Stellen Sie sicher, dass Sie auch das JS/CSS von Bootstrap in Ihr Projekt einbinden, um eine korrekte Anzeige von AvalynxTable zu gewährleisten. |
| 118 | + |
| 119 | +## Verwendung |
| 120 | + |
| 121 | +Um AvalynxTable in Ihrem Projekt zu verwenden, stellen Sie zunächst sicher, dass Sie Tabellen in Ihrem HTML entsprechend markiert haben. Binden Sie dann die JavaScript-Datei von AvalynxTable in Ihr Projekt ein und initialisieren Sie die Klasse mit dem entsprechenden Selektor. |
| 122 | + |
| 123 | +```html |
| 124 | +<table class="avalynx-table table table-bordered table-striped"> |
| 125 | + <thead> |
| 126 | + <tr> |
| 127 | + <th>Header 1</th> |
| 128 | + <th>Header 2</th> |
| 129 | + </tr> |
| 130 | + </thead> |
| 131 | + <tbody> |
| 132 | + <tr> |
| 133 | + <td>Zelle 1</td> |
| 134 | + <td>Zelle 2</td> |
| 135 | + </tr> |
| 136 | + <!-- Weitere Zeilen... --> |
| 137 | + </tbody> |
| 138 | +</table> |
| 139 | +``` |
| 140 | + |
| 141 | +```javascript |
| 142 | +new AvalynxTable('.avalynx-table'); |
| 143 | +``` |
| 144 | + |
| 145 | +## Optionen |
| 146 | + |
| 147 | +AvalynxTable ermöglicht die folgenden Optionen zur Anpassung: |
| 148 | + |
| 149 | +- `selector`: (string) Der Selektor, der für das Ansprechen von Tabellen innerhalb des DOM verwendet werden soll (Standard: `'.avalynx-table'`). |
| 150 | +- `options`: Ein Objekt, das die folgenden Schlüssel enthält: (**demnächst**) |
| 151 | + |
| 152 | +## Mitwirken |
| 153 | + |
| 154 | +Beiträge sind willkommen! Wenn Sie einen Beitrag leisten möchten, forken Sie bitte das Repository und senden Sie einen Pull-Request mit Ihren Änderungen oder Verbesserungen. Wir suchen nach Beiträgen in den folgenden Bereichen: |
| 155 | + |
| 156 | +- Fehlerbehebungen (Bug fixes) |
| 157 | +- Funktionserweiterungen |
| 158 | +- Dokumentationsverbesserungen |
| 159 | + |
| 160 | +Bevor Sie Ihren Pull-Request absenden, stellen Sie bitte sicher, dass Ihre Änderungen gut dokumentiert sind und dem bestehenden Codestil des Projekts entsprechen. |
| 161 | + |
| 162 | +## Lizenz |
| 163 | + |
| 164 | +AvalynxTable ist eine quelloffene Software, die unter der [MIT-Lizenz](LICENSE) lizenziert ist. |
| 165 | + |
| 166 | +## Kontakt |
| 167 | + |
| 168 | +Wenn Sie Fragen, Funktionswünsche oder Probleme haben, eröffnen Sie bitte ein Issue in unserem [GitHub-Repository](https://github.com/avalynx/avalynx-table/issues) oder senden Sie einen Pull-Request. |
| 169 | + |
| 170 | +Vielen Dank, dass Sie AvalynxTable für Ihr Projekt in Betracht ziehen! |
0 commit comments