Skip to content

Commit

Permalink
docs: add additional links to-from data-table and api
Browse files Browse the repository at this point in the history
  • Loading branch information
MajesticPotatoe committed Oct 9, 2024
1 parent 281bd16 commit d795591
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/docs/src/data/page-to-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@
"VDataTableServer",
"VDataTableVirtual"
],
"components/data-tables/server-side-tables": [
"VDataTableServer"
],
"components/data-tables/virtual-tables": [
"VDataTableVirtual"
],
"components/date-inputs": ["VDateInput", "VDatePicker"],
"components/date-pickers-month": ["VDatePicker"],
"components/date-pickers": ["VDatePicker", "VDateInput"],
Expand Down
10 changes: 10 additions & 0 deletions packages/docs/src/pages/en/components/data-tables/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ The standard data table presumes that the entire data set is available locally.
| [v-data-table](/api/v-data-table/) | Primary Component |
| [v-data-table-headers](/api/v-data-table-headers/) | Functional Component used to display Data-table headers |
| [v-data-table-footer](/api/v-data-table-footer/) | Functional Component used to display Data-table footers |
| [v-data-table-row](/api/v-data-table-row/) | Functional Component used to display a single row of a data-table |
| [v-data-table-rows](/api/v-data-table-rows/) | Functional Component used to display all of the rows in a data-table |
| [v-checkbox-btn](/api/v-checkbox-btn/) | Reusable lightweight [v-checkbox](/components/checkboxes) |

<ApiInline hide-links />
Expand All @@ -44,6 +46,10 @@ The standard data table presumes that the entire data set is available locally.

This variant of the data table is meant to be used for very large datasets, where it would be inefficient to load all the data into the client. It supports sorting, filtering, pagination, and selection like a standard data table, but all the logic must be handled externally by your backend or database.

| Component | Description |
| - | - |
| [v-data-table-server](/api/v-data-table-server/) | Primary Component |

Find more information and examples on the [Server side tables](/components/data-tables/server-side-tables) page.

<ExamplesExample file="v-data-table/server" />
Expand All @@ -52,6 +58,10 @@ Find more information and examples on the [Server side tables](/components/data-

The virtual variant of the data table relies, like the standard variant, on all data being available locally. But unlike the standard variant it uses virtualization to only render a small portion of the rows. This makes it well suited for displaying large data sets. It supports client-side sorting and filtering, but not pagination.

| Component | Description |
| - | - |
| [v-data-table-virtual](/api/v-data-table-virtual/) | Primary Component |

Find more information and examples on the [Virtual tables](/components/data-tables/virtual-tables) page.

<ExamplesExample file="v-data-table/virtual" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Server-side Data tables are used for showing data coming from an API.

<PromotedEntry />

## API

| Component | Description |
| - | - |
| [v-data-table-server](/api/v-data-table-server/) | Primary Component |

<ApiInline hide-links />

## Examples

### Server-side paginate and sort
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ The v-data-table-virtual component relies on all data being available locally. B

<PromotedEntry />

## API

| Component | Description |
| - | - |
| [v-data-table-virtual](/api/v-data-table-virtual/) | Primary Component |

<ApiInline hide-links />

## Examples

### Basic example
Expand Down

0 comments on commit d795591

Please sign in to comment.