Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avalynx/avalynx-table
A simple table system for responsive web applications. Based on Bootstrap >=5.3 without any framework dependencies.
https://github.com/avalynx/avalynx-table
avalynx bootstrap bootstrap5 component responsive stackable table
Last synced: 8 days ago
JSON representation
A simple table system for responsive web applications. Based on Bootstrap >=5.3 without any framework dependencies.
- Host: GitHub
- URL: https://github.com/avalynx/avalynx-table
- Owner: avalynx
- License: mit
- Created: 2024-04-03T09:09:34.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-02T16:31:50.000Z (4 months ago)
- Last Synced: 2024-10-13T17:14:24.580Z (about 1 month ago)
- Topics: avalynx, bootstrap, bootstrap5, component, responsive, stackable, table
- Language: CSS
- Homepage:
- Size: 202 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# AvalynxTable
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.
## Features
- **Automatic Table Enhancement**: Enhances tables by adding data attributes to table cells based on the corresponding header row. This is particularly useful for responsive designs where table cells may need to display their headers inline on smaller screens.
- **Flexible Selector Support**: Supports custom selectors for targeting tables within the DOM. This allows for fine-grained control over which tables are enhanced.
- **Custom Breakpoints**: Allows you to specify custom breakpoints for when tables should stack on top of each other. This is useful for creating a consistent user experience across different screen sizes.
## Example
Here's a simple example of how to use AvalynxTable in your project:
* [Overview](https://avalynx-table.jbs-newmedia.de/examples/index.html)
* [Table](https://avalynx-table.jbs-newmedia.de/examples/table.html)
## Installation
To use AvalynxTable in your project, you can directly include it in your HTML file. Ensure you have Bootstrap 5.3 or higher included in your project for AvalynxTable to work correctly.
First, include Bootstrap:
```html
```
Then, include AvalynxTable:
```html
```
Replace `path/to/avalynx-table.js` and `path/to/avalynx-table.css` with the actual path to the files in your project.
## Installation via jsDelivr ([Link](https://cdn.jsdelivr.net/npm/avalynx-table/))
AvalynxTable is also available via [jsDelivr](https://www.jsdelivr.com/). You can include it in your project like this:
```html
```
Make sure to also include Bootstrap's JS/CSS in your project to ensure AvalynxTable displays correctly.
## Installation via NPM ([Link](https://www.npmjs.com/package/avalynx-table))
AvalynxTable is also available as a npm package. You can add it to your project with the following command:
```bash
npm install avalynx-table
```
After installing, you can import AvalynxTable into your JavaScript file like this:
```javascript
import { AvalynxTable } from 'avalynx-table';
import 'avalynx-table/dist/css/avalynx-table.min.css';
```
Make sure to also include Bootstrap's JS/CSS in your project to ensure AvalynxTable displays correctly.
## Installation via Symfony AssetMapper
```bash
php bin/console importmap:require avalynx-table
```
After installing, you can import AvalynxTable into your JavaScript file like this:
```javascript
import { AvalynxTable } from 'avalynx-table';
import 'avalynx-table/dist/css/avalynx-table.min.css';
```
Make sure to also include Bootstrap's JS/CSS in your project to ensure AvalynxTable displays correctly.
## Installation via Composer ([Link](https://packagist.org/packages/avalynx/avalynx-table))
AvalynxTable is also available as a Composer package. You can add it to your project with the following command:
```bash
composer require avalynx/avalynx-table
```
After installing, you can import AvalynxTable into your HTML file like this:
```html
```
Make sure to also include Bootstrap's JS/CSS in your project to ensure AvalynxTable displays correctly.
## Usage
To use AvalynxTable in your project, first ensure you have tables marked up in your HTML. Then, include the AvalynxTable JavaScript file in your project and initialize the class with the appropriate selector.
```html
Header 1
Header 2
Cell 1
Cell 2
```
```javascript
new AvalynxTable('.avalynx-table');
```
## Options
AvalynxTable allows the following options for customization:
- `selector`: (string) The selector to use for targeting tables within the DOM (default: `'.avalynx-table'`).
- `options`: An object containing the following keys: (**coming soon**)
## Contributing
Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request with your changes or improvements. We're looking for contributions in the following areas:
- Bug fixes
- Feature enhancements
- Documentation improvements
Before submitting your pull request, please ensure your changes are well-documented and follow the existing coding style of the project.
## License
AvalynxTable is open-sourced software licensed under the [MIT license](LICENSE).
## Contact
If you have any questions, feature requests, or issues, please open an issue on our [GitHub repository](https://github.com/avalynx/avalynx-table/issues) or submit a pull request.
Thank you for considering AvalynxTable for your project!