Skip to content

Commit

Permalink
Merge branch 'main' into feat-angular-adapter
Browse files Browse the repository at this point in the history
# Conflicts:
#	package.json
#	pnpm-lock.yaml
  • Loading branch information
jrgokavalsa committed Feb 24, 2024
2 parents 51c11a6 + 631886b commit 73d90a3
Show file tree
Hide file tree
Showing 168 changed files with 3,180 additions and 1,169 deletions.
7 changes: 6 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,15 @@ jobs:
with:
node-version-file: .nvmrc
cache: pnpm
- name: Start Nx Agents
run: npx nx-cloud start-ci-run --distribute-on=".nx/workflows/dynamic-changesets.yaml"
- name: Install dependencies
run: pnpm install --frozen-lockfile --prefer-offline
- name: Run Tests
run: pnpm run test:ci
run: pnpm run test:ci --parallel=3
- name: Stop Nx Agents
if: ${{ always() }}
run: npx nx-cloud stop-all-agents
- name: Publish
run: |
git config --global user.name 'Tanner Linsley'
Expand Down
7 changes: 6 additions & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,16 @@ jobs:
with:
node-version-file: .nvmrc
cache: pnpm
- name: Start Nx Agents
run: npx nx-cloud start-ci-run --distribute-on=".nx/workflows/dynamic-changesets.yaml"
- name: Install dependencies
run: pnpm install --frozen-lockfile --prefer-offline
- name: Get base and head commits for `nx affected`
uses: nrwl/nx-set-shas@v3
with:
main-branch-name: 'main'
- name: Run Checks
run: pnpm run test:pr
run: pnpm run test:pr --parallel=3
- name: Stop Nx Agents
if: ${{ always() }}
run: npx nx-cloud stop-all-agents
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

# dependencies
node_modules
package-lock.json
yarn.lock

# builds
types
Expand Down Expand Up @@ -36,9 +38,8 @@ stats.html

*.log
.DS_Store
node_modules
.cache
dist
.pnpm-store

