Skip to content

Commit fd650e9

Browse files
committed
Enhance tbl_explorer documentation
1 parent 358d7db commit fd650e9

1 file changed

Lines changed: 24 additions & 6 deletions

File tree

user_guide/33-table-explorer.qmd

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,8 @@ Tables are paginated at **20 rows per page** by default. The pagination bar show
131131
- **First**, **Previous**, **Next**, and **Last** navigation buttons
132132
- page number buttons with ellipsis for large page counts
133133

134-
The row count updates to reflect any active filters (e.g., "Showing 1–5 of 5 rows (filtered from 24)").
134+
The row count updates to reflect any active filters (e.g., "Showing 1–5 of 5 rows (filtered from
135+
24)").
135136

136137
To disable pagination and show all rows at once, set `page_size=0`:
137138

@@ -278,19 +279,29 @@ tbl_explorer(
278279

279280
## Progressive Enhancement
280281

282+
Interactive widgets can be fragile: if JavaScript fails to load or the page is consumed outside a
283+
browser (RSS readers, email digests, search engine crawlers), readers see nothing. The table
284+
explorer avoids this problem.
285+
281286
The `tbl_explorer()` output is designed with **progressive enhancement** in mind. The initial HTML
282287
contains a fully rendered static table (the first page of data) that is readable without JavaScript.
283288
When JavaScript is available, the static table is enhanced with interactive controls.
284289

285290
This means:
286291

287-
- **RSS feeds and email** — readers see a usable static table
288-
- **Search engines** — table content is indexable
289-
- **Accessibility** — the base table works with screen readers
290-
- **No-JS environments** — content is still visible
292+
- **RSS feeds and email**: readers see a usable static table
293+
- **Search engines**: table content is indexable
294+
- **Accessibility**: the base table works with screen readers
295+
- **No-JS environments**: content is still visible
296+
297+
Because the static fallback is a real HTML table (not a placeholder), it carries semantic structure
298+
that assistive technology and search engines can parse directly.
291299

292300
## Choosing Between `tbl_preview()` and `tbl_explorer()`
293301

302+
Great Docs offers two table display functions that serve different purposes. Use this comparison to
303+
decide which one fits your page:
304+
294305
| | `tbl_preview()` | `tbl_explorer()` |
295306
|---|---|---|
296307
| **Interactivity** | None (static HTML) | Sorting, filtering, pagination, column toggle |
@@ -300,8 +311,14 @@ This means:
300311
| **Large datasets** | Efficient (shows only head + tail) | All data embedded (watch page weight) |
301312
| **Dark mode** | Full support | Full support |
302313

314+
In general, reach for `tbl_preview()` when you want a quick, lightweight snapshot and
315+
`tbl_explorer()` when readers need to search, sort, or page through the data.
316+
303317
## Parameters Reference
304318

319+
All parameters for `tbl_explorer()` are listed below. Every parameter has a sensible default, so in
320+
most cases you only need to pass the data source itself.
321+
305322
| Parameter | Type | Default | Description |
306323
|-----------|------|---------|-------------|
307324
| `data` | various || Data source: DataFrame, file path, dict, or list of dicts |
@@ -333,6 +350,7 @@ The table explorer turns static data tables into interactive views with filterin
333350
pagination, and CSV export. Use it when readers need to search through larger datasets or compare
334351
specific rows.
335352

336-
- [Table Previews](table-previews.qmd) covers a lighter-weight table display for quick data summaries
353+
- [Table Previews](table-previews.qmd) covers a lighter-weight table display for quick data
354+
summaries
337355
- [Scale-to-Fit](scale-to-fit.qmd) keeps wide tables readable on narrow screens
338356
- [Configuration](configuration.qmd) covers all `great-docs.yml` options

0 commit comments

Comments
 (0)