Skip to content

Commit 0c258f5

Browse files
committed
Bump AvalynxTable version to 1.0.2: updated version references, enhanced Jest with coverage thresholds, added CommonJS export, included German README, and switched examples to use local asset paths.
1 parent 54ca812 commit 0c258f5

12 files changed

Lines changed: 220 additions & 23 deletions

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
/.idea/
2+
/ai.txt
3+
/coverage/
24
/node_modules/
3-
/package-lock.json

README.de.md

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
# AvalynxTable
2+
3+
[![npm version](https://img.shields.io/npm/v/avalynx-table)](https://www.npmjs.com/package/avalynx-table)
4+
[![npm downloads](https://img.shields.io/npm/dt/avalynx-table)](https://www.npmjs.com/package/avalynx-table)
5+
[![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/avalynx-table)](https://www.jsdelivr.com/package/npm/avalynx-table)
6+
[![Lizenz](https://img.shields.io/npm/l/avalynx-table)](LICENSE)
7+
[![Tests](https://github.com/avalynx/avalynx-table/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/avalynx/avalynx-table/actions/workflows/tests.yml)
8+
[![codecov](https://codecov.io/gh/avalynx/avalynx-table/branch/main/graph/badge.svg)](https://codecov.io/gh/avalynx/avalynx-table)
9+
[![GitHub stars](https://img.shields.io/github/stars/avalynx/avalynx-table?style=flat&logo=github)](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!

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# AvalynxTable
22

3+
[![npm version](https://img.shields.io/npm/v/avalynx-table)](https://www.npmjs.com/package/avalynx-table)
4+
[![npm downloads](https://img.shields.io/npm/dt/avalynx-table)](https://www.npmjs.com/package/avalynx-table)
5+
[![jsDelivr](https://img.shields.io/jsdelivr/npm/hm/avalynx-table)](https://www.jsdelivr.com/package/npm/avalynx-table)
6+
[![License](https://img.shields.io/npm/l/avalynx-table)](LICENSE)
7+
[![Tests](https://github.com/avalynx/avalynx-table/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/avalynx/avalynx-table/actions/workflows/tests.yml)
8+
[![codecov](https://codecov.io/gh/avalynx/avalynx-table/branch/main/graph/badge.svg)](https://codecov.io/gh/avalynx/avalynx-table)
9+
[![GitHub stars](https://img.shields.io/github/stars/avalynx/avalynx-table?style=flat&logo=github)](https://github.com/avalynx/avalynx-table)
10+
311
AvalynxTable is a lightweight, dependency-free table system designed for responsive web applications. It leverages Bootstrap (version 5.3 or higher) to provide a seamless integration with your project. When the table's breakpoint is reached, the rows and columns stack on top of each other to create an easily readable view.
412

513
## Features
@@ -42,8 +50,8 @@ Replace `path/to/avalynx-table.js` and `path/to/avalynx-table.css` with the actu
4250
AvalynxTable is also available via [jsDelivr](https://www.jsdelivr.com/). You can include it in your project like this:
4351

4452
```html
45-
<link href="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.1/dist/css/avalynx-table.min.css" rel="stylesheet">
46-
<script src="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.1/dist/js/avalynx-table.min.js"></script>
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>
4755
```
4856

4957
Make sure to also include Bootstrap's JS/CSS in your project to ensure AvalynxTable displays correctly.

dist/css/avalynx-table.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* A simple table system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.
55
*
6-
* @version 1.0.1
6+
* @version 1.0.2
77
* @license MIT
88
* @author https://github.com/avalynx/avalynx-table/graphs/contributors
99
* @website https://github.com/avalynx/

dist/js/avalynx-table.esm.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* A simple table system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.
55
*
6-
* @version 1.0.1
6+
* @version 1.0.2
77
* @license MIT
88
* @author https://github.com/avalynx/avalynx-table/graphs/contributors
99
* @website https://github.com/avalynx/
@@ -52,4 +52,9 @@ export class AvalynxTable {
5252
});
5353
});
5454
}
55-
}
55+
}
56+
57+
/* istanbul ignore next */
58+
if (typeof module !== 'undefined' && module.exports) {
59+
module.exports = AvalynxTable;
60+
}

dist/js/avalynx-table.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* A simple table system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.
55
*
6-
* @version 1.0.1
6+
* @version 1.0.2
77
* @license MIT
88
* @author https://github.com/avalynx/avalynx-table/graphs/contributors
99
* @website https://github.com/avalynx/
@@ -52,6 +52,7 @@ class AvalynxTable {
5252
}
5353
}
5454

55+
/* istanbul ignore next */
5556
if (typeof module !== 'undefined' && module.exports) {
5657
module.exports = AvalynxTable;
5758
}

examples/table-custom-css.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9/build/styles/stackoverflow-light.min.css" id="hljsTheme">
1717
<script>hljs.highlightAll();</script>
1818

19-
<!-- AvalynxTable 1.0.1 -->
20-
<link href="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.1/dist/css/avalynx-table.min.css" rel="stylesheet">
21-
<script src="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.1/dist/js/avalynx-table.min.js"></script>
19+
<!-- AvalynxTable -->
20+
<link href="../src/css/avalynx-table.css" rel="stylesheet">
21+
<script src="../src/js/avalynx-table.min.js"></script>
2222

2323
<!-- Example helper -->
2424
<link href="./css/helper.css" rel="stylesheet">

examples/table.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9/build/styles/stackoverflow-light.min.css" id="hljsTheme">
1717
<script>hljs.highlightAll();</script>
1818

19-
<!-- AvalynxTable 1.0.1 -->
20-
<link href="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.1/dist/css/avalynx-table.min.css" rel="stylesheet">
21-
<script src="https://cdn.jsdelivr.net/npm/avalynx-table@1.0.1/dist/js/avalynx-table.min.js"></script>
19+
<!-- AvalynxTable -->
20+
<link href="../src/css/avalynx-table.css" rel="stylesheet">
21+
<script src="../src/js/avalynx-table.min.js"></script>
2222

2323
<!-- Example helper -->
2424
<link href="./css/helper.css" rel="stylesheet">

jest.config.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,15 @@ module.exports = {
88
transform: {
99
"^.+\\.js$": "babel-jest"
1010
},
11+
collectCoverage: true,
12+
collectCoverageFrom: ["src/**/*.js"],
13+
coverageReporters: ["text", "lcov", "html"],
14+
coverageThreshold: {
15+
global: {
16+
branches: 100,
17+
functions: 100,
18+
lines: 100,
19+
statements: 100
20+
}
21+
}
1122
};

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "avalynx-table",
33
"title": "AvalynxTable",
44
"description": "AvalynxTable is a simple table system for web applications. Based on Bootstrap >=5.3 without any framework dependencies.",
5-
"version": "1.0.1",
5+
"version": "1.0.2",
66
"license": "MIT",
77
"main": "dist/js/avalynx-table.js",
88
"module": "dist/js/avalynx-table.esm.js",
@@ -44,12 +44,12 @@
4444
"bootstrap": ">=5.3"
4545
},
4646
"devDependencies": {
47-
"@babel/core": "^7",
48-
"@babel/preset-env": "^7",
49-
"babel-jest": "^29",
50-
"jest": "^29",
51-
"jest-environment-jsdom": "^29",
52-
"shelljs": "^0",
53-
"shx": "^0"
47+
"@babel/core": "^7.29.0",
48+
"@babel/preset-env": "^7.29.0",
49+
"babel-jest": "^30.2.0",
50+
"jest": "^30.2.0",
51+
"jest-environment-jsdom": "^30.2.0",
52+
"shelljs": "^0.10.0",
53+
"shx": "^0.4.0"
5454
}
5555
}

0 commit comments

Comments
 (0)