|
5 | 5 | </p> |
6 | 6 |
|
7 | 7 | <p align="center"> |
8 | | - <a href="https://www.npmjs.com/package/snap-records" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/npm/v/snap-records.svg?style=flat-square&color=007acc" alt="NPM Version"></a> |
9 | | - <a href="https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/npm/l/snap-records.svg?style=flat-square&color=007acc" alt="License"></a> |
10 | | - <a href="https://github.com/lbassuncao/SnapRecords/actions/workflows/ci.yml" target="_blank" rel="noopener noreferrer"><img src="https://github.com/lbassuncao/SnapRecords/actions/workflows/ci.yml/badge.svg" alt="Build Status"></a> |
| 8 | + <a href="https://www.npmjs.com/package/snap-records"><img src="https://img.shields.io/npm/v/snap-records.svg?style=flat-square&color=007acc" alt="NPM Version"></a> |
| 9 | + <a href="https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/snap-records.svg?style=flat-square&color=007acc" alt="License"></a> |
| 10 | + <a href="https://github.com/lbassuncao/SnapRecords/actions/workflows/ci.yml"><img src="https://github.com/lbassuncao/SnapRecords/actions/workflows/ci.yml/badge.svg" alt="Build Status"></a> |
11 | 11 | </p> |
12 | 12 |
|
13 | 13 | <br> |
14 | 14 |
|
15 | 15 | <p align="center" style="font-size: 1.15rem"> |
16 | | - <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/CONFIG.md" target="_blank" rel="noopener noreferrer">Configuration</a></strong> | |
17 | | - <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/BUILD.md" target="_blank" rel="noopener noreferrer">Build Guide</a></strong> | |
18 | | - <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/KEYBOARD.md" target="_blank" rel="noopener noreferrer">Keyboard Navigation</a></strong> | |
19 | | - <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">Contributing</a></strong> | |
20 | | - <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">License</a></strong> | |
21 | | - <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/COC.md" target="_blank" rel="noopener noreferrer">Code of Conduct</a></strong> |
| 16 | + <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/CONFIG.md">Configuration</a></strong> | |
| 17 | + <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/BUILD.md">Build Guide</a></strong> | |
| 18 | + <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/KEYBOARD.md">Keyboard Navigation</a></strong> | |
| 19 | + <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/CONTRIBUTING.md">Contributing</a></strong> | |
| 20 | + <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE">License</a></strong> | |
| 21 | + <strong><a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/COC.md">Code of Conduct</a></strong> |
22 | 22 | </p> |
23 | 23 |
|
24 | 24 | <br> |
25 | 25 |
|
26 | 26 | **SnapRecords** is a powerful, flexible TypeScript-based data grid component for displaying, managing, and interacting with tabular data in web applications. |
27 | 27 |
|
28 | | -Inspired by <a href="https://github.com/alfajango/jquery-dynatable" target="_blank" rel="noopener noreferrer">jQuery Dynatable</a>, it modernizes the concept with type safety, enhanced features, and performance optimizations. |
| 28 | +Inspired by [jQuery Dynatable](https://github.com/alfajango/jquery-dynatable), it modernizes the concept with type safety, enhanced features, and performance optimizations. |
29 | 29 |
|
30 | 30 | It supports server-side pagination, sorting, filtering, caching, multiple rendering modes, and accessibility, making it ideal for both simple and complex data-driven interfaces. |
31 | 31 |
|
@@ -234,7 +234,7 @@ api.setRenderMode(RenderType.MOBILE_CARDS); |
234 | 234 |
|
235 | 235 | ## Configuration Options |
236 | 236 |
|
237 | | -The `SnapRecordsOptions<T>` interface defines all configuration options. Key options include (see <a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/CONFIG.md" target="_blank" rel="noopener noreferrer">config.md</a> for full details): |
| 237 | +The `SnapRecordsOptions<T>` interface defines all configuration options. Key options include (see [config.md](https://github.com/lbassuncao/SnapRecords/blob/main/docs/CONFIG.md) for full details): |
238 | 238 |
|
239 | 239 | - `url` (string, required): API URL for data fetching. |
240 | 240 | - `columns` (string[], required): Column keys to display. |
@@ -311,7 +311,7 @@ Override styles in your CSS as needed. |
311 | 311 | SnapRecords prioritizes accessibility: |
312 | 312 |
|
313 | 313 | - **ARIA Attributes**: Supports `aria-sort`, `aria-selected`, `aria-label` for table, list, and card modes. |
314 | | -- **Keyboard Navigation**: ArrowUp/Down for row navigation, Enter/Space for selection, PageUp/Down for pagination (see <a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/KEYBOARD.md" target="_blank" rel="noopener noreferrer">keyboard.md</a>). |
| 314 | +- **Keyboard Navigation**: ArrowUp/Down for row navigation, Enter/Space for selection, PageUp/Down for pagination (see [keyboard.md](https://github.com/lbassuncao/SnapRecords/blob/main/docs/KEYBOARD.md)). |
315 | 315 | - **Screen Reader Support**: Announces updates (e.g., row selection, mode changes) via ARIA live regions. |
316 | 316 |
|
317 | 317 | ## State Management |
@@ -464,7 +464,7 @@ Customize rendering or event handling by providing custom `renderer`, `eventMana |
464 | 464 |
|
465 | 465 | ## License |
466 | 466 |
|
467 | | -MIT License. See <a href="https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">LICENSE</a> for details. |
| 467 | +MIT License. See [LICENSE](https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE) for details. |
468 | 468 |
|
469 | 469 | ## Support |
470 | 470 |
|
|
0 commit comments