Merge branch 'main' into main

Author: tychenjiajun

.changeset/config.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": [
+    "@svitejs/changesets-changelog-github-compact",
+    { "repo": "TanStack/table" }
+  ],
+  "commit": false,
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "fixed": [],
+  "linked": [],
+  "ignore": []
+}

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+## 🎯 Changes
+
+<!-- What changes are made in this PR? Describe the change and its motivation. -->
+
+## ✅ Checklist
+
+- [ ] I have followed the steps in the [Contributing guide](https://github.com/TanStack/table/blob/main/CONTRIBUTING.md).
+- [ ] I have tested this code locally with `pnpm test:pr`.
+
+## 🚀 Release Impact
+
+- [ ] This change affects published code, and I have generated a [changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
+- [ ] This change is docs/CI/dev-only (no release).

.github/workflows/autofix.yml

@@ -18,7 +18,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
       - name: Setup Tools
         uses: tanstack/config/.github/setup@main
       - name: Fix formatting

.github/workflows/pr.yml

@@ -1,4 +1,4 @@
-name: pr
+name: PR
 
 on:
   pull_request:
@@ -23,15 +23,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           fetch-depth: 0
       - name: Start Nx Agents
         run: npx nx-cloud start-ci-run --distribute-on=".nx/workflows/dynamic-changesets.yaml"
       - name: Setup Tools
         uses: tanstack/config/.github/setup@main
       - name: Get base and head commits for `nx affected`
-        uses: nrwl/nx-set-shas@v4
+        uses: nrwl/nx-set-shas@v4.3.3
         with:
           main-branch-name: main
       - name: Run Checks
@@ -44,7 +44,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           fetch-depth: 0
       - name: Setup Tools

.github/workflows/ci.yml .github/workflows/release.yml.github/workflows/ci.yml renamed to .github/workflows/release.yml

@@ -1,11 +1,6 @@
 name: ci
 
 on:
-  workflow_dispatch:
-    inputs:
-      tag:
-        description: override release tag
-        required: false
   push:
     branches: [main, alpha, beta, rc]
 
@@ -19,15 +14,16 @@ env:
 permissions:
   contents: write
   id-token: write
+  pull-requests: write
 
 jobs:
-  test-and-publish:
-    name: Test & Publish
-    if: github.repository == 'TanStack/table'
+  release:
+    name: Release
+    if: github.repository_owner == 'TanStack'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           fetch-depth: 0
       - name: Start Nx Agents
@@ -39,13 +35,13 @@ jobs:
       - name: Stop Nx Agents
         if: ${{ always() }}
         run: npx nx-cloud stop-all-agents
-      - name: Publish
-        run: |
-          git config --global user.name 'Tanner Linsley'
-          git config --global user.email '[email protected]'
-          npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
-          pnpm run cipublish
+      - name: Run Changesets (version or publish)
+        uses: changesets/[email protected]
+        with:
+          version: pnpm run changeset:version
+          publish: pnpm run changeset:publish
+          commit: 'ci: Version Packages'
+          title: 'ci: Version Packages'
         env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          TAG: ${{ inputs.tag }}

.nvmrc

@@ -1 +1 @@
-20.15.1
+24.8.0

README.md

@@ -1,141 +1,118 @@
-![TanStack Table Header](https://github.com/tanstack/table/raw/main/media/repo-header.png)
+<div align="center">
+  <img src="./media/header_table.png" alt="TanStack Table">
+</div>
 
-# [TanStack](https://tanstack.com) Table v8
+<br />
 
-Headless UI for building **powerful tables & datagrids** for **React, Solid, Vue, Svelte, Qwik and TS/JS**.
-
-<a href="https://twitter.com/intent/tweet?button_hashtag=TanStack" target="\_parent">
-  <img alt="#TanStack" src="https://img.shields.io/twitter/url?color=%2308a0e9&label=%23TanStack&style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Fbutton_hashtag%3DTanStack" />
-</a>
-<a href="https://github.com/tanstack/table/actions?table=workflow%3A%22react-table+tests%22">
-  <img src="https://github.com/tanstack/table/workflows/react-table%20tests/badge.svg" />
-</a>
+<div align="center">
 <a href="https://npmjs.com/package/@tanstack/react-table" target="\_parent">
-  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/react-table.svg" />
+  <img alt="npm downloads" src="https://img.shields.io/npm/dm/@tanstack/react-table.svg" />
+</a>
+<a href="https://github.com/tanstack/table" target="\_parent">
+  <img alt="github stars" src="https://img.shields.io/github/stars/tanstack/react-table.svg?style=social&label=Star" />
 </a>
 <a href="https://bundlephobia.com/result?p=@tanstack/react-table@latest" target="\_parent">
-  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-table@latest" />
+  <img alt="bundle size" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-table@latest" />
 </a>
+</div>
+
+<div align="center">
 <a href="#badge">
   <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
 </a>
-<a href="https://github.com/tanstack/table/discussions">
-  <img alt="Join the discussion on Github" src="https://img.shields.io/badge/Github%20Discussions%20%26%20Support-Chat%20now!-blue" />
-</a>
-<a href="https://github.com/tanstack/table" target="\_parent">
-  <img alt="" src="https://img.shields.io/github/stars/tanstack/react-table.svg?style=social&label=Star" />
-</a>
-<a href="https://twitter.com/tannerlinsley" target="\_parent">
-  <img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
-</a>
-
-> [Looking for version 7 of `react-table`? Click here!](https://github.com/tanstack/table/tree/v7)
-
-## Enjoy this library?
-
-Try other [TanStack](https://tanstack.com) libraries:
-
-- [TanStack Query](https://github.com/TanStack/query) <img alt="" src="https://img.shields.io/github/stars/tanstack/query.svg" />
-- [TanStack Table](https://github.com/TanStack/table) <img alt="" src="https://img.shields.io/github/stars/tanstack/table.svg" />
-- [TanStack Router](https://github.com/TanStack/router) <img alt="" src="https://img.shields.io/github/stars/tanstack/router.svg" />
-- [TanStack Virtual](https://github.com/TanStack/virtual) <img alt="" src="https://img.shields.io/github/stars/tanstack/virtual.svg" />
-- [TanStack Form](https://github.com/TanStack/form) <img alt="" src="https://img.shields.io/github/stars/tanstack/form.svg" />
-- [TanStack Ranger](https://github.com/TanStack/ranger) <img alt="" src="https://img.shields.io/github/stars/tanstack/ranger.svg" />
-
-## Visit [tanstack.com/table](https://tanstack.com/table) for docs, guides, API and more!
-
-You may know **TanStack Table** by our adapter names, too!
-
-- [Angular Table](https://tanstack.com/table/v8/docs/framework/angular/angular-table)
-- [Lit Table](https://tanstack.com/table/v8/docs/framework/lit/lit-table)
-- [Qwik Table](https://tanstack.com/table/v8/docs/framework/qwik/qwik-table)
-- [**React Table**](https://tanstack.com/table/v8/docs/framework/react/react-table)
-- [Solid Table](https://tanstack.com/table/v8/docs/framework/solid/solid-table)
-- [Svelte Table](https://tanstack.com/table/v8/docs/framework/svelte/svelte-table)
-- [Vue Table](https://tanstack.com/table/v8/docs/framework/vue/vue-table)
-
-## Summary
-
-TanStack Table is a **headless** table library, which means it does not ship with components, markup or styles. This means that you have **full control** over markup and styles (CSS, CSS-in-JS, UI Component Libraries, etc) and this is also what gives it its portable nature. You can even use it in React Native!
-
-If you want a **lightweight table with full control over markup and implementation**, then you should consider using **TanStack Table, a headless table library**.
-
-If you want a **ready-to-use component-based table with more power but more constraints around markup/styles/implementation**, you should consider using [AG Grid](https://ag-grid.com/react-data-grid/?utm_source=reacttable&utm_campaign=githubreacttable), a component-based table library from our OSS partner [AG Grid](https://ag-grid.com).
-
-TanStack Table and AG Grid are respectfully the
-**best table/datagrid libraries around**. Instead
-of competing, we're working together to ensure the highest
-quality table/datagrid options are available for the entire
-JS/TS ecosystem and every use-case.
-
-## Quick Features
-
-- Agnostic core (JS/TS)
-- 1st-class framework bindings for React, Vue, Solid
-- ~15kb or less (with tree-shaking)
-- 100% TypeScript (but not required)
-- Headless (100% customizable, Bring-your-own-UI)
-- Auto out of the box, opt-in controllable state
-- Filters (column and global)
-- Sorting (multi-column, multi-directional)
-- Grouping & Aggregation
-- Pivoting (coming soon!)
-- Row Selection
-- Row Expansion
-- Column Visibility/Ordering/Pinning/Resizing
-- Table Splitting
-- Animatable
-- Virtualizable
-- Server-side/external data model support
-
-# Migrating from React Table v7
-
-## Notable Changes
-
-- Full rewrite to TypeScript with types included in the base package
-- Removal of plugin system to favor more inversion of control
-- Vastly larger and improved API (and new features like pinning)
-- Better controlled state management
-- Better support for server-side operations
-- Complete (but optional) data pipeline control
-- Agnostic core with framework adapters for React, Solid, Svelte, Vue, and potentially more in the future
-- New Dev Tools
-
-## Migration
-
-There are a fair amount of breaking changes (they're worth it, trust us!):
-
-- Turns out that TypeScript makes your code **a lot** better/safer, but also usually requires breaking changes to architecture.
-- Plugin system has been removed so plugins must be rewritten to wrap/compose the new functional API. Contact us if you need help!
-- Column configuration options have changed, but only slightly.
-- Table options are mostly the same, with some larger changes around optional state management/control and data pipeline control
-- The `table` instance while similar in spirit to v7 has been reconfigured to be much faster.
-
-## Installation
-
-Install one of the following packages based on your framework of choice:
-
-```bash
-# Npm
-npm install @tanstack/angular-table
-npm install @tanstack/lit-table
-npm install @tanstack/qwik-table
-npm install @tanstack/react-table
-npm install @tanstack/solid-table
-npm install @tanstack/svelte-table
-npm install @tanstack/vue-table
-npm install @tanstack/table-core #vanilla js that can work with any framework
-```
-
-## How to help?
-
-- Try out the already-migrated examples
-- Try it out in your own projects.
-- Introspect the types! Even without the docs finished, the library ships with 100% typescript to help you explore its capabilities.
-- [Read the contribution guidelines](https://github.com/tanstack/table/tree/main/CONTRIBUTING.md)
-- Write some docs! Start with the [API docs](https://github.com/TanStack/react-table/tree/main/docs/api) and try adding some information about one or more of the features. The types do a decent job of showing what's supported and the capabilities of the library.
-- **Using a plugin?** Try rewriting your plugin (v8 doesn't have a plugin system any more) as a functional wrapper that uses TanStack Table internally. The new API is much more powerful and easier to compose. If you find something you can't figure out, let us know and we'll add it to the API.
-
-### [Become a Sponsor](https://github.com/sponsors/tannerlinsley/)
+<a href="https://bestofjs.org/projects/tanstack-table"><img alt="Best of JS" src="https://img.shields.io/endpoint?url=https://bestofjs-serverless.now.sh/api/project-badge?fullName=TanStack%2Ftable%26since=daily" /></a>
+  <a href="https://twitter.com/tan_stack"><img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/></a>
+</div>
+
+### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+
+</div>
+
+# TanStack Table
+
+> [!NOTE]
+> You may know TanStack Table by the adapter names:
+>
+> - [Angular Table](https://tanstack.com/table/v8/docs/framework/angular/angular-table)
+> - [Lit Table](https://tanstack.com/table/v8/docs/framework/lit/lit-table)
+> - [Qwik Table](https://tanstack.com/table/v8/docs/framework/qwik/qwik-table)
+> - [React Table](https://tanstack.com/table/v8/docs/framework/react/react-table)
+> - [Solid Table](https://tanstack.com/table/v8/docs/framework/solid/solid-table)
+> - [Svelte Table](https://tanstack.com/table/v8/docs/framework/svelte/svelte-table)
+> - [Vue Table](https://tanstack.com/table/v8/docs/framework/vue/vue-table)
+
+A headless table library for building powerful datagrids with full control over markup, styles, and behavior.
+
+- Framework‑agnostic core with bindings for React, Vue & Solid
+- 100% customizable — bring your own UI, components, and styles
+- Sorting, filtering, grouping, aggregation & row selection
+- Lightweight, virtualizable & server‑side friendly
+
+### <a href="https://tanstack.com/table">Read the Docs →</a>
+
+## Get Involved
+
+- We welcome issues and pull requests!
+- Participate in [GitHub discussions](https://github.com/TanStack/table/discussions)
+- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
+- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
+
+## Partners
+
+<table align="center">
+  <tr>
+    <td>
+        <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS">
+			<picture>
+			  <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" />
+			  <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" />
+			  <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
+			</picture>        
+		</a>
+    </td>
+    <td padding="20">
+      <a href="https://www.cloudflare.com?utm_source=tanstack">
+         <picture>
+		  <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" />
+		  <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" />
+		  <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
+		</picture>
+      </a>
+    </td>
+    <td>
+     <a href="https://ag-grid.com/react-data-grid/?utm_source=reacttable&utm_campaign=githubreacttable" style="display: flex; align-items: center; border: none;">
+       <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./media/ag-grid-dark.svg" height="40" />
+        <source media="(prefers-color-scheme: light)" srcset="./media/ag-grid-light.svg" height="40" />
+        <img src="https://raw.githubusercontent.com/tannerlinsley/files/master/partners/ag-grid.svg" height="60" alt="AG Grid" />
+      </picture>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<div align="center">
+<img src="./media/partner_logo.svg" alt="Table & you?" height="65">
+<p>
+We're looking for TanStack Table Partners to join our mission! Partner with us to push the boundaries of TanStack Table and build amazing things together.
+</p>
+<a href="mailto:[email protected]?subject=TanStack Table Partnership"><b>LET'S CHAT</b></a>
+</div>
+
+## Explore the TanStack Ecosystem
+
+- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
+- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
+- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
+- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
+- <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching <br/>
+- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
+- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
+- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
+- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
+- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
+- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
+
+… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
 
 <!-- USE THE FORCE LUKE -->

docs/api/core/cell.md

@@ -2,7 +2,7 @@
 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).
+These are **core** options and API properties for all cells. More options and API properties are available for other [table features](../../../guide/features.md).
 
 ## Cell API
 

docs/api/core/column.md

@@ -2,7 +2,7 @@
 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).
+These are **core** options and API properties for all columns. More options and API properties are available for other [table features](../../../guide/features.md).
 
 ## Column API