package-lock.json
yarn.lock
Expand Down
4 changes: 4 additions & 0 deletions .nx/workflows/dynamic-changesets.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
distribute-on:
small-changeset: 8 linux-medium-js
medium-changeset: 10 linux-medium-js
large-changeset: 12 linux-medium-js
1 change: 0 additions & 1 deletion babel.config.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ module.exports = {
'@babel/preset-typescript',
],
plugins: [
// 'babel-plugin-transform-async-to-promises',
cjs && ['@babel/transform-modules-commonjs', { loose }],
// [
// '@babel/transform-runtime',
Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/cell.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cell
title: Cell APIs
---

These are **core** options and API properties for all cells. More options and API properties are available for other [table features](../../guide/features).
Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/column-def.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: ColumnDef
title: ColumnDef APIs
---

Column definitions are plain objects with the following options:
Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/column.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Column
title: Column APIs
---

These are **core** options and API properties for all columns. More options and API properties are available for other [table features](../../guide/features).
Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/header-group.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: HeaderGroup
title: HeaderGroup APIs
---

These are **core** options and API properties for all header groups. More options and API properties may be available for other [table features](../../guide/features).
Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/header.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Header
title: Header APIs
---

These are **core** options and API properties for all headers. More options and API properties may be available for other [table features](../../guide/features).
Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/row.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Row
title: Row APIs
---

These are **core** options and API properties for all rows. More options and API properties are available for other [table features](../../guide/features).
Expand Down
4 changes: 2 additions & 2 deletions docs/api/core/table.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Table
title: Table APIs
---

## `useReactTable` / `createSolidTable` / `useVueTable` / `createSvelteTable`
Expand Down Expand Up @@ -89,7 +89,7 @@ declare module '@tanstack/table-core' {
}
```

> 🧠 Think of this option as an arbitrary "context" for your table. This is a great way to pass arbitrary data or functions to your table without having to pass it to every thing the table touches. A good example is passing a locale object to your table to use for formatting dates, numbers, etc or even a function that can be used to update editable data like in the [editable-data example](../examples/react/editable-data).
> 🧠 Think of this option as an arbitrary "context" for your table. This is a great way to pass arbitrary data or functions to your table without having to pass it to every thing the table touches. A good example is passing a locale object to your table to use for formatting dates, numbers, etc or even a function that can be used to update editable data like in the [editable-data example](../framework/react/examples/editable-data).
### `state`

Expand Down
28 changes: 27 additions & 1 deletion docs/api/features/column-ordering.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Column Ordering
title: Column Ordering APIs
id: column-ordering
---

Expand Down Expand Up @@ -42,3 +42,29 @@ resetColumnOrder: (defaultState?: boolean) => void
```
Resets the **columnOrder** state to `initialState.columnOrder`, or `true` can be passed to force a default blank state reset to `[]`.
## Column API
### `getIndex`
```tsx
getIndex: (position?: ColumnPinningPosition) => number
```
Returns the index of the column in the order of the visible columns. Optionally pass a `position` parameter to get the index of the column in a sub-section of the table.
### `getIsFirstColumn`
```tsx
getIsFirstColumn: (position?: ColumnPinningPosition) => boolean
```
Returns `true` if the column is the first column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the first in a sub-section of the table.
### `getIsLastColumn`
```tsx
getIsLastColumn: (position?: ColumnPinningPosition) => boolean
```
Returns `true` if the column is the last column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the last in a sub-section of the table.
20 changes: 15 additions & 5 deletions docs/api/features/column-sizing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Column Sizing
title: Column Sizing APIs
id: column-sizing
---

Expand Down Expand Up @@ -61,8 +61,6 @@ The maximum allowed size for the column
## Column API
## Table Options
### `getSize`
```tsx
Expand All @@ -77,7 +75,19 @@ Returns the current size of the column
getStart: (position?: ColumnPinningPosition) => number
```
Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the column.
Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the column, measuring the size of all preceding columns.
Useful for sticky or absolute positioning of columns. (e.g. `left` or `transform`)
### `getAfter`
```tsx
getAfter: (position?: ColumnPinningPosition) => number
```
Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the column, measuring the size of all succeeding columns.
Useful for sticky or absolute positioning of columns. (e.g. `right` or `transform`)
### `getCanResize`
Expand Down Expand Up @@ -134,7 +144,7 @@ Returns an event handler function that can be used to resize the header. It can
The dragging and release events are automatically handled for you.
## Table API Options
## Table Options
### `enableColumnResizing`
Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/column-visibility.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Column Visibility
title: Column Visibility APIs
id: column-visibility
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/expanding.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Expanding
title: Expanding APIs
id: expanding
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/filters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Filters
title: Filter APIs
id: filters
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/grouping.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Grouping
title: Grouping APIs
id: grouping
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/pagination.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Pagination
title: Pagination APIs
id: pagination
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/pinning.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Pinning
title: Pinning APIs
id: pinning
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/row-selection.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Row Selection
title: Row Selection APIs
id: row-selection
---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/features/sorting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sorting
title: Sorting APIs
id: sorting
---

Expand Down
8 changes: 8 additions & 0 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,10 @@
"to": "framework/react/examples/column-pinning",
"label": "Column Pinning"
},
{
"to": "framework/react/examples/column-pinning-sticky",
"label": "Sticky Column Pinning"
},
{
"to": "framework/react/examples/column-sizing",
"label": "Column Sizing"
Expand Down Expand Up @@ -430,6 +434,10 @@
"to": "framework/svelte/examples/column-visibility",
"label": "Column Visibility"
},
{
"to": "framework/svelte/examples/filtering",
"label": "Filtering"
},
{
"to": "framework/svelte/examples/sorting",
"label": "Sorting"
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/cells.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Cells
title: Cells Guide
---

## API
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/column-defs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Columns
title: Columns Guide
---

## API
Expand Down
14 changes: 7 additions & 7 deletions docs/guide/column-filtering.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Column Filtering
title: Column Filtering Guide
---

## Examples

Want to skip to the implementation? Check out these examples:

- [filters](../examples/react/filters) (includes faceting)
- [editable-data](../examples/react/editable-data)
- [expanding](../examples/react/expanding)
- [grouping](../examples/react/grouping)
- [pagination](../examples/react/pagination)
- [row-selection](../examples/react/row-selection)
- [filters](../framework/react/examples/filters) (includes faceting)
- [editable-data](../framework/react/examples/editable-data)
- [expanding](../framework/react/examples/expanding)
- [grouping](../framework/react/examples/grouping)
- [pagination](../framework/react/examples/pagination)
- [row-selection](../framework/react/examples/row-selection)

## API

Expand Down
Loading

0 comments on commit 73d90a3

Please sign in to comment.