doc: link to TableState

bryanmylee · Jun 27, 2022 · 9096f02 · 9096f02 · vercel · Jun 27, 2022
1 parent eed7fe2
commit 9096f02
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 22 deletions.
diff --git a/...routes/docs/[...2]api/[...9]header-row.md → ...outes/docs/[...2]api/[...10]header-row.md b/...routes/docs/[...2]api/[...9]header-row.md → ...outes/docs/[...2]api/[...10]header-row.md
diff --git a/...utes/docs/[...2]api/[...10]header-cell.md → ...utes/docs/[...2]api/[...11]header-cell.md b/...utes/docs/[...2]api/[...10]header-cell.md → ...utes/docs/[...2]api/[...11]header-cell.md
diff --git a/.../routes/docs/[...2]api/[...11]body-row.md → .../routes/docs/[...2]api/[...12]body-row.md b/.../routes/docs/[...2]api/[...11]body-row.md → .../routes/docs/[...2]api/[...12]body-row.md
diff --git a/...routes/docs/[...2]api/[...12]body-cell.md → ...routes/docs/[...2]api/[...13]body-cell.md b/...routes/docs/[...2]api/[...12]body-cell.md → ...routes/docs/[...2]api/[...13]body-cell.md
diff --git a/docs/src/routes/docs/[...2]api/[...3]create-columns.md b/docs/src/routes/docs/[...2]api/[...3]create-columns.md
@@ -77,11 +77,9 @@ _Defaults to the value of `accessor` if a string accessor is passed_. Required i
 
 #### `columnDef.header: RenderConfig | ((state) => RenderConfig)`
 
-<!-- TODO Document and link `TableState` -->
-
 Defines the component to use for the header cell of the data column.
 
-`header` is either a [`RenderConfig`](./--render.md#renderconfig), or a function that takes `TableState` and returns a [`RenderConfig`](./--render.md#renderconfig).
+`header` is either a [`RenderConfig`](./--render.md#renderconfig), or a function that takes [`TableState`](./table-state.md) and returns a [`RenderConfig`](./--render.md#renderconfig).
 
 :::example
 
@@ -119,12 +117,10 @@ const columns = table.createColumns([
 
 Defines the component to use for the body cells of the data column.
 
-<!-- TODO Document and link `TableState` -->
-
 `cell` is a function that takes
 
 1. an object with a reference to the [`BodyRow`](./body-row.md), `DataColumn`, and `value` of the cell, and
-2. `TableState`,
+2. [`TableState`](./table-state.md),
 
 and returns a [`RenderConfig`](./--render.md#renderconfig).
 
@@ -219,11 +215,9 @@ const columns = table.createColumns([
 
 #### `groupDef.header: RenderConfig | ((state) => RenderConfig)`
 
-<!-- TODO Document and link `TableState` -->
-
 Defines the component to use for the header cell of the group column.
 
-`header` is either a [`RenderConfig`](./--render.md#renderconfig), or a function that takes `TableState` and returns a [`RenderConfig`](./--render.md#renderconfig).
+`header` is either a [`RenderConfig`](./--render.md#renderconfig), or a function that takes [`TableState`](./table-state.md) and returns a [`RenderConfig`](./--render.md#renderconfig).
 
 :::example
 
@@ -302,11 +296,9 @@ const columns = table.createColumns([
 
 #### `displayDef.header: RenderConfig | ((state) => RenderConfig)`
 
-<!-- TODO Document and link `TableState` -->
-
 Defines the component to use for the header cell of the display column.
 
-`header` is either a [`RenderConfig`](./--render.md#renderconfig), or a function that takes `TableState` and returns a [`RenderConfig`](./--render.md#renderconfig).
+`header` is either a [`RenderConfig`](./--render.md#renderconfig), or a function that takes [`TableState`](./table-state.md) and returns a [`RenderConfig`](./--render.md#renderconfig).
 
 :::example
 
@@ -336,11 +328,9 @@ const columns = table.createColumns([
 
 Defines the component to use for the body cells of the display column.
 
-<!-- TODO Document and link `TableState` -->
-
 `cell` is a function that takes
 
 1. an object with a reference to the [`BodyRow`](./body-row.md) and `DataColumn` of the cell, and
-2. `TableState`,
+2. [`TableState`](./table-state.md),
 
 and returns a [`RenderConfig`](./--render.md#renderconfig).
diff --git a/docs/src/routes/docs/[...2]api/[...5]table-view-model.md b/docs/src/routes/docs/[...2]api/[...5]table-view-model.md
@@ -1,6 +1,6 @@
 ---
 title: TableViewModel
-description: Generate the view model for the table
+description: The view model of the data table
 sidebar_title: TableViewModel
 ---
 

diff --git a/docs/src/routes/docs/[...2]api/[...6]table-state.md b/docs/src/routes/docs/[...2]api/[...6]table-state.md
@@ -0,0 +1,24 @@
+---
+title: TableState
+description: The current state of the table
+sidebar_title: TableState
+---
+
+<script>
+  import { useHljs } from '$lib/utils/useHljs';
+  useHljs('ts');
+</script>
+
+# {$frontmatter.title}
+
+`TableState` is the [`TableViewModel`](./table-view-model.md) with two additional properties.
+
+## Usage
+
+### `data: ReadOrWritable<Item[]>`
+
+A reference to the original data source.
+
+### `columns: Column[]`
+
+A reference to the columns of the table.
diff --git a/...tes/docs/[...2]api/[...6]create-render.md → ...tes/docs/[...2]api/[...7]create-render.md b/...tes/docs/[...2]api/[...6]create-render.md → ...tes/docs/[...2]api/[...7]create-render.md
diff --git a/...c/routes/docs/[...2]api/[...7]--render.md → ...c/routes/docs/[...2]api/[...8]--render.md b/...c/routes/docs/[...2]api/[...7]--render.md → ...c/routes/docs/[...2]api/[...8]--render.md
diff --git a/.../routes/docs/[...2]api/[...8]subscribe.md → .../routes/docs/[...2]api/[...9]subscribe.md b/.../routes/docs/[...2]api/[...8]subscribe.md → .../routes/docs/[...2]api/[...9]subscribe.md
diff --git a/docs/src/routes/docs/[...3]plugins/[...3]add-column-filters.md b/docs/src/routes/docs/[...3]plugins/[...3]add-column-filters.md
@@ -55,9 +55,7 @@ Receives `filterValue` and the column cell `value`, and returns `true` if the ce
 
 Defines the component to render on `HeaderCell->props.[pluginName].render`.
 
-<!-- TODO Document and link `TableState` -->
-
-`renderProps` extends `TableState` and includes additional properties.
+`renderProps` extends [`TableState`](../api/table-state.md) and includes additional properties.
 
 #### `renderProps.id: string`
 

diff --git a/docs/src/routes/docs/[...3]plugins/[...9]add-group-by.md b/docs/src/routes/docs/[...3]plugins/[...9]add-group-by.md
@@ -89,12 +89,10 @@ _Required if `value` is not a `string` or `number`, defaults to (value) => value
 
 Defines the component to use for the body cells of aggregated values on grouping rows.
 
-<!-- TODO Document and link `TableState` -->
-
 `cell` is a function that takes
 
 1. an object with a reference to the `BodyRow`, `DataColumn`, and `value` of the cell, and
-2. `TableState`,
+2. [`TableState`](../api/table-state.md),
 
 and returns a `RenderConfig`.