|
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 [jQuery Dynatable](https://github.com/alfajango/jquery-dynatable), it modernizes the concept with type safety, enhanced features, and performance optimizations. |
| 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. |
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 |
|
@@ -65,7 +65,7 @@ To quickly set up SnapRecords: |
65 | 65 | import { SnapRecords, RowsPerPage } from './SnapRecords'; |
66 | 66 |
|
67 | 67 | new SnapRecords('table-container', { |
68 | | - url: '[https://api.example.com/data](https://api.example.com/data)', |
| 68 | + url: 'https://api.example.com/data', |
69 | 69 | columns: ['id', 'name'], |
70 | 70 | rowsPerPage: RowsPerPage.DEFAULT, |
71 | 71 | // No theme specified, so it uses 'default' and inherits host page styles |
@@ -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 `config.md` for full details): |
| 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): |
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 `keyboard.md`). |
| 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>). |
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 [`LICENSE`](./docs/LICENSE.txt) for details. |
| 467 | +MIT License. See <a href="https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">LICENSE</a> for details. |
468 | 468 |
|
469 | 469 | ## Support |
470 | 470 |
|
|
0 commit comments