Skip to content

Commit 9edbe99

Browse files
author
Luís Assunção
committed
docs: finalize target='_blank' for all README links and fix code example typo
1 parent ea32a63 commit 9edbe99

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
**SnapRecords** is a powerful, flexible TypeScript-based data grid component for displaying, managing, and interacting with tabular data in web applications.
2727

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.
2929

3030
It supports server-side pagination, sorting, filtering, caching, multiple rendering modes, and accessibility, making it ideal for both simple and complex data-driven interfaces.
3131

@@ -65,7 +65,7 @@ To quickly set up SnapRecords:
6565
import { SnapRecords, RowsPerPage } from './SnapRecords';
6666
6767
new SnapRecords('table-container', {
68-
url: '[https://api.example.com/data](https://api.example.com/data)',
68+
url: 'https://api.example.com/data',
6969
columns: ['id', 'name'],
7070
rowsPerPage: RowsPerPage.DEFAULT,
7171
// No theme specified, so it uses 'default' and inherits host page styles
@@ -234,7 +234,7 @@ api.setRenderMode(RenderType.MOBILE_CARDS);
234234
235235
## Configuration Options
236236
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):
238238
239239
- `url` (string, required): API URL for data fetching.
240240
- `columns` (string[], required): Column keys to display.
@@ -311,7 +311,7 @@ Override styles in your CSS as needed.
311311
SnapRecords prioritizes accessibility:
312312
313313
- **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>).
315315
- **Screen Reader Support**: Announces updates (e.g., row selection, mode changes) via ARIA live regions.
316316
317317
## State Management
@@ -464,7 +464,7 @@ Customize rendering or event handling by providing custom `renderer`, `eventMana
464464
465465
## License
466466
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.
468468
469469
## Support
470470

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"jquery-dynatable"
1818
],
1919
"type": "module",
20-
"version": "1.1.7",
20+
"version": "1.1.8",
2121
"name": "snap-records",
2222
"dependencies": {
2323
"dexie": "^4.0.11",

0 commit comments

Comments
 (0)