@svgrid/mcp 3.0.46 → 3.0.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/data.js +56 -47
- package/dist/preview.d.ts +1 -1
- package/dist/preview.js +1 -1
- package/package.json +2 -2
- package/server.json +2 -2
package/dist/data.js
CHANGED
|
@@ -5178,14 +5178,14 @@ export const docs = [
|
|
|
5178
5178
|
"path": "docs/help/base/automations.md",
|
|
5179
5179
|
"title": "Automations",
|
|
5180
5180
|
"section": "SvGrid Base",
|
|
5181
|
-
"markdown": "# Automations\n\nAn automation does something on its own when something happens to a\nrecord: a task set to Done ticks its Done box, a new request goes to Todo, a\nblocked task tells its owner, a button starts the work. Each table of a base\nhas its own, under \"Automations\" in the view bar.\n\n<div data-docs-demo=\"504-project-tracker\" data-height=\"680\"></div>\n\nIn the demo, set a task's Status to Done, press Start in the Kick off\ncolumn, or send the Request a task form, then open \"5 automations\" and look\nat Runs.\n\n\n\n## Add one\n\nOpen \"Automations\" in the view bar and press \"+ New automation\". The dialog\nhas three parts:\n\n- **When**: what sets it off.\n- **Only for records where**: a condition written with the view bar's\n filter, so it compares a select's option, a person, a linked record's name\n or \"within the past week\" the way the filter does. Leave it empty for\n every record.\n- **Do**: the actions, in order.\n\n\n\nEvery change is kept as you make it. \"Run now\" tries the automation on the\nrecord you pick, as if its trigger had happened.\n\n## When\n\n| Trigger | Runs |\n|---|---|\n| A record is created | When a record is added: \"+ Add row\", a form, a board lane, a calendar day, another automation. A record brought back by Restore or an undo of a delete is not created, and no rule runs for it |\n| A record changes | When a record is edited; pick fields to run only when one of them changes. A link made from the other table counts: adding a guest to an event from Guests changes the event's Guests field |\n| A record matches a condition | When a record starts to match the condition. It does not run again while the record keeps matching |\n| A form is sent | When a form view sends a record; pick the form, or any form of the table |\n| A button is pressed | When a Button field is pressed on a record |\n| At a scheduled time | Every day at 9, every Monday, every hour, or a cron expression: once for each record that matches the condition then, or once with no record |\n\nA paste or a fill that changes several cells of one record is one change to\nit. An undo or a redo is no change: it runs no automation.\n\n## Do\n\n| Action | What it does |\n|---|---|\n| Update the record | Sets fields of the record that set it off |\n| Create a record | Adds a record to any table of the base; \"Link it back\" fills a link field of the new record with the record that set it off |\n| Show a notice | A toast; `{Field name}` is that field of the record |\n| Color the record while it matches | Colors the whole row, or some fields, for as long as the record matches the condition |\n| Call a webhook | POSTs the record (or a body you write) to a URL: a team chat, your API. Secrets as `{secret:NAME}`, read on the server only |\n| Send an email | To, subject and text with field names; sent by the [server](#on-the-server) |\n| Your own actions | Anything the app adds with `registerAutomationAction` |\n\nA webhook's URL, headers and body name fields in braces, and secrets as\n`{secret:NAME}`; leave the body empty to send the record as JSON. A secret is\nnamed only by the automation: what a record holds is data, so `{secret:NAME}`\ntyped into a field goes out as that text.\n\nFrom the server a webhook does not call private or local addresses (`localhost`,\n`10.x`, `192.168.x`, `169.254.169.254`, a name that resolves to one, an IPv6 form\nthat wraps one) and does not follow redirects. On Node it connects to the\naddresses it checked, so a name cannot answer one way for the check and another\nfor the call; a name that does not resolve is not sent. A `fetch` of your own\npassed to `createAutomationServer` gets the check but not that pin, and neither\ndoes a runtime with no sockets of its own. For a webhook on your own network, set\n`allowInternalWebhooks: true` on `createAutomationServer`.\n\n\n\n\nValues are written as the field shows them:\n\n| Field | Write |\n|---|---|\n| Single or multiple select | The option's name: `Done`, `Bug, Risk` |\n| Person | The person's name: `Ana Ruiz` |\n| Checkbox | `true` or `false` |\n| Number | `42`; in a percent field, `100%` |\n| Date | `2026-11-01`, `today`, `today+7`, `today-1`, `now` |\n| Link | A record's name, several with commas, or `{record}` for the record that set it off |\n| Any text | Text with fields in braces: `{Task} follow-up` |\n| Any field | Nothing, to clear it |\n\n## Runs\n\nEvery run is listed under Runs, newest first, with what each action did and\nthe record it ran on. A failed action stops the run there and says why.\n\nEdit fields on more than 10,000 records asks first, and that question says how many\nruns the change can start in the page and how long they will likely take: at the rate\nruns went in this tab, or, before any did, from how long the server takes to answer. Untick\n\"Also run automations\" to make the change without them. The choice holds for that change\nonly. An automation that runs on the server is not counted and cannot be skipped from here.\n\nRuns in the page go one at a time, in the tab, after the change is saved. From 20 runs on, the top\nbar says how far they are and about how long is left, with a Stop button. Stop drops the runs\nnot started and says how many, and those do not run later. Runs left when the tab closes do\nnot happen either, so the browser asks before it closes. For a change of hundreds of thousands of records,\nrun the automation on the server (`runOn: 'server'`).\n\n\n\n## In code\n\nA table's automations are its `automations`, plain data you can store with\nthe rest of the table:\n\n```ts\nimport type { BaseAutomation } from '@svgrid/enterprise/base'\n\nconst statusIs = (value: string) => ({\n kind: 'fieldFilter' as const,\n conjunction: 'and' as const,\n conditions: [{ column: 'status', kind: 'select' as const, op: 'is' as const, value }],\n})\n\nexport const taskAutomations: BaseAutomation[] = [\n {\n id: 'done',\n name: 'Done closes the task',\n enabled: true,\n trigger: { type: 'recordUpdated', fields: ['status'] },\n condition: statusIs('Done'),\n actions: [\n { type: 'updateRecord', values: { done: 'true', progress: '100%' } },\n { type: 'notify', message: '{Task} is done', severity: 'success' },\n ],\n },\n {\n id: 'blocked',\n name: 'Open an issue for a blocked task',\n enabled: true,\n trigger: { type: 'recordMatches' },\n condition: statusIs('Blocked'),\n actions: [{ type: 'createRecord', table: 'issues', values: { title: 'Unblock {Task}', owner: '{Assignee}' }, linkField: 'task' }],\n },\n]\n```\n\n```svelte\n<script lang=\"ts\">\n import { SvToaster } from '@svgrid/grid'\n import { SvBase, enableBase, type BaseTable } from '@svgrid/enterprise/base'\n import { taskAutomations } from '$lib/automations'\n\n enableBase()\n let { tasks, issues }: { tasks: BaseTable; issues: BaseTable } = $props()\n let tables = $state.raw([{ ...tasks, automations: taskAutomations }, issues])\n</script>\n\n<SvBase bind:tables editable onTablesChange={(t) => console.log('save', t)} />\n<SvToaster />\n```\n\nAutomations edited in the dialog reach `onTablesChange` with the rest of the\ntable. Automations need `<SvBase tables>`; one table is a list of one.\nNotices show as a base's other notices do: see [Notices](./quick-start.md#notices).\n\n## Your own actions\n\n`registerAutomationAction` adds an action to the dialog's list. It runs in\nthe page, so call your own server for anything that needs a secret:\n\n```ts\nimport { registerAutomationAction } from '@svgrid/enterprise/base'\n\nregisterAutomationAction('post-to-chat', {\n label: 'Post to the team chat',\n run: async ({ record, text }) => {\n if (!record) return 'No record'\n const res = await fetch('/api/chat', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ message: `${text('Task')} needs a hand (${text('Assignee')})` }),\n })\n if (!res.ok) throw new Error(`Chat answered ${res.status}`)\n return 'Posted'\n },\n})\n```\n\nAn automation runs it with `{ type: 'run', action: 'post-to-chat' }`. What it\nreturns is the run's detail; what it throws is the run's error.\n\n## Where they run\n\nEach automation says where it runs, under \"Runs in\":\n\n- **This browser** (the default): in the page of the person who made the\n change, right away and once. A change that arrives from someone else\n through [realtime](./data.md#changes-made-elsewhere) does not run it again\n in your page. Scheduled ones run while the base is open.\n- **The server**: in your server, for every change to the database, whoever\n or whatever made it, with secrets and email. Set it up as below.\n\nEither way, a change an automation makes is an ordinary change: with a\n[source](./data.md), it is written to the database like an edit. What an\naction changes can set off other automations, up to four deep; past that the\nrun stops and says so, so two automations that answer each other cannot loop.\n\n## On the server\n\n\n\n`createAutomationServer` runs the automations set to \"The server\". It reads\nthe same tables, with the same automations, through sources of its own. It remembers\nthe last 10,000 records of a table it heard deleted: on a table with no `softDelete` an\nundo writes the record again, and only that memory tells it from a new one, so such an\nundo after a server restart reads as a creation.\nKeep the tables in one module both sides import, each side handing in its\nown way to reach the data:\n\n```ts\n// src/lib/tables.ts: the tables, for the browser and for the server.\nimport { baseSource, type BaseTable } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\nexport function trackerTables(source: (table: string) => ServerDataSource<Record<string, unknown>>): BaseTable[] {\n return [\n {\n id: 'tasks',\n name: 'Tasks',\n primaryField: 'name',\n data: [],\n columns: [\n { field: 'name', header: 'Task', fieldType: 'text' },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: [{ value: 'Todo' }, { value: 'Blocked' }, { value: 'Done' }] } },\n { field: 'owner_email', header: 'Owner email', fieldType: 'email' },\n ],\n automations: [\n {\n id: 'blocked',\n name: 'Tell the team about a blocked task',\n enabled: true,\n runOn: 'server',\n trigger: { type: 'recordMatches' },\n condition: { kind: 'fieldFilter', conjunction: 'and', conditions: [{ column: 'status', kind: 'select', op: 'is', value: 'Blocked' }] },\n actions: [\n { type: 'webhook', url: 'https://hooks.slack.com/services/{secret:SLACK_HOOK}', body: '{\"text\": \"{Task} is blocked\"}' },\n { type: 'email', to: '{Owner email}', subject: '{Task} is blocked', body: 'Someone marked {Task} as blocked.' },\n ],\n },\n ],\n source: baseSource(source('tasks')),\n },\n ]\n}\n```\n\nThe server side, in a SvelteKit app:\n\nThe code on this page is for SvelteKit 2. On SvelteKit 3,\n[these names differ](../../getting-started/sveltekit.md#on-sveltekit-3).\n\n```ts\n// src/lib/server/automations.ts\nimport pg from 'pg'\nimport { createAutomationServer } from '@svgrid/enterprise/base'\nimport { createSqlDataSource, type EntitySchema } from '@svgrid/enterprise'\nimport { env } from '$env/dynamic/private'\nimport { trackerTables } from '$lib/tables'\n\nconst pool = new pg.Pool({ connectionString: env.DATABASE_URL })\nconst schemas: Record<string, EntitySchema> = {\n tasks: {\n name: 'tasks',\n fields: [\n { field: 'id', type: 'text', primaryKey: true },\n { field: 'name', type: 'text' },\n { field: 'status', type: 'text' },\n { field: 'owner_email', type: 'text' },\n ],\n },\n}\n\n// Your mail provider's client.\ndeclare const mailer: { send: (m: { from: string; to: string[]; subject: string; text: string }) => Promise<unknown> }\n\nexport const automations = createAutomationServer({\n tables: trackerTables((table) =>\n createSqlDataSource({\n schema: schemas[table]!,\n table,\n dialect: { placeholders: '$', ilike: true },\n execute: async (sql, params) => (await pool.query(sql, params)).rows,\n }),\n ),\n // {secret:SLACK_HOOK} in a webhook reads this. List what automations may use:\n // whoever writes an automation can send any secret named here to any URL.\n secrets: { SLACK_HOOK: env.SLACK_HOOK },\n sendEmail: (m) => mailer.send({ from: 'tracker@example.com', ...m }),\n onRun: (run) => {\n if (run.status !== 'ok') console.error('automation failed', run)\n },\n})\n```\n\nThen tell it about changes, in whichever way fits your app:\n\n- **Through your endpoint.** Pass its `audit` hook to `createKitHandlers`:\n every create, update and delete through the endpoint reaches it, with the\n record as stored. It compares with what it read last, so it needs a server\n that stays up between requests. A server that has just started reads its\n tables before the first write reaches the database: the hook has a `before`\n that `createKitHandlers` waits for. So each record of a pasted block is\n judged by what it held, and a record the write left as it was runs nothing.\n Columns the row carries that no field names, such as a tenant, are not\n compared.\n\n To keep an audit hook of your own, pass it as the second argument,\n `automations.audit('tasks', (entry) => log(entry))`. It is called first with\n each entry. A hook that wraps this one loses `before`; then the server reads\n its tables after the first write, and each record of that request goes by\n the fields the write named.\n\n ```ts\n // src/routes/api/[table]/+server.ts\n import { createKitHandlers, createSqlDataSource, type EntitySchema } from '@svgrid/enterprise'\n import { automations } from '$lib/server/automations'\n\n declare const schema: EntitySchema\n declare const source: ReturnType<typeof createSqlDataSource>\n\n export const { POST } = createKitHandlers({ schema, source, audit: automations.audit('tasks') })\n ```\n\n- **From the database.** A Supabase database webhook, or a Postgres trigger\n that posts the old and new row, hands over both sides of the change.\n Nothing has to stay in memory, so it suits serverless hosts too:\n\n ```ts\n // src/routes/api/automations/changes/+server.ts\n import { error } from '@sveltejs/kit'\n import { env } from '$env/dynamic/private'\n import { automations } from '$lib/server/automations'\n\n export async function POST({ request }: { request: Request }) {\n if (request.headers.get('x-webhook-secret') !== env.WEBHOOK_SECRET) error(401, 'No')\n // Supabase sends { type, table, record, old_record }.\n const change = await request.json()\n await automations.recordChanged(change.table, { before: change.old_record, after: change.record })\n return new Response('ok')\n }\n ```\n\n- **By reading the table again**, when all you know is that it changed:\n `automations.tableChanged('tasks')`.\n\nScheduled automations run on `tick()`. Call it once a minute: from a cron\njob your host runs against an endpoint, or a timer in a long-running server.\nTwo ticks in one minute run them once.\n\n```ts\n// src/routes/api/automations/tick/+server.ts: called by your host's cron every minute.\nimport { automations } from '$lib/server/automations'\n\nexport async function POST() {\n const runs = await automations.tick()\n return new Response(JSON.stringify({ ran: runs.length }))\n}\n```\n\nThe server's runs show in the dialog next to the page's, tagged Server,\nwhen the base can fetch them:\n\n```ts\n// src/routes/api/automations/runs/+server.ts\nimport { json } from '@sveltejs/kit'\nimport { automations } from '$lib/server/automations'\n\nexport function GET() {\n return json(automations.runs)\n}\n```\n\n```svelte\n<SvBase bind:tables editable serverRuns={() => fetch('/api/automations/runs').then((r) => r.json())} />\n```\n\n\n\nThe server ignores the echo of its own writes (the webhook the database\nsends for a change it made), so one change runs each automation once.\n\nThe [Postgres demo](./postgres.md) runs a server in the page, standing in\nfor yours: set a task to Blocked and its chat message shows under \"Sent by\nthe server\"; run `update tasks set status = 'Blocked' where id = 't9'` and it\nruns for that change too.\n\n## Every automation on the server\n\nAn app whose server hears of every change (people, its API, AI agents)\ncan run all of a base's automations there and none in the page:\n\n```svelte\n<SvBase\n bind:tables\n editable\n automationsOnServer\n serverRuns={() => fetch('/api/automations/runs').then((r) => r.json())}\n runAutomation={(automation, tableId, recordId) =>\n fetch('/api/automations/run', { method: 'POST', body: JSON.stringify({ automation: automation.id, table: tableId, record: recordId }) })}\n/>\n```\n\nWith `automationsOnServer` the dialog offers no \"Runs in\", every\nautomation saved through it is `runOn: 'server'`, and none runs in the page.\n`runAutomation` is \"Run now\" in the dialog and what a Button field does:\nthe page asks the server to run the automation on that record (or on none),\nthen reads the server's runs. A Promise that rejects shows its message in\nthe dialog, or as a notice for a button. Without `runAutomation` the dialog\nsays the automation runs on the server, and a Button field that only server\nautomations listen to does nothing in the page.\n\n## See also\n\n- [Keep a base in a database](./data.md)\n- [Field types](../fields.md): the view bar's filter, which conditions use\n"
|
|
5181
|
+
"markdown": "# Automations\n\nAn automation does something on its own when something happens to a\nrecord: a task set to Done ticks its Done box, a new request goes to Todo, a\nblocked task tells its owner, a button starts the work. Each table of a base\nhas its own, under \"Automations\" in the view bar.\n\n<div data-docs-demo=\"504-project-tracker\" data-height=\"680\"></div>\n\nIn the demo, set a task's Status to Done, press Start in the Kick off\ncolumn, or send the Request a task form, then open \"5 automations\" and look\nat Runs.\n\n\n\n## Add one\n\nOpen \"Automations\" in the view bar and press \"+ New automation\". The dialog\nhas three parts:\n\n- **When**: what sets it off.\n- **Only for records where**: a condition written with the view bar's\n filter, so it compares a select's option, a person, a linked record's name\n or \"within the past week\" the way the filter does. Leave it empty for\n every record.\n- **Do**: the actions, in order.\n\n\n\nEvery change is kept as you make it. \"Run now\" tries the automation on the\nrecord you pick, as if its trigger had happened.\n\n## When\n\n| Trigger | Runs |\n|---|---|\n| A record is created | When a record is added: \"+ Add row\", a form, a board lane, a calendar day, another automation. A record brought back by Restore or an undo of a delete is not created, and no rule runs for it |\n| A record changes | When a record is edited; pick fields to run only when one of them changes. A link made from the other table counts: adding a guest to an event from Guests changes the event's Guests field |\n| A record matches a condition | When a record starts to match the condition. It does not run again while the record keeps matching |\n| A form is sent | When a form view sends a record; pick the form, or any form of the table |\n| A button is pressed | When a Button field is pressed on a record |\n| At a scheduled time | Every day at 9, every Monday, every hour, or a cron expression: once for each record that matches the condition then, or once with no record |\n| A webhook is received | On the server: a request to the automation's own address, with no record. The body's values are `{webhook.name}` in the steps ([below](#a-webhook-starts-it)) |\n\nA paste or a fill that changes several cells of one record is one change to\nit. An undo or a redo is no change: it runs no automation.\n\n## Do\n\n| Action | What it does |\n|---|---|\n| Update the record | Sets fields of the record that set it off |\n| Create a record | Adds a record to any table of the base; \"Link it back\" fills a link field of the new record with the record that set it off |\n| Show a notice | A toast; `{Field name}` is that field of the record. `to` (user ids, or `field:<column id>` for the people a person field names) also sends it to their notifications when a server runs the automation |\n| Color the record while it matches | Colors the whole row, or some fields, for as long as the record matches the condition |\n| Call a webhook | POSTs the record (or a body you write) to a URL: a team chat, your API. Secrets as `{secret:NAME}`, read on the server only |\n| Send an email | To, subject and text with field names; sent by the [server](#on-the-server) |\n| Send a Slack, Teams or Google Chat message | A message to a channel through the address its chat app gave; only that app's own addresses ([below](#chat-messages)) |\n| Send a text message (SMS or Viber) | A text to phone numbers, or a phone field, by SMS or by Viber; sent by the [server](#on-the-server) through your provider ([below](#text-messages)) |\n| Find records and, for each, do | Steps run on every record of a table that matches a condition ([below](#if-and-find-records)) |\n| If a condition holds, do | Then steps when the record matches, Otherwise steps when it does not |\n| Ask AI | A prompt with field names; the answer goes into a field, and is `{ai}` in the next steps ([below](#ask-ai)) |\n| Run a script | JavaScript in a sandbox in the browser, as Airtable's automation scripts ([below](#run-a-script)) |\n| Your own actions | Anything the app adds with `registerAutomationAction` |\n\nA webhook's URL, headers and body name fields in braces, and secrets as\n`{secret:NAME}`; leave the body empty to send the record as JSON. A secret is\nnamed only by the automation: what a record holds is data, so `{secret:NAME}`\ntyped into a field goes out as that text.\n\nFrom the server a webhook does not call private or local addresses (`localhost`,\n`10.x`, `192.168.x`, `169.254.169.254`, a name that resolves to one, an IPv6 form\nthat wraps one) and does not follow redirects. On Node it connects to the\naddresses it checked, so a name cannot answer one way for the check and another\nfor the call; a name that does not resolve is not sent. A `fetch` of your own\npassed to `createAutomationServer` gets the check but not that pin, and neither\ndoes a runtime with no sockets of its own. For a webhook on your own network, set\n`allowInternalWebhooks: true` on `createAutomationServer`.\n\n\n\n\nValues are written as the field shows them:\n\n| Field | Write |\n|---|---|\n| Single or multiple select | The option's name: `Done`, `Bug, Risk` |\n| Person | The person's name: `Ana Ruiz` |\n| Checkbox | `true` or `false` |\n| Number | `42`; in a percent field, `100%` |\n| Date | `2026-11-01`, `today`, `today+7`, `today-1`, `now` |\n| Link | A record's name, several with commas, or `{record}` for the record that set it off |\n| Any text | Text with fields in braces: `{Task} follow-up` |\n| Any field | Nothing, to clear it |\n\n## If and Find records\n\n\"If a condition holds\" runs its Then steps when the record matches the\ncondition, and its Otherwise steps when it does not. With no record (a\nschedule, a webhook) only an \"If\" with no condition runs Then.\n\n\"Find records and, for each, do\" reads the records of a table that match a\ncondition, at most the number you set (100, up to 1,000), and runs its steps\non each: in them `{Field}` is the found record's field, `{trigger.Field}` the\nfield of the record that set the automation off, and `{found}` how many were\nfound. \"Update the record\" there updates the found record.\n\n```ts\n{ type: 'repeat', table: 'tasks', condition: statusIs('Todo'), limit: 50, actions: [\n { type: 'updateRecord', values: { note: 'Waiting on {trigger.Task}' } },\n] }\n{ type: 'if', condition: statusIs('Done'), then: [{ type: 'notify', message: 'Shipped' }], else: [] }\n```\n\nA step can be inside an \"If\" or a \"Find records\", and one of those inside\nanother, but no deeper. A script or a color is a step of the automation\nitself only.\n\n## Chat messages\n\nPaste the address the chat app gives for its channel:\n\n| App | Where the address comes from | What is sent |\n|---|---|---|\n| Slack | Apps, Incoming Webhooks, Add to a channel (`https://hooks.slack.com/...`) | `{ \"text\": ... }` |\n| Microsoft Teams | The channel's Workflows, \"Post to a channel when a webhook request is received\" (`*.logic.azure.com`, `*.powerplatform.com`) | An Adaptive Card with the text |\n| Google Chat | The space's Apps and integrations, Webhooks (`https://chat.googleapis.com/...`) | `{ \"text\": ... }` |\n\nThe text names fields in braces. A message goes only to its app's own https\naddresses, so a chat step cannot be pointed at any other server; an address\nmay name a secret (`{secret:SLACK_HOOK}`) on the server.\n\n## Text messages\n\n\"Send a text message\" sends a text to the numbers in **To**: written with their\ncountry code (`+359 88 123 4567`), or a phone field in braces (`{Phone}`),\nseveral apart with commas. The message names fields in braces. **Send by** is\nSMS, or Viber, which your provider may send as an SMS to a phone that is not on\nViber.\n\nThe browser has no account to send texts with, so this step runs on the\n[server](#on-the-server): give `createAutomationServer` a `sendText`, which gets\n`{ to, text, channel }` and calls your SMS or Viber provider.\n\n```ts\nimport { createAutomationServer, type BaseTable } from '@svgrid/enterprise/base'\n\n// Your tables, and your SMS or Viber provider's client.\ndeclare const tables: BaseTable[]\ndeclare const texts: { send: (m: { phone: string; text: string; viber: boolean }) => Promise<unknown> }\n\nexport const automations = createAutomationServer({\n tables,\n sendText: ({ to, text, channel }) => Promise.all(to.map((phone) => texts.send({ phone, text, viber: channel === 'viber' }))),\n})\n```\n\n## Ask AI\n\nThe prompt names fields in braces: `Write a two-line summary of {Name} for\nthe weekly report.` The answer goes into a text field of the record when you\npick one, and is `{ai}` in the steps after it. In the page the model is the\nrunner's `ai` option, on the server `createAutomationServer({ ai })`: a\nfunction from a prompt to the answer, behind which you call your model, with\nyour key on your server.\n\n```ts\ncreateAutomationServer({ tables, ai: async (prompt) => (await anthropic.messages.create({ model, max_tokens: 1000, messages: [{ role: 'user', content: prompt }] })).content[0].text })\n```\n\n## Run a script\n\nA script is JavaScript with Airtable's automation scripting objects:\n\n```js\nconst { recordId, Status } = input.config() // the record's fields, as text, by name\nconst tasks = base.getTable('Tasks')\nconst query = await tasks.selectRecordsAsync()\nfor (const r of query.records) {\n if (r.getCellValueAsString('Status') === 'Blocked') await tasks.updateRecordAsync(r.id, { Owner: 'Ana Ruiz' })\n}\noutput.set('blocked', query.records.length) // {script.blocked} in the next steps\n```\n\n`base.getTable(name)` has `selectRecordsAsync`, `updateRecordAsync`,\n`updateRecordsAsync`, `createRecordAsync`, `createRecordsAsync`,\n`deleteRecordAsync` and `deleteRecordsAsync`; a record has `id`, `name`,\n`getCellValue` and `getCellValueAsString`. Values are written as the field\nshows them, as in \"Update the record\". `console.log` lines are the step's\ndetail in the run history, and `fetch` calls https addresses that allow it.\n\nIt runs in the browser, in a sandboxed iframe with no access to the page, its\ncookies or its storage, for up to 30 seconds and 1,000 calls to the base\n(`runScript` from `@svgrid/enterprise/base` runs one with a bridge of your\nown). The browser runner runs it in the page of the person who made the\nchange; the server runner (`createAutomationServer`) cannot run JavaScript of\na person's and fails the step, saying so. An app can hand a server run's\nscript to that person's page instead, as Artavolo does: pass\n`scriptsInPage` to `<SvBaseAutomations>` so the editor does not warn.\n\n## A webhook starts it\n\n\"A webhook is received\" gives the automation an address of its own: the\neditor shows it (`webhookUrl` on `<SvBaseAutomations>` turns the token into\nyour endpoint's URL) and makes a new one on request. Your endpoint hands the\nrequest to the server runner:\n\n```ts\n// POST /hooks/[token]\nexport const POST = async ({ params, request }) => json(await automations.webhookReceived(params.token, await request.json()))\n```\n\nThe JSON body's values are `{webhook.name}` in the steps, `{webhook.order.id}`\ninside objects and `{webhook.items.0.sku}` in lists; `{webhook}` is the whole\nbody. The run has no record: \"Create a record\" with values from the body is\nthe usual first step. Anyone with the address can start the automation, so\nkeep it secret, and limit how often your endpoint takes a request.\n\n## Runs\n\nEvery run is listed under Runs, newest first, with what each action did and\nthe record it ran on. A failed action stops the run there and says why.\n\nEdit fields on more than 10,000 records asks first, and that question says how many\nruns the change can start in the page and how long they will likely take: at the rate\nruns went in this tab, or, before any did, from how long the server takes to answer. Untick\n\"Also run automations\" to make the change without them. The choice holds for that change\nonly. An automation that runs on the server is not counted and cannot be skipped from here.\n\nRuns in the page go one at a time, in the tab, after the change is saved. From 20 runs on, the top\nbar says how far they are and about how long is left, with a Stop button. Stop drops the runs\nnot started and says how many, and those do not run later. Runs left when the tab closes do\nnot happen either, so the browser asks before it closes. For a change of hundreds of thousands of records,\nrun the automation on the server (`runOn: 'server'`).\n\n\n\n## In code\n\nA table's automations are its `automations`, plain data you can store with\nthe rest of the table:\n\n```ts\nimport type { BaseAutomation } from '@svgrid/enterprise/base'\n\nconst statusIs = (value: string) => ({\n kind: 'fieldFilter' as const,\n conjunction: 'and' as const,\n conditions: [{ column: 'status', kind: 'select' as const, op: 'is' as const, value }],\n})\n\nexport const taskAutomations: BaseAutomation[] = [\n {\n id: 'done',\n name: 'Done closes the task',\n enabled: true,\n trigger: { type: 'recordUpdated', fields: ['status'] },\n condition: statusIs('Done'),\n actions: [\n { type: 'updateRecord', values: { done: 'true', progress: '100%' } },\n { type: 'notify', message: '{Task} is done', severity: 'success' },\n ],\n },\n {\n id: 'blocked',\n name: 'Open an issue for a blocked task',\n enabled: true,\n trigger: { type: 'recordMatches' },\n condition: statusIs('Blocked'),\n actions: [{ type: 'createRecord', table: 'issues', values: { title: 'Unblock {Task}', owner: '{Assignee}' }, linkField: 'task' }],\n },\n]\n```\n\n```svelte\n<script lang=\"ts\">\n import { SvToaster } from '@svgrid/grid'\n import { SvBase, enableBase, type BaseTable } from '@svgrid/enterprise/base'\n import { taskAutomations } from '$lib/automations'\n\n enableBase()\n let { tasks, issues }: { tasks: BaseTable; issues: BaseTable } = $props()\n let tables = $state.raw([{ ...tasks, automations: taskAutomations }, issues])\n</script>\n\n<SvBase bind:tables editable onTablesChange={(t) => console.log('save', t)} />\n<SvToaster />\n```\n\nAutomations edited in the dialog reach `onTablesChange` with the rest of the\ntable. Automations need `<SvBase tables>`; one table is a list of one.\nNotices show as a base's other notices do: see [Notices](./quick-start.md#notices).\n\n## Your own actions\n\n`registerAutomationAction` adds an action to the dialog's list. It runs in\nthe page, so call your own server for anything that needs a secret:\n\n```ts\nimport { registerAutomationAction } from '@svgrid/enterprise/base'\n\nregisterAutomationAction('post-to-chat', {\n label: 'Post to the team chat',\n run: async ({ record, text }) => {\n if (!record) return 'No record'\n const res = await fetch('/api/chat', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ message: `${text('Task')} needs a hand (${text('Assignee')})` }),\n })\n if (!res.ok) throw new Error(`Chat answered ${res.status}`)\n return 'Posted'\n },\n})\n```\n\nAn automation runs it with `{ type: 'run', action: 'post-to-chat' }`. What it\nreturns is the run's detail; what it throws is the run's error.\n\n## Where they run\n\nEach automation says where it runs, under \"Runs in\":\n\n- **This browser** (the default): in the page of the person who made the\n change, right away and once. A change that arrives from someone else\n through [realtime](./data.md#changes-made-elsewhere) does not run it again\n in your page. Scheduled ones run while the base is open.\n- **The server**: in your server, for every change to the database, whoever\n or whatever made it, with secrets and email. Set it up as below.\n\nEither way, a change an automation makes is an ordinary change: with a\n[source](./data.md), it is written to the database like an edit. What an\naction changes can set off other automations, up to four deep; past that the\nrun stops and says so, so two automations that answer each other cannot loop.\n\n## On the server\n\n\n\n`createAutomationServer` runs the automations set to \"The server\". It reads\nthe same tables, with the same automations, through sources of its own. It remembers\nthe last 10,000 records of a table it heard deleted: on a table with no `softDelete` an\nundo writes the record again, and only that memory tells it from a new one, so such an\nundo after a server restart reads as a creation.\nKeep the tables in one module both sides import, each side handing in its\nown way to reach the data:\n\n```ts\n// src/lib/tables.ts: the tables, for the browser and for the server.\nimport { baseSource, type BaseTable } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\nexport function trackerTables(source: (table: string) => ServerDataSource<Record<string, unknown>>): BaseTable[] {\n return [\n {\n id: 'tasks',\n name: 'Tasks',\n primaryField: 'name',\n data: [],\n columns: [\n { field: 'name', header: 'Task', fieldType: 'text' },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: [{ value: 'Todo' }, { value: 'Blocked' }, { value: 'Done' }] } },\n { field: 'owner_email', header: 'Owner email', fieldType: 'email' },\n ],\n automations: [\n {\n id: 'blocked',\n name: 'Tell the team about a blocked task',\n enabled: true,\n runOn: 'server',\n trigger: { type: 'recordMatches' },\n condition: { kind: 'fieldFilter', conjunction: 'and', conditions: [{ column: 'status', kind: 'select', op: 'is', value: 'Blocked' }] },\n actions: [\n { type: 'webhook', url: 'https://hooks.slack.com/services/{secret:SLACK_HOOK}', body: '{\"text\": \"{Task} is blocked\"}' },\n { type: 'email', to: '{Owner email}', subject: '{Task} is blocked', body: 'Someone marked {Task} as blocked.' },\n ],\n },\n ],\n source: baseSource(source('tasks')),\n },\n ]\n}\n```\n\nThe server side, in a SvelteKit app:\n\nThe code on this page is for SvelteKit 2. On SvelteKit 3,\n[these names differ](../../getting-started/sveltekit.md#on-sveltekit-3).\n\n```ts\n// src/lib/server/automations.ts\nimport pg from 'pg'\nimport { createAutomationServer } from '@svgrid/enterprise/base'\nimport { createSqlDataSource, type EntitySchema } from '@svgrid/enterprise'\nimport { env } from '$env/dynamic/private'\nimport { trackerTables } from '$lib/tables'\n\nconst pool = new pg.Pool({ connectionString: env.DATABASE_URL })\nconst schemas: Record<string, EntitySchema> = {\n tasks: {\n name: 'tasks',\n fields: [\n { field: 'id', type: 'text', primaryKey: true },\n { field: 'name', type: 'text' },\n { field: 'status', type: 'text' },\n { field: 'owner_email', type: 'text' },\n ],\n },\n}\n\n// Your mail provider's client.\ndeclare const mailer: { send: (m: { from: string; to: string[]; subject: string; text: string }) => Promise<unknown> }\n\nexport const automations = createAutomationServer({\n tables: trackerTables((table) =>\n createSqlDataSource({\n schema: schemas[table]!,\n table,\n dialect: { placeholders: '$', ilike: true },\n execute: async (sql, params) => (await pool.query(sql, params)).rows,\n }),\n ),\n // {secret:SLACK_HOOK} in a webhook reads this. List what automations may use:\n // whoever writes an automation can send any secret named here to any URL.\n secrets: { SLACK_HOOK: env.SLACK_HOOK },\n sendEmail: (m) => mailer.send({ from: 'tracker@example.com', ...m }),\n // \"Send a text message\": { to, text, channel } to your SMS or Viber provider.\n // sendText: (m) => texts.send(m),\n onRun: (run) => {\n if (run.status !== 'ok') console.error('automation failed', run)\n },\n})\n```\n\nThen tell it about changes, in whichever way fits your app:\n\n- **Through your endpoint.** Pass its `audit` hook to `createKitHandlers`:\n every create, update and delete through the endpoint reaches it, with the\n record as stored. It compares with what it read last, so it needs a server\n that stays up between requests. A server that has just started reads its\n tables before the first write reaches the database: the hook has a `before`\n that `createKitHandlers` waits for. So each record of a pasted block is\n judged by what it held, and a record the write left as it was runs nothing.\n Columns the row carries that no field names, such as a tenant, are not\n compared.\n\n To keep an audit hook of your own, pass it as the second argument,\n `automations.audit('tasks', (entry) => log(entry))`. It is called first with\n each entry. A hook that wraps this one loses `before`; then the server reads\n its tables after the first write, and each record of that request goes by\n the fields the write named.\n\n ```ts\n // src/routes/api/[table]/+server.ts\n import { createKitHandlers, createSqlDataSource, type EntitySchema } from '@svgrid/enterprise'\n import { automations } from '$lib/server/automations'\n\n declare const schema: EntitySchema\n declare const source: ReturnType<typeof createSqlDataSource>\n\n export const { POST } = createKitHandlers({ schema, source, audit: automations.audit('tasks') })\n ```\n\n- **From the database.** A Supabase database webhook, or a Postgres trigger\n that posts the old and new row, hands over both sides of the change.\n Nothing has to stay in memory, so it suits serverless hosts too:\n\n ```ts\n // src/routes/api/automations/changes/+server.ts\n import { error } from '@sveltejs/kit'\n import { env } from '$env/dynamic/private'\n import { automations } from '$lib/server/automations'\n\n export async function POST({ request }: { request: Request }) {\n if (request.headers.get('x-webhook-secret') !== env.WEBHOOK_SECRET) error(401, 'No')\n // Supabase sends { type, table, record, old_record }.\n const change = await request.json()\n await automations.recordChanged(change.table, { before: change.old_record, after: change.record })\n return new Response('ok')\n }\n ```\n\n- **By reading the table again**, when all you know is that it changed:\n `automations.tableChanged('tasks')`.\n\nScheduled automations run on `tick()`. Call it once a minute: from a cron\njob your host runs against an endpoint, or a timer in a long-running server.\nTwo ticks in one minute run them once.\n\n```ts\n// src/routes/api/automations/tick/+server.ts: called by your host's cron every minute.\nimport { automations } from '$lib/server/automations'\n\nexport async function POST() {\n const runs = await automations.tick()\n return new Response(JSON.stringify({ ran: runs.length }))\n}\n```\n\nThe server's runs show in the dialog next to the page's, tagged Server,\nwhen the base can fetch them:\n\n```ts\n// src/routes/api/automations/runs/+server.ts\nimport { json } from '@sveltejs/kit'\nimport { automations } from '$lib/server/automations'\n\nexport function GET() {\n return json(automations.runs)\n}\n```\n\n```svelte\n<SvBase bind:tables editable serverRuns={() => fetch('/api/automations/runs').then((r) => r.json())} />\n```\n\n\n\nThe server ignores the echo of its own writes (the webhook the database\nsends for a change it made), so one change runs each automation once.\n\nThe [Postgres demo](./postgres.md) runs a server in the page, standing in\nfor yours: set a task to Blocked and its chat message shows under \"Sent by\nthe server\"; run `update tasks set status = 'Blocked' where id = 't9'` and it\nruns for that change too.\n\n## Every automation on the server\n\nAn app whose server hears of every change (people, its API, AI agents)\ncan run all of a base's automations there and none in the page:\n\n```svelte\n<SvBase\n bind:tables\n editable\n automationsOnServer\n serverRuns={() => fetch('/api/automations/runs').then((r) => r.json())}\n runAutomation={(automation, tableId, recordId) =>\n fetch('/api/automations/run', { method: 'POST', body: JSON.stringify({ automation: automation.id, table: tableId, record: recordId }) })}\n/>\n```\n\nWith `automationsOnServer` the dialog offers no \"Runs in\", every\nautomation saved through it is `runOn: 'server'`, and none runs in the page.\n`runAutomation` is \"Run now\" in the dialog and what a Button field does:\nthe page asks the server to run the automation on that record (or on none),\nthen reads the server's runs. A Promise that rejects shows its message in\nthe dialog, or as a notice for a button. Without `runAutomation` the dialog\nsays the automation runs on the server, and a Button field that only server\nautomations listen to does nothing in the page.\n\n## A page of their own\n\nThe dialog shows one table's automations. `SvBaseAutomations` shows every\ntable's on a page, the way an app gives automations a section of their own:\n\n- **On the left**, every automation of the base, with its table, what sets it\n off and an on/off switch, \"+ Create automation\" and \"Run history\".\n- **In the middle**, the one picked as a flow of cards: its trigger, its\n condition, then its actions in order. A \"+\" between two cards adds an\n action there, and \"+ Add an action\" adds one at the end.\n- **On the right**, the settings of the card picked: the trigger and its\n table, the condition, or the action, with its order and Remove. Under them,\n Test on a record of the table, and Delete automation.\n\nChanging the trigger's table moves the automation to that table: its trigger\nstarts again there, and its condition and the fields its actions set go, as\nthey were the other table's fields.\n\n```svelte\n<script lang=\"ts\">\n import { SvBaseAutomations, enableBase, type BaseAutomation, type BaseTable } from '@svgrid/enterprise/base'\n\n enableBase()\n\n let { tables }: { tables: BaseTable[] } = $props()\n\n // The page hands back a table's whole list after each change: store it with the table.\n function changed(tableId: string, automations: BaseAutomation[]) {\n tables = tables.map((t) => (t.id === tableId ? { ...t, automations } : t))\n void fetch(`/api/tables/${tableId}/automations`, { method: 'PUT', body: JSON.stringify(automations) })\n }\n</script>\n\n<SvBaseAutomations\n {tables}\n onChange={changed}\n onServer\n serverRuns={() => fetch('/api/automations/runs').then((r) => r.json())}\n runOnServer={(automation, tableId, recordId) =>\n fetch('/api/automations/run', { method: 'POST', body: JSON.stringify({ automation: automation.id, table: tableId, record: recordId }) })}\n records={(tableId) => fetch(`/api/tables/${tableId}/rows?limit=200`).then((r) => r.json())}\n height=\"100%\"\n/>\n```\n\n| Prop | Type | What it does |\n|---|---|---|\n| `tables` | `BaseTable[]` | The base's tables, each with its `automations`. |\n| `onChange` | `(tableId, automations) => void` | A table's automations changed: its whole list, as `automations` on the table. |\n| `onServer` | `boolean` | Every automation runs on the server, as `automationsOnServer`: no \"Runs in\" to pick. |\n| `runOnServer` | `(automation, tableId, recordId) => Promise` | Test for an automation that runs on the server: your server runs it on that record (or on none). |\n| `serverRuns` | `() => Promise<AutomationRun[]>` | The server's runs, for Run history. |\n| `runner` | automation runner | Runs automations set to \"This browser\" when tested, and lists their runs. |\n| `records` | `(tableId) => Promise<Row[]>` | Records to test on, for a table whose rows are on a server. Without it, the table's `data`. |\n| `height` | `number \\| string` | The page's height (default `'100%'`). |\n\nThe page and the dialog edit the same `automations`. When both are on one\npage, keep one copy of the tables and hand each list the page gives back to\nthat copy, so a change in one is not undone by the other.\n\n## See also\n\n- [Keep a base in a database](./data.md)\n- [Field types](../fields.md): the view bar's filter, which conditions use\n"
|
|
5182
5182
|
},
|
|
5183
5183
|
{
|
|
5184
5184
|
"slug": "help/base/collaboration",
|
|
5185
5185
|
"path": "docs/help/base/collaboration.md",
|
|
5186
5186
|
"title": "People, comments and files",
|
|
5187
5187
|
"section": "SvGrid Base",
|
|
5188
|
-
"markdown": "# People, comments and files\n\nA tracker one person fills in needs a status column and little else. Once a\nteam uses it, people want to see who a task is assigned to, who changed the\nstatus and when, a thread of comments on the task, and the mockups attached\nto it, kept somewhere that survives a reload. This page adds those to the\ntask tracker from [Build a project tracker](./start.md).\n\n<div data-docs-demo=\"514-base-hiring-tracker\" data-height=\"680\"></div>\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\nIn the demo, double-click a candidate's card on the pipeline (or switch to\n\"All candidates\" and press Space on a row), change the Stage, leave a\ncomment, and watch the Activity column on the right of the record.\n\nThe base cannot know who your users are or where your files and comments\nlive. You tell it with four calls in the browser; the change log needs\nnothing:\n\n\n\nEach step below works on its own.\n\n## 1. List the people\n\nUser fields pick from one list of people that you hand to the base. A person\nis a `FieldUser`:\n\n```ts\nimport { setFieldUsers, type FieldUser } from '@svgrid/enterprise/base'\n\nconst team: FieldUser[] = [\n { id: 'u1', name: 'Ana Ruiz', email: 'ana@example.com', avatarUrl: 'https://cdn.example.com/ana.jpg' },\n { id: 'u2', name: 'Ben Okafor', email: 'ben@example.com' },\n { id: 'u3', name: 'Cleo Park', email: 'cleo@example.com' },\n]\n\n// In the browser only; step 2 shows where in SvelteKit.\nsetFieldUsers(team)\n```\n\nGive the tasks a `user` field for the owner and one with `multiple` for\nreviewers. The cell stores ids, never names, so renaming a person renames\nthem everywhere:\n\n```ts\nconst columns = [\n { field: 'task', header: 'Task', fieldType: 'text' },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: STATUS } },\n { field: 'assignee', header: 'Assignee', fieldType: 'user' },\n { field: 'reviewers', header: 'Reviewers', fieldType: 'user', fieldProps: { multiple: true } },\n]\n\nconst data = [\n { id: 't1', task: 'Write the brief', status: 'Todo', assignee: 'u1', reviewers: ['u2', 'u3'] },\n { id: 't2', task: 'Pick the fonts', status: 'In progress', assignee: 'u2', reviewers: [] },\n]\n```\n\nA cell draws an avatar and the name. With several people it overlaps up to\nfour avatars and writes the first name with a count: \"Ben Okafor +1\".\n`avatarUrl` is used when it is an `http(s):`, `blob:` or `data:image` URL;\nanything else, or no URL, draws the initials on a color worked out from the\nname, so a person keeps the same color on every page. An id that is not in\nthe list shows as the id itself.\n\nEditing a user cell opens a panel with a \"Find a person\" box and the people\nfrom the list, each with their avatar; typing filters them. If the list is\nempty the panel says \"No people (setFieldUsers)\". Text pasted or filled into\na user cell is matched against each person's id, name and email, ignoring\ncase; a multiple field takes them comma-separated and drops repeats. A name\nthat matches nobody is left out and the page says so, and with nobody left the\ncell keeps its value. With no list of people set the field takes what it is\ngiven. Copying a user cell writes the names, so a copy and paste between\nrecords keeps the people, and a copy in the same page keeps the very person when\ntwo share a name.\n`fieldProps.default` takes an id for new rows. The field reference has the\n[user field's properties](../fields.md#declare-columns-by-type).\n\nA Kanban view can stack by a single user field (`stackBy: 'assignee'`): one\nlane per person in the list, plus \"Uncategorized\" while some task has nobody.\nDragging a card to a lane reassigns the task through the grid's edit path,\nso it counts as an edit.\n\n## 2. Say who is signed in\n\n`setCurrentUser` names the person using the page. Several things read it:\n\n- `createdBy` fills new rows with their id, and `lastModifiedBy` writes it\n on every edit it watches.\n- Each comment is saved with their id as `by`.\n- Each change in a record's activity is noted with their id.\n- A filter condition with the value `'@me'` (`ME`) matches them.\n- Your own code can read it with `getCurrentUser()`.\n\nIn SvelteKit the session is on the server, so load the person and the team\nin a layout and hand both to the base in the browser:\n\n```ts\n// src/routes/(app)/+layout.server.ts\nimport { redirect } from '@sveltejs/kit'\nimport type { LayoutServerLoad } from './$types'\nimport { db } from '$lib/server/db'\n\nexport const load: LayoutServerLoad = async ({ locals }) => {\n if (!locals.user) redirect(303, '/login')\n const team = await db.query(\n 'select id, name, email, avatar_url as \"avatarUrl\" from users where team_id = $1 order by name',\n [locals.user.teamId],\n )\n return { me: { id: locals.user.id, name: locals.user.name }, team: team.rows }\n}\n```\n\n```svelte\n<!-- src/routes/(app)/+layout.svelte -->\n<script lang=\"ts\">\n import type { Snippet } from 'svelte'\n import { setCurrentUser, setFieldUsers, type FieldUser } from '@svgrid/enterprise/base'\n\n let { data, children }: { data: { me: FieldUser; team: FieldUser[] }; children: Snippet } = $props()\n\n // Again when the data changes: a sign-in as someone else.\n $effect.pre(() => {\n setFieldUsers(data.team)\n setCurrentUser(data.me)\n })\n</script>\n\n{@render children()}\n```\n\nThe four setters on this page write state shared by the whole module, so\ncall them in the browser only: an `$effect` as here (it does not run during\nserver rendering), `onMount`, or behind `browser` from `$app/environment`.\nCalled at the top of a component's `<script>`, they would also run on the\nserver and hand one request's team and user to the next. Cells and pickers\nread both values reactively, so the base can draw before they arrive. The signed-in person does not have to be in the team list for\ntheir name to show, but they only appear in the picker if they are.\n\nNow add who made each task and when, and give a new task to whoever adds it:\n\n```ts\nimport { getCurrentUser, type BaseTable } from '@svgrid/enterprise/base'\n\nconst tasks: BaseTable = {\n id: 'tasks',\n name: 'Tasks',\n primaryField: 'task',\n data,\n columns: [\n ...columns,\n { field: 'createdBy', header: 'Created by', fieldType: 'createdBy' },\n { field: 'createdAt', header: 'Created', fieldType: 'createdTime', fieldProps: { dateFormat: 'friendly' } },\n ],\n props: {\n rowAdder: { label: 'Add task', defaults: () => ({ status: 'Todo', assignee: getCurrentUser()?.id ?? null }) },\n },\n}\n```\n\nBoth fields are read-only. Every record the base makes gets the current user\nand the time: \"+ Add row\", a form, the record menu, \"+ Add a card\" on a\nKanban, a calendar day. Last modified fields start out the same way. Rows\nyou load keep whatever your database sends.\n\nOn sign-out, call `closeRecord()`, then `setCurrentUser(null)` and\n`setFieldUsers([])`.\n\n## 3. Add a \"My tasks\" view\n\nA filter condition on a user field compares it with a person's id. The value\n`'@me'` (exported as `ME`) stands for whoever is signed in when the filter\nruns, so one view works for everyone:\n\n```ts\nimport { ME, type FieldView } from '@svgrid/enterprise/base'\n\nconst views: FieldView[] = [\n {\n id: 'mine',\n name: 'My tasks',\n type: 'grid',\n state: {\n advancedFilter: {\n kind: 'fieldFilter',\n conjunction: 'or',\n conditions: [\n { column: 'assignee', kind: 'select', op: 'is', value: ME },\n { column: 'reviewers', kind: 'multi', op: 'hasAnyOf', value: [ME] },\n ],\n },\n },\n },\n { id: 'all', name: 'All tasks', type: 'grid' },\n]\n```\n\nIn the Filter panel the person picker lists \"Me\" first, so users can build\nthe same view themselves. The condition reads \"Assignee is me\".\n\nA single user field filters with the select operators (`is`, `isNot`,\n`isAnyOf`, `isNoneOf`), a multiple one with `hasAnyOf`, `hasAllOf`,\n`isExactly` and `hasNoneOf`; both also have `isEmpty` and `isNotEmpty`.\nCreated by and last modified by filter the same way, so \"Created by is me\"\nworks too. The [filter conditions](../fields.md#filter-conditions) table\nlists them all.\n\nThe view stores `'@me'`, not an id, so it can be saved with the other views\n(`onViewsChange`, or the `views` inside `onTablesChange`) and Ben sees his own\ntasks when he opens it.\n\n## 4. Open a record\n\n`expandRows` with `showRowNumbers` turns the row number into a checkbox and an\nexpand button:\n\n```svelte\n<SvBase bind:tables editable showRowNumbers expandRows onTablesChange={save} />\n```\n\nA record opens from the expand button, from Space on a selected cell (not a\ncheckbox cell, and only with `expandRows`), from \"Expand record\" in the\nright-click menu, from a gallery card, from a double click (or F2) on a\nKanban card, from a calendar event and from a Gantt task.\n\n\n\nThe record shows:\n\n- The primary field as the title.\n- Every field with its type icon and name, drawn as its cell draws it. A click\n opens the cell's own editor; the value is written through the grid's edit\n path, so undo, validation, `onCellValueChange` and last-modified fields work\n the same as in the cell. Read-only fields say \"read-only\".\n- Fields hidden in the view, folded under \"Show N hidden fields\" and marked\n \"hidden in the grid\". They are read-only here.\n- Activity on the right: changes and comments, oldest first, with \"just now\",\n \"5 minutes ago\", \"3 hours ago\" or the date. The box under them takes a\n comment; Ctrl+Enter (Cmd+Enter) or Comment sends it. A base without\n `editable` still takes comments. Text not sent stays with its record until the\n page reloads: stepping to the next record leaves it behind, and coming back finds it.\n Closing the record says so.\n- Previous and next buttons that step through the rows in the view's order,\n and \"3 of 12\".\n\nA record with comments shows how many by its row number (the pointer over the\nrow swaps the count for the checkbox and expand button) and as a badge on its\nKanban card. The card's badge opens the record with the comment box focused,\nas does \"Comment\" in the right-click menu of a row or a card.\n\nOn a narrow screen the activity moves under the fields. If an edit makes the\nrecord leave the view's filter, the record says \"This row is not in the\ngrid's view any more.\" and the footer \"Not in view (12 records)\". Previous\nand next still work: they move to the records that were before and after it.\n\nApp code opens a record with the grid api that `onApiReady` hands it:\n\n```ts\nimport { openRecord, closeRecord } from '@svgrid/enterprise/base'\n\nlet api: unknown\n// <SvBase ... onApiReady={(a) => (api = a)} />\n\nopenRecord({ api, rowId: 't1' })\nopenRecord({ api, rowId: 't1', focus: 'comment' }) // with the comment box focused\ncloseRecord(api)\n```\n\n`closeRecord()` closes whatever record is open, from anywhere: call it on\nsign-out or when the route changes. `closeRecord(api)` closes it only when it\nis open on that grid. A custom field type's `cell` component gets the grid\nas `ctrl` (with `row.id`), and `openRecord({ ctrl, rowId })` takes that too.\nA button field's `fieldProps.onClick` receives `{ row, rowId, columnId, api }`,\nso a button can open its own record.\n\n## 5. Keep comments in your backend\n\nWithout a store, comments live in memory and are gone on reload. In\n`<SvBase tables>` they are kept by table id and record id for the whole\npage, so two bases that show the same table, or a base mounted again, show\nthe same comments. Give unrelated bases on one page different table ids.\nWith one table (`data` and `columns`) they are kept per grid. A comment is\na `RecordComment`, and a store is two functions:\n\n```ts {nocheck}\nexport type RecordComment = { id: string; rowId: string; tableId?: string; text: string; at: number; by?: string; mentions?: string[] }\n\nexport type RecordCommentContext = { tableId?: string; api: unknown }\n\nexport type RecordCommentStore = {\n list: (rowId: string, api: unknown, context: RecordCommentContext) => ReadonlyArray<RecordComment>\n add: (rowId: string, comment: RecordComment, api: unknown, context: RecordCommentContext) => void\n update?: (rowId: string, comment: RecordComment, api: unknown, context: RecordCommentContext) => void\n remove?: (rowId: string, commentId: string, api: unknown, context: RecordCommentContext) => void\n onMention?: (event: MentionEvent) => void\n}\n```\n\n`rowId` is the record's id (its `id`, or the table's `getRowId`). In\n`<SvBase tables>`, `context.tableId` (and the comment's `tableId`) names the\ntable, so Tasks `1` and Milestones `1` are two records; with one table it is\nundefined. `at` is milliseconds since 1970, `by` the id of the person who was\nsigned in. The record view makes `id`, `at` and `by` itself and calls `add`.\nA comment's author sees Edit and Delete under it, with no one signed in that is\nwhoever is at the page. An edited comment shows \"(edited)\" and carries `editedAt`;\nsomeone newly mentioned in it hears of it once. A store without `update` or\n`remove` offers neither.\nA store written for `list(rowId, api)` and `add(rowId, comment, api)` still\nworks.\n\nBoth functions are synchronous, and `list` runs often: for the open record,\nand for every row the grid draws (with `expandRows`) and every Kanban card,\nto show the comment count. So fetch a whole table's comments once into reactive state and answer\nfrom it. Because `list` runs inside the base's reactive code, the counts and\nthe record draw again when the fetch lands:\n\n```ts\n// src/lib/comments.svelte.ts\nimport { browser } from '$app/environment'\nimport { toast } from '@svgrid/grid'\nimport { setRecordComments, type RecordComment, type RecordCommentStore } from '@svgrid/enterprise/base'\n\ntype ByRecord = Record<string, ReadonlyArray<RecordComment>>\n\n// Each table's comments by record id, fetched once per table.\nlet byTable = $state.raw<Record<string, ByRecord>>({})\nconst asked = new Set<string>()\n\nfunction put(table: string, rowId: string, list: ReadonlyArray<RecordComment>) {\n byTable = { ...byTable, [table]: { ...byTable[table], [rowId]: list } }\n}\n\nasync function load(table: string) {\n asked.add(table)\n const res = await fetch(`/api/comments?table=${encodeURIComponent(table)}`)\n if (!res.ok) return void asked.delete(table)\n const grouped: Record<string, RecordComment[]> = {}\n for (const c of (await res.json()) as RecordComment[]) (grouped[c.rowId] ??= []).push(c)\n byTable = { ...byTable, [table]: grouped }\n}\n\n// `update` and `remove` are optional: without them a comment stays as it was written.\nconst store: RecordCommentStore = {\n list(rowId, _api, { tableId = '' }) {\n if (!asked.has(tableId)) void load(tableId)\n return byTable[tableId]?.[rowId] ?? []\n },\n add(rowId, comment, _api, { tableId = '' }) {\n const mine = () => byTable[tableId]?.[rowId] ?? []\n // Shown at once; the server's copy replaces it, or it goes away again.\n put(tableId, rowId, [...mine(), comment])\n fetch('/api/comments', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ id: comment.id, tableId, rowId, text: comment.text }),\n })\n .then(async (res) => {\n if (!res.ok) throw new Error(`HTTP ${res.status}`)\n const saved = (await res.json()) as RecordComment\n put(tableId, rowId, mine().map((c) => (c.id === comment.id ? saved : c)))\n })\n .catch(() => {\n put(tableId, rowId, mine().filter((c) => c.id !== comment.id))\n toast.error('Your comment was not saved')\n })\n },\n}\n\n// On the server this cache would be shared by every request.\nif (browser) setRecordComments(store)\n```\n\nImport the file once, in the page that shows the base. The failure notice shows\nas a base's other notices do: see [Notices](./quick-start.md#notices).\n`setRecordComments(null)` goes back to memory. For a table with a very large\ndiscussion, have the endpoint return counts per record and fetch a record's\ncomments when it opens.\n\nThe endpoint takes the author and the time from the server, never from the\nrequest body:\n\n```ts\n// src/routes/api/comments/+server.ts\nimport { error, json } from '@sveltejs/kit'\nimport type { RequestHandler } from './$types'\nimport { db } from '$lib/server/db'\n\nexport const GET: RequestHandler = async ({ url, locals }) => {\n if (!locals.user) error(401, 'Sign in first')\n const tableId = url.searchParams.get('table') ?? ''\n // `at` is a bigint column; the cast hands it back as a number, not a string.\n const { rows } = await db.query(\n 'select id, table_id as \"tableId\", row_id as \"rowId\", text, at::float8 as at, author as \"by\" from comments where team_id = $1 and table_id = $2 order by at',\n [locals.user.teamId, tableId],\n )\n return json(rows)\n}\n\nexport const POST: RequestHandler = async ({ request, locals }) => {\n if (!locals.user) error(401, 'Sign in first')\n const body = (await request.json()) as { id?: unknown; tableId?: unknown; rowId?: unknown; text?: unknown }\n const text = String(body.text ?? '').trim().slice(0, 4000)\n if (typeof body.id !== 'string' || typeof body.rowId !== 'string' || !text) error(400, 'Bad comment')\n const tableId = typeof body.tableId === 'string' ? body.tableId : ''\n const comment = { id: body.id, tableId, rowId: body.rowId, text, at: Date.now(), by: locals.user.id }\n await db.query(\n 'insert into comments (id, team_id, table_id, row_id, text, at, author) values ($1, $2, $3, $4, $5, $6, $7)',\n [comment.id, locals.user.teamId, comment.tableId, comment.rowId, comment.text, comment.at, comment.by],\n )\n return json(comment, { status: 201 })\n}\n```\n\nThe activity names the author from the people list: a `by` that is not in\n`setFieldUsers` (and is not the current user) shows as \"Someone\", and a\ncomment with no `by` shows as \"You\". Keep people who left the team in the\nlist, or return their name from your own data.\n\nComments other people add show once the cache changes. To see them while the\nbase is open, call `put` from your realtime channel or a poll.\n\n### Mentions\n\nTyping `@` in the comment box lists the people from `setFieldUsers`, narrowed\nby the letters after it (the start of any word of a name, or of an email).\nUp and Down move through the list, Enter or Tab picks, Escape closes the\nlist and leaves the record open. An `@` inside a word, as in an email\naddress, does not open it.\n\nEscape in the comment box leaves the box and keeps the text. On a comment\nbeing changed it is Cancel. While a comment has text not sent, or is being\nchanged, Escape does not close the record and says why, a click outside does\nnothing, and the Close button still closes it. An empty box holds nothing open.\n\nA mention is kept in the comment's `text` as a token, and its id in\n`mentions`:\n\n```ts {nocheck}\n{ text: 'Numbers match. @[Ana Ruiz](u1) can you get legal to sign off?', mentions: ['u1'] }\n```\n\nThe record view draws the token as a chip with the person's avatar and their\nname from the people list today, so renaming someone renames their mentions.\nA person no longer in the list shows with the name written in the token. The\nrest of the text is drawn as text, never as HTML. `mentionText(text)` turns\nthe tokens back into `@Ana Ruiz` for an email or a chat message, and\n`mentionIds(text)` reads the ids, for a server that does not trust the\n`mentions` the browser sent.\n\nTo send notifications, pass `onMention` to `<SvBase>`, give the store an\n`onMention` hook, or call `setMentionHandler` (they work with the in-memory\ndefault too). Each runs once\nper comment that mentions someone, after `add`:\n\n```ts\nimport { mentionText, setMentionHandler, type MentionEvent } from '@svgrid/enterprise/base'\n\nsetMentionHandler((e: MentionEvent) => {\n // e.comment, e.mentioned (FieldUser[]), e.rowId, e.tableId, e.record, e.api\n const to = e.mentioned.filter((p) => p.id !== e.comment.by && p.email).map((p) => p.email)\n if (!to.length) return\n void fetch('/api/notify', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ to, record: e.record?.task, text: mentionText(e.comment.text) }),\n })\n})\n```\n\n`mentioned` lists each person once, in the order they first appear,\nincluding the author when they mention themselves. Someone not in\n`setFieldUsers` comes with the name written in the token. A hook that throws\nis logged, and the comment stays. When your comments endpoint already saves\n`mentions`, sending from the server, where the author is known, is the safer\nplace for the email.\n\n<div data-docs-demo=\"712-base-mentions\" data-height=\"640\"></div>\n\n## 6. Upload files\n\nAn attachment cell holds an array of `Attachment`: `id`, `url`, `name`,\n`type` (the MIME type), and optional `size`, `width`, `height` and\n`thumbnailUrl` (a smaller image the cell uses instead of `url`). The\n[attachments section](../fields.md#attachments) of the field reference has\nan example value.\n\nWithout an uploader, added files stay in the page as `blob:` URLs and are\ngone on reload. `setAttachmentUploader` sets the function every attachment\ncolumn uses. It gets the `File` and an `AttachmentUploadContext`: `row` (the\nrecord), `columnId`, a `signal` that aborts when the user removes the file\nor closes the dialog, and `onProgress(fraction)` with a value from 0 to 1.\nIt returns the attachment.\n\nThis one asks your server for a presigned URL and sends the bytes straight\nto object storage. It uses `XMLHttpRequest` because `fetch` reports no upload\nprogress:\n\n```ts\n// src/lib/uploads.ts\nimport { browser } from '$app/environment'\nimport { setAttachmentUploader, type AttachmentUploader } from '@svgrid/enterprise/base'\n\nconst upload: AttachmentUploader = async (file, { columnId, signal, onProgress }) => {\n const res = await fetch('/api/uploads', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ name: file.name, type: file.type, size: file.size, columnId }),\n signal,\n })\n if (!res.ok) throw new Error(res.status === 413 ? 'File is too large' : `Upload refused (${res.status})`)\n const { id, uploadUrl, fileUrl } = (await res.json()) as { id: string; uploadUrl: string; fileUrl: string }\n\n await new Promise<void>((resolve, reject) => {\n const xhr = new XMLHttpRequest()\n xhr.open('PUT', uploadUrl)\n xhr.setRequestHeader('content-type', file.type || 'application/octet-stream')\n xhr.upload.onprogress = (e) => e.lengthComputable && onProgress(e.loaded / e.total)\n xhr.onload = () => (xhr.status < 300 ? resolve() : reject(new Error(`Storage said ${xhr.status}`)))\n xhr.onerror = () => reject(new Error('Network error'))\n xhr.onabort = () => reject(new Error('Cancelled'))\n signal.addEventListener('abort', () => xhr.abort(), { once: true })\n xhr.send(file)\n })\n\n return { id, url: fileUrl, name: file.name, type: file.type, size: file.size }\n}\n\nif (browser) setAttachmentUploader(upload)\n```\n\nThe message of the error you throw is what the user reads on the failed tile,\nnext to Retry and Remove, so write it for them.\n\nThe server checks the user and the size, signs a URL for one key, and keeps\na row per file:\n\n```ts\n// src/routes/api/uploads/+server.ts\nimport { error, json } from '@sveltejs/kit'\nimport type { RequestHandler } from './$types'\nimport { db } from '$lib/server/db'\nimport { presignPut } from '$lib/server/storage'\n\nconst MAX = 25 * 1024 * 1024\n\nexport const POST: RequestHandler = async ({ request, locals, url }) => {\n if (!locals.user) error(401, 'Sign in first')\n const { name, type, size } = (await request.json()) as { name: string; type: string; size: number }\n if (!(size > 0 && size <= MAX)) error(413, 'File is too large')\n const id = crypto.randomUUID()\n const safe = String(name).replace(/[^\\w.-]+/g, '_')\n const key = `${locals.user.teamId}/${id}/${safe}`\n await db.query('insert into files (id, team_id, key, type) values ($1, $2, $3, $4)', [id, locals.user.teamId, key, type])\n return json({ id, uploadUrl: await presignPut(key, type), fileUrl: `${url.origin}/api/files/${id}/${safe}` })\n}\n```\n\n`fileUrl` points at your app, not at the bucket. A presigned read URL\nexpires, and a cell keeps its URL for as long as the record exists. Serve\n`/api/files/[id]/[name]` with a `GET` that checks the user and the team,\nlooks up the key by `id` and answers `redirect(303, signedReadUrl)`:\nthumbnails, the preview and Download all follow the redirect, and old records\nkeep working.\n\nThe URL is absolute and ends in the file name for the sake of copy and\npaste. Copying an attachment cell writes the files' URLs, and a paste\nattaches each `http(s)` URL it finds, taking the name from the path and the\ntype from its extension. A relative URL would show fine in the cell but be\ndropped on paste, and a URL without the name would come back as a file named\nby its id, an image drawn as a chip.\n\nThe column limits what the dialog takes with\n[`AttachmentFieldProps`](../fields.md#attachments): `accept` (as for\n`<input accept>`, such as `'image/*,.pdf'`), `maxFiles` (default 20) and\n`maxSize` in bytes (default 25 MB). A file over a limit is listed under the\ntiles with the reason, such as \"At most 1 file\", \"Larger than 2 MB\" or \"Not\nan accepted type\". A URL added in the dialog, and text pasted into a cell,\nare checked the same way, their type read from the extension: what fails is\ndropped, the rest is kept. The field editor offers `accept` and `maxFiles`;\n`maxSize` is set in code:\n\n```ts\nconst photo = {\n field: 'photo',\n header: 'Photo',\n fieldType: 'attachment',\n fieldProps: { accept: 'image/*', maxFiles: 1, maxSize: 2 * 1024 * 1024 },\n}\n```\n\n`fieldProps.upload` sets an uploader for one column instead of the app's.\n\n### What the user sees\n\nThe cell shows images as thumbnails and other files as chips with the\nextension and the name, as many as the column width holds, then \"+N\". Enter\nor a double click opens the dialog: add files with \"Add files\", by dropping,\nby pasting files, or by pasting a URL into \"or paste a URL\". Each upload is a\ntile with its percent and a bar; Done reads \"Uploading 2...\" and stays\ndisabled until they finish. Tiles can be dragged to reorder, or moved with\nAlt+Left and Alt+Right; Delete removes one. Cancel or Escape leaves the cell\nas it was and aborts the uploads still running.\n\nFiles can also be dropped straight on a cell. Each one uploads on its own,\nwith a thin progress bar along the bottom of the cell, and the ones that\nupload are written to the cell in one edit. A file over a limit shows in a\n\"Not added\" toast and an upload that throws in an \"Upload failed\" toast, each\nwith the file name and the reason; the others still land. The toasts need\nthe same `<SvToaster />` as the comment store. Uploads still running when the\ncell goes away (scrolled out, or the table switched) are aborted through\n`signal`.\n\nEnter on a tile, or a click on its picture, opens the preview: images inline,\nPDFs in an iframe, anything else as its name with a Download link. Left and\nRight step through the files. A PDF is framed only when the page could read its\nbytes and they are a PDF, so your storage has to allow the page's origin with CORS\n(`Access-Control-Allow-Origin`). A file it cannot read, or one that is not a PDF\nwhatever it calls itself, offers its Download link instead.\n\n## 7. Track who changed what\n\n`lastModifiedTime` and `lastModifiedBy` change on every edit to the record by\ndefault. With `watch: 'specific'` they change only when one of `watchFields`\ndoes, which turns them into \"status changed at\" and \"status changed by\":\n\n```ts\nconst stamps = [\n { field: 'updatedAt', header: 'Last modified', fieldType: 'lastModifiedTime', fieldProps: { dateFormat: 'friendly' } },\n { field: 'statusAt', header: 'Status changed', fieldType: 'lastModifiedTime', fieldProps: { watch: 'specific', watchFields: ['status'] } },\n { field: 'statusBy', header: 'Status changed by', fieldType: 'lastModifiedBy', fieldProps: { watch: 'specific', watchFields: ['status'] } },\n]\n```\n\n`watchFields` holds column ids: the column's `id`, or its `field` when it has\nnone. The time is an ISO string; the person is the current user's id. With\nnobody signed in, the time still moves and the person stays as it was. A\ncommit that leaves the value as it was (an editor opened and closed with\nEnter) is not an edit: nothing is stamped and `onCellValueChange` does not\nfire. An automation's `updateRecord` moves the time but not the person.\n\nThe stamp is written into the row before `onCellValueChange` fires, so the\nevent's `row` already holds it. If you save cell by cell, the event names\nonly the edited column: send the stamps along, or have the server write\n`updated_at` and `updated_by` from its own clock and session, which a\nbrowser cannot fake. With `onTablesChange` or a table `source` ([Keep a base\nin a database](./data.md)) the stamps travel with the rest of the row.\n\n## Protected fields\n\nA protected field takes edits from the people it lists. Everyone else sees\nit read-only, with a lock after its name that says who can edit it:\n\n```ts\nconst columns = [\n { field: 'priority', header: 'Priority', fieldType: 'singleSelect', fieldProps: { options: PRIORITY, editors: ['u1', 'u2'] } },\n { field: 'approved', header: 'Approved', fieldType: 'checkbox', fieldProps: { editors: [] } },\n]\n```\n\n`editors` holds user ids, matched against `setCurrentUser`. An empty list\nmeans nobody can edit the values, and with nobody signed in a protected\nfield is read-only. In the base, Edit field > Who can edit its values sets\nthe list: \"Only these people\" starts with the person setting it, so they do\nnot lock themselves out. `protectFields={false}` on `<SvBase>` takes that\nchoice away from someone your app does not let change it.\n\nWhat the protection covers, for the person in front of the page:\n\n- typing, pasting, the fill handle, Delete, and the record view;\n- a board stacked by the field (its cards do not move) and a calendar or\n timeline whose dates it holds (its events do not drag);\n- an import into the table, which does not offer the field as a target.\n\nA field's name, type and options stay editable: protection is about the\nvalues. A new record still takes its group's value, so \"+\" on a group still\nadds a record to it, and a form fills the fields its author put on it.\n\nWith roles of your own, pass a check in place of the lists. It decides for\nevery field of every base on the page; `defaultCanEditField` is the\n`editors` check, to fall back on:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, defaultCanEditField, type CanEditField } from '@svgrid/enterprise/base'\n let { tables, role } = $props()\n // Admins edit everything; everyone else follows each field's editors.\n const canEditField: CanEditField = (field, user) => role === 'admin' || defaultCanEditField(field, user)\n</script>\n\n<SvBase bind:tables {canEditField} protectFields={role === 'admin'} editable />\n```\n\nThe browser enforces this. A base whose records live in a database still\nneeds the server to refuse a write to a protected field, as it would any\nwrite the person is not allowed.\n\n<div data-docs-demo=\"710-base-personal-locked-views\" data-height=\"620\"></div>\n\n## Share a base read-only\n\nFor people who may look but not change anything, such as a client opening a\nshare link your app serves, pass `readOnly`:\n\n```svelte\n<SvBase {tables} readOnly sortable expandRows fieldMenu />\n```\n\nWhat it closes:\n\n- cells and the record view: no typing, pasting, fill handle, Delete or\n checkbox clicks, and buttons do not run automations;\n- the record menu keeps Expand record and Copy; the field menu keeps Filter,\n Group, Hide and Color rows by this field;\n- no \"+ Add row\", no \"+\" column, no \"+\" on a group, and the selection bar\n drops Edit fields and Delete;\n- a board's cards do not move and its lanes add none; a calendar's or\n timeline's events do not drag, and a day picked adds no record;\n- the tab bar has no table menu, no renaming, no Add table, no import, no\n trash, no undo, and no Download as SQL; it shows a \"View only\" badge;\n- no Automations button, and scheduled automations do not run in the page;\n- comments are read, and the box to write one is gone;\n- form views are not shared.\n\nViewers still switch tables and views, search, filter, sort, group, and open\nrecords with their activity. What they change in a view (a sort, a filter,\na new view) stays in the page while it is open, also across table switches,\nand never reaches `onTablesChange` or a table's `source`.\n\nA share on the same page as the editing base (a preview, or the demo below)\nshows the comments written in the editor, with their counts on rows and\ncards: comments are kept by table id and record id, not by base. The\nchanges in a record's activity and the unseen marks stay with the base that\nnoted them. On a separate page, the share sees the comments your\n`setRecordComments` store returns; in-page comments do not travel between\nbrowsers.\n\nAn object picks what the share shows. Every list is optional:\n\n```svelte\n<SvBase\n {tables}\n readOnly={{\n tables: ['projects', 'clients'],\n views: ['all', 'board'],\n hideFields: ['budget', 'clients.notes'],\n }}\n/>\n```\n\n`tables` and `views` are ids; a table none of whose listed views exists\nshows its first view. `hideFields` takes a column id, which hides it in\nevery table, or `tableId.columnId`. The primary field always shows. A hidden\nfield takes along every field that would show what it holds: the formulas\nthat read it, a rollup or lookup of it in another table, and the lookups,\nrollups and counts of a link to a table the share leaves out.\n\nHiding is for display. A page handed the whole base still holds the hidden\nvalues in memory, so for anything secret build the shared copy on the server\nwith `sharedTables(tables, share)`, which also takes the hidden fields'\nvalues out of the records, and send only that.\n\n<div data-docs-demo=\"717-base-read-only-share\" data-height=\"620\"></div>\n\n## The activity log\n\nEvery edit through the grid is noted for the record: a typed value, a paste,\na fill, a clear, a checkbox click, a card dragged to another lane, an edit in\nthe record view, files added in the dialog or dropped on a cell. Each note\nholds the time, the current user's id, the column, the new value and the one\nbefore it, and the record view writes it as \"Ana Ruiz changed Status\" over the\nold value and the new one as the cell shows them, or \"(cleared)\". Undo and redo\nare noted too, as \"You undid a change to Status\" and \"You redid a change to\nStatus\", so the log ends on what the record holds. A field an automation's `updateRecord` sets is\nnoted under the automation's name: \"Automation: Done ticks the box changed\nDone\".\n\nA change someone else made in the database, read in through a table's\n`realtime` source, is noted too, under the name in the record's\n`lastModifiedBy` field, with the value before it: \"Triage agent changed\nPriority\", Low → Urgent. Until the record is opened, its changed cells are\ntinted and its row number has a dot. See [Changes made\nelsewhere](./data.md#changes-made-elsewhere).\n\nBy default the log lives in memory and keeps the latest 50 changes of each\nrecord, for the 20,000 records of a table changed longest ago last: a bulk edit of a\nmillion records does not stay in the tab. In `<SvBase tables>` it is kept by base, table and record id, so it\nsurvives switching tabs; with one table it is kept per grid. Changes made by\nyour code replacing `tables` or `data` are not noted.\n\n### A history that lasts\n\nYour audit log already has every change. `setRecordHistory` lets the record\nview read it, and hands it each change made in the page to keep:\n\n```ts\nimport { setRecordHistory, type RecordChange } from '@svgrid/enterprise/base'\n\nsetRecordHistory({\n // Each time a record is opened. A promise is fine: the activity says\n // \"Loading the history...\" until it settles.\n list: async (rowId, { tableId }) => {\n const res = await fetch(`/api/history/${tableId}/${rowId}`)\n return (await res.json()) as RecordChange[]\n },\n // Each change made in this page, as it is made.\n add: (rowId, change, { tableId }) => {\n void fetch(`/api/history/${tableId}/${rowId}`, { method: 'POST', body: JSON.stringify(change) })\n },\n})\n```\n\nA change is `{ at, by, columnId, value, from? }` (`at` in milliseconds,\n`by` a user id from `setFieldUsers`), plus `automation` for a change an\nautomation made, `via` for a proposal someone accepted (\"CRM agent (accepted\nby Ana)\"), and `through` for a change a person made through an app as\nthemselves, an AI chat client say (\"Ana via Claude\"). The record view\nshows what `list` gave with this session's changes it does not have yet;\ngive back the `at` that `add` received, and a change shows once. A change\nmade elsewhere and read in through `realtime` is not passed to `add`:\nwhoever made it keeps it.\n\n`historyOf(ctrl, rowId)` gives a record's history as the record view shows\nit, for a panel of your own. `setRecordHistory(null)` goes back to memory.\n\n## The record menu\n\nRight-click a record in a base's grid:\n\n| Item | What it does |\n| --- | --- |\n| Expand record | Opens the record, with or without `expandRows` |\n| Comment | Opens the record with the comment box focused |\n| Insert record above, Insert record below | A new record beside this one with the values of the fields the view groups by, so it stays in the group; editing starts on its first field |\n| Duplicate record | A copy below, with lists copied; autonumber, created and last modified fields get fresh values |\n| Copy, Paste | The grid's own cell copy and paste |\n| Delete record | Asks \"Delete record?\" (\"Write the brief is deleted, and its links from other records go with it.\"), then removes it and fires `onRowsDelete` |\n\nWithout `editable`, only Expand record, Comment and Copy show. A new record\nfrom the menu is made the way \"+ Add row\" makes one: the `rowAdder` defaults,\na new id, the next autonumber, the current user in created by, and `onRowAdd`\nfired, so a table with a database writes it. The grid scrolls to it. A Kanban\ncard's right-click menu has Expand record and Comment, and with `editable`\n\"Move to\" a lane, Duplicate record and Delete record. Passing your own\n`contextMenu` to `SvBase` replaces the grid's menu.\n\n## Pitfalls\n\n- **No current user, no author.** Without `setCurrentUser`, new rows get\n `null` in created by, and an edit leaves last modified by as it was, so\n the field names whoever edited last while signed in.\n- **People are page-wide.** `setFieldUsers` and `setCurrentUser` set one list\n and one person for every base on the page. Two bases for two teams on one\n page share them.\n- **Records need real ids.** Comments and the activity are keyed by row id:\n each record's `id`, or `getRowId`. With one table a record without an `id`\n falls back to its index, so its comments move to another record when a row\n above it is deleted. In `<SvBase tables>` every record without an `id`\n shares the id `''`, and with it one thread. Give every record an id.\n- **Your store tells tables apart by id only.** In memory, each `<SvBase>`\n keeps its own comments and activity, even when two bases on one page use\n the same table ids. Your comment store gets the table id and nothing about\n the base: if two bases share one store and their table ids, key the store\n by something of your own as well. With `serverIds: true` a new record\n keeps the page's id until the table loads again; re-key its comments when\n the insert returns.\n- **`'@me'` is whoever runs the filter.** Before `setCurrentUser` it\n matches no one; the grid filters again once a user is set. In an\n automation's condition it is the person whose edit set it off, and on the\n server runner, where nobody is signed in, it matches no one.\n- **A URL's type is its extension.** Under `accept: 'image/*'` a URL with no\n extension is refused, and a URL's size is checked only when it is known.\n The browser checks are for the user; check types and sizes on the server\n too.\n- **Storage keeps what the cell drops.** Removing a file, Cancel after an\n upload finished, or deleting the record leaves the object in the bucket.\n Clean up on the server, for example files no record has pointed at for a\n day.\n- **`fieldProps.upload` does not survive JSON.** A function in a column is\n lost when you store columns in a database through `onTablesChange`. Use\n `setAttachmentUploader` and branch on `columnId` instead.\n\n## Next\n\n- [Linked records](./linked-records.md): tasks that point at milestones,\n people that point at teams, and the records that link back.\n- [Formulas](./formulas.md): fields worked out from other fields.\n- [Views](./views.md): grids, boards, calendars and galleries over the same\n records.\n- [Forms](./forms.md): let people outside the team add records.\n- [Your own field type](./custom-field-type.md): a cell of your own, with the\n grid's `ctrl` to open records from it.\n- [Automations](./automations.md): tell the assignee when a task is blocked.\n"
|
|
5188
|
+
"markdown": "# People, comments and files\n\nA tracker one person fills in needs a status column and little else. Once a\nteam uses it, people want to see who a task is assigned to, who changed the\nstatus and when, a thread of comments on the task, and the mockups attached\nto it, kept somewhere that survives a reload. This page adds those to the\ntask tracker from [Build a project tracker](./start.md).\n\n<div data-docs-demo=\"514-base-hiring-tracker\" data-height=\"680\"></div>\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\nIn the demo, double-click a candidate's card on the pipeline (or switch to\n\"All candidates\" and press Space on a row), change the Stage, leave a\ncomment, and watch the Activity column on the right of the record.\n\nThe base cannot know who your users are or where your files and comments\nlive. You tell it with four calls in the browser; the change log needs\nnothing:\n\n\n\nEach step below works on its own.\n\n## 1. List the people\n\nUser fields pick from one list of people that you hand to the base. A person\nis a `FieldUser`:\n\n```ts\nimport { setFieldUsers, type FieldUser } from '@svgrid/enterprise/base'\n\nconst team: FieldUser[] = [\n { id: 'u1', name: 'Ana Ruiz', email: 'ana@example.com', avatarUrl: 'https://cdn.example.com/ana.jpg' },\n { id: 'u2', name: 'Ben Okafor', email: 'ben@example.com' },\n { id: 'u3', name: 'Cleo Park', email: 'cleo@example.com' },\n]\n\n// In the browser only; step 2 shows where in SvelteKit.\nsetFieldUsers(team)\n```\n\nGive the tasks a `user` field for the owner and one with `multiple` for\nreviewers. The cell stores ids, never names, so renaming a person renames\nthem everywhere:\n\n```ts\nconst columns = [\n { field: 'task', header: 'Task', fieldType: 'text' },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: STATUS } },\n { field: 'assignee', header: 'Assignee', fieldType: 'user' },\n { field: 'reviewers', header: 'Reviewers', fieldType: 'user', fieldProps: { multiple: true } },\n]\n\nconst data = [\n { id: 't1', task: 'Write the brief', status: 'Todo', assignee: 'u1', reviewers: ['u2', 'u3'] },\n { id: 't2', task: 'Pick the fonts', status: 'In progress', assignee: 'u2', reviewers: [] },\n]\n```\n\nA cell draws an avatar and the name. With several people it overlaps up to\nfour avatars and writes the first name with a count: \"Ben Okafor +1\".\n`avatarUrl` is used when it is an `http(s):`, `blob:` or `data:image` URL;\nanything else, or no URL, draws the initials on a color worked out from the\nname, so a person keeps the same color on every page. An id that is not in\nthe list shows as the id itself.\n\nEditing a user cell opens a panel with a \"Find a person\" box and the people\nfrom the list, each with their avatar; typing filters them. If the list is\nempty the panel says \"No people (setFieldUsers)\". Text pasted or filled into\na user cell is matched against each person's id, name and email, ignoring\ncase; a multiple field takes them comma-separated and drops repeats. A name\nthat matches nobody is left out and the page says so, and with nobody left the\ncell keeps its value. With no list of people set the field takes what it is\ngiven. Copying a user cell writes the names, so a copy and paste between\nrecords keeps the people, and a copy in the same page keeps the very person when\ntwo share a name.\n`fieldProps.default` takes an id for new rows. The field reference has the\n[user field's properties](../fields.md#declare-columns-by-type).\n\nA Kanban view can stack by a single user field (`stackBy: 'assignee'`): one\nlane per person in the list, plus \"Uncategorized\" while some task has nobody.\nDragging a card to a lane reassigns the task through the grid's edit path,\nso it counts as an edit.\n\n## 2. Say who is signed in\n\n`setCurrentUser` names the person using the page. Several things read it:\n\n- `createdBy` fills new rows with their id, and `lastModifiedBy` writes it\n on every edit it watches.\n- Each comment is saved with their id as `by`.\n- Each change in a record's activity is noted with their id.\n- A filter condition with the value `'@me'` (`ME`) matches them.\n- Your own code can read it with `getCurrentUser()`.\n\nIn SvelteKit the session is on the server, so load the person and the team\nin a layout and hand both to the base in the browser:\n\n```ts\n// src/routes/(app)/+layout.server.ts\nimport { redirect } from '@sveltejs/kit'\nimport type { LayoutServerLoad } from './$types'\nimport { db } from '$lib/server/db'\n\nexport const load: LayoutServerLoad = async ({ locals }) => {\n if (!locals.user) redirect(303, '/login')\n const team = await db.query(\n 'select id, name, email, avatar_url as \"avatarUrl\" from users where team_id = $1 order by name',\n [locals.user.teamId],\n )\n return { me: { id: locals.user.id, name: locals.user.name }, team: team.rows }\n}\n```\n\n```svelte\n<!-- src/routes/(app)/+layout.svelte -->\n<script lang=\"ts\">\n import type { Snippet } from 'svelte'\n import { setCurrentUser, setFieldUsers, type FieldUser } from '@svgrid/enterprise/base'\n\n let { data, children }: { data: { me: FieldUser; team: FieldUser[] }; children: Snippet } = $props()\n\n // Again when the data changes: a sign-in as someone else.\n $effect.pre(() => {\n setFieldUsers(data.team)\n setCurrentUser(data.me)\n })\n</script>\n\n{@render children()}\n```\n\nThe four setters on this page write state shared by the whole module, so\ncall them in the browser only: an `$effect` as here (it does not run during\nserver rendering), `onMount`, or behind `browser` from `$app/environment`.\nCalled at the top of a component's `<script>`, they would also run on the\nserver and hand one request's team and user to the next. Cells and pickers\nread both values reactively, so the base can draw before they arrive. The signed-in person does not have to be in the team list for\ntheir name to show, but they only appear in the picker if they are.\n\nNow add who made each task and when, and give a new task to whoever adds it:\n\n```ts\nimport { getCurrentUser, type BaseTable } from '@svgrid/enterprise/base'\n\nconst tasks: BaseTable = {\n id: 'tasks',\n name: 'Tasks',\n primaryField: 'task',\n data,\n columns: [\n ...columns,\n { field: 'createdBy', header: 'Created by', fieldType: 'createdBy' },\n { field: 'createdAt', header: 'Created', fieldType: 'createdTime', fieldProps: { dateFormat: 'friendly' } },\n ],\n props: {\n rowAdder: { label: 'Add task', defaults: () => ({ status: 'Todo', assignee: getCurrentUser()?.id ?? null }) },\n },\n}\n```\n\nBoth fields are read-only. Every record the base makes gets the current user\nand the time: \"+ Add row\", a form, the record menu, \"+ Add a card\" on a\nKanban, a calendar day. Last modified fields start out the same way. Rows\nyou load keep whatever your database sends.\n\nOn sign-out, call `closeRecord()`, then `setCurrentUser(null)` and\n`setFieldUsers([])`.\n\n## 3. Add a \"My tasks\" view\n\nA filter condition on a user field compares it with a person's id. The value\n`'@me'` (exported as `ME`) stands for whoever is signed in when the filter\nruns, so one view works for everyone:\n\n```ts\nimport { ME, type FieldView } from '@svgrid/enterprise/base'\n\nconst views: FieldView[] = [\n {\n id: 'mine',\n name: 'My tasks',\n type: 'grid',\n state: {\n advancedFilter: {\n kind: 'fieldFilter',\n conjunction: 'or',\n conditions: [\n { column: 'assignee', kind: 'select', op: 'is', value: ME },\n { column: 'reviewers', kind: 'multi', op: 'hasAnyOf', value: [ME] },\n ],\n },\n },\n },\n { id: 'all', name: 'All tasks', type: 'grid' },\n]\n```\n\nIn the Filter panel the person picker lists \"Me\" first, so users can build\nthe same view themselves. The condition reads \"Assignee is me\".\n\nA single user field filters with the select operators (`is`, `isNot`,\n`isAnyOf`, `isNoneOf`), a multiple one with `hasAnyOf`, `hasAllOf`,\n`isExactly` and `hasNoneOf`; both also have `isEmpty` and `isNotEmpty`.\nCreated by and last modified by filter the same way, so \"Created by is me\"\nworks too. The [filter conditions](../fields.md#filter-conditions) table\nlists them all.\n\nThe view stores `'@me'`, not an id, so it can be saved with the other views\n(`onViewsChange`, or the `views` inside `onTablesChange`) and Ben sees his own\ntasks when he opens it.\n\n## 4. Open a record\n\n`expandRows` with `showRowNumbers` turns the row number into a checkbox and an\nexpand button:\n\n```svelte\n<SvBase bind:tables editable showRowNumbers expandRows onTablesChange={save} />\n```\n\nA record opens from the expand button, from Space on a selected cell (not a\ncheckbox cell, and only with `expandRows`), from \"Expand record\" in the\nright-click menu, from a gallery card, from a double click (or F2) on a\nKanban card, from a calendar event and from a Gantt task.\n\n\n\nThe record shows:\n\n- The primary field as the title.\n- Every field with its type icon and name, drawn as its cell draws it. A click\n opens the cell's own editor; the value is written through the grid's edit\n path, so undo, validation, `onCellValueChange` and last-modified fields work\n the same as in the cell. Read-only fields say \"read-only\".\n- Fields hidden in the view, folded under \"Show N hidden fields\" and marked\n \"hidden in the grid\". They are read-only here.\n- Activity on the right: changes and comments, oldest first, with \"just now\",\n \"5 minutes ago\", \"3 hours ago\" or the date. The box under them takes a\n comment; Ctrl+Enter (Cmd+Enter) or Comment sends it. A base without\n `editable` still takes comments. Text not sent stays with its record until the\n page reloads: stepping to the next record leaves it behind, and coming back finds it.\n Closing the record says so.\n- Previous and next buttons that step through the rows in the view's order,\n and \"3 of 12\".\n\nA record with comments shows how many by its row number (the pointer over the\nrow swaps the count for the checkbox and expand button) and as a badge on its\nKanban card. The card's badge opens the record with the comment box focused,\nas does \"Comment\" in the right-click menu of a row or a card.\n\nOn a narrow screen the activity moves under the fields. If an edit makes the\nrecord leave the view's filter, the record says \"This row is not in the\ngrid's view any more.\" and the footer \"Not in view (12 records)\". Previous\nand next still work: they move to the records that were before and after it.\n\nApp code opens a record with the grid api that `onApiReady` hands it:\n\n```ts\nimport { openRecord, closeRecord } from '@svgrid/enterprise/base'\n\nlet api: unknown\n// <SvBase ... onApiReady={(a) => (api = a)} />\n\nopenRecord({ api, rowId: 't1' })\nopenRecord({ api, rowId: 't1', focus: 'comment' }) // with the comment box focused\ncloseRecord(api)\n```\n\n`closeRecord()` closes whatever record is open, from anywhere: call it on\nsign-out or when the route changes. `closeRecord(api)` closes it only when it\nis open on that grid. A custom field type's `cell` component gets the grid\nas `ctrl` (with `row.id`), and `openRecord({ ctrl, rowId })` takes that too.\nA button field's `fieldProps.onClick` receives `{ row, rowId, columnId, api }`,\nso a button can open its own record.\n\n## 5. Keep comments in your backend\n\nWithout a store, comments live in memory and are gone on reload. In\n`<SvBase tables>` they are kept by table id and record id for the whole\npage, so two bases that show the same table, or a base mounted again, show\nthe same comments. Give unrelated bases on one page different table ids.\nWith one table (`data` and `columns`) they are kept per grid. A comment is\na `RecordComment`, and a store is two functions:\n\n```ts {nocheck}\nexport type RecordComment = { id: string; rowId: string; tableId?: string; text: string; at: number; by?: string; mentions?: string[]; files?: Attachment[]; internal?: boolean }\n\nexport type RecordCommentContext = { tableId?: string; api: unknown }\n\nexport type RecordCommentStore = {\n list: (rowId: string, api: unknown, context: RecordCommentContext) => ReadonlyArray<RecordComment>\n add: (rowId: string, comment: RecordComment, api: unknown, context: RecordCommentContext) => void\n update?: (rowId: string, comment: RecordComment, api: unknown, context: RecordCommentContext) => void\n remove?: (rowId: string, commentId: string, api: unknown, context: RecordCommentContext) => void\n onMention?: (event: MentionEvent) => void\n files?: boolean\n internal?: boolean\n}\n```\n\n### Files and internal notes\n\nA store with `files: true` gets an **Attach files** button in the comment\nbox. Each file goes through the app's attachment uploader\n(`setAttachmentUploader`, see [Upload files](#6-upload-files)) and the comment carries the\nresults in `files`; a comment of files alone has empty `text`. The record\nview lists them under the comment as links.\n\nA store with `internal: true` gets an **Internal note** box to tick. The\ncomment comes with `internal: true` and shows with an \"Internal\" mark. Hiding\nit from people outside the team (the clients of a portal, say) is the\nstore's job: `list` should leave it out for them, and the server should\nrefuse it from them.\n\n```ts\nimport { setRecordComments, type RecordComment } from '@svgrid/enterprise/base'\n\nconst kept: RecordComment[] = []\nsetRecordComments({ list: () => kept, add: (_rowId, comment) => kept.push(comment), files: true, internal: true })\n```\n\n### Saved replies\n\n`setCommentSnippets` gives the comment box a **Saved replies** button: a\nservice desk's standard answers. `list` is asked for the record open (its\ntable, its id and its values), so the app can fill each reply in from the\nrecord before it is shown (\"Hi Ana, we have your invoice\"). The person\nsearches, picks one, and its text (and its files) go into the box to change\nbefore sending; picking sends nothing. With `save`, the panel also offers\n**Save this text as a reply**, which hands the app the text and a name.\n\n```ts\nimport { setCommentSnippets } from '@svgrid/enterprise/base'\n\nsetCommentSnippets({\n list: async (tableId, { row }) => [\n { id: 'received', title: 'Invoice received', text: `Hi ${String(row.contact ?? '')}, we have your invoice and will pay it this week.` },\n ],\n save: async (tableId, { title, text }) => {\n await fetch('/replies', { method: 'POST', body: JSON.stringify({ tableId, title, text }) })\n },\n})\n```\n\n`rowId` is the record's id (its `id`, or the table's `getRowId`). In\n`<SvBase tables>`, `context.tableId` (and the comment's `tableId`) names the\ntable, so Tasks `1` and Milestones `1` are two records; with one table it is\nundefined. `at` is milliseconds since 1970, `by` the id of the person who was\nsigned in. The record view makes `id`, `at` and `by` itself and calls `add`.\nA comment's author sees Edit and Delete under it, with no one signed in that is\nwhoever is at the page. An edited comment shows \"(edited)\" and carries `editedAt`;\nsomeone newly mentioned in it hears of it once. A store without `update` or\n`remove` offers neither.\nA store written for `list(rowId, api)` and `add(rowId, comment, api)` still\nworks.\n\nBoth functions are synchronous, and `list` runs often: for the open record,\nand for every row the grid draws (with `expandRows`) and every Kanban card,\nto show the comment count. So fetch a whole table's comments once into reactive state and answer\nfrom it. Because `list` runs inside the base's reactive code, the counts and\nthe record draw again when the fetch lands:\n\n```ts\n// src/lib/comments.svelte.ts\nimport { browser } from '$app/environment'\nimport { toast } from '@svgrid/grid'\nimport { setRecordComments, type RecordComment, type RecordCommentStore } from '@svgrid/enterprise/base'\n\ntype ByRecord = Record<string, ReadonlyArray<RecordComment>>\n\n// Each table's comments by record id, fetched once per table.\nlet byTable = $state.raw<Record<string, ByRecord>>({})\nconst asked = new Set<string>()\n\nfunction put(table: string, rowId: string, list: ReadonlyArray<RecordComment>) {\n byTable = { ...byTable, [table]: { ...byTable[table], [rowId]: list } }\n}\n\nasync function load(table: string) {\n asked.add(table)\n const res = await fetch(`/api/comments?table=${encodeURIComponent(table)}`)\n if (!res.ok) return void asked.delete(table)\n const grouped: Record<string, RecordComment[]> = {}\n for (const c of (await res.json()) as RecordComment[]) (grouped[c.rowId] ??= []).push(c)\n byTable = { ...byTable, [table]: grouped }\n}\n\n// `update` and `remove` are optional: without them a comment stays as it was written.\nconst store: RecordCommentStore = {\n list(rowId, _api, { tableId = '' }) {\n if (!asked.has(tableId)) void load(tableId)\n return byTable[tableId]?.[rowId] ?? []\n },\n add(rowId, comment, _api, { tableId = '' }) {\n const mine = () => byTable[tableId]?.[rowId] ?? []\n // Shown at once; the server's copy replaces it, or it goes away again.\n put(tableId, rowId, [...mine(), comment])\n fetch('/api/comments', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ id: comment.id, tableId, rowId, text: comment.text }),\n })\n .then(async (res) => {\n if (!res.ok) throw new Error(`HTTP ${res.status}`)\n const saved = (await res.json()) as RecordComment\n put(tableId, rowId, mine().map((c) => (c.id === comment.id ? saved : c)))\n })\n .catch(() => {\n put(tableId, rowId, mine().filter((c) => c.id !== comment.id))\n toast.error('Your comment was not saved')\n })\n },\n}\n\n// On the server this cache would be shared by every request.\nif (browser) setRecordComments(store)\n```\n\nImport the file once, in the page that shows the base. The failure notice shows\nas a base's other notices do: see [Notices](./quick-start.md#notices).\n`setRecordComments(null)` goes back to memory. For a table with a very large\ndiscussion, have the endpoint return counts per record and fetch a record's\ncomments when it opens.\n\nThe endpoint takes the author and the time from the server, never from the\nrequest body:\n\n```ts\n// src/routes/api/comments/+server.ts\nimport { error, json } from '@sveltejs/kit'\nimport type { RequestHandler } from './$types'\nimport { db } from '$lib/server/db'\n\nexport const GET: RequestHandler = async ({ url, locals }) => {\n if (!locals.user) error(401, 'Sign in first')\n const tableId = url.searchParams.get('table') ?? ''\n // `at` is a bigint column; the cast hands it back as a number, not a string.\n const { rows } = await db.query(\n 'select id, table_id as \"tableId\", row_id as \"rowId\", text, at::float8 as at, author as \"by\" from comments where team_id = $1 and table_id = $2 order by at',\n [locals.user.teamId, tableId],\n )\n return json(rows)\n}\n\nexport const POST: RequestHandler = async ({ request, locals }) => {\n if (!locals.user) error(401, 'Sign in first')\n const body = (await request.json()) as { id?: unknown; tableId?: unknown; rowId?: unknown; text?: unknown }\n const text = String(body.text ?? '').trim().slice(0, 4000)\n if (typeof body.id !== 'string' || typeof body.rowId !== 'string' || !text) error(400, 'Bad comment')\n const tableId = typeof body.tableId === 'string' ? body.tableId : ''\n const comment = { id: body.id, tableId, rowId: body.rowId, text, at: Date.now(), by: locals.user.id }\n await db.query(\n 'insert into comments (id, team_id, table_id, row_id, text, at, author) values ($1, $2, $3, $4, $5, $6, $7)',\n [comment.id, locals.user.teamId, comment.tableId, comment.rowId, comment.text, comment.at, comment.by],\n )\n return json(comment, { status: 201 })\n}\n```\n\nThe activity names the author from the people list: a `by` that is not in\n`setFieldUsers` (and is not the current user) shows as \"Someone\", and a\ncomment with no `by` shows as \"You\". Keep people who left the team in the\nlist, or return their name from your own data.\n\nComments other people add show once the cache changes. To see them while the\nbase is open, call `put` from your realtime channel or a poll.\n\n### Mentions\n\nTyping `@` in the comment box lists the people from `setFieldUsers`, narrowed\nby the letters after it (the start of any word of a name, or of an email).\nUp and Down move through the list, Enter or Tab picks, Escape closes the\nlist and leaves the record open. An `@` inside a word, as in an email\naddress, does not open it.\n\nEscape in the comment box leaves the box and keeps the text. On a comment\nbeing changed it is Cancel. While a comment has text not sent, or is being\nchanged, Escape does not close the record and says why, a click outside does\nnothing, and the Close button still closes it. An empty box holds nothing open.\n\nA mention is kept in the comment's `text` as a token, and its id in\n`mentions`:\n\n```ts {nocheck}\n{ text: 'Numbers match. @[Ana Ruiz](u1) can you get legal to sign off?', mentions: ['u1'] }\n```\n\nThe record view draws the token as a chip with the person's avatar and their\nname from the people list today, so renaming someone renames their mentions.\nA person no longer in the list shows with the name written in the token. The\nrest of the text is drawn as text, never as HTML. `mentionText(text)` turns\nthe tokens back into `@Ana Ruiz` for an email or a chat message, and\n`mentionIds(text)` reads the ids, for a server that does not trust the\n`mentions` the browser sent.\n\nTo send notifications, pass `onMention` to `<SvBase>`, give the store an\n`onMention` hook, or call `setMentionHandler` (they work with the in-memory\ndefault too). Each runs once\nper comment that mentions someone, after `add`:\n\n```ts\nimport { mentionText, setMentionHandler, type MentionEvent } from '@svgrid/enterprise/base'\n\nsetMentionHandler((e: MentionEvent) => {\n // e.comment, e.mentioned (FieldUser[]), e.rowId, e.tableId, e.record, e.api\n const to = e.mentioned.filter((p) => p.id !== e.comment.by && p.email).map((p) => p.email)\n if (!to.length) return\n void fetch('/api/notify', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ to, record: e.record?.task, text: mentionText(e.comment.text) }),\n })\n})\n```\n\n`mentioned` lists each person once, in the order they first appear,\nincluding the author when they mention themselves. Someone not in\n`setFieldUsers` comes with the name written in the token. A hook that throws\nis logged, and the comment stays. When your comments endpoint already saves\n`mentions`, sending from the server, where the author is known, is the safer\nplace for the email.\n\n<div data-docs-demo=\"712-base-mentions\" data-height=\"640\"></div>\n\n## 6. Upload files\n\nAn attachment cell holds an array of `Attachment`: `id`, `url`, `name`,\n`type` (the MIME type), and optional `size`, `width`, `height` and\n`thumbnailUrl` (a smaller image the cell uses instead of `url`). The\n[attachments section](../fields.md#attachments) of the field reference has\nan example value.\n\nWithout an uploader, added files stay in the page as `blob:` URLs and are\ngone on reload. `setAttachmentUploader` sets the function every attachment\ncolumn uses. It gets the `File` and an `AttachmentUploadContext`: `row` (the\nrecord), `columnId`, a `signal` that aborts when the user removes the file\nor closes the dialog, and `onProgress(fraction)` with a value from 0 to 1.\nIt returns the attachment.\n\nThis one asks your server for a presigned URL and sends the bytes straight\nto object storage. It uses `XMLHttpRequest` because `fetch` reports no upload\nprogress:\n\n```ts\n// src/lib/uploads.ts\nimport { browser } from '$app/environment'\nimport { setAttachmentUploader, type AttachmentUploader } from '@svgrid/enterprise/base'\n\nconst upload: AttachmentUploader = async (file, { columnId, signal, onProgress }) => {\n const res = await fetch('/api/uploads', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify({ name: file.name, type: file.type, size: file.size, columnId }),\n signal,\n })\n if (!res.ok) throw new Error(res.status === 413 ? 'File is too large' : `Upload refused (${res.status})`)\n const { id, uploadUrl, fileUrl } = (await res.json()) as { id: string; uploadUrl: string; fileUrl: string }\n\n await new Promise<void>((resolve, reject) => {\n const xhr = new XMLHttpRequest()\n xhr.open('PUT', uploadUrl)\n xhr.setRequestHeader('content-type', file.type || 'application/octet-stream')\n xhr.upload.onprogress = (e) => e.lengthComputable && onProgress(e.loaded / e.total)\n xhr.onload = () => (xhr.status < 300 ? resolve() : reject(new Error(`Storage said ${xhr.status}`)))\n xhr.onerror = () => reject(new Error('Network error'))\n xhr.onabort = () => reject(new Error('Cancelled'))\n signal.addEventListener('abort', () => xhr.abort(), { once: true })\n xhr.send(file)\n })\n\n return { id, url: fileUrl, name: file.name, type: file.type, size: file.size }\n}\n\nif (browser) setAttachmentUploader(upload)\n```\n\nThe message of the error you throw is what the user reads on the failed tile,\nnext to Retry and Remove, so write it for them.\n\nThe server checks the user and the size, signs a URL for one key, and keeps\na row per file:\n\n```ts\n// src/routes/api/uploads/+server.ts\nimport { error, json } from '@sveltejs/kit'\nimport type { RequestHandler } from './$types'\nimport { db } from '$lib/server/db'\nimport { presignPut } from '$lib/server/storage'\n\nconst MAX = 25 * 1024 * 1024\n\nexport const POST: RequestHandler = async ({ request, locals, url }) => {\n if (!locals.user) error(401, 'Sign in first')\n const { name, type, size } = (await request.json()) as { name: string; type: string; size: number }\n if (!(size > 0 && size <= MAX)) error(413, 'File is too large')\n const id = crypto.randomUUID()\n const safe = String(name).replace(/[^\\w.-]+/g, '_')\n const key = `${locals.user.teamId}/${id}/${safe}`\n await db.query('insert into files (id, team_id, key, type) values ($1, $2, $3, $4)', [id, locals.user.teamId, key, type])\n return json({ id, uploadUrl: await presignPut(key, type), fileUrl: `${url.origin}/api/files/${id}/${safe}` })\n}\n```\n\n`fileUrl` points at your app, not at the bucket. A presigned read URL\nexpires, and a cell keeps its URL for as long as the record exists. Serve\n`/api/files/[id]/[name]` with a `GET` that checks the user and the team,\nlooks up the key by `id` and answers `redirect(303, signedReadUrl)`:\nthumbnails, the preview and Download all follow the redirect, and old records\nkeep working.\n\nThe URL is absolute and ends in the file name for the sake of copy and\npaste. Copying an attachment cell writes the files' URLs, and a paste\nattaches each `http(s)` URL it finds, taking the name from the path and the\ntype from its extension. A relative URL would show fine in the cell but be\ndropped on paste, and a URL without the name would come back as a file named\nby its id, an image drawn as a chip.\n\nThe column limits what the dialog takes with\n[`AttachmentFieldProps`](../fields.md#attachments): `accept` (as for\n`<input accept>`, such as `'image/*,.pdf'`), `maxFiles` (default 20) and\n`maxSize` in bytes (default 25 MB). A file over a limit is listed under the\ntiles with the reason, such as \"At most 1 file\", \"Larger than 2 MB\" or \"Not\nan accepted type\". A URL added in the dialog, and text pasted into a cell,\nare checked the same way, their type read from the extension: what fails is\ndropped, the rest is kept. The field editor offers `accept` and `maxFiles`;\n`maxSize` is set in code:\n\n```ts\nconst photo = {\n field: 'photo',\n header: 'Photo',\n fieldType: 'attachment',\n fieldProps: { accept: 'image/*', maxFiles: 1, maxSize: 2 * 1024 * 1024 },\n}\n```\n\n`fieldProps.upload` sets an uploader for one column instead of the app's.\n\n### What the user sees\n\nThe cell shows images as thumbnails and other files as chips with the\nextension and the name, as many as the column width holds, then \"+N\". Enter\nor a double click opens the dialog: add files with \"Add files\", by dropping,\nby pasting files, or by pasting a URL into \"or paste a URL\". Each upload is a\ntile with its percent and a bar; Done reads \"Uploading 2...\" and stays\ndisabled until they finish. Tiles can be dragged to reorder, or moved with\nAlt+Left and Alt+Right; Delete removes one. Cancel or Escape leaves the cell\nas it was and aborts the uploads still running.\n\nFiles can also be dropped straight on a cell. Each one uploads on its own,\nwith a thin progress bar along the bottom of the cell, and the ones that\nupload are written to the cell in one edit. A file over a limit shows in a\n\"Not added\" toast and an upload that throws in an \"Upload failed\" toast, each\nwith the file name and the reason; the others still land. The toasts need\nthe same `<SvToaster />` as the comment store. Uploads still running when the\ncell goes away (scrolled out, or the table switched) are aborted through\n`signal`.\n\nEnter on a tile, or a click on its picture, opens the preview: images inline,\nPDFs in an iframe, anything else as its name with a Download link. Left and\nRight step through the files. A PDF is framed only when the page could read its\nbytes and they are a PDF, so your storage has to allow the page's origin with CORS\n(`Access-Control-Allow-Origin`). A file it cannot read, or one that is not a PDF\nwhatever it calls itself, offers its Download link instead.\n\n## 7. Track who changed what\n\n`lastModifiedTime` and `lastModifiedBy` change on every edit to the record by\ndefault. With `watch: 'specific'` they change only when one of `watchFields`\ndoes, which turns them into \"status changed at\" and \"status changed by\":\n\n```ts\nconst stamps = [\n { field: 'updatedAt', header: 'Last modified', fieldType: 'lastModifiedTime', fieldProps: { dateFormat: 'friendly' } },\n { field: 'statusAt', header: 'Status changed', fieldType: 'lastModifiedTime', fieldProps: { watch: 'specific', watchFields: ['status'] } },\n { field: 'statusBy', header: 'Status changed by', fieldType: 'lastModifiedBy', fieldProps: { watch: 'specific', watchFields: ['status'] } },\n]\n```\n\n`watchFields` holds column ids: the column's `id`, or its `field` when it has\nnone. The time is an ISO string; the person is the current user's id. With\nnobody signed in, the time still moves and the person stays as it was. A\ncommit that leaves the value as it was (an editor opened and closed with\nEnter) is not an edit: nothing is stamped and `onCellValueChange` does not\nfire. An automation's `updateRecord` moves the time but not the person.\n\nThe stamp is written into the row before `onCellValueChange` fires, so the\nevent's `row` already holds it. If you save cell by cell, the event names\nonly the edited column: send the stamps along, or have the server write\n`updated_at` and `updated_by` from its own clock and session, which a\nbrowser cannot fake. With `onTablesChange` or a table `source` ([Keep a base\nin a database](./data.md)) the stamps travel with the rest of the row.\n\n## Protected fields\n\nA protected field takes edits from the people it lists. Everyone else sees\nit read-only, with a lock after its name that says who can edit it:\n\n```ts\nconst columns = [\n { field: 'priority', header: 'Priority', fieldType: 'singleSelect', fieldProps: { options: PRIORITY, editors: ['u1', 'u2'] } },\n { field: 'approved', header: 'Approved', fieldType: 'checkbox', fieldProps: { editors: [] } },\n]\n```\n\n`editors` holds user ids, matched against `setCurrentUser`. An empty list\nmeans nobody can edit the values, and with nobody signed in a protected\nfield is read-only. In the base, Edit field > Who can edit its values sets\nthe list: \"Only these people\" starts with the person setting it, so they do\nnot lock themselves out. `protectFields={false}` on `<SvBase>` takes that\nchoice away from someone your app does not let change it.\n\nWhat the protection covers, for the person in front of the page:\n\n- typing, pasting, the fill handle, Delete, and the record view;\n- a board stacked by the field (its cards do not move) and a calendar or\n timeline whose dates it holds (its events do not drag);\n- an import into the table, which does not offer the field as a target.\n\nA field's name, type and options stay editable: protection is about the\nvalues. A new record still takes its group's value, so \"+\" on a group still\nadds a record to it, and a form fills the fields its author put on it.\n\nWith roles of your own, pass a check in place of the lists. It decides for\nevery field of every base on the page; `defaultCanEditField` is the\n`editors` check, to fall back on:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, defaultCanEditField, type CanEditField } from '@svgrid/enterprise/base'\n let { tables, role } = $props()\n // Admins edit everything; everyone else follows each field's editors.\n const canEditField: CanEditField = (field, user) => role === 'admin' || defaultCanEditField(field, user)\n</script>\n\n<SvBase bind:tables {canEditField} protectFields={role === 'admin'} editable />\n```\n\nThe browser enforces this. A base whose records live in a database still\nneeds the server to refuse a write to a protected field, as it would any\nwrite the person is not allowed.\n\n<div data-docs-demo=\"710-base-personal-locked-views\" data-height=\"620\"></div>\n\n## Share a base read-only\n\nFor people who may look but not change anything, such as a client opening a\nshare link your app serves, pass `readOnly`:\n\n```svelte\n<SvBase {tables} readOnly sortable expandRows fieldMenu />\n```\n\nWhat it closes:\n\n- cells and the record view: no typing, pasting, fill handle, Delete or\n checkbox clicks, and buttons do not run automations;\n- the record menu keeps Expand record and Copy; the field menu keeps Filter,\n Group, Hide and Color rows by this field;\n- no \"+ Add row\", no \"+\" column, no \"+\" on a group, and the selection bar\n drops Edit fields and Delete;\n- a board's cards do not move and its lanes add none; a calendar's or\n timeline's events do not drag, and a day picked adds no record;\n- the tab bar has no table menu, no renaming, no Add table, no import, no\n trash, no undo, and no Download as SQL; it shows a \"View only\" badge;\n- no Automations button, and scheduled automations do not run in the page;\n- comments are read, and the box to write one is gone;\n- form views are not shared.\n\nViewers still switch tables and views, search, filter, sort, group, and open\nrecords with their activity. What they change in a view (a sort, a filter,\na new view) stays in the page while it is open, also across table switches,\nand never reaches `onTablesChange` or a table's `source`.\n\nA share on the same page as the editing base (a preview, or the demo below)\nshows the comments written in the editor, with their counts on rows and\ncards: comments are kept by table id and record id, not by base. The\nchanges in a record's activity and the unseen marks stay with the base that\nnoted them. On a separate page, the share sees the comments your\n`setRecordComments` store returns; in-page comments do not travel between\nbrowsers.\n\nAn object picks what the share shows. Every list is optional:\n\n```svelte\n<SvBase\n {tables}\n readOnly={{\n tables: ['projects', 'clients'],\n views: ['all', 'board'],\n hideFields: ['budget', 'clients.notes'],\n }}\n/>\n```\n\n`tables` and `views` are ids; a table none of whose listed views exists\nshows its first view. `hideFields` takes a column id, which hides it in\nevery table, or `tableId.columnId`. The primary field always shows. A hidden\nfield takes along every field that would show what it holds: the formulas\nthat read it, a rollup or lookup of it in another table, and the lookups,\nrollups and counts of a link to a table the share leaves out.\n\nHiding is for display. A page handed the whole base still holds the hidden\nvalues in memory, so for anything secret build the shared copy on the server\nwith `sharedTables(tables, share)`, which also takes the hidden fields'\nvalues out of the records, and send only that.\n\n<div data-docs-demo=\"717-base-read-only-share\" data-height=\"620\"></div>\n\n## The activity log\n\nEvery edit through the grid is noted for the record: a typed value, a paste,\na fill, a clear, a checkbox click, a card dragged to another lane, an edit in\nthe record view, files added in the dialog or dropped on a cell. Each note\nholds the time, the current user's id, the column, the new value and the one\nbefore it, and the record view writes it as \"Ana Ruiz changed Status\" over the\nold value and the new one as the cell shows them, or \"(cleared)\". Undo and redo\nare noted too, as \"You undid a change to Status\" and \"You redid a change to\nStatus\", so the log ends on what the record holds. A field an automation's `updateRecord` sets is\nnoted under the automation's name: \"Automation: Done ticks the box changed\nDone\".\n\nA change someone else made in the database, read in through a table's\n`realtime` source, is noted too, under the name in the record's\n`lastModifiedBy` field, with the value before it: \"Triage agent changed\nPriority\", Low → Urgent. Until the record is opened, its changed cells are\ntinted and its row number has a dot. See [Changes made\nelsewhere](./data.md#changes-made-elsewhere).\n\nBy default the log lives in memory and keeps the latest 50 changes of each\nrecord, for the 20,000 records of a table changed longest ago last: a bulk edit of a\nmillion records does not stay in the tab. In `<SvBase tables>` it is kept by base, table and record id, so it\nsurvives switching tabs; with one table it is kept per grid. Changes made by\nyour code replacing `tables` or `data` are not noted.\n\n### A history that lasts\n\nYour audit log already has every change. `setRecordHistory` lets the record\nview read it, and hands it each change made in the page to keep:\n\n```ts\nimport { setRecordHistory, type RecordChange } from '@svgrid/enterprise/base'\n\nsetRecordHistory({\n // Each time a record is opened. A promise is fine: the activity says\n // \"Loading the history...\" until it settles.\n list: async (rowId, { tableId }) => {\n const res = await fetch(`/api/history/${tableId}/${rowId}`)\n return (await res.json()) as RecordChange[]\n },\n // Each change made in this page, as it is made.\n add: (rowId, change, { tableId }) => {\n void fetch(`/api/history/${tableId}/${rowId}`, { method: 'POST', body: JSON.stringify(change) })\n },\n})\n```\n\nA change is `{ at, by, columnId, value, from? }` (`at` in milliseconds,\n`by` a user id from `setFieldUsers`), plus `automation` for a change an\nautomation made, `via` for a proposal someone accepted (\"CRM agent (accepted\nby Ana)\"), and `through` for a change a person made through an app as\nthemselves, an AI chat client say (\"Ana via Claude\"). The record view\nshows what `list` gave with this session's changes it does not have yet;\ngive back the `at` that `add` received, and a change shows once. A change\nmade elsewhere and read in through `realtime` is not passed to `add`:\nwhoever made it keeps it.\n\n`historyOf(ctrl, rowId)` gives a record's history as the record view shows\nit, for a panel of your own. `setRecordHistory(null)` goes back to memory.\n\n## The record menu\n\nRight-click a record in a base's grid:\n\n| Item | What it does |\n| --- | --- |\n| Expand record | Opens the record, with or without `expandRows` |\n| Comment | Opens the record with the comment box focused |\n| Insert record above, Insert record below | A new record beside this one with the values of the fields the view groups by, so it stays in the group; editing starts on its first field |\n| Duplicate record | A copy below, with lists copied; autonumber, created and last modified fields get fresh values |\n| Copy, Paste | The grid's own cell copy and paste |\n| Delete record | Asks \"Delete record?\" (\"Write the brief is deleted, and its links from other records go with it.\"), then removes it and fires `onRowsDelete` |\n\nWithout `editable`, only Expand record, Comment and Copy show. A new record\nfrom the menu is made the way \"+ Add row\" makes one: the `rowAdder` defaults,\na new id, the next autonumber, the current user in created by, and `onRowAdd`\nfired, so a table with a database writes it. The grid scrolls to it. A Kanban\ncard's right-click menu has Expand record and Comment, and with `editable`\n\"Move to\" a lane, Duplicate record and Delete record. Passing your own\n`contextMenu` to `SvBase` replaces the grid's menu.\n\n## Pitfalls\n\n- **No current user, no author.** Without `setCurrentUser`, new rows get\n `null` in created by, and an edit leaves last modified by as it was, so\n the field names whoever edited last while signed in.\n- **People are page-wide.** `setFieldUsers` and `setCurrentUser` set one list\n and one person for every base on the page. Two bases for two teams on one\n page share them.\n- **Records need real ids.** Comments and the activity are keyed by row id:\n each record's `id`, or `getRowId`. With one table a record without an `id`\n falls back to its index, so its comments move to another record when a row\n above it is deleted. In `<SvBase tables>` every record without an `id`\n shares the id `''`, and with it one thread. Give every record an id.\n- **Your store tells tables apart by id only.** In memory, each `<SvBase>`\n keeps its own comments and activity, even when two bases on one page use\n the same table ids. Your comment store gets the table id and nothing about\n the base: if two bases share one store and their table ids, key the store\n by something of your own as well. With `serverIds: true` a new record\n keeps the page's id until the table loads again; re-key its comments when\n the insert returns.\n- **`'@me'` is whoever runs the filter.** Before `setCurrentUser` it\n matches no one; the grid filters again once a user is set. In an\n automation's condition it is the person whose edit set it off, and on the\n server runner, where nobody is signed in, it matches no one.\n- **A URL's type is its extension.** Under `accept: 'image/*'` a URL with no\n extension is refused, and a URL's size is checked only when it is known.\n The browser checks are for the user; check types and sizes on the server\n too.\n- **Storage keeps what the cell drops.** Removing a file, Cancel after an\n upload finished, or deleting the record leaves the object in the bucket.\n Clean up on the server, for example files no record has pointed at for a\n day.\n- **`fieldProps.upload` does not survive JSON.** A function in a column is\n lost when you store columns in a database through `onTablesChange`. Use\n `setAttachmentUploader` and branch on `columnId` instead.\n\n## Next\n\n- [Linked records](./linked-records.md): tasks that point at milestones,\n people that point at teams, and the records that link back.\n- [Formulas](./formulas.md): fields worked out from other fields.\n- [Views](./views.md): grids, boards, calendars and galleries over the same\n records.\n- [Forms](./forms.md): let people outside the team add records.\n- [Your own field type](./custom-field-type.md): a cell of your own, with the\n grid's `ctrl` to open records from it.\n- [Automations](./automations.md): tell the assignee when a task is blocked.\n"
|
|
5189
5189
|
},
|
|
5190
5190
|
{
|
|
5191
5191
|
"slug": "help/base/custom-field-type",
|
|
@@ -5199,14 +5199,14 @@ export const docs = [
|
|
|
5199
5199
|
"path": "docs/help/base/data.md",
|
|
5200
5200
|
"title": "Keep a base in a database",
|
|
5201
5201
|
"section": "SvGrid Base",
|
|
5202
|
-
"markdown": "# Keep a base in a database\n\nA base can keep its records in your database instead of the page. Give a\ntable a `source` and `<SvBase>` loads the records from it when it opens, then\nwrites every change back: a cell edit, a pasted range, a new record, a\ndeleted one, a link made from either side. Postgres, MySQL, SQLite, Supabase\nand any REST API work the same way, because each is reached through the\ndata source contract the grid already uses.\n\n<div data-docs-demo=\"516-base-postgres\" data-height=\"760\"></div>\n\nThe demo above is SvGrid Base on a real Postgres database running in the\npage (PGlite). Change a status and the log shows the `UPDATE` it ran.\n\n## How it fits together\n\n\n\n- **The page holds every record of a table.** Views, filters, groups,\n summaries, colors and automations all work on those records, so they stay\n instant. A table with more records than the page should hold (10,000 by\n default) is read from the database a part at a time instead, by itself: see\n [A table of millions](#a-table-of-millions).\n- **The writer sends what changed.** After each change it compares the\n tables with what the database holds and queues an `INSERT` for a new\n record, an `UPDATE` with only the fields that changed, or a `DELETE`. The\n writes go one at a time, in order, so an update never overtakes the insert\n of its own record.\n- **A refused write goes back.** When the database says no (a constraint, a\n row level security policy, a network error), the cell returns to what the\n database holds, the end of the tab bar says why in plain words, and a notice\n names the record and the field. What the database said is in the tooltip, or\n through an endpoint in the server log, because it names tables and values:\n [what a person reads](./postgres.md#3-one-endpoint-per-table).\n- **Changes made elsewhere come in.** With `realtime`, the base reads a table\n again when someone else changed it and takes what moved, without writing\n anything back.\n\n## Give a table a source\n\n`baseSource` wraps any data source:\n\n```ts\nimport { baseSource, type BaseTable } from '@svgrid/enterprise/base'\nimport { createRestDataSource } from '@svgrid/enterprise'\n\nconst tasks: BaseTable = {\n id: 'tasks',\n name: 'Tasks',\n primaryField: 'name',\n data: [],\n columns: [\n { field: 'name', header: 'Task', fieldType: 'text' },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: [{ value: 'Todo' }, { value: 'Done' }] } },\n ],\n source: baseSource(createRestDataSource({ url: '/api/tasks' })),\n}\n```\n\n```svelte\n<script lang=\"ts\">\n import { SvToaster } from '@svgrid/grid'\n import { SvBase, enableBase, type BaseTable } from '@svgrid/enterprise/base'\n\n enableBase()\n let { tables }: { tables: BaseTable[] } = $props()\n</script>\n\n<SvBase bind:tables editable />\n<SvToaster />\n```\n\n`data` can start empty: the base fills it. A write that is refused shows a notice\nand the tab bar says so; see [Notices](./quick-start.md#notices).\n\nThe data sources that ship with `@svgrid/enterprise`:\n\n| Source | Talks to | Tutorial |\n|---|---|---|\n| `createSupabaseDataSource` | Supabase (PostgREST), from the browser | [Build a base on Supabase](./supabase.md) |\n| `createSqlDataSource` | Any SQL database, through an `execute(sql, params)` you write. It reads and writes the columns on its schema and no others; `wholeRecords: true` reads and writes every column, for a source in the same process as the page, and `createKitHandlers` refuses one | [Build a base on Postgres](./postgres.md) |\n| `createKitDataSource` | Your SvelteKit endpoint, which runs `createSqlDataSource` on the server | [Build a base on Postgres](./postgres.md) |\n| `createRestDataSource` | A JSON API: `GET`, `POST`, `PATCH`, `DELETE` | [Build a base on your API](./rest-api.md) |\n| `createInMemoryDataSource` | An array, for tests and prototypes | |\n\nYour own source works too: an object with `getRows`, `createRow`,\n`updateRow` and `deleteRow` (the grid's `ServerDataSource`).\n\n## Tables your server makes, copies and deletes\n\nA table with a source lives in your database, so a new one should too. Give\n`<SvBase>` the four hooks and the tab bar's Add table, Duplicate table and\nDelete table, and the trash's Restore for a table, go through your server:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, baseSource, type BaseTable } from '@svgrid/enterprise/base'\n import { createRestDataSource } from '@svgrid/enterprise'\n\n let { tables } = $props()\n\n // What your API answers for a table, as a BaseTable reading its records from it.\n const asTable = (t: any): BaseTable => ({ ...t, data: [], source: baseSource(createRestDataSource({ url: `/api/tables/${t.id}/rows` })) })\n const post = async (url: string, body?: unknown) => {\n const res = await fetch(url, { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify(body ?? {}) })\n if (!res.ok) throw new Error((await res.json()).error ?? 'The table was not saved.')\n return res.json()\n }\n</script>\n\n<SvBase\n bind:tables\n editable\n onAddTable={async (name) => asTable(await post('/api/tables', { name }))}\n onDuplicateTable={async (table, name) => asTable(await post(`/api/tables/${table.id}/copy`, { name }))}\n onDeleteTable={async (table) => (await post(`/api/tables/${table.id}/trash`)).item}\n onRestoreTable={async (item) => asTable(await post(`/api/tables/${item.table.id}/restore`))}\n/>\n```\n\n- **Add table** calls `onAddTable` with the name the base would give the\n table (\"Table\", \"Table 2\"...). The table it answers is added and opened,\n and its `source` is read at once, as the first tables' were. Nothing\n answered adds nothing. A rejection's message is shown.\n- **Import a file as a table** calls `onImportTable` with the table the\n import built: its fields (with the types it found) and its records in\n `data`. Keep it, and answer the table to add, with its `source`; it opens and\n is read from there. Nothing answered adds nothing; a rejection's message is\n shown. Without the hook the table is made in the page.\n- **Duplicate table** calls `onDuplicateTable` with the table and\n \"Name copy\". The copy it answers is added and opened.\n- **Delete table** asks the person first, as always, then calls\n `onDeleteTable`. `false`, or a rejection, keeps the table. A trash item it\n answers is what the trash shows for the table, and your `trashStore` is not\n handed it again. Otherwise the base keeps its own item.\n- **Restore** of a table in the trash calls `onRestoreTable` with the item.\n The table it answers goes back where it was, read from its `source`, and\n opens. Nothing answered leaves the item in the trash.\n\nA table made, copied or brought back this way is yours, not a step of the\npage's history: Ctrl+Z does not take it away. Without a hook, the base makes,\ncopies, deletes and restores tables in the page, as before.\n\nAny table you put in `tables` after the base opened, hooks or not, is read\nfrom its `source` and kept in sync like the first ones.\n\n## Link fields\n\n\n\nIn the page a link field holds record ids. `links` says how each one is kept:\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport { createRestDataSource } from '@svgrid/enterprise'\n\nconst taskTags = createRestDataSource({ url: '/api/task_tags' })\n\nconst source = baseSource(createRestDataSource({ url: '/api/tasks' }), {\n links: {\n // A link to one record: the column with the linked record's id.\n project: { column: 'project_id' },\n // A link to many records: a junction table, one row per pair.\n tags: { through: taskTags, from: 'task_id', to: 'tag_id' },\n },\n})\n```\n\nThe field that links back (a project's Tasks, when tasks have a Project\nfield) is worked out in the page from the other side and never stored. Link\na task from the project's side and the base writes that task's\n`project_id`. A link field that is neither in `links` nor the other side of\none is written as it is, a list of ids, which suits a Postgres `text[]` or a\n`jsonb` column.\n\nA list (a multiple select, a vote, a sparkline) goes to its column as that column takes\nit: an array to `text[]`, JSON to `json` and `jsonb`, and JSON text to a text column, on\nMySQL, SQL Server and SQLite too. It reads back as the list it was.\n\n## Keys the base can use\n\nA record needs one column that names it. When a base reads a database:\n\n- A table with a primary key of one column is a table.\n- A table keyed by both ends, `order_tags (order_id, tag_id, primary key (order_id, tag_id))`,\n with both columns foreign keys, is a link to many, like a junction with its own `id`. A\n link goes by the whole key, so removing a tag deletes that one pair. A tenant column in\n the key, named in `tenantColumn`, is part of the key and no end of the link. Other columns\n on such a table are not read and not written: a new link gives them their defaults, one\n that is `NOT NULL` with no default refuses the link, and the server log names them. A\n pair whose two ends the base does not hold, by their keys, is left out.\n- Any other table with a composite key, or with no primary key, is left out of the base, a\n view included. The rest of the base opens, and the log names the table and says why.\n Nothing runs on part of a key, because a delete by one column of two reaches every row\n that shares it.\n\n`keys` brings such a table in, when one of its columns is unique:\n\n```ts\nexport const { GET, POST } = createBaseEndpoint({ execute, allTables: true, public: true, keys: { v_orders: 'id' } })\n```\n\nThat is your word for it: nothing checks, and a delete reaches every row that holds the\nvalue. `baseFromDatabase` and `baseFromSupabase` take it too. On Supabase the key comes\nfrom the API description; a project that does not show that to the key in use has only a\ncolumn named `id` to go by.\n\n### Foreign keys of more than one column\n\nA foreign key of more than one column, as a database keeps tenants apart with,\n`foreign key (tenant, customer_id) references customers (tenant, id)`, is a link through\n`customer_id` to that tenant's customer, when `tenantColumn` names `tenant` on both tables.\nThe tenant column stays the read-only tenant, not a link. It works the same in a pair\ntable, `(tenant, order_id) -> orders (tenant, id)`. Any other key of more than one column,\nthree columns or two without the tenant, links nothing: its columns are plain values and\nthe log names the key. A key links only to a table its bare name reaches: on Postgres a\ntable of any schema on the search path, unless a table of that name in an earlier schema\nhides it (a key to a hidden table stays a plain value); on SQL Server the user's default\nschema; on MySQL the connected database. The other table still has to be one the base\nserves. Supabase does not describe a key of more than one column, so there\nneither column is a link.\n\n## Record ids\n\nA new record gets an id in the page at once, so it can be edited and linked\nbefore the database answers. By default that id is its key in the database\ntoo: give the key column a text type.\n\nWhen the database makes the key (a `serial` column, a `uuid` with a default),\nset `serverIds: true`. The record is inserted without the page's id, and the\nwriter keeps the page id for the grid and translates to the database id for\nevery later write and every link that points at the record.\n\n## What a write answers\n\nThe row a server answers is the truth. After a write the cell, the record and the views\nshow what was stored: a value a `before*` hook or a trigger changed, a tenant the scope\nstamped, a default on a new record. A number the column rounded shows rounded. Undo goes\nback from what was stored. A block of Edit fields or of a range on a big table answers with\nwhat hooks changed, and a trigger's work on such a block shows when the view reads the rows\nagain. On a table the page holds, a paste, a clear or an Undo of 20 records or more is\nwritten in blocks, and each block's records are read back once it lands, so a trigger's\nwork shows at once there too.\n\nThe answer is the row the write left, not a teammate's write a moment later. Postgres and\nSQLite say it in the write itself (`RETURNING`). SQL Server writes and reads it back in one\ntransaction of one batch. MySQL has no way to do either in one statement: give\n`createSqlDataSource` (or `baseFromDatabase`, `createBaseEndpoint`) its `transaction` and the\nwrite and its read go in one. Without it a teammate's write to the same cell in the moment\nbetween the two is taken for yours, and an Undo of yours can then write over theirs.\n\n## What is not written\n\nFields the page works out are never sent: formula, lookup, rollup, count and\nbutton fields, and the field that links back. Add any other field to `skip`\nto keep it in the page only.\n\n## What a cell holds\n\nA base reads dates, times, bigints and decimals as the database writes them, as\ntext. A SQL source asks for a text copy of each such column\n(`to_json(col) #>> '{}'` on Postgres, `CAST(col AS CHAR)` on MySQL) beside the\ncolumn itself, so sorting and filtering still use the real column.\n\n| Column | What the page holds | What people see |\n|---|---|---|\n| `date` | `2026-03-08` | That day, in any zone |\n| `timestamp`, `datetime` | `2026-03-08T02:30:00.123456` | That wall clock, in any zone |\n| MySQL `timestamp` | The wall clock of the connection's `time_zone` | That wall clock, in any zone |\n| `timestamptz` | `2026-03-14T22:00:00.654321+00:00` | That moment, in the viewer's zone |\n| `bigint`, `numeric`, `decimal` | Text past what a JS number holds | Every digit |\n| `json`, `jsonb` | The text the database writes | Every digit: a driver's `JSON.parse` would round a number past 2^53 |\n\nA time someone types keeps its wall clock on a column without a zone, and is that\nmoment on a `timestamptz`. An undo or a restore writes back the text it read, so\nnothing moves by a zone or loses digits past the millisecond.\n\nThe days of a filter and the months of a chart are the viewer's. On a column of moments\n(Postgres `timestamptz`, SQL Server `datetimeoffset`, SQLite text that ends in a zone)\n\"is 8 March\", \"today\" and \"within the past week\" keep the records whose moment falls on\nthose days where the person is, and a chart counts each record in the month it reads as\nthere, across a change of the clocks too. The page sends each date condition with the\nmoments its days start and end (`moments` on the condition), since a server has no zone\nof the viewer's, and `createSqlDataSource` compares them on such a column. A date and a\nwall clock, a MySQL `TIMESTAMP` among them, compare their days and read the same everywhere.\nOn Supabase, say which columns hold moments: `supabaseFieldFilter(columns, { moments: (def) => def.field === 'starts_at' })`.\nWithout that, a condition there compares the database's days.\n\nOver PostgREST (Supabase) a date already arrives as text. A JSON number cannot\ncarry more than about 15 digits, so the first read that shows a longer one reads\nthat column again with `col::text`, and later reads bring the copy along. A change\nthat arrives through Realtime is plain JSON: such a number in it is rounded until\nthe next read.\n\nJSON in a `text` or `longText` field shows as JSON text. A change goes back as\nJSON; text that is not valid JSON is refused with a message and the cell goes back. A\n`jsonb` column writes its own spaces and key order, and that is no change: nobody is told\nof one. Over PostgREST a JSON column arrives as JSON, so a number past 2^53 in it is rounded.\n\nOpening a cell and leaving it writes nothing, whatever the field shows.\n\n## Changes made elsewhere\n\n\n\n`realtime` takes a function that calls `apply` with what changed and returns a\nfunction that stops listening. With Supabase, hand it Realtime's events as\nthey come:\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport {\n createSupabaseDataSource,\n createSupabaseRealtime,\n type EntitySchema,\n type SupabaseClientLike,\n type SupabaseRealtimeClientLike,\n} from '@svgrid/enterprise'\n\n// Your supabase-js client: createClient(url, anonKey).\ndeclare const client: SupabaseClientLike & SupabaseRealtimeClientLike\ndeclare const schema: EntitySchema\n\nconst source = baseSource(createSupabaseDataSource({ client, table: 'tasks', schema }), {\n realtime: (apply) => createSupabaseRealtime({ client, table: 'tasks', onChange: apply }),\n})\n```\n\nThe base updates just the records a change names: the other records keep\ntheir objects, so the grid redraws one row, not 50,000, and the table is not\nread again. A burst of changes (an agent updating 200 records) goes into the\npage as one update. A change to a record this page wrote in the last few\nseconds may be its own write coming back late, or someone else's edit after\nit: that record alone is read again, by id, to know which.\n\nAny other feed works the same way: a WebSocket message, a server-sent event,\na poll. Call `apply` with the changes, as the database has the records\n(its column names, its ids):\n\n```ts\nimport { baseSource, type BaseChangeInput } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\ndeclare const tasksSource: ServerDataSource<Record<string, unknown>>\n\nconst source = baseSource(tasksSource, {\n realtime: (apply: (changes?: BaseChangeInput) => void) => {\n const socket = new WebSocket('wss://example.com/tasks')\n socket.onmessage = (m) => {\n const { type, id, row, changed } = JSON.parse(m.data)\n if (type === 'update' && changed) apply([{ type: 'update', id, fields: changed }])\n else if (type === 'delete') apply([{ type: 'delete', id }])\n else apply([{ type, record: row }])\n }\n return () => socket.close()\n },\n})\n```\n\n| A change | Carries |\n|---|---|\n| `{ type: 'insert', record }` | The new record, with its key column. |\n| `{ type: 'update', id, record }` | The whole record as it is now. |\n| `{ type: 'update', id, fields }` | Just the columns that changed. |\n| `{ type: 'delete', id }` | The key of the record that went. |\n\nA change that comes back from the page's own write (the database tells every\nlistener, the page that wrote it included) moves nothing and is not reported.\nAn update with `fields` for a record the page does not have, and `apply()`\nwith nothing, read the whole table again. An update with `id` alone reads that one record.\n\n### A feed on an endpoint\n\n`baseFromEndpoint` takes one `feed` for the whole base. It opens when the first table\nlistens and closes with the last. Each message names its table, a junction table\nincluded, and a change in a junction reaches the record it starts from:\n\n```ts\nimport { baseFromEndpoint } from '@svgrid/enterprise/base'\n\nconst tables = await baseFromEndpoint('/api/base', {\n feed: (apply) => {\n const events = new EventSource('/api/base/feed')\n events.onmessage = (e) => {\n // { \"table\": \"orders\", \"changes\": [{ \"type\": \"update\", \"id\": \"o1\", \"fields\": { \"status\": \"Paid\" } }] }\n const { table, changes } = JSON.parse(e.data)\n apply(table, changes)\n }\n // After a reconnect, changes may have been missed: every table reads again.\n let opened = false\n events.onopen = () => {\n if (opened) apply()\n opened = true\n }\n return () => events.close()\n },\n})\n```\n\n`apply(table)` with no changes reads that table again, and `apply()` reads every table again.\n\nKeep it to one connection. A browser opens at most six connections to one host over\nHTTP/1.1, which is what a Vite or Node dev server speaks, and a connection held open by a\nfeed is one of them. With a feed per table on a base of six tables and junctions, no write\nreaches the server. `realtime: (table, apply) => stop`, called per table, is still taken\nfor a feed that shares one connection itself, such as channels on one socket.\n\nThe feed is yours to write and yours to scope: with a tenant `scope`, send each person their\ntenant's rows only.\n\n### What a feed has to cover\n\nA feed is per table, and some of what a person changes is not in that table:\n\n- **A link to many lives in its junction table.** Adding a tag writes a row to `order_tags`\n and nothing to `orders`, so a feed of `orders` alone never tells teammates. Listen to the\n junction too, on the table that stores the link, and name the record it starts from:\n\n ```ts\n import { baseSource } from '@svgrid/enterprise/base'\n import type { ServerDataSource } from '@svgrid/grid'\n\n declare const ordersSource: ServerDataSource<Record<string, unknown>>\n declare const orderTags: ServerDataSource<Record<string, unknown>>\n // Your feed: calls back with what changed in that table, and returns how to stop.\n declare function listen(table: string, on: (change: any) => void): () => void\n\n const source = baseSource(ordersSource, {\n links: { tags: { through: orderTags, from: 'order_id', to: 'tag_id' } },\n realtime: (apply) => {\n const orders = listen('orders', (change) => apply(change))\n const pairs = listen('order_tags', (row) => apply(row?.order_id == null ? undefined : { type: 'update', id: row.order_id }))\n return () => { orders(); pairs() }\n },\n })\n ```\n\n A feed that only says \"something changed\" calls `apply()` for both. `baseFromSupabase`\n and `baseFromEndpoint` listen to the junction tables by themselves, and needs them in the `supabase_realtime`\n publication. A delete's event there has only the key unless the junction table has\n `REPLICA IDENTITY FULL`, so a removed link reads the table again.\n- **A soft delete reaches a feed as an update.** The base reads an update that sets the mark\n as a delete, so send the column. Through `createKitDataSource` the page learns the column\n from the server's first answer. A restore reads as an update of a record the page does not\n have. A page-held table takes it in, and reads the table if it has links through a junction.\n A table read a part at a time reads the rows on screen, at most once a second, because a\n feed cannot tell a restore from an edit of a record scrolled out of view.\n- **A feed that goes down says nothing.** Nothing here can tell silence from no changes.\n\n### What people see\n\nA change made elsewhere does not just appear. Until someone opens the record:\n\n- in a grid view, the cells that changed are tinted, and a record added\n elsewhere is tinted across the row (Kanban and gallery cards are not);\n- the row number has a dot; hover it for \"Ana Ruiz changed this record 2\n minutes ago\";\n- the view bar counts them, \"3 changed by Ana Ruiz\", and a click on the count\n marks them all seen.\n\nOpening the record clears its marks. Its activity lists each change as\n\"Ana Ruiz changed Priority\", with the value before crossed out and the value\nnow: Low → Urgent.\n\nThe name comes from the record itself: its `lastModifiedBy` field (for a\nrecord added elsewhere, `createdBy` first). Whoever writes to the database\nwrites their user id to that column, and the base looks it up in\n`setFieldUsers`. Without such a field the change is credited to \"Someone\nelse\". Your own writes are never reported back to you: the base compares what\nit reads with what it last wrote.\n\n### An AI agent writing to the base\n\nThe same path serves an agent: a script, a worker calling a model, or Claude\nCode with your database's MCP server. Give the agent a user id, add it to\n`setFieldUsers` with a name and an avatar, and have it set `modified_by` (or\nwhichever column your `lastModifiedBy` field reads) on every row it writes.\nPeople then see exactly what it changed, review it in a view filtered on a\n\"Needs review\" field, correct what it got wrong, and approve the rest with a\nbutton field and an automation.\n\n[Let an AI agent work in your base](./ai-agents.md) walks through it with\nClaude Code and Supabase, and [Review what an agent changed](./review-queue.md)\ncovers the review side on any database. Here the agent is a stand-in made of\nkeyword rules, so the demo runs without a model or a key. It writes to the database with SQL; press \"Run the triage\nagent\", then open a ticket.\n\n<div data-docs-demo=\"700-base-ai-triage\" data-height=\"900\"></div>\n\nTo act on changes made elsewhere in code (a notice, a log, a count of your\nown), pass `onRemoteChange` to `<SvBase>`. It gets each change once it is in\nthe page:\n\n```ts\nimport type { BaseRemoteChange } from '@svgrid/enterprise/base'\n\nfunction onRemoteChange(changes: BaseRemoteChange[]) {\n for (const c of changes) {\n // c.type: 'insert' | 'update' | 'delete'; c.table, c.id, c.record\n // c.fields (updates): [{ field: 'priority', from: 'Low', to: 'Urgent' }]\n if (c.type === 'update') console.log(c.id, c.fields)\n }\n}\n```\n\n## Status and errors\n\nThe end of the tab bar says what the base is doing:\n\n| It reads | When |\n|---|---|\n| Loading records... | The tables are loading |\n| Saving... | Writes are on their way |\n| Still saving: the server has not answered yet | A write has been waiting a while |\n| All changes saved | Every write went through |\n| Not saved: *reason* | A write was refused; the cell went back |\n\n\n\nA table that cannot be read says so where its records would be, for as long as it lasts,\nwith why and a **Try again**. No empty table is shown for it, and nothing can be added to\nit. The other tables of the base open as usual.\n\nA table read a part at a time (`serverRows`) whose next part cannot be read says so in the\ntab bar, \"Could not load *table*: *reason*\", with **Try again**, for as long as a part of the\nview is unread, wherever it is scrolled to. The rows that did not come are a tinted band with\n\"Could not load these rows.\" and **Retry** on its first row on screen. A read again of rows\nalready on screen, after a teammate's change, that fails leaves those rows as they were: the\ntab bar says so with **Try again**, which reads them again.\n\nWhen the server sent a reason with its error (`{ \"error\": \"...\" }` and no `code`), that reason\nis what the notice says. `createRestDataSource` passes on an API's `{ \"error\" }` or\n`{ \"message\" }` the same way.\n\nA failed write is told in a notice that names the record and the field, says why in\nplain words and shows what was entered, with **Try again** where that can work. The record\nis named as it is stored, never by the value that was refused. A foreign key of more than one\nfield that refuses a write names all of its fields. The notice stays until it is dismissed,\nand \"Not saved\" stays until that record is written: a later write of another record does not\nclear it. A click, a tap or Enter on the status line opens it in full: the reason, and the\nserver's own words when it sent some and the reason does not already say them. The text of\nthe request itself (a status code, a JSON body) is never shown; it is in the browser's\nnetwork log and the server's log.\n\nA new record the database refused takes no edit while it is still listed (while another cell or\nrecord is being edited, or a draft on a table read a part at a time whose refusal no retry can\nchange, such as an id column too narrow): a click, a key or a paste on\nit shows its notice again instead of an editor. An editor open on it when the refusal comes closes\nwith what it holds, and the notice names it. A draft refused for a reason a retry may get past keeps\ntaking edits, and its next edit sends it again.\n\n**Try again** reads the record first, as an undo does. A value that changed since the\nwrite failed, whether a teammate wrote it or you typed it again, keeps that value and the\npage says so. A record deleted since is reported with what you entered. If the record\ncannot be read, nothing is written and the notice offers Try again once more.\n\nA change of many records at once (a paste, a clear or an Undo of 20 or more) that fails\nis one notice with the number of records, and the same **Try again**: it reads them all\nfirst, sends what is still as it was in blocks, and says how many cells changed since and\nhow many records were deleted since. Part of a block may have landed; the page reads the\ntable again to show which. An Undo of some of those cells takes them out of what Try\nagain would send. A refusal of your permission offers no Try again and leaves no step to\nundo, and so does a refusal of the values, an answer of `400`, `409` or `422`: the same\nvalues would be refused again.\n\nA write that gets no answer is not given up on: it may still land, or be refused. After\n`writeTimeout` (60 seconds by default, on `<SvBase>`) writes to other records go on, and\nlater writes to the same record wait behind it, so none can overtake it or be overwritten\nby it landing late. The status says \"Still saving\" for as long as it has no answer, and\nstarts warning at a sixth of `writeTimeout`. The page keeps what was entered, and goes back\nonly if the write is refused. A delete with no answer keeps its copy in the trash until the\noutcome is known, and leaving the page asks first.\n\nWhile someone is typing in a cell or in a field of a record, changes from others wait\nuntil the editor closes, so no row moves under it and no text changes under the cursor.\nThat holds for a live feed and for a read of the table, on any table. If the record was\ndeleted meanwhile, saving it says so and shows the text.\n\n## Options\n\n`baseSource(dataSource, options)`:\n\n| Option | Default | What it does |\n|---|---|---|\n| `links` | none | How link fields are stored: `{ column }` or `{ through, from, to }` |\n| `columns` | none | Column names that differ from field names: `{ dueDate: 'due_date' }` |\n| `idField` | `'id'` | The key column |\n| `serverIds` | `false` | The database makes the key of a new record |\n| `realtime` | none | Hear of changes made elsewhere: `(apply) => stop`; `apply(changes)` updates those records in place |\n| `skip` | none | Fields kept in the page only |\n| `holdInPage` | `10000` | How many records a table may hold in the page. It is where a table changes how it is read, not a cap: a bigger one is read from the database a part at a time, and no record is left out. (`limit` is the old name.) |\n| `convertField` | none | A field of a big table changed type: rewrite its values in the database and resolve with `true`. Without it the base rewrites them a block at a time. |\n| `duplicate` | none | Copy a big table in the database and resolve with the new table's source. |\n| `serverRows` | automatic | `true` always reads from the database, and the first screen comes sooner on a table you know is big; `{ blockSize }` sets the rows per request (200). `false` always holds every record in the page, however many. Left out, the base decides by `holdInPage`. |\n\n## Build a base from your database\n\n`baseTablesFromSchemas` makes the tables from your database's own\ndescription of them: a number column becomes a number field, an enum a\nsingle select with its values, a foreign key a link with a field in the\nother table that links back. Read the descriptions with\n`introspectSupabaseTable`, `introspectDatabase` or `introspectOpenApi`, or\nwrite them out:\n\n```ts\nimport { baseTablesFromSchemas } from '@svgrid/enterprise/base'\nimport { createRestDataSource, type EntitySchema } from '@svgrid/enterprise'\n\nconst schemas: EntitySchema[] = [\n {\n name: 'deals',\n fields: [\n { field: 'id', type: 'text', primaryKey: true },\n { field: 'title', type: 'text' },\n { field: 'stage', type: 'enum', options: [{ value: 'Open', label: 'Open' }, { value: 'Won', label: 'Won' }] },\n { field: 'company_id', type: 'relation', relation: { entity: 'companies', labelField: 'name' } },\n ],\n },\n { name: 'companies', fields: [{ field: 'id', type: 'text', primaryKey: true }, { field: 'name', type: 'text' }] },\n]\n\nconst tables = baseTablesFromSchemas(schemas, (schema) => createRestDataSource({ url: `/api/${schema.name}`, schema }))\n```\n\nThe result is ordinary `BaseTable` objects: change a field's type, add views,\nrename a table. [Build a base on your API](./rest-api.md) does this end to end.\n\nThe other way round, `baseToSql(tables)` writes a base as Postgres SQL:\ntables, foreign keys, the tables behind links to many, and the records, with\n`svgrid:` comments for the field settings, views and automations that SQL\nhas no type for. The tables it makes have text keys with a\n`gen_random_uuid()` default, so a record added later gets its key from the\ndatabase. See [Take a base to a database](./quick-start.md#take-a-base-to-a-database).\n\n## A table of millions\n\nA table has no size limit, and nothing here is a setting you have to get right.\nA table of the thousands of records a team keeps in a tracker, a CRM or an\ninventory is held in the page. One that grows past `holdInPage` is read from the\ndatabase a part at a time, the next time it is read, and looks and works the\nsame: every view, link, lookup, rollup, automation and search reads all of it.\nThe page then holds none of its records, only what is on screen.\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\ndeclare const orders: ServerDataSource<Record<string, unknown>>\n\n// Nothing to set: it reads from the database once the table outgrows the page.\nconst source = baseSource(orders)\n\n// A table you know is big: skip the first look, and size the requests.\nconst big = baseSource(orders, { serverRows: { blockSize: 200 } })\n```\n\n<div data-docs-demo=\"723-base-million-orders\" data-height=\"620\"></div>\n\nHow each part of a base reads such a table:\n\n| | Read a part at a time |\n|---|---|\n| Grid views | Read through the server row model. Each request carries the view's filter (`filterModel.expression`), its sort, its groups (one row per key with its count, the records under an opened key) and the search. The count in the view bar is the server's. A grouped view shows select groups in option order and each group as the field draws it, with the records it holds at every level, and the totals of the fields with a sum, average, lowest or highest picked in the footer. Whenever the view is read again (your delete, Restore, Undo or Redo, a new record, an edit once you leave the record, an option renamed, a field converted, a teammate's change), the group rows and the loaded records of every open group are read, with or without a feed: a deleted record leaves its group, a restored or new one shows in its group, and the counts follow. A group closed at the time reads again when it is opened. A teammate's change that a feed sends with its row patches that row where it is; when it changes a field the view groups or sorts by (any field, when the view groups or sorts by a formula or lookup), the view is read again at once, so the record takes its place in the order and in its group. A filtered view reads again within a second after any change, so a record that left the filter goes. |\n| Kanban | Each lane shows its true size, from one grouped request, and reads its cards as they scroll into sight. A card moved to another lane is written by id and sits at the top of that lane until the lane is read again. Sorted by a number field, dropping a card elsewhere in its lane writes that number, so the order is the table's. |\n| Calendar | Reads the dates on screen and no others. A range of up to 400 records is read whole. A busier one is read a day at a time: each day's first records and its size, from one grouped request where the backend groups and the view has no end date, so an empty day costs nothing and a write reads only the days whose size moved. \"+N more\" lists every record of that day. The days are the viewer's: on a column of moments (Postgres `timestamptz`, SQL Server `datetimeoffset`) the sizes, each day's records and that list follow the page's zone, also across a change of the clocks. A date and a wall clock (`timestamp`, `datetime`, a MySQL `TIMESTAMP`, which reads as the server's clock) show the same everywhere, and their days follow what the cell shows. |\n| Gantt | Rows by start date, read as they scroll into sight. The axis runs from the table's first start to its last end. Dependency arrows and rescheduling reach the rows read so far. |\n| Gallery, list, inbox | Only the records in sight are drawn and read. A grouped list shows each group's size and reads its records when opened. |\n| Chart, dashboard | The server groups and adds up, over every record. A date axis is read a month at a time, in the viewer's months on a column of moments: one grouped request for each part of the records' span with one UTC offset, two a year in a zone with summer time. The records behind a tile show the first 200 and how many there are. |\n| Form | Stores its record through the source, and reads nothing. |\n| Links | A link cell reads the records it names by id, for the cells on screen, in one request. The picker searches the whole table, and a name pasted into the cell is found there. A link edits from either side: on the side that holds no list (a customer's orders), each tick changes that order. |\n| Lookups, rollups and counts | Read the linked records by id. Over a link stored on the big table (a customer's orders), the server counts and adds up: one grouped request a screen, whatever the size. |\n| Search across tables | Each big table searches on the server, and says how many match. |\n| Find in a grid | The search box filters on the server: a find bar could only mark the rows loaded. |\n| Automations | Run on any record, read by id. A scheduled one runs on every matching record, block by block. |\n| Share links | Show the whole table, without the fields the share leaves out. |\n| Autonumber | The next number is the table's largest plus one. Two people can reach it together, so each record is checked once stored: of any two holding a number the later one takes the next, and a column with a UNIQUE constraint refuses the second and the write tries again. Numbers can skip. A number a person deleted in this page is not given out again while it stays open, so an undo finds its number free. After a reload, or on a teammate's page, the number of a deleted record can be given out again, since the next one follows the largest left. A restored record whose number was given out meanwhile takes the next one. |\n| Changing a field's type | Asks first, with the number of records. Then `convertField` does it in one statement (`createSqlDataSource` with `schemaChanges: true` has one on Postgres), or the base reads a block at a time and writes the records whose value changes, sixteen at a time. The other choice changes the field only. |\n| Download as SQL | Writes every record, a block at a time, so the file can be larger than the page could hold. |\n| Duplicate table | Copies in the database with the `duplicate` option (`schemaChanges: true` gives a Postgres source one). Without it the records are read into the page a block at a time, with the count in the tab bar, and the copy lives in the page, so a very large table needs the option. |\n| Edits | Written by id: a change to the 900,000th record is one `update`. |\n| Edit fields | On a selection, in a dialog with progress and Stop. The selection is read first, and only records whose value changes are written, a block of 1,000 at a time. Past 10,000 records it asks first, with the exact number, because Undo cannot take that many back. Stop ends it after the block under way. A block that fails ends it too: the page reads that block back, says how many records changed, and Undo takes those back. Records that landed past 10,000 stay changed. |\n| A range of cells | Paste, one value pasted over a range, Delete, the fill handle and Ctrl+Enter reach every record the selection covers, loaded or not. Up to 200 cells of rows the grid holds are written at once, cell by cell. Anything larger, or reaching rows not loaded, runs in the Edit fields dialog: the records are read in view order, then written a block of 1,000 at a time (200 on a source that writes a request a record, such as Supabase, so the count moves and Stop answers within a block), with the same progress, Stop, count at the end, question past 10,000 and one Undo step. A block the database refuses part way ends the job: the count says how many records changed, and Undo takes those back. If records moved while the range was read (a teammate's edit changed the order or the set of a sorted view), nothing is written or copied: the page says, for a paste, \"Records moved while this was read. Nothing was changed. Try again pastes from \"Acme\" down over the rows as they are now.\", naming the first record selected. Try again finds that record by its id where the list has it at the click, goes from it over as many rows below it as before, and selects those rows first, so the screen shows what it writes; its dialog lies over them, so it names them too (\"From \"Acme\" down over 2,500 rows, selected in the view.\"). If the record is gone or no longer among the rows shown, it writes nothing and says so, and so it does when fewer rows stand below the record now than the first try covered (the record fell to the end of a sorted view): it never turns lines into new records the first try wrote over records that were there. To tell that records moved, the whole id sequence is checked, in requests that ask for ids alone: a range longer than a block reads its ids first and each block must bring the same ids in the same places, each block also reads the last record of the one before again, a record read twice counts as moved, and once the last block is in, the ids of the whole range are read again and must be the very ids read, in the same order. Each of those reads asks for the whole range at once (up to 20,000 ids); a server that caps an answer (PostgREST's `db-max-rows`, 1,000 on Supabase) is read on from where its answer ended, a page of its own size at a time, and only a different id sequence, or a list that ends before the range does, counts as moved. On Supabase and PostgREST these reads select the key alone. Any difference counts, a move inside the part already read too. Try again acts only in the view the cells were chosen in, as it was then: after a switch to another view, or a change of its sort, filter, groups, open groups or shown fields, it writes nothing and says \"That view is no longer open, so nothing was changed.\" or \"The view has changed since, so nothing was changed.\" An answer to a question the job asked (past 10,000 records, new records past the last row, a delete) does the same. A new record that is not stored yet sits on top of the list and in no block of the table: a range over it leaves it out and says how many it left, a paste keeps its line for it, and a copy has its line. A drag of a range over rows not loaded is refused, with the number. A paste while the view is still loading is refused too, and never makes a record. |\n| Copy | Rows not loaded are read first, in a dialog with progress and Cancel, each line a real record with its worked out fields. A copy holds up to 2,000,000 cells: that many, 20 MB of text, took 4.6 s with a longest frame of 450 ms in Chrome on a production build, reading from the page. Past that nothing is copied, the page says how many cells were asked for, and Download gets all of it. If a browser will not take the text so long after the key press, the dialog asks for one more click. |\n| A paste past the last row | A line where no value fits its field makes no record. Up to 10 new records are added at once; past 10 the page asks first, with the number. They go in blocks of 1,000 (`createRows` makes a block one statement), and one Undo takes them out the same way, with the cells the paste wrote. A record someone has worked on since stays, and the page says so. |\n| \"+\" | In every view of records. It opens a new record, filled in from the view's filter (Region is EU in a view of EU orders). Nothing is stored until it holds a value, and one closed empty is gone. If the database refuses it, it stays in the grid with its values and the next edit tries again. What the database fills in, such as an order number, comes back into the record. Ctrl+Z takes a stored record out again. |\n| Insert record, Duplicate | Insert opens a draft, as \"+\" does. Duplicate stores the copy and shows it at the top of the grid. |\n| A new field | The \"+\" at the right of the header row, for whoever may change the schema (`columnAdder={false}` hides it). `createSqlDataSource` with `schemaChanges: true` adds the column on Postgres, MySQL and SQLite. A new field starts empty, or with its default: on a table held in the page the base writes the default to every record; on a table read a part at a time `addField` gets it as `default`, to fill the stored records (the one `createSqlDataSource` makes does not yet). When a column by that name is already in the table it takes the next free name, and says so. A column that cannot be added takes the field back. A source that cannot add one, such as Supabase, shows the `ALTER TABLE` to run, and `addField` on `baseSource` is your own way to make it. There, Duplicate field copies nothing: it shows the statement for the copy's column, to run before duplicating. An Autonumber or Created time field stays blank on the records already there. |\n| Delete | By id, to the trash, as the database holds the record at that moment; Ctrl+Z puts it back whole, columns the base shows no field for included, under the key it had, on a table the page holds and on a big one alike. A column off the source's schema never reaches the page, so it takes its default, unless the source reads whole records (`wholeRecords` on `createSqlDataSource`). The record stays in the trash until the database has it. What only the database may write stays the database's: a generated column works itself out again, and a `GENERATED ALWAYS` key gets a new value. Time columns go back as the database wrote them, past the millisecond and at a local time the clocks skipped, on Postgres and MySQL with any driver. A record the database refuses to delete stays in the table and out of the trash, and so does one a row-level policy skipped without an error: after a delete the base looks. |\n| Soft delete | `softDelete: 'deleted_at'` marks a record instead of removing it, and a restore clears the mark, so nothing is rewritten. See [Undo, trash and import](./undo-trash-import.md#soft-delete). |\n| Select all | Selects every record of the view, read or not, and the count says so; a group's tick selects all of the group. A new filter clears the selection. With `selectionBar={{ actions: ['deleteRows'] }}` (and `enableSelectionBar()`), Delete first reads what the selection covers, then asks with the exact number. The records go a block at a time, with a Stop button: what went before you stopped stays gone and stays restorable. `deleteRows` and `createRows` on your data source make a block one statement. Up to 10,000 go to the trash and can be undone; above that the question says they cannot be restored. A group that reads back a different size from its group row stops the job with nothing deleted, since what was left out of the selection could not be told apart. A record that leaves the view after you confirm is still deleted, since you confirmed that set. |\n| Changes made elsewhere | `apply(changes)` updates those rows in the grid, highlighted and credited, whether the page holds them or not. |\n| Formulas | Worked out in the page for the rows on screen. |\n\nAll of this is `getRows` with what a grid view already sends: a range, the\nview's filter, a sort, `groupBy` and `groupKeys`, an `in` list on the key\n(`filterModel.columns.id.selectedValues`), and for a chart or a total\n`aggregations` and `needsGrandTotal`. Grouping a link for a count from its other\nside sets `groupRawKeys`: group by the linked id, which a foreign key does. A calendar's\n`groupDays` and a chart's `groupMonths` ask for a date level by day (`2026-03-14`) or month\n(`2026-03`), on a column of moments in the zone `dayOffset` minutes ahead of UTC. A source that passes over them answers by value and the page adds the groups\nup, which on a time field is a group a record. The data source applies the view's filter\nand acknowledges it with `appliedExpression: true`. The\nSupabase, REST and SQL sources already answer all of these, and\n`createSqlDataSource` also runs a view's filter, sort, groups and totals on a\nformula, lookup or rollup in the database\n([computed fields in SQL](./server-compute.md#computed-fields-in-sql)). On your own\nsource, index the fields views group and place records by: a busy calendar\nmonth is a request per day.\n\n### Index what views sort on\n\nA sort on a column with no index sorts the table again for every block a person\nscrolls to, and that is what limits how many people a big table serves. Give each\nfield a view sorts on an index with the table's key after it:\n\n```sql\nCREATE INDEX orders_amount ON orders (amount, id);\n```\n\nThe key is there because a read breaks ties on it, in the sort's direction\n(`ORDER BY amount DESC, id DESC`). Leave both columns ascending, as above: one index\nthen serves a sort either way. `(amount DESC, id)` matches neither direction, and on\nMySQL it goes unused.\n\nThrough `createBaseEndpoint` on a table of 1,000,000 records, sorted on a numeric\ncolumn, blocks of 100, default database settings, on a shared development machine:\n\n| Median time for a block | No index | With the index |\n|---|---|---|\n| Postgres, one person | 2,263 ms | 567 ms |\n| MySQL, one person | 2,476 ms | 42 ms |\n| Postgres, 30 people at once | 23,576 ms | 2,118 ms |\n| MySQL, 30 people at once | 22,968 ms | 713 ms |\n\nA formula or a lookup has no column to index: a sort on one costs a sort of the\ntable for every block, so a view with many people on it is better sorted on a stored\nfield. A filter narrows what is sorted, and an index that starts with the filtered\nfield and ends with the sorted one serves both.\n\n### What the database cannot run\n\nA view never goes unanswered. When a filter, sort, group or total needs a field\nthe data source cannot compute, or the source does not acknowledge a filter, or\nit fails on a computed field, the page reads the table a block at a time, works\nthe field out with the same code the cells use, and keeps the ids and the values\nthe request needs. The view then reads its records by id. The tab bar shows how\nfar it has got.\n\nIt gives what the cells say, on any backend, and it is slower than the database:\nabout a minute for a lookup over the 1,000,000 records of the demo on a dev\nserver. It is read once. Scrolling, sorting again and the lanes of a board cost\nnothing more, a record you or someone else changes is updated where it stands,\nand changing a field reads again. Taking the sort or filter away stops the read.\nRecords changing while it reads are read again once, and if the count still moves\nthe base says so.\n\nTell the base what your source can work out with `computes`, and that field stays\nin the database. Without it, only `createSqlDataSource` is asked: a `queryRecords`\nbackend needs `computes: () => true` or it is right but slow.\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\ndeclare const orders: ServerDataSource<Record<string, unknown>>\n\nconst source = baseSource(orders, { computes: (def) => def.field === 'tax' })\n```\n\n`@svgrid/enterprise/base/compute` has both halves:\n[`queryRecords`](./server-compute.md#answer-a-paged-table) for records a\nserver holds, and [`fieldFilterToSql`](./server-compute.md#the-views-filter-in-sql)\nfor a database.\n"
|
|
5202
|
+
"markdown": "# Keep a base in a database\n\nA base can keep its records in your database instead of the page. Give a\ntable a `source` and `<SvBase>` loads the records from it when it opens, then\nwrites every change back: a cell edit, a pasted range, a new record, a\ndeleted one, a link made from either side. Postgres, MySQL, SQLite, Supabase\nand any REST API work the same way, because each is reached through the\ndata source contract the grid already uses.\n\n<div data-docs-demo=\"516-base-postgres\" data-height=\"760\"></div>\n\nThe demo above is SvGrid Base on a real Postgres database running in the\npage (PGlite). Change a status and the log shows the `UPDATE` it ran.\n\n## How it fits together\n\n\n\n- **The page holds every record of a table.** Views, filters, groups,\n summaries, colors and automations all work on those records, so they stay\n instant. A table with more records than the page should hold (10,000 by\n default) is read from the database a part at a time instead, by itself: see\n [A table of millions](#a-table-of-millions).\n- **The writer sends what changed.** After each change it compares the\n tables with what the database holds and queues an `INSERT` for a new\n record, an `UPDATE` with only the fields that changed, or a `DELETE`. The\n writes go one at a time, in order, so an update never overtakes the insert\n of its own record.\n- **A refused write goes back.** When the database says no (a constraint, a\n row level security policy, a network error), the cell returns to what the\n database holds, the end of the tab bar says why in plain words, and a notice\n names the record and the field. What the database said is in the tooltip, or\n through an endpoint in the server log, because it names tables and values:\n [what a person reads](./postgres.md#3-one-endpoint-per-table).\n- **Changes made elsewhere come in.** With `realtime`, the base reads a table\n again when someone else changed it and takes what moved, without writing\n anything back.\n\n## Give a table a source\n\n`baseSource` wraps any data source:\n\n```ts\nimport { baseSource, type BaseTable } from '@svgrid/enterprise/base'\nimport { createRestDataSource } from '@svgrid/enterprise'\n\nconst tasks: BaseTable = {\n id: 'tasks',\n name: 'Tasks',\n primaryField: 'name',\n data: [],\n columns: [\n { field: 'name', header: 'Task', fieldType: 'text' },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: [{ value: 'Todo' }, { value: 'Done' }] } },\n ],\n source: baseSource(createRestDataSource({ url: '/api/tasks' })),\n}\n```\n\n```svelte\n<script lang=\"ts\">\n import { SvToaster } from '@svgrid/grid'\n import { SvBase, enableBase, type BaseTable } from '@svgrid/enterprise/base'\n\n enableBase()\n let { tables }: { tables: BaseTable[] } = $props()\n</script>\n\n<SvBase bind:tables editable />\n<SvToaster />\n```\n\n`data` can start empty: the base fills it. A write that is refused shows a notice\nand the tab bar says so; see [Notices](./quick-start.md#notices).\n\nThe data sources that ship with `@svgrid/enterprise`:\n\n| Source | Talks to | Tutorial |\n|---|---|---|\n| `createSupabaseDataSource` | Supabase (PostgREST), from the browser | [Build a base on Supabase](./supabase.md) |\n| `createSqlDataSource` | Any SQL database, through an `execute(sql, params)` you write. It reads and writes the columns on its schema and no others; `wholeRecords: true` reads and writes every column, for a source in the same process as the page, and `createKitHandlers` refuses one | [Build a base on Postgres](./postgres.md) |\n| `createKitDataSource` | Your SvelteKit endpoint, which runs `createSqlDataSource` on the server | [Build a base on Postgres](./postgres.md) |\n| `createRestDataSource` | A JSON API: `GET`, `POST`, `PATCH`, `DELETE` | [Build a base on your API](./rest-api.md) |\n| `createInMemoryDataSource` | An array, for tests and prototypes | |\n\nYour own source works too: an object with `getRows`, `createRow`,\n`updateRow` and `deleteRow` (the grid's `ServerDataSource`).\n\n## Tables your server makes, copies and deletes\n\nA table with a source lives in your database, so a new one should too. Give\n`<SvBase>` the four hooks and the tab bar's Add table, Duplicate table and\nDelete table, and the trash's Restore for a table, go through your server:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, baseSource, type BaseTable } from '@svgrid/enterprise/base'\n import { createRestDataSource } from '@svgrid/enterprise'\n\n let { tables } = $props()\n\n // What your API answers for a table, as a BaseTable reading its records from it.\n const asTable = (t: any): BaseTable => ({ ...t, data: [], source: baseSource(createRestDataSource({ url: `/api/tables/${t.id}/rows` })) })\n const post = async (url: string, body?: unknown) => {\n const res = await fetch(url, { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify(body ?? {}) })\n if (!res.ok) throw new Error((await res.json()).error ?? 'The table was not saved.')\n return res.json()\n }\n</script>\n\n<SvBase\n bind:tables\n editable\n onAddTable={async (name) => asTable(await post('/api/tables', { name }))}\n onDuplicateTable={async (table, name) => asTable(await post(`/api/tables/${table.id}/copy`, { name }))}\n onDeleteTable={async (table) => (await post(`/api/tables/${table.id}/trash`)).item}\n onRestoreTable={async (item) => asTable(await post(`/api/tables/${item.table.id}/restore`))}\n/>\n```\n\n- **Add table** calls `onAddTable` with the name the base would give the\n table (\"Table\", \"Table 2\"...). The table it answers is added and opened,\n and its `source` is read at once, as the first tables' were. Nothing\n answered adds nothing. A rejection's message is shown.\n- **Import a file as a table** calls `onImportTable` with the table the\n import built: its fields (with the types it found) and its records in\n `data`. Keep it, and answer the table to add, with its `source`; it opens and\n is read from there. Nothing answered adds nothing; a rejection's message is\n shown. Without the hook the table is made in the page.\n- **Duplicate table** calls `onDuplicateTable` with the table and\n \"Name copy\". The copy it answers is added and opened.\n- **Delete table** asks the person first, as always, then calls\n `onDeleteTable`. `false`, or a rejection, keeps the table. A trash item it\n answers is what the trash shows for the table, and your `trashStore` is not\n handed it again. Otherwise the base keeps its own item.\n- **Restore** of a table in the trash calls `onRestoreTable` with the item.\n The table it answers goes back where it was, read from its `source`, and\n opens. Nothing answered leaves the item in the trash.\n\nA table made, copied or brought back this way is yours, not a step of the\npage's history: Ctrl+Z does not take it away. Without a hook, the base makes,\ncopies, deletes and restores tables in the page, as before.\n\nAny table you put in `tables` after the base opened, hooks or not, is read\nfrom its `source` and kept in sync like the first ones.\n\n## Link fields\n\n\n\nIn the page a link field holds record ids. `links` says how each one is kept:\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport { createRestDataSource } from '@svgrid/enterprise'\n\nconst taskTags = createRestDataSource({ url: '/api/task_tags' })\n\nconst source = baseSource(createRestDataSource({ url: '/api/tasks' }), {\n links: {\n // A link to one record: the column with the linked record's id.\n project: { column: 'project_id' },\n // A link to many records: a junction table, one row per pair.\n tags: { through: taskTags, from: 'task_id', to: 'tag_id' },\n },\n})\n```\n\nThe field that links back (a project's Tasks, when tasks have a Project\nfield) is worked out in the page from the other side and never stored. Link\na task from the project's side and the base writes that task's\n`project_id`. A link field that is neither in `links` nor the other side of\none is written as it is, a list of ids, which suits a Postgres `text[]` or a\n`jsonb` column.\n\nA list (a multiple select, a vote, a sparkline) goes to its column as that column takes\nit: an array to `text[]`, JSON to `json` and `jsonb`, and JSON text to a text column, on\nMySQL, SQL Server and SQLite too. It reads back as the list it was.\n\n## Keys the base can use\n\nA record needs one column that names it. When a base reads a database:\n\n- A table with a primary key of one column is a table.\n- A table keyed by both ends, `order_tags (order_id, tag_id, primary key (order_id, tag_id))`,\n with both columns foreign keys, is a link to many, like a junction with its own `id`. A\n link goes by the whole key, so removing a tag deletes that one pair. A tenant column in\n the key, named in `tenantColumn`, is part of the key and no end of the link. Other columns\n on such a table are not read and not written: a new link gives them their defaults, one\n that is `NOT NULL` with no default refuses the link, and the server log names them. A\n pair whose two ends the base does not hold, by their keys, is left out.\n- Any other table with a composite key, or with no primary key, is left out of the base, a\n view included. The rest of the base opens, and the log names the table and says why.\n Nothing runs on part of a key, because a delete by one column of two reaches every row\n that shares it.\n\n`keys` brings such a table in, when one of its columns is unique:\n\n```ts\nexport const { GET, POST } = createBaseEndpoint({ execute, allTables: true, public: true, keys: { v_orders: 'id' } })\n```\n\nThat is your word for it: nothing checks, and a delete reaches every row that holds the\nvalue. `baseFromDatabase` and `baseFromSupabase` take it too. On Supabase the key comes\nfrom the API description; a project that does not show that to the key in use has only a\ncolumn named `id` to go by.\n\n### Foreign keys of more than one column\n\nA foreign key of more than one column, as a database keeps tenants apart with,\n`foreign key (tenant, customer_id) references customers (tenant, id)`, is a link through\n`customer_id` to that tenant's customer, when `tenantColumn` names `tenant` on both tables.\nThe tenant column stays the read-only tenant, not a link. It works the same in a pair\ntable, `(tenant, order_id) -> orders (tenant, id)`. Any other key of more than one column,\nthree columns or two without the tenant, links nothing: its columns are plain values and\nthe log names the key. A key links only to a table its bare name reaches: on Postgres a\ntable of any schema on the search path, unless a table of that name in an earlier schema\nhides it (a key to a hidden table stays a plain value); on SQL Server the user's default\nschema; on MySQL the connected database. The other table still has to be one the base\nserves. Supabase does not describe a key of more than one column, so there\nneither column is a link.\n\n## Record templates\n\nA table's `recordTemplates` are saved values a new record can start with,\nas Airtable's record templates. The arrow beside \"+ Add row\" lists them; a\nrecord added from one gets its values, worked out at that moment and written\nas an automation's \"Update the record\" writes them: an option's name, a\nperson's name, `today` or `today+7` for a date, a linked record's name.\n\n```ts\n{\n id: 'tasks',\n name: 'Tasks',\n columns,\n recordTemplates: [\n { id: 'bug', name: 'Bug report', values: { status: 'Todo', priority: 'High', due: 'today+3' } },\n ],\n}\n```\n\n\"Manage templates\" in the same menu adds and changes them, for whoever may\nchange the table's design (`permissions.canEditSchema`); the changed table\ncomes back through `onTablesChange`. Keep `recordTemplates` with the rest of\nthe table's design on your server.\n\n## Record ids\n\nA new record gets an id in the page at once, so it can be edited and linked\nbefore the database answers. By default that id is its key in the database\ntoo: give the key column a text type.\n\nWhen the database makes the key (a `serial` column, a `uuid` with a default),\nset `serverIds: true`. The record is inserted without the page's id, and the\nwriter keeps the page id for the grid and translates to the database id for\nevery later write and every link that points at the record.\n\n## What a write answers\n\nThe row a server answers is the truth. After a write the cell, the record and the views\nshow what was stored: a value a `before*` hook or a trigger changed, a tenant the scope\nstamped, a default on a new record. A number the column rounded shows rounded. Undo goes\nback from what was stored. A block of Edit fields or of a range on a big table answers with\nwhat hooks changed, and a trigger's work on such a block shows when the view reads the rows\nagain. On a table the page holds, a paste, a clear or an Undo of 20 records or more is\nwritten in blocks, and each block's records are read back once it lands, so a trigger's\nwork shows at once there too.\n\nThe answer is the row the write left, not a teammate's write a moment later. Postgres and\nSQLite say it in the write itself (`RETURNING`). SQL Server writes and reads it back in one\ntransaction of one batch. MySQL has no way to do either in one statement: give\n`createSqlDataSource` (or `baseFromDatabase`, `createBaseEndpoint`) its `transaction` and the\nwrite and its read go in one. Without it a teammate's write to the same cell in the moment\nbetween the two is taken for yours, and an Undo of yours can then write over theirs.\n\n## What is not written\n\nFields the page works out are never sent: formula, lookup, rollup, count and\nbutton fields, and the field that links back. Add any other field to `skip`\nto keep it in the page only.\n\n## What a cell holds\n\nA base reads dates, times, bigints and decimals as the database writes them, as\ntext. A SQL source asks for a text copy of each such column\n(`to_json(col) #>> '{}'` on Postgres, `CAST(col AS CHAR)` on MySQL) beside the\ncolumn itself, so sorting and filtering still use the real column.\n\n| Column | What the page holds | What people see |\n|---|---|---|\n| `date` | `2026-03-08` | That day, in any zone |\n| `timestamp`, `datetime` | `2026-03-08T02:30:00.123456` | That wall clock, in any zone |\n| MySQL `timestamp` | The wall clock of the connection's `time_zone` | That wall clock, in any zone |\n| `timestamptz` | `2026-03-14T22:00:00.654321+00:00` | That moment, in the viewer's zone |\n| `bigint`, `numeric`, `decimal` | Text past what a JS number holds | Every digit |\n| `json`, `jsonb` | The text the database writes | Every digit: a driver's `JSON.parse` would round a number past 2^53 |\n\nA time someone types keeps its wall clock on a column without a zone, and is that\nmoment on a `timestamptz`. An undo or a restore writes back the text it read, so\nnothing moves by a zone or loses digits past the millisecond.\n\nThe days of a filter and the months of a chart are the viewer's. On a column of moments\n(Postgres `timestamptz`, SQL Server `datetimeoffset`, SQLite text that ends in a zone)\n\"is 8 March\", \"today\" and \"within the past week\" keep the records whose moment falls on\nthose days where the person is, and a chart counts each record in the month it reads as\nthere, across a change of the clocks too. The page sends each date condition with the\nmoments its days start and end (`moments` on the condition), since a server has no zone\nof the viewer's, and `createSqlDataSource` compares them on such a column. A date and a\nwall clock, a MySQL `TIMESTAMP` among them, compare their days and read the same everywhere.\nOn Supabase, say which columns hold moments: `supabaseFieldFilter(columns, { moments: (def) => def.field === 'starts_at' })`.\nWithout that, a condition there compares the database's days.\n\nOver PostgREST (Supabase) a date already arrives as text. A JSON number cannot\ncarry more than about 15 digits, so the first read that shows a longer one reads\nthat column again with `col::text`, and later reads bring the copy along. A change\nthat arrives through Realtime is plain JSON: such a number in it is rounded until\nthe next read.\n\nJSON in a `text` or `longText` field shows as JSON text. A change goes back as\nJSON; text that is not valid JSON is refused with a message and the cell goes back. A\n`jsonb` column writes its own spaces and key order, and that is no change: nobody is told\nof one. Over PostgREST a JSON column arrives as JSON, so a number past 2^53 in it is rounded.\n\nOpening a cell and leaving it writes nothing, whatever the field shows.\n\n## Changes made elsewhere\n\n\n\n`realtime` takes a function that calls `apply` with what changed and returns a\nfunction that stops listening. With Supabase, hand it Realtime's events as\nthey come:\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport {\n createSupabaseDataSource,\n createSupabaseRealtime,\n type EntitySchema,\n type SupabaseClientLike,\n type SupabaseRealtimeClientLike,\n} from '@svgrid/enterprise'\n\n// Your supabase-js client: createClient(url, anonKey).\ndeclare const client: SupabaseClientLike & SupabaseRealtimeClientLike\ndeclare const schema: EntitySchema\n\nconst source = baseSource(createSupabaseDataSource({ client, table: 'tasks', schema }), {\n realtime: (apply) => createSupabaseRealtime({ client, table: 'tasks', onChange: apply }),\n})\n```\n\nThe base updates just the records a change names: the other records keep\ntheir objects, so the grid redraws one row, not 50,000, and the table is not\nread again. A burst of changes (an agent updating 200 records) goes into the\npage as one update. A change to a record this page wrote in the last few\nseconds may be its own write coming back late, or someone else's edit after\nit: that record alone is read again, by id, to know which.\n\nAny other feed works the same way: a WebSocket message, a server-sent event,\na poll. Call `apply` with the changes, as the database has the records\n(its column names, its ids):\n\n```ts\nimport { baseSource, type BaseChangeInput } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\ndeclare const tasksSource: ServerDataSource<Record<string, unknown>>\n\nconst source = baseSource(tasksSource, {\n realtime: (apply: (changes?: BaseChangeInput) => void) => {\n const socket = new WebSocket('wss://example.com/tasks')\n socket.onmessage = (m) => {\n const { type, id, row, changed } = JSON.parse(m.data)\n if (type === 'update' && changed) apply([{ type: 'update', id, fields: changed }])\n else if (type === 'delete') apply([{ type: 'delete', id }])\n else apply([{ type, record: row }])\n }\n return () => socket.close()\n },\n})\n```\n\n| A change | Carries |\n|---|---|\n| `{ type: 'insert', record }` | The new record, with its key column. |\n| `{ type: 'update', id, record }` | The whole record as it is now. |\n| `{ type: 'update', id, fields }` | Just the columns that changed. |\n| `{ type: 'delete', id }` | The key of the record that went. |\n\nA change that comes back from the page's own write (the database tells every\nlistener, the page that wrote it included) moves nothing and is not reported.\nAn update with `fields` for a record the page does not have, and `apply()`\nwith nothing, read the whole table again. An update with `id` alone reads that one record.\n\n### A feed on an endpoint\n\n`baseFromEndpoint` takes one `feed` for the whole base. It opens when the first table\nlistens and closes with the last. Each message names its table, a junction table\nincluded, and a change in a junction reaches the record it starts from:\n\n```ts\nimport { baseFromEndpoint } from '@svgrid/enterprise/base'\n\nconst tables = await baseFromEndpoint('/api/base', {\n feed: (apply) => {\n const events = new EventSource('/api/base/feed')\n events.onmessage = (e) => {\n // { \"table\": \"orders\", \"changes\": [{ \"type\": \"update\", \"id\": \"o1\", \"fields\": { \"status\": \"Paid\" } }] }\n const { table, changes } = JSON.parse(e.data)\n apply(table, changes)\n }\n // After a reconnect, changes may have been missed: every table reads again.\n let opened = false\n events.onopen = () => {\n if (opened) apply()\n opened = true\n }\n return () => events.close()\n },\n})\n```\n\n`apply(table)` with no changes reads that table again, and `apply()` reads every table again.\n\nKeep it to one connection. A browser opens at most six connections to one host over\nHTTP/1.1, which is what a Vite or Node dev server speaks, and a connection held open by a\nfeed is one of them. With a feed per table on a base of six tables and junctions, no write\nreaches the server. `realtime: (table, apply) => stop`, called per table, is still taken\nfor a feed that shares one connection itself, such as channels on one socket.\n\nThe feed is yours to write and yours to scope: with a tenant `scope`, send each person their\ntenant's rows only.\n\n### What a feed has to cover\n\nA feed is per table, and some of what a person changes is not in that table:\n\n- **A link to many lives in its junction table.** Adding a tag writes a row to `order_tags`\n and nothing to `orders`, so a feed of `orders` alone never tells teammates. Listen to the\n junction too, on the table that stores the link, and name the record it starts from:\n\n ```ts\n import { baseSource } from '@svgrid/enterprise/base'\n import type { ServerDataSource } from '@svgrid/grid'\n\n declare const ordersSource: ServerDataSource<Record<string, unknown>>\n declare const orderTags: ServerDataSource<Record<string, unknown>>\n // Your feed: calls back with what changed in that table, and returns how to stop.\n declare function listen(table: string, on: (change: any) => void): () => void\n\n const source = baseSource(ordersSource, {\n links: { tags: { through: orderTags, from: 'order_id', to: 'tag_id' } },\n realtime: (apply) => {\n const orders = listen('orders', (change) => apply(change))\n const pairs = listen('order_tags', (row) => apply(row?.order_id == null ? undefined : { type: 'update', id: row.order_id }))\n return () => { orders(); pairs() }\n },\n })\n ```\n\n A feed that only says \"something changed\" calls `apply()` for both. `baseFromSupabase`\n and `baseFromEndpoint` listen to the junction tables by themselves, and needs them in the `supabase_realtime`\n publication. A delete's event there has only the key unless the junction table has\n `REPLICA IDENTITY FULL`, so a removed link reads the table again.\n- **A soft delete reaches a feed as an update.** The base reads an update that sets the mark\n as a delete, so send the column. Through `createKitDataSource` the page learns the column\n from the server's first answer. A restore reads as an update of a record the page does not\n have. A page-held table takes it in, and reads the table if it has links through a junction.\n A table read a part at a time reads the rows on screen, at most once a second, because a\n feed cannot tell a restore from an edit of a record scrolled out of view.\n- **A feed that goes down says nothing.** Nothing here can tell silence from no changes.\n\n### What people see\n\nA change made elsewhere does not just appear. Until someone opens the record:\n\n- in a grid view, the cells that changed are tinted, and a record added\n elsewhere is tinted across the row (Kanban and gallery cards are not);\n- the row number has a dot; hover it for \"Ana Ruiz changed this record 2\n minutes ago\";\n- the view bar counts them, \"3 changed by Ana Ruiz\", and a click on the count\n marks them all seen.\n\nOpening the record clears its marks. Its activity lists each change as\n\"Ana Ruiz changed Priority\", with the value before crossed out and the value\nnow: Low → Urgent.\n\nThe name comes from the record itself: its `lastModifiedBy` field (for a\nrecord added elsewhere, `createdBy` first). Whoever writes to the database\nwrites their user id to that column, and the base looks it up in\n`setFieldUsers`. Without such a field the change is credited to \"Someone\nelse\". Your own writes are never reported back to you: the base compares what\nit reads with what it last wrote.\n\n### An AI agent writing to the base\n\nThe same path serves an agent: a script, a worker calling a model, or Claude\nCode with your database's MCP server. Give the agent a user id, add it to\n`setFieldUsers` with a name and an avatar, and have it set `modified_by` (or\nwhichever column your `lastModifiedBy` field reads) on every row it writes.\nPeople then see exactly what it changed, review it in a view filtered on a\n\"Needs review\" field, correct what it got wrong, and approve the rest with a\nbutton field and an automation.\n\n[Let an AI agent work in your base](./ai-agents.md) walks through it with\nClaude Code and Supabase, and [Review what an agent changed](./review-queue.md)\ncovers the review side on any database. Here the agent is a stand-in made of\nkeyword rules, so the demo runs without a model or a key. It writes to the database with SQL; press \"Run the triage\nagent\", then open a ticket.\n\n<div data-docs-demo=\"700-base-ai-triage\" data-height=\"900\"></div>\n\nTo act on changes made elsewhere in code (a notice, a log, a count of your\nown), pass `onRemoteChange` to `<SvBase>`. It gets each change once it is in\nthe page:\n\n```ts\nimport type { BaseRemoteChange } from '@svgrid/enterprise/base'\n\nfunction onRemoteChange(changes: BaseRemoteChange[]) {\n for (const c of changes) {\n // c.type: 'insert' | 'update' | 'delete'; c.table, c.id, c.record\n // c.fields (updates): [{ field: 'priority', from: 'Low', to: 'Urgent' }]\n if (c.type === 'update') console.log(c.id, c.fields)\n }\n}\n```\n\n## Status and errors\n\nThe end of the tab bar says what the base is doing:\n\n| It reads | When |\n|---|---|\n| Loading records... | The tables are loading |\n| Saving... | Writes are on their way |\n| Still saving: the server has not answered yet | A write has been waiting a while |\n| All changes saved | Every write went through |\n| Not saved: *reason* | A write was refused; the cell went back |\n\n\n\nA table that cannot be read says so where its records would be, for as long as it lasts,\nwith why and a **Try again**. No empty table is shown for it, and nothing can be added to\nit. The other tables of the base open as usual.\n\nA table read a part at a time (`serverRows`) whose next part cannot be read says so in the\ntab bar, \"Could not load *table*: *reason*\", with **Try again**, for as long as a part of the\nview is unread, wherever it is scrolled to. The rows that did not come are a tinted band with\n\"Could not load these rows.\" and **Retry** on its first row on screen. A read again of rows\nalready on screen, after a teammate's change, that fails leaves those rows as they were: the\ntab bar says so with **Try again**, which reads them again.\n\nWhen the server sent a reason with its error (`{ \"error\": \"...\" }` and no `code`), that reason\nis what the notice says. `createRestDataSource` passes on an API's `{ \"error\" }` or\n`{ \"message\" }` the same way.\n\nA failed write is told in a notice that names the record and the field, says why in\nplain words and shows what was entered, with **Try again** where that can work. The record\nis named as it is stored, never by the value that was refused. A foreign key of more than one\nfield that refuses a write names all of its fields. The notice stays until it is dismissed,\nand \"Not saved\" stays until that record is written: a later write of another record does not\nclear it. A click, a tap or Enter on the status line opens it in full: the reason, and the\nserver's own words when it sent some and the reason does not already say them. The text of\nthe request itself (a status code, a JSON body) is never shown; it is in the browser's\nnetwork log and the server's log.\n\nA new record the database refused takes no edit while it is still listed (while another cell or\nrecord is being edited, or a draft on a table read a part at a time whose refusal no retry can\nchange, such as an id column too narrow): a click, a key or a paste on\nit shows its notice again instead of an editor. An editor open on it when the refusal comes closes\nwith what it holds, and the notice names it. A draft refused for a reason a retry may get past keeps\ntaking edits, and its next edit sends it again.\n\n**Try again** reads the record first, as an undo does. A value that changed since the\nwrite failed, whether a teammate wrote it or you typed it again, keeps that value and the\npage says so. A record deleted since is reported with what you entered. If the record\ncannot be read, nothing is written and the notice offers Try again once more.\n\nA change of many records at once (a paste, a clear or an Undo of 20 or more) that fails\nis one notice with the number of records, and the same **Try again**: it reads them all\nfirst, sends what is still as it was in blocks, and says how many cells changed since and\nhow many records were deleted since. Part of a block may have landed; the page reads the\ntable again to show which. An Undo of some of those cells takes them out of what Try\nagain would send. A refusal of your permission offers no Try again and leaves no step to\nundo, and so does a refusal of the values, an answer of `400`, `409` or `422`: the same\nvalues would be refused again.\n\nA write that gets no answer is not given up on: it may still land, or be refused. After\n`writeTimeout` (60 seconds by default, on `<SvBase>`) writes to other records go on, and\nlater writes to the same record wait behind it, so none can overtake it or be overwritten\nby it landing late. The status says \"Still saving\" for as long as it has no answer, and\nstarts warning at a sixth of `writeTimeout`. The page keeps what was entered, and goes back\nonly if the write is refused. A delete with no answer keeps its copy in the trash until the\noutcome is known, and leaving the page asks first.\n\nWhile someone is typing in a cell or in a field of a record, changes from others wait\nuntil the editor closes, so no row moves under it and no text changes under the cursor.\nThat holds for a live feed and for a read of the table, on any table. If the record was\ndeleted meanwhile, saving it says so and shows the text.\n\n## Options\n\n`baseSource(dataSource, options)`:\n\n| Option | Default | What it does |\n|---|---|---|\n| `links` | none | How link fields are stored: `{ column }` or `{ through, from, to }` |\n| `columns` | none | Column names that differ from field names: `{ dueDate: 'due_date' }` |\n| `idField` | `'id'` | The key column |\n| `serverIds` | `false` | The database makes the key of a new record |\n| `realtime` | none | Hear of changes made elsewhere: `(apply) => stop`; `apply(changes)` updates those records in place |\n| `skip` | none | Fields kept in the page only |\n| `holdInPage` | `10000` | How many records a table may hold in the page. It is where a table changes how it is read, not a cap: a bigger one is read from the database a part at a time, and no record is left out. (`limit` is the old name.) |\n| `convertField` | none | A field of a big table changed type: rewrite its values in the database and resolve with `true`. Without it the base rewrites them a block at a time. |\n| `duplicate` | none | Copy a big table in the database and resolve with the new table's source. |\n| `serverRows` | automatic | `true` always reads from the database, and the first screen comes sooner on a table you know is big; `{ blockSize }` sets the rows per request (200). `false` always holds every record in the page, however many. Left out, the base decides by `holdInPage`. |\n\n## Build a base from your database\n\n`baseTablesFromSchemas` makes the tables from your database's own\ndescription of them: a number column becomes a number field, an enum a\nsingle select with its values, a foreign key a link with a field in the\nother table that links back. Read the descriptions with\n`introspectSupabaseTable`, `introspectDatabase` or `introspectOpenApi`, or\nwrite them out:\n\n```ts\nimport { baseTablesFromSchemas } from '@svgrid/enterprise/base'\nimport { createRestDataSource, type EntitySchema } from '@svgrid/enterprise'\n\nconst schemas: EntitySchema[] = [\n {\n name: 'deals',\n fields: [\n { field: 'id', type: 'text', primaryKey: true },\n { field: 'title', type: 'text' },\n { field: 'stage', type: 'enum', options: [{ value: 'Open', label: 'Open' }, { value: 'Won', label: 'Won' }] },\n { field: 'company_id', type: 'relation', relation: { entity: 'companies', labelField: 'name' } },\n ],\n },\n { name: 'companies', fields: [{ field: 'id', type: 'text', primaryKey: true }, { field: 'name', type: 'text' }] },\n]\n\nconst tables = baseTablesFromSchemas(schemas, (schema) => createRestDataSource({ url: `/api/${schema.name}`, schema }))\n```\n\nThe result is ordinary `BaseTable` objects: change a field's type, add views,\nrename a table. [Build a base on your API](./rest-api.md) does this end to end.\n\nThe other way round, `baseToSql(tables)` writes a base as Postgres SQL:\ntables, foreign keys, the tables behind links to many, and the records, with\n`svgrid:` comments for the field settings, views and automations that SQL\nhas no type for. The tables it makes have text keys with a\n`gen_random_uuid()` default, so a record added later gets its key from the\ndatabase. See [Take a base to a database](./quick-start.md#take-a-base-to-a-database).\n\n## A table of millions\n\nA table has no size limit, and nothing here is a setting you have to get right.\nA table of the thousands of records a team keeps in a tracker, a CRM or an\ninventory is held in the page. One that grows past `holdInPage` is read from the\ndatabase a part at a time, the next time it is read, and looks and works the\nsame: every view, link, lookup, rollup, automation and search reads all of it.\nThe page then holds none of its records, only what is on screen.\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\ndeclare const orders: ServerDataSource<Record<string, unknown>>\n\n// Nothing to set: it reads from the database once the table outgrows the page.\nconst source = baseSource(orders)\n\n// A table you know is big: skip the first look, and size the requests.\nconst big = baseSource(orders, { serverRows: { blockSize: 200 } })\n```\n\n<div data-docs-demo=\"723-base-million-orders\" data-height=\"620\"></div>\n\nHow each part of a base reads such a table:\n\n| | Read a part at a time |\n|---|---|\n| Grid views | Read through the server row model. Each request carries the view's filter (`filterModel.expression`), its sort, its groups (one row per key with its count, the records under an opened key) and the search. The count in the view bar is the server's. A grouped view shows select groups in option order and each group as the field draws it, with the records it holds at every level, and the totals of the fields with a sum, average, lowest or highest picked in the footer. Whenever the view is read again (your delete, Restore, Undo or Redo, a new record, an edit once you leave the record, an option renamed, a field converted, a teammate's change), the group rows and the loaded records of every open group are read, with or without a feed: a deleted record leaves its group, a restored or new one shows in its group, and the counts follow. A group closed at the time reads again when it is opened. A teammate's change that a feed sends with its row patches that row where it is; when it changes a field the view groups or sorts by (any field, when the view groups or sorts by a formula or lookup), the view is read again at once, so the record takes its place in the order and in its group. A filtered view reads again within a second after any change, so a record that left the filter goes. |\n| Kanban | Each lane shows its true size, from one grouped request, and reads its cards as they scroll into sight. A card moved to another lane is written by id and sits at the top of that lane until the lane is read again. Sorted by a number field, dropping a card elsewhere in its lane writes that number, so the order is the table's. |\n| Calendar | Reads the dates on screen and no others. A range of up to 400 records is read whole. A busier one is read a day at a time: each day's first records and its size, from one grouped request where the backend groups and the view has no end date, so an empty day costs nothing and a write reads only the days whose size moved. \"+N more\" lists every record of that day. The days are the viewer's: on a column of moments (Postgres `timestamptz`, SQL Server `datetimeoffset`) the sizes, each day's records and that list follow the page's zone, also across a change of the clocks. A date and a wall clock (`timestamp`, `datetime`, a MySQL `TIMESTAMP`, which reads as the server's clock) show the same everywhere, and their days follow what the cell shows. |\n| Gantt | Rows by start date, read as they scroll into sight. The axis runs from the table's first start to its last end. Dependency arrows and rescheduling reach the rows read so far. |\n| Gallery, list, inbox | Only the records in sight are drawn and read. A grouped list shows each group's size and reads its records when opened. |\n| Chart, dashboard | The server groups and adds up, over every record. A date axis is read a month at a time, in the viewer's months on a column of moments: one grouped request for each part of the records' span with one UTC offset, two a year in a zone with summer time. The records behind a tile show the first 200 and how many there are. |\n| Form | Stores its record through the source, and reads nothing. |\n| Links | A link cell reads the records it names by id, for the cells on screen, in one request. The picker searches the whole table, and a name pasted into the cell is found there. A link edits from either side: on the side that holds no list (a customer's orders), each tick changes that order. |\n| Lookups, rollups and counts | Read the linked records by id. Over a link stored on the big table (a customer's orders), the server counts and adds up: one grouped request a screen, whatever the size. |\n| Search across tables | Each big table searches on the server, and says how many match. |\n| Find in a grid | The search box filters on the server: a find bar could only mark the rows loaded. |\n| Automations | Run on any record, read by id. A scheduled one runs on every matching record, block by block. |\n| Share links | Show the whole table, without the fields the share leaves out. |\n| Autonumber | The next number is the table's largest plus one. Two people can reach it together, so each record is checked once stored: of any two holding a number the later one takes the next, and a column with a UNIQUE constraint refuses the second and the write tries again. Numbers can skip. A number a person deleted in this page is not given out again while it stays open, so an undo finds its number free. After a reload, or on a teammate's page, the number of a deleted record can be given out again, since the next one follows the largest left. A restored record whose number was given out meanwhile takes the next one. |\n| Changing a field's type | Asks first, with the number of records. Then `convertField` does it in one statement (`createSqlDataSource` with `schemaChanges: true` has one on Postgres), or the base reads a block at a time and writes the records whose value changes, sixteen at a time. The other choice changes the field only. |\n| Download as SQL | Writes every record, a block at a time, so the file can be larger than the page could hold. |\n| Duplicate table | Copies in the database with the `duplicate` option (`schemaChanges: true` gives a Postgres source one). Without it the records are read into the page a block at a time, with the count in the tab bar, and the copy lives in the page, so a very large table needs the option. |\n| Edits | Written by id: a change to the 900,000th record is one `update`. |\n| Edit fields | On a selection, in a dialog with progress and Stop. The selection is read first, and only records whose value changes are written, a block of 1,000 at a time. Past 10,000 records it asks first, with the exact number, because Undo cannot take that many back. Stop ends it after the block under way. A block that fails ends it too: the page reads that block back, says how many records changed, and Undo takes those back. Records that landed past 10,000 stay changed. |\n| A range of cells | Paste, one value pasted over a range, Delete, the fill handle and Ctrl+Enter reach every record the selection covers, loaded or not. Up to 200 cells of rows the grid holds are written at once, cell by cell. Anything larger, or reaching rows not loaded, runs in the Edit fields dialog: the records are read in view order, then written a block of 1,000 at a time (200 on a source that writes a request a record, such as Supabase, so the count moves and Stop answers within a block), with the same progress, Stop, count at the end, question past 10,000 and one Undo step. A block the database refuses part way ends the job: the count says how many records changed, and Undo takes those back. If records moved while the range was read (a teammate's edit changed the order or the set of a sorted view), nothing is written or copied: the page says, for a paste, \"Records moved while this was read. Nothing was changed. Try again pastes from \"Acme\" down over the rows as they are now.\", naming the first record selected. Try again finds that record by its id where the list has it at the click, goes from it over as many rows below it as before, and selects those rows first, so the screen shows what it writes; its dialog lies over them, so it names them too (\"From \"Acme\" down over 2,500 rows, selected in the view.\"). If the record is gone or no longer among the rows shown, it writes nothing and says so, and so it does when fewer rows stand below the record now than the first try covered (the record fell to the end of a sorted view): it never turns lines into new records the first try wrote over records that were there. To tell that records moved, the whole id sequence is checked, in requests that ask for ids alone: a range longer than a block reads its ids first and each block must bring the same ids in the same places, each block also reads the last record of the one before again, a record read twice counts as moved, and once the last block is in, the ids of the whole range are read again and must be the very ids read, in the same order. Each of those reads asks for the whole range at once (up to 20,000 ids); a server that caps an answer (PostgREST's `db-max-rows`, 1,000 on Supabase) is read on from where its answer ended, a page of its own size at a time, and only a different id sequence, or a list that ends before the range does, counts as moved. On Supabase and PostgREST these reads select the key alone. Any difference counts, a move inside the part already read too. Try again acts only in the view the cells were chosen in, as it was then: after a switch to another view, or a change of its sort, filter, groups, open groups or shown fields, it writes nothing and says \"That view is no longer open, so nothing was changed.\" or \"The view has changed since, so nothing was changed.\" An answer to a question the job asked (past 10,000 records, new records past the last row, a delete) does the same. A new record that is not stored yet sits on top of the list and in no block of the table: a range over it leaves it out and says how many it left, a paste keeps its line for it, and a copy has its line. A drag of a range over rows not loaded is refused, with the number. A paste while the view is still loading is refused too, and never makes a record. |\n| Copy | Rows not loaded are read first, in a dialog with progress and Cancel, each line a real record with its worked out fields. A copy holds up to 2,000,000 cells: that many, 20 MB of text, took 4.6 s with a longest frame of 450 ms in Chrome on a production build, reading from the page. Past that nothing is copied, the page says how many cells were asked for, and Download gets all of it. If a browser will not take the text so long after the key press, the dialog asks for one more click. |\n| A paste past the last row | A line where no value fits its field makes no record. Up to 10 new records are added at once; past 10 the page asks first, with the number. They go in blocks of 1,000 (`createRows` makes a block one statement), and one Undo takes them out the same way, with the cells the paste wrote. A record someone has worked on since stays, and the page says so. |\n| \"+\" | In every view of records. It opens a new record, filled in from the view's filter (Region is EU in a view of EU orders). Nothing is stored until it holds a value, and one closed empty is gone. If the database refuses it, it stays in the grid with its values and the next edit tries again. What the database fills in, such as an order number, comes back into the record. Ctrl+Z takes a stored record out again. |\n| Insert record, Duplicate | Insert opens a draft, as \"+\" does. Duplicate stores the copy and shows it at the top of the grid. |\n| A new field | The \"+\" at the right of the header row, for whoever may change the schema (`columnAdder={false}` hides it). `createSqlDataSource` with `schemaChanges: true` adds the column on Postgres, MySQL and SQLite. A new field starts empty, or with its default: on a table held in the page the base writes the default to every record; on a table read a part at a time `addField` gets it as `default`, to fill the stored records (the one `createSqlDataSource` makes does not yet). When a column by that name is already in the table it takes the next free name, and says so. A column that cannot be added takes the field back. A source that cannot add one, such as Supabase, shows the `ALTER TABLE` to run, and `addField` on `baseSource` is your own way to make it. There, Duplicate field copies nothing: it shows the statement for the copy's column, to run before duplicating. An Autonumber or Created time field stays blank on the records already there. |\n| Delete | By id, to the trash, as the database holds the record at that moment; Ctrl+Z puts it back whole, columns the base shows no field for included, under the key it had, on a table the page holds and on a big one alike. A column off the source's schema never reaches the page, so it takes its default, unless the source reads whole records (`wholeRecords` on `createSqlDataSource`). The record stays in the trash until the database has it. What only the database may write stays the database's: a generated column works itself out again, and a `GENERATED ALWAYS` key gets a new value. Time columns go back as the database wrote them, past the millisecond and at a local time the clocks skipped, on Postgres and MySQL with any driver. A record the database refuses to delete stays in the table and out of the trash, and so does one a row-level policy skipped without an error: after a delete the base looks. |\n| Soft delete | `softDelete: 'deleted_at'` marks a record instead of removing it, and a restore clears the mark, so nothing is rewritten. See [Undo, trash and import](./undo-trash-import.md#soft-delete). |\n| Select all | Selects every record of the view, read or not, and the count says so; a group's tick selects all of the group. A new filter clears the selection. With `selectionBar={{ actions: ['deleteRows'] }}` (and `enableSelectionBar()`), Delete first reads what the selection covers, then asks with the exact number. The records go a block at a time, with a Stop button: what went before you stopped stays gone and stays restorable. `deleteRows` and `createRows` on your data source make a block one statement. Up to 10,000 go to the trash and can be undone; above that the question says they cannot be restored. A group that reads back a different size from its group row stops the job with nothing deleted, since what was left out of the selection could not be told apart. A record that leaves the view after you confirm is still deleted, since you confirmed that set. |\n| Changes made elsewhere | `apply(changes)` updates those rows in the grid, highlighted and credited, whether the page holds them or not. |\n| Formulas | Worked out in the page for the rows on screen. |\n\nAll of this is `getRows` with what a grid view already sends: a range, the\nview's filter, a sort, `groupBy` and `groupKeys`, an `in` list on the key\n(`filterModel.columns.id.selectedValues`), and for a chart or a total\n`aggregations` and `needsGrandTotal`. Grouping a link for a count from its other\nside sets `groupRawKeys`: group by the linked id, which a foreign key does. A calendar's\n`groupDays` and a chart's `groupMonths` ask for a date level by day (`2026-03-14`) or month\n(`2026-03`), on a column of moments in the zone `dayOffset` minutes ahead of UTC. A source that passes over them answers by value and the page adds the groups\nup, which on a time field is a group a record. The data source applies the view's filter\nand acknowledges it with `appliedExpression: true`. The\nSupabase, REST and SQL sources already answer all of these, and\n`createSqlDataSource` also runs a view's filter, sort, groups and totals on a\nformula, lookup or rollup in the database\n([computed fields in SQL](./server-compute.md#computed-fields-in-sql)). On your own\nsource, index the fields views group and place records by: a busy calendar\nmonth is a request per day.\n\n### Index what views sort on\n\nA sort on a column with no index sorts the table again for every block a person\nscrolls to, and that is what limits how many people a big table serves. Give each\nfield a view sorts on an index with the table's key after it:\n\n```sql\nCREATE INDEX orders_amount ON orders (amount, id);\n```\n\nThe key is there because a read breaks ties on it, in the sort's direction\n(`ORDER BY amount DESC, id DESC`). Leave both columns ascending, as above: one index\nthen serves a sort either way. `(amount DESC, id)` matches neither direction, and on\nMySQL it goes unused.\n\nThrough `createBaseEndpoint` on a table of 1,000,000 records, sorted on a numeric\ncolumn, blocks of 100, default database settings, on a shared development machine:\n\n| Median time for a block | No index | With the index |\n|---|---|---|\n| Postgres, one person | 2,263 ms | 567 ms |\n| MySQL, one person | 2,476 ms | 42 ms |\n| Postgres, 30 people at once | 23,576 ms | 2,118 ms |\n| MySQL, 30 people at once | 22,968 ms | 713 ms |\n\nA formula or a lookup has no column to index: a sort on one costs a sort of the\ntable for every block, so a view with many people on it is better sorted on a stored\nfield. A filter narrows what is sorted, and an index that starts with the filtered\nfield and ends with the sorted one serves both.\n\n### What the database cannot run\n\nA view never goes unanswered. When a filter, sort, group or total needs a field\nthe data source cannot compute, or the source does not acknowledge a filter, or\nit fails on a computed field, the page reads the table a block at a time, works\nthe field out with the same code the cells use, and keeps the ids and the values\nthe request needs. The view then reads its records by id. The tab bar shows how\nfar it has got.\n\nIt gives what the cells say, on any backend, and it is slower than the database:\nabout a minute for a lookup over the 1,000,000 records of the demo on a dev\nserver. It is read once. Scrolling, sorting again and the lanes of a board cost\nnothing more, a record you or someone else changes is updated where it stands,\nand changing a field reads again. Taking the sort or filter away stops the read.\nRecords changing while it reads are read again once, and if the count still moves\nthe base says so.\n\nTell the base what your source can work out with `computes`, and that field stays\nin the database. Without it, only `createSqlDataSource` is asked: a `queryRecords`\nbackend needs `computes: () => true` or it is right but slow.\n\n```ts\nimport { baseSource } from '@svgrid/enterprise/base'\nimport type { ServerDataSource } from '@svgrid/grid'\n\ndeclare const orders: ServerDataSource<Record<string, unknown>>\n\nconst source = baseSource(orders, { computes: (def) => def.field === 'tax' })\n```\n\n`@svgrid/enterprise/base/compute` has both halves:\n[`queryRecords`](./server-compute.md#answer-a-paged-table) for records a\nserver holds, and [`fieldFilterToSql`](./server-compute.md#the-views-filter-in-sql)\nfor a database.\n"
|
|
5203
5203
|
},
|
|
5204
5204
|
{
|
|
5205
5205
|
"slug": "help/base/forms",
|
|
5206
5206
|
"path": "docs/help/base/forms.md",
|
|
5207
5207
|
"title": "Collect records with forms",
|
|
5208
5208
|
"section": "SvGrid Base",
|
|
5209
|
-
"markdown": "# Collect records with forms\n\nA form view asks for some of a table's fields and adds a record when it is\nsent. Use it for records other people start: a bug report, an expense, a\njob application. This page builds a hiring tracker's application flow.\nCandidates apply through a form, the record lands in the Candidates table,\nand recruiters move it across a Kanban by stage.\n\n<div data-docs-demo=\"514-base-hiring-tracker\" data-height=\"680\"></div>\n\nIn the demo, pick the \"Apply\" view, fill in the form and press Submit, then\nswitch to \"Hiring pipeline\": the new candidate is a card in Applied.\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\n## 1. Declare the Candidates table\n\nKeep the fields in one module. The base imports them, and so do the public\npage and the server you build later on this page, so all three agree on\nfield ids and types.\n\n```ts\n// src/lib/hiring.ts\nimport type { BaseTable } from '@svgrid/enterprise/base'\n\nexport const STAGES = [\n { value: 'Applied', color: '#94a3b8' },\n { value: 'Phone screen', color: '#18bfff' },\n { value: 'Onsite', color: '#2d7ff9' },\n { value: 'Offer', color: '#fcb400' },\n { value: 'Hired', color: '#20c933' },\n { value: 'Rejected', color: '#f82b60' },\n]\nexport const SOURCES = [{ value: 'Careers page' }, { value: 'Referral' }, { value: 'Job board' }]\n\nexport const candidateColumns: BaseTable['columns'] = [\n { field: 'name', header: 'Candidate', fieldType: 'text' },\n { field: 'email', header: 'Email', fieldType: 'email' },\n { field: 'phone', header: 'Phone', fieldType: 'phone', description: 'With the country code.' },\n { field: 'role', header: 'Role', fieldType: 'link', fieldProps: { table: 'roles', multiple: false, inverse: 'candidates' } },\n {\n field: 'resume', header: 'Resume', fieldType: 'attachment',\n fieldProps: { accept: '.pdf,.doc,.docx', maxFiles: 1, maxSize: 10 * 1024 * 1024 },\n description: 'One PDF or Word file, up to 10 MB.',\n },\n { field: 'portfolio', header: 'Portfolio', fieldType: 'url', description: 'A site, a repository or a design portfolio.' },\n { field: 'years', header: 'Years of experience', fieldType: 'number', fieldProps: { format: 'integer', allowNegative: false } },\n { field: 'start', header: 'Earliest start', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'notes', header: 'Notes', fieldType: 'longText' },\n // The team's fields. The form leaves them out.\n { field: 'stage', header: 'Stage', fieldType: 'singleSelect', fieldProps: { options: STAGES, default: 'Applied' } },\n { field: 'source', header: 'Source', fieldType: 'singleSelect', fieldProps: { options: SOURCES } },\n { field: 'recruiter', header: 'Recruiter', fieldType: 'user' },\n { field: 'applied', header: 'Applied', fieldType: 'createdTime' },\n]\n\nexport const roleColumns: BaseTable['columns'] = [\n { field: 'name', header: 'Role', fieldType: 'text' },\n { field: 'candidates', header: 'Candidates', fieldType: 'link', fieldProps: { table: 'candidates', multiple: true, inverse: 'role' } },\n]\n\n/** What a candidate fills in, in order. */\nexport const APPLY_FIELDS: string[] = ['name', 'email', 'phone', 'role', 'resume', 'portfolio', 'years', 'start', 'notes']\n```\n\nThe form labels each field with the column's `header`, the type's icon in\nfront of it. A column's `description` is the help text: the form shows it in\nsmall grey type under the field, and the grid shows it on the info mark in\nthe header.\n\n## 2. Add the form view\n\nA form is a view, next to the pipeline and the grid:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, setFieldUsers, type BaseTable } from '@svgrid/enterprise/base'\n import { APPLY_FIELDS, candidateColumns, roleColumns } from '$lib/hiring'\n\n enableBase()\n setFieldUsers([{ id: 'u1', name: 'Ana Ruiz' }, { id: 'u2', name: 'Ben Okafor' }])\n\n let { candidates, roles }: { candidates: Record<string, unknown>[]; roles: Record<string, unknown>[] } = $props()\n\n let tables = $state.raw<BaseTable[]>([\n {\n id: 'candidates',\n name: 'Candidates',\n primaryField: 'name',\n data: candidates,\n columns: candidateColumns,\n views: [\n { id: 'pipeline', name: 'Pipeline', type: 'kanban', stackBy: 'stage' },\n { id: 'all', name: 'All candidates', type: 'grid', color: { mode: 'field', field: 'stage' } },\n {\n id: 'apply',\n name: 'Apply',\n type: 'form',\n formFields: APPLY_FIELDS,\n formTitle: 'Join the team',\n formDescription: 'Tell us about yourself. We reply to every application within a week.',\n formRequired: ['name', 'email', 'role', 'resume'],\n formSubmitLabel: 'Send application',\n },\n ],\n },\n { id: 'roles', name: 'Roles', primaryField: 'name', data: roles, columns: roleColumns },\n ])\n</script>\n\n<SvBase bind:tables editable expandRows containerHeight={640} onTablesChange={(t) => console.log('save', t)} />\n```\n\nPick \"Apply\" in the view menu. The grid stays mounted underneath and the\nform covers it: a card with \"Join the team\" as the heading, the description\nunder it, and one box per field. A click on a box opens the editor the cell\nuses: the select panel for a select, the record picker for Role, the date\npicker for Earliest start, the attachment dialog for Resume, the number box\nfor Years of experience. Tab and Shift+Tab move to the next or previous\nfield from inside an editor.\n\n\n\nWhoever may change views can do all of this without code: \"Customize form\" in\nthe view bar opens a dialog with the title, the line under it, the button's text\nand every field a person can fill in, each with a switch to ask for it, arrows\nto move it and a box to require it. Each change shows in the form behind the\ndialog and is kept in the view as `formTitle`, `formDescription`,\n`formSubmitLabel`, `formFields` and `formRequired`.\n\nFor a form view, the view bar keeps the view menu, \"Customize form\" and, when the base runs\nautomations, the Automations button. Hide fields, Filter, Sort, the record\ncount and search are gone.\n\nWithout `formFields`, the form asks for every field a person can fill in:\nthe primary field first, then the rest in the grid's column order, hidden\ncolumns included. Computed types (formula, lookup, rollup, count,\nautonumber, created and modified time and by, button), columns with\n`editable: false` and columns with a `fieldFn` are always left out, even\nwhen `formFields` names them. Without `formTitle`, the heading is the\nview's `name`.\n\n## 3. See what a sent form adds\n\n\n\nA form with nothing in any field does not send: it says \"Fill in at least one\nfield before you send this.\" and adds no record. A field filled by a default or\na link counts.\n\nPress Submit and the form runs its checks first\n([What the form checks](#what-the-form-checks)). When they pass, it builds\nthe record the way the row adder builds a new row, from three layers, each\nwinning over the one before:\n\n1. Each field's own new-row value: a `fieldProps.default`, today for a date\n with `defaultToday`, the next autonumber, the created time, the current\n user for created by.\n2. The grid's `rowAdder.defaults()`. In a base, set it in the table's\n `props`.\n3. What the form's fields show.\n\nInside `<SvBase tables>` every new record also gets an `id`, even in a table\nwhose `props` set `rowAdder: false`.\n\nThe first two layers also fill the form when it opens: a field the form\nasks for starts with the value the new record would get, and the person\ncan change it. A field the form does not ask for still gets its value, so a\ncandidate who never sees Stage lands in Applied because of\n`default: 'Applied'`.\n\nThe record is appended to the grid, then the grid's `onRowAdd` fires with\nit, and with `tables` the base hands the whole list to `onTablesChange`:\n\n```svelte\n<SvBase bind:tables editable onRowAdd={(e: { row: Record<string, unknown> }) => console.log('new candidate', e.row)} />\n```\n\nThe form then shows \"Thank you\" and \"The record was added.\" with a \"Submit\nanother\" button, which starts a new record with the defaults again. A form\nview starts a new record each time it opens, so switching to another view\ndrops what was typed.\n\nA sent record holds values in the shapes the cells use:\n\n| Field type | Value |\n|---|---|\n| `text`, `longText`, `email`, `url`, `phone` | A string, as typed |\n| `richText` | An HTML string, sanitized (`null` when the editor was left empty) |\n| `number` | A number, as typed (an integer field: a whole number). Past 15 significant digits, text holding every digit |\n| `date` without time | `'2026-11-02'` |\n| `singleSelect` | The option's `value` |\n| `link` | An array of record ids, also with `multiple: false`: `['r2']` |\n| `attachment` | An array of [attachments](../fields.md#attachments) |\n| `user` | The person's id |\n\nEach value goes through the same coercion and column `valueParser` as a\ncell edit, so a custom field type parses the same in a form. A field left\nblank is not in the record. A field that showed a default and was cleared\nis sent empty (`''`, `null` or `[]`, as its editor leaves it): the person\nremoved the default, so it does not come back.\n\n## 4. Put the form on a public page\n\nCandidates should not open your base. Give them a page that draws only the\nform and posts what they send to your server, while the team keeps working\nin the base.\n\n`SvBaseForm` is the form the view draws, as a component. It reads its fields\nfrom a grid through that grid's api, so the page mounts a grid with the\nCandidates columns and no rows, out of sight:\n\n```svelte\n<!-- src/routes/apply/+page.svelte -->\n<script lang=\"ts\">\n import { SvGrid } from '@svgrid/grid'\n import { SvBaseForm, enableBase, registerLinkedTable } from '@svgrid/enterprise/base'\n import { APPLY_FIELDS, candidateColumns } from '$lib/hiring'\n\n enableBase()\n\n let { data }: { data: { roles: Array<{ id: string; name: string }> } } = $props()\n\n // The record picker for Role lists the open roles, and only those. In an\n // effect: it runs in the browser only (the list is page-wide, so a server\n // render must not set it for every visitor), and it unregisters on leave.\n $effect(() => registerLinkedTable({ id: 'roles', name: 'Roles', primaryField: 'name', rows: () => data.roles }))\n\n // Raw: the form finds the grid by the api object itself.\n let api = $state.raw<any>(null)\n\n // The form waits on the Promise: thanks when it resolves, the message when it rejects.\n async function send(row: Record<string, unknown>) {\n const res = await fetch('/apply', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify(row),\n })\n if (!res.ok) throw new Error('Your application did not reach us. Press Send application again.')\n }\n</script>\n\n<div class=\"store\" aria-hidden=\"true\">\n <SvGrid data={[]} columns={candidateColumns} onApiReady={(a) => (api = a)} />\n</div>\n\n{#if api}\n <SvBaseForm\n {api}\n fields={APPLY_FIELDS}\n required={['name', 'email', 'role', 'resume']}\n title=\"Apply to Acme\"\n description=\"Tell us about yourself. We reply to every application within a week.\"\n submitLabel=\"Send application\"\n onSubmit={send}\n />\n{/if}\n\n<style>\n .store { position: absolute; width: 1px; height: 1px; overflow: hidden; visibility: hidden; }\n</style>\n```\n\n```ts\n// src/routes/apply/+page.server.ts\ndeclare const db: { openRoles: () => Promise<Array<{ id: string; name: string }>> }\n\nexport async function load() {\n return { roles: await db.openRoles() }\n}\n```\n\nA required field shows a red asterisk after its label. Press \"Send\napplication\" with Email empty and its box turns red, with \"Email is\nrequired\" under it; nothing is sent. Type `ana@` and the line reads \"Not a\nvalid email address\". The message goes away as soon as the field gets a new\nvalue.\n\n`send` returns a Promise, so the form waits for the server, with the button\ndisabled. When the Promise resolves, the form shows \"Thank you\". When it\nrejects, the form takes the row back out of the hidden grid, keeps every\nfield as it was, and shows the error's message above the button; pressing\nthe button again sends the same record. An error with no message shows \"The\nrecord could not be sent. Try again.\" An `onSubmit` that returns nothing\nshows \"Thank you\" at once.\n\nThe form draws with the `--sg-*` tokens (`--sg-bg`, `--sg-fg`,\n`--sg-border`, `--sg-muted`, `--sg-accent`, `--sg-accent-fg`,\n`--sg-danger`, `--sg-font`), so the page's theme styles it.\n\n## 5. Prefill hidden values from the URL\n\nA job post links to `/apply?role=r2&source=Referral`. The candidate should\nnot pick the role again, and should never see Source. Read both in `load`,\ncheck them, and hand them to the hidden grid as its `rowAdder.defaults`:\nthe form starts every record from them, and what is typed wins over them.\nThis `load` replaces the one in step 4:\n\n```ts\n// src/routes/apply/+page.server.ts\nimport { SOURCES } from '$lib/hiring'\n\ndeclare const db: { openRoles: () => Promise<Array<{ id: string; name: string }>> }\n\nexport async function load({ url }: { url: URL }) {\n const roles = await db.openRoles()\n const role = roles.find((r) => r.id === url.searchParams.get('role'))?.id ?? null\n const asked = url.searchParams.get('source')\n const source = SOURCES.some((s) => s.value === asked) ? asked : 'Careers page'\n return { roles, role, source }\n}\n```\n\nIn the page, leave the role out of the fields when the link named one, and\ngive the hidden grid the defaults. Source is not among the fields, so it\nstays hidden and still lands in the record. The rest of the page is as in\nstep 4:\n\n```svelte\n<script lang=\"ts\">\n import { APPLY_FIELDS } from '$lib/hiring'\n // ...the other imports, registerLinkedTable, api and send from step 4\n\n let { data }: { data: { roles: Array<{ id: string; name: string }>; role: string | null; source: string } } = $props()\n\n const fields = $derived(data.role ? APPLY_FIELDS.filter((f) => f !== 'role') : APPLY_FIELDS)\n const rowAdder = $derived({\n defaults: () => ({ source: data.source, ...(data.role ? { role: [data.role] } : {}) }),\n })\n</script>\n\n<div class=\"store\" aria-hidden=\"true\">\n <SvGrid data={[]} columns={candidateColumns} {rowAdder} onApiReady={(a) => (api = a)} />\n</div>\n\n{#if api}\n <SvBaseForm {api} {fields} required={['name', 'email', 'resume']} submitLabel=\"Send application\" onSubmit={send} />\n{/if}\n```\n\nA link value is an array of ids, so the default is `[data.role]`. Drop\n`'role'` from `required` too: a required id that is not among the fields is\nignored, but leaving it there reads as if the role were still asked for.\n\n## 6. Upload the resume\n\nWith no uploader, a file added in the form stays in the browser as a `blob:`\nURL, and the server receives a link it cannot open. Set an uploader on the\npublic page:\n\n```ts\nimport { setAttachmentUploader } from '@svgrid/enterprise/base'\n\nsetAttachmentUploader(async (file, { signal, onProgress }) => {\n const res = await fetch(`/apply/upload?name=${encodeURIComponent(file.name)}`, {\n method: 'PUT',\n body: file,\n signal,\n headers: { 'content-type': file.type || 'application/octet-stream' },\n })\n if (!res.ok) throw new Error(res.status === 413 ? 'Larger than 10 MB' : `Upload failed (${res.status})`)\n onProgress(1)\n const { url } = (await res.json()) as { url: string }\n return { id: url, url, name: file.name, type: file.type, size: file.size }\n})\n```\n\n```ts\n// src/routes/apply/upload/+server.ts\nimport { error, json } from '@sveltejs/kit'\n\n// Returns the stored file's URL, under https://files.example.com/resumes/.\ndeclare const storage: { put: (key: string, body: ArrayBuffer, type: string) => Promise<string> }\n\nconst TYPES = new Set([\n 'application/pdf',\n 'application/msword',\n 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',\n])\n\nexport async function PUT({ request, url }: { request: Request; url: URL }) {\n const type = request.headers.get('content-type') ?? ''\n if (!TYPES.has(type)) error(415, 'Send a PDF or a Word file')\n const body = await request.arrayBuffer()\n if (body.byteLength > 10 * 1024 * 1024) error(413, 'Larger than 10 MB')\n const name = (url.searchParams.get('name') ?? 'resume').replace(/[^\\w.-]+/g, '_').slice(0, 100)\n return json({ url: await storage.put(`resumes/${crypto.randomUUID()}-${name}`, body, type) })\n}\n```\n\nClick the Resume box (\"Add files\") and the attachment dialog opens: pick,\ndrop or paste a file, or paste a URL. Before uploading, the dialog checks\nthe field's `maxFiles` (default 20), `maxSize` (default 25 MB) and\n`accept`, and lists each refused file with its name and the reason:\n\"At most 1 file\", \"Larger than 10 MB\", \"Not an accepted type\". A file added\nby URL gets the `maxFiles` and `accept` checks; its type comes from the\nname's extension, so with `accept: '.pdf,.doc,.docx'` a link to `cv.pdf` is\ntaken and a link with no extension is refused. A file that fails to upload\nstays in the dialog with Retry. The upload runs when the file is added, not\nwhen the form is sent, and Done waits for uploads still running.\n\nAn uploader for one column only goes in that column's `fieldProps.upload`;\nit wins over the app-wide one. Both get the file, an abort signal (aborted\nwhen the candidate removes the file or cancels the dialog), `onProgress`,\nthe column id and `row`, which in a form is what the fields show so far,\nwith no record id yet.\n\n## 7. Check it again on the server\n\nThe form's checks help a person filling it in, and `formRequired` is one of them:\nnothing on a server knows of it. A table served by `createBaseEndpoint` is checked\nonly if you pass `validate` or `hooks` ([how](./quick-start.md#add-it-to-an-app-you-have)).\nAnyone can post to `/apply` without the form, so the endpoint checks every field again with the same\n`linkHref` the form uses for email, URL and phone, keeps only the fields a\ncandidate may set, and sets the team's fields itself:\n\n```ts\n// src/routes/apply/+server.ts\nimport { error, json } from '@sveltejs/kit'\nimport { linkHref } from '@svgrid/enterprise/base'\nimport { SOURCES } from '$lib/hiring'\nimport { automations } from '$lib/server/automations'\n\ndeclare const db: {\n roleIsOpen: (id: string) => Promise<boolean>\n insertCandidate: (row: Record<string, unknown>) => Promise<string>\n}\n\n// Where the upload endpoint in step 6 stores resumes.\nconst FILES = 'https://files.example.com/resumes/'\n\nexport async function POST({ request }: { request: Request }) {\n const body = (await request.json()) as Record<string, unknown>\n const text = (k: string, max = 200) => {\n const v = body[k]\n return typeof v === 'string' ? v.trim().slice(0, max) : ''\n }\n\n const name = text('name')\n if (!name) error(400, 'Candidate is required')\n const email = text('email')\n if (!linkHref('email', email)) error(400, 'Not a valid email address')\n const phone = text('phone', 40)\n if (phone && !linkHref('phone', phone)) error(400, 'Not a valid phone number')\n const portfolio = text('portfolio', 500)\n if (portfolio && !linkHref('url', portfolio)) error(400, 'Not a valid web address')\n\n const role = Array.isArray(body.role) ? String(body.role[0] ?? '') : ''\n if (!(await db.roleIsOpen(role))) error(400, 'Pick an open role')\n\n const resume = Array.isArray(body.resume) ? body.resume.slice(0, 1) : []\n if (!resume.length || !resume.every((a) => typeof a?.url === 'string' && a.url.startsWith(FILES))) error(400, 'Upload a resume')\n\n const years = body.years == null ? null : Number(body.years)\n if (years != null && !(Number.isInteger(years) && years >= 0 && years <= 60)) error(400, 'Years is not a whole number')\n\n const start = text('start', 10)\n if (start && !/^\\d{4}-\\d{2}-\\d{2}$/.test(start)) error(400, 'Earliest start is not a date')\n\n const source = SOURCES.some((s) => s.value === body.source) ? body.source : 'Careers page'\n\n const id = await db.insertCandidate({\n name, email, phone, role: [role], resume, portfolio, years, start, source,\n notes: text('notes', 5000),\n // Never from the request: these belong to the team.\n stage: 'Applied', recruiter: null, applied: new Date().toISOString(),\n })\n // Step 8: the \"A form is sent\" automations that run on the server.\n await automations.formSubmitted('candidates', id, 'apply')\n return json({ id })\n}\n```\n\nThe form shows the `error()` message only if `send` passes it on; the one\nin step 4 shows its own line for any failure.\n\nTo see new applications in the base without a reload, give the Candidates\ntable a `source` with `realtime`:\n[Keep a base in a database](./data.md#changes-made-elsewhere).\n\n## 8. Run an automation when a form is sent\n\nIn the Automations dialog the trigger is \"A form is sent\", with a Form\npicker: \"Any form of this table\" or one form view. In code it is\n`formSubmitted`, and `view` names the form:\n\n```ts\nimport type { BaseAutomation } from '@svgrid/enterprise/base'\n\nexport const candidateAutomations: BaseAutomation[] = [\n {\n id: 'new-application',\n name: 'Announce a new application',\n enabled: true,\n trigger: { type: 'formSubmitted', view: 'apply' },\n actions: [{ type: 'notify', message: 'New application from {Candidate}', severity: 'info' }],\n },\n {\n id: 'thank-you-email',\n name: 'Thank the candidate',\n enabled: true,\n runOn: 'server',\n trigger: { type: 'formSubmitted', view: 'apply' },\n actions: [\n {\n type: 'email',\n to: '{Email}',\n subject: 'We got your application',\n body: 'Hi {Candidate}, thank you for applying. We reply within a week.',\n },\n ],\n },\n]\n```\n\nPut them on the table (`automations: candidateAutomations`). A form on its own\nneeds one `<SvToaster />` from `@svgrid/grid` for the notice; inside a base it\nshows without one. In the base, a form view\nsends its record to the table's automations with the view's `id`. They need\n`<SvBase tables>`: with `data` and `columns` a form still adds records, but\nno automation runs.\n\nThe public page has no base and no browser runner, so the endpoint in step 7\ntells the [automation server](./automations.md#on-the-server) after the\ninsert. The view id there is whatever string your automations name. Only\nautomations with `runOn: 'server'` run on the server. If it has not seen\nthe record yet, it reads the table again first, and that reading also runs\nthe table's \"A record is created\" server automations for the new record.\n\n## Show a field only for some answers\n\n<div data-docs-demo=\"711-base-form-logic\" data-height=\"720\"></div>\n\nIn the demo, pick Bug as the Topic and App version appears; switch to\nBilling and it gives way to Invoice number. The buttons on the right open\nthe form from prefilled links.\n\nA field can wait for an answer before it shows. `conditions` maps a column id\nto a [view bar filter](./views.md) over the other answers, the same\n`FieldFilter` the Filter button saves. On a form view the key is\n`formConditions`:\n\n```ts\nimport type { FieldFilter } from '@svgrid/enterprise/base'\n\nconst is = (column: string, value: string): FieldFilter => ({\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [{ column, kind: 'select', op: 'is', value }],\n})\n\nconst apply = {\n id: 'apply',\n name: 'Apply',\n type: 'form',\n formFields: ['name', 'email', 'employment', 'company', 'reason', 'otherReason'],\n formRequired: ['name', 'email', 'company', 'otherReason'],\n formConditions: {\n company: is('employment', 'Employed'),\n otherReason: is('reason', 'Other'),\n },\n}\n```\n\nWith `SvBaseForm` it is `conditions={{ company: is('employment', 'Employed') }}`.\n\nThe form checks the conditions each time an answer changes. While a\nfield's condition does not hold:\n\n- the field is not drawn, and Tab skips it;\n- it is not required and not checked, so `formRequired` can name it;\n- what was typed in it is cleared, and a field whose condition reads it\n hides too;\n- the record does not get it, not even its `fieldProps.default`.\n\nWhen the field shows again it starts with the value a new record gets. A\ncondition reads the answers by column id; a field the form does not ask\nfor is read as the new record would have it.\n\n## Fill the form from a link\n\n`prefill` fills fields from a link, the convention people already paste\ninto emails: `?prefill_<Field name>=value`. The name is the field's\n`header` or its column id, URL-encoded. `hide_<Field name>=true` keeps a\nfilled field out of sight and still sends it:\n\n```\nhttps://example.com/apply?prefill_Role=Product%20designer&prefill_Source=Referral&hide_Role=true\n```\n\nOn a form view, `formPrefill: true` reads the page's own URL. On a page,\npass it to `SvBaseForm`:\n\n```svelte\n<SvBaseForm {api} fields={APPLY_FIELDS} prefill />\n<SvBaseForm {api} fields={APPLY_FIELDS} prefill={page.url.searchParams} />\n<SvBaseForm {api} fields={APPLY_FIELDS} prefill={{ Role: 'r2', Source: 'Referral' }} />\n```\n\n`prefill` takes `true` (the page's URL, nothing during a server render), a\nURL or query string, `URLSearchParams`, or values by field name or column\nid. When it changes to other answers, the form starts a new record.\n\nEach value is read the way a pasted cell is:\n\n| Field type | `prefill_` value |\n|---|---|\n| text, email, URL, phone | As written |\n| number, currency, percent | The number as typed, `1,200` included; text that is no number is dropped |\n| checkbox | `true`, `1`, `yes`, `on` check it; anything else unchecks it |\n| date | `2026-11-02` |\n| single select | An option's value or label, any case |\n| multiple select | Values or labels, comma-separated |\n| user | A person's id, name or email |\n| link | Record ids or names, comma-separated |\n\nAn option the select does not have, a person nobody is, or a record that\ndoes not exist is dropped: a link never adds an option. Files and computed\nfields cannot be filled. A link's value goes over the field's default.\n`hide_` works only on a field the link filled; if a hidden value fails a\ncheck on Submit, the field shows with its message.\n\n`formPrefillLink` builds such a link from values by column id:\n\n```ts\nimport { formPrefillLink } from '@svgrid/enterprise/base'\n\nformPrefillLink('https://example.com/apply', { role: ['r2'], source: 'Referral' }, candidateColumns, { hide: ['role'] })\n// https://example.com/apply?prefill_Role=r2&prefill_Source=Referral&hide_Role=true\n```\n\nWith the columns, each parameter carries the field's `header`. A list is\njoined with commas, a `Date` written as `YYYY-MM-DD`, and the base URL's own\nquery and `#hash` are kept.\n\nThe link is typed by whoever sends it. On a public form, say which fields a\nlink may fill: `prefillFields` on `SvBaseForm`, or a list for `formPrefill`\non a form view. A `prefill_` or `hide_` for any other field is ignored, so a\nlink cannot set the Source or the Owner you meant to fill yourself:\n\n```ts\nimport type { FieldView } from '@svgrid/enterprise/base'\n\nconst apply: FieldView = {\n id: 'apply',\n name: 'Apply',\n type: 'form',\n formFields: ['name', 'email', 'role', 'source'],\n // A link may pick the role and say where the candidate came from, nothing else.\n formPrefill: ['Role', 'source'],\n formFooter: 'We keep your answers for 12 months. Write to jobs@example.com to have them removed.',\n}\n```\n\nCheck every value on the server as in\n[step 7](#7-check-it-again-on-the-server) all the same.\n\n## A footer under the button\n\n`formFooter` on a form view is a line of plain text under the submit button:\nwho reads the answers, how long they are kept. For more than a line (a logo,\nlinks to your terms), give `<SvBase>` a `formFooter` snippet; it gets the\nform view, so one snippet can serve every form:\n\n```svelte\n<SvBase bind:tables editable>\n {#snippet formFooter(view)}\n <p>By sending {view.name.toLowerCase()} you agree to our <a href=\"/terms\">terms</a>.</p>\n {/snippet}\n</SvBase>\n```\n\nOn a page of your own, `SvBaseForm` takes the same as `footerText` and a\n`footer` snippet.\n\n## SvBaseForm props\n\n| Prop | Type | Default | What it does |\n|---|---|---|---|\n| `api` | grid api | required | The api of the grid the record is added to, from its `onApiReady`. Nothing draws until that grid has drawn once. |\n| `fields` | `ReadonlyArray<string>` | every field a person can fill in | Column ids, in order. An id that is not such a field is skipped. |\n| `required` | `ReadonlyArray<string>` | `[]` | Column ids that must have a value before the record is added. |\n| `title` | `string` | `'New record'` | The heading. |\n| `description` | `string` | `''` | The line under the heading. |\n| `submitLabel` | `string` | `'Submit'` | The button's text. |\n| `defaults` | `() => Record<string, unknown>` | | Values each record from this form starts with. The grid's `rowAdder.defaults()` wins over them. Called once per record. `<SvBase tables>` passes one that gives an `id`. |\n| `conditions` | `Record<string, FieldFilter>` | | Column id -> when that field shows. A hidden field is not required, not checked and not sent ([Show a field only for some answers](#show-a-field-only-for-some-answers)). |\n| `prefill` | `boolean \\| string \\| URLSearchParams \\| Record<string, unknown>` (`FormPrefill`) | | Answers to start with: `true` reads the page's URL, a string or `URLSearchParams` is read for `prefill_` and `hide_`, an object gives values by field name or column id ([Fill the form from a link](#fill-the-form-from-a-link)). |\n| `prefillFields` | `ReadonlyArray<string>` | every field asked for | The fields `prefill` may fill or hide, by field name or column id. |\n| `footerText` | `string` | | A line under the submit button. |\n| `footer` | `Snippet` | | What goes under the submit button, after `footerText`. |\n| `onSubmit` | `(row: Record<string, unknown>) => void \\| Promise<unknown>` | | Called after the row was appended to the grid and the grid's `onRowAdd` ran. A Promise keeps the button disabled until it settles: resolved shows \"Thank you\", rejected takes the row back out of the grid, keeps the fields and shows the error's message. |\n\n## Form view keys\n\n| Key | Read as |\n|---|---|\n| `type` | `'form'` |\n| `name` | The view's name in the menu; the heading when there is no `formTitle` |\n| `formFields` | The fields it asks for, in order |\n| `formTitle` | The heading |\n| `formDescription` | The line under it |\n| `formRequired` | Column ids that must have a value, as `required` on `SvBaseForm` |\n| `formSubmitLabel` | The button's text (default `'Submit'`) |\n| `formConditions` | Column id -> when that field shows, as `conditions` on `SvBaseForm` |\n| `formPrefill` | `true` fills fields from the page's URL, as `prefill` on `SvBaseForm`; a list of field names or column ids lets the link fill only those |\n| `formFooter` | A line of plain text under the submit button |\n\nA record the view sends reaches `onRowAdd`, `onTablesChange` and the\n`formSubmitted` automations, which get the view's `id`.\n\n## What a screen reader and a browser get\n\nA field that takes typed text (text, long text, number, email, URL, phone) is a\nreal `<input>` or `<textarea>` with a `<label>` from the start, and a checkbox a\nreal checkbox. A required field has `aria-required`. Fields with a picker (a\nselect, a date, a file, a link) are a labelled button until opened, and their\nname says when they are required.\n\nA field in error gets `aria-invalid` and its message through `aria-describedby`.\nA submit that fails says how many fields need attention, and focus goes to the\nfirst of them.\n\nEmail, phone and URL fields carry their `autocomplete` purpose, so a browser can\nfill them in. A text field gets one from an English name (Name, First name, Last\nname, Company, Address, City, Zip, Country). For any other name or language, set\nit on the field:\n\n```ts\n{ field: 'nombre', header: 'Nombre', fieldType: 'text', fieldProps: { autocomplete: 'name' } }\n```\n\n## What the form checks\n\n- **Required**: empty means no value, an empty string or an empty list. A\n checkbox that is off and a number that is 0 count as filled. The message\n is \"{header} is required\".\n- **Number and duration**: the editor refuses text that is not a number\n (\"Not a number\") and a negative where `allowNegative: false` (\"Negative\n numbers are not allowed\"), and keeps the box open. A click outside the\n box while it shows the error drops what was typed. A value is stored as\n typed; precision is how it shows, and only an integer field rounds.\n- **Attachment**: `maxFiles`, `maxSize` and `accept`, file by file, before\n uploading. A file added by URL is checked against `maxFiles` and `accept`\n (by the name's extension); its size is not known, so `maxSize` does not\n apply.\n- **Email, URL, phone**: on submit, a value must be one the cell can link:\n an address for `mailto:`, an http or https address (a bare host such as\n `svgrid.com/docs` counts), or 3 to 20 digits with an optional leading `+`\n and spaces, dots, dashes or parentheses. The messages are \"Not a valid\n email address\", \"Not a valid web address\" and \"Not a valid phone number\".\n An empty field is not checked.\n- **The column's `validate`**: on submit, the form calls it as the grid\n does, with `value`, `row` (what the fields show), `rowIndex: -1` and\n `column`. `false` shows \"{header} is not valid\"; a string shows that\n string. It runs on empty fields too, and it blocks the submit even\n without `rejectInvalid`.\n- **Select**: only the field's options. Text that matches none shows \"No\n option matches\"; a form never offers \"Add option\".\n- **Link**: only records of the linked table, plus `Create \"...\"` for the\n typed name when that table has `create`.\n\nA failed check shows its message under the field and nothing is sent. The\nmessage goes away when that field gets a new value.\n\n## Pitfalls\n\n- **\"Thank you\" waits only for a Promise.** If `onSubmit` posts but does\n not return the Promise (or throw), the form thanks the person before the\n server answers. Return it, as `send` in step 4 does.\n- **A rejected `onSubmit` comes after `onRowAdd`.** On a rejection the form\n takes the row back out of the grid, but anything your `onRowAdd` did with\n it stays done. Save in one of the two, not both.\n- **Automatic values come from the browser.** On the public page the hidden\n grid has no rows, so an autonumber is always 1, and a created time is the\n visitor's clock. Set them on the server.\n- **One form sets off two triggers.** In `<SvBase tables>`, a sent form runs\n the \"A record is created\" automations, then the \"A form is sent\" ones. An\n automation on each that does the same thing does it twice.\n- **Uploads outlive abandoned forms.** A file is uploaded when it is added,\n so a candidate who adds a resume and leaves leaves a file behind. Remove\n stored files no record points to.\n\n## Next\n\n- [Automations](./automations.md): the other triggers, and the server\n runner the public page reports to.\n- [Keep a base in a database](./data.md): give Candidates a source so\n applications show up for the team.\n- [Saved views](./views.md): the Kanban the recruiters work in, its stacks\n and colors.\n- [Linked records](./linked-records.md): the Role link and the Candidates\n list on each role.\n- [Field types](../fields.md#declare-columns-by-type): every type's\n `fieldProps`, including `default` and `defaultToday`.\n"
|
|
5209
|
+
"markdown": "# Collect records with forms\n\nA form view asks for some of a table's fields and adds a record when it is\nsent. Use it for records other people start: a bug report, an expense, a\njob application. This page builds a hiring tracker's application flow.\nCandidates apply through a form, the record lands in the Candidates table,\nand recruiters move it across a Kanban by stage.\n\n<div data-docs-demo=\"514-base-hiring-tracker\" data-height=\"680\"></div>\n\nIn the demo, pick the \"Apply\" view, fill in the form and press Submit, then\nswitch to \"Hiring pipeline\": the new candidate is a card in Applied.\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\n## 1. Declare the Candidates table\n\nKeep the fields in one module. The base imports them, and so do the public\npage and the server you build later on this page, so all three agree on\nfield ids and types.\n\n```ts\n// src/lib/hiring.ts\nimport type { BaseTable } from '@svgrid/enterprise/base'\n\nexport const STAGES = [\n { value: 'Applied', color: '#94a3b8' },\n { value: 'Phone screen', color: '#18bfff' },\n { value: 'Onsite', color: '#2d7ff9' },\n { value: 'Offer', color: '#fcb400' },\n { value: 'Hired', color: '#20c933' },\n { value: 'Rejected', color: '#f82b60' },\n]\nexport const SOURCES = [{ value: 'Careers page' }, { value: 'Referral' }, { value: 'Job board' }]\n\nexport const candidateColumns: BaseTable['columns'] = [\n { field: 'name', header: 'Candidate', fieldType: 'text' },\n { field: 'email', header: 'Email', fieldType: 'email' },\n { field: 'phone', header: 'Phone', fieldType: 'phone', description: 'With the country code.' },\n { field: 'role', header: 'Role', fieldType: 'link', fieldProps: { table: 'roles', multiple: false, inverse: 'candidates' } },\n {\n field: 'resume', header: 'Resume', fieldType: 'attachment',\n fieldProps: { accept: '.pdf,.doc,.docx', maxFiles: 1, maxSize: 10 * 1024 * 1024 },\n description: 'One PDF or Word file, up to 10 MB.',\n },\n { field: 'portfolio', header: 'Portfolio', fieldType: 'url', description: 'A site, a repository or a design portfolio.' },\n { field: 'years', header: 'Years of experience', fieldType: 'number', fieldProps: { format: 'integer', allowNegative: false } },\n { field: 'start', header: 'Earliest start', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'notes', header: 'Notes', fieldType: 'longText' },\n // The team's fields. The form leaves them out.\n { field: 'stage', header: 'Stage', fieldType: 'singleSelect', fieldProps: { options: STAGES, default: 'Applied' } },\n { field: 'source', header: 'Source', fieldType: 'singleSelect', fieldProps: { options: SOURCES } },\n { field: 'recruiter', header: 'Recruiter', fieldType: 'user' },\n { field: 'applied', header: 'Applied', fieldType: 'createdTime' },\n]\n\nexport const roleColumns: BaseTable['columns'] = [\n { field: 'name', header: 'Role', fieldType: 'text' },\n { field: 'candidates', header: 'Candidates', fieldType: 'link', fieldProps: { table: 'candidates', multiple: true, inverse: 'role' } },\n]\n\n/** What a candidate fills in, in order. */\nexport const APPLY_FIELDS: string[] = ['name', 'email', 'phone', 'role', 'resume', 'portfolio', 'years', 'start', 'notes']\n```\n\nThe form labels each field with the column's `header`, the type's icon in\nfront of it. A column's `description` is the help text: the form shows it in\nsmall grey type under the field, and the grid shows it on the info mark in\nthe header.\n\n## 2. Add the form view\n\nA form is a view, next to the pipeline and the grid:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, setFieldUsers, type BaseTable } from '@svgrid/enterprise/base'\n import { APPLY_FIELDS, candidateColumns, roleColumns } from '$lib/hiring'\n\n enableBase()\n setFieldUsers([{ id: 'u1', name: 'Ana Ruiz' }, { id: 'u2', name: 'Ben Okafor' }])\n\n let { candidates, roles }: { candidates: Record<string, unknown>[]; roles: Record<string, unknown>[] } = $props()\n\n let tables = $state.raw<BaseTable[]>([\n {\n id: 'candidates',\n name: 'Candidates',\n primaryField: 'name',\n data: candidates,\n columns: candidateColumns,\n views: [\n { id: 'pipeline', name: 'Pipeline', type: 'kanban', stackBy: 'stage' },\n { id: 'all', name: 'All candidates', type: 'grid', color: { mode: 'field', field: 'stage' } },\n {\n id: 'apply',\n name: 'Apply',\n type: 'form',\n formFields: APPLY_FIELDS,\n formTitle: 'Join the team',\n formDescription: 'Tell us about yourself. We reply to every application within a week.',\n formRequired: ['name', 'email', 'role', 'resume'],\n formSubmitLabel: 'Send application',\n },\n ],\n },\n { id: 'roles', name: 'Roles', primaryField: 'name', data: roles, columns: roleColumns },\n ])\n</script>\n\n<SvBase bind:tables editable expandRows containerHeight={640} onTablesChange={(t) => console.log('save', t)} />\n```\n\nPick \"Apply\" in the view menu. The grid stays mounted underneath and the\nform covers it: a card with \"Join the team\" as the heading, the description\nunder it, and one box per field. A click on a box opens the editor the cell\nuses: the select panel for a select, the record picker for Role, the date\npicker for Earliest start, the attachment dialog for Resume, the number box\nfor Years of experience. Tab and Shift+Tab move to the next or previous\nfield from inside an editor.\n\n\n\nWhoever may change views can do all of this without code: \"Customize form\" in\nthe view bar opens a dialog with the title, the line under it, the button's text\nand every field a person can fill in, each with a switch to ask for it, arrows\nto move it and a box to require it. Each change shows in the form behind the\ndialog and is kept in the view as `formTitle`, `formDescription`,\n`formSubmitLabel`, `formFields` and `formRequired`.\n\nFor a form view, the view bar keeps the view menu, \"Customize form\" and, when the base runs\nautomations, the Automations button. Hide fields, Filter, Sort, the record\ncount and search are gone.\n\nWithout `formFields`, the form asks for every field a person can fill in:\nthe primary field first, then the rest in the grid's column order, hidden\ncolumns included. Computed types (formula, lookup, rollup, count,\nautonumber, created and modified time and by, button), columns with\n`editable: false` and columns with a `fieldFn` are always left out, even\nwhen `formFields` names them. Without `formTitle`, the heading is the\nview's `name`.\n\n## 3. See what a sent form adds\n\n\n\nA form with nothing in any field does not send: it says \"Fill in at least one\nfield before you send this.\" and adds no record. A field filled by a default or\na link counts.\n\nPress Submit and the form runs its checks first\n([What the form checks](#what-the-form-checks)). When they pass, it builds\nthe record the way the row adder builds a new row, from three layers, each\nwinning over the one before:\n\n1. Each field's own new-row value: a `fieldProps.default`, today for a date\n with `defaultToday`, the next autonumber, the created time, the current\n user for created by.\n2. The grid's `rowAdder.defaults()`. In a base, set it in the table's\n `props`.\n3. What the form's fields show.\n\nInside `<SvBase tables>` every new record also gets an `id`, even in a table\nwhose `props` set `rowAdder: false`.\n\nThe first two layers also fill the form when it opens: a field the form\nasks for starts with the value the new record would get, and the person\ncan change it. A field the form does not ask for still gets its value, so a\ncandidate who never sees Stage lands in Applied because of\n`default: 'Applied'`.\n\nThe record is appended to the grid, then the grid's `onRowAdd` fires with\nit, and with `tables` the base hands the whole list to `onTablesChange`:\n\n```svelte\n<SvBase bind:tables editable onRowAdd={(e: { row: Record<string, unknown> }) => console.log('new candidate', e.row)} />\n```\n\nThe form then shows \"Thank you\" and \"The record was added.\" with a \"Submit\nanother\" button, which starts a new record with the defaults again. A form\nview starts a new record each time it opens, so switching to another view\ndrops what was typed.\n\nA sent record holds values in the shapes the cells use:\n\n| Field type | Value |\n|---|---|\n| `text`, `longText`, `email`, `url`, `phone` | A string, as typed |\n| `richText` | An HTML string, sanitized (`null` when the editor was left empty) |\n| `number` | A number, as typed (an integer field: a whole number). Past 15 significant digits, text holding every digit |\n| `date` without time | `'2026-11-02'` |\n| `singleSelect` | The option's `value` |\n| `link` | An array of record ids, also with `multiple: false`: `['r2']` |\n| `attachment` | An array of [attachments](../fields.md#attachments) |\n| `user` | The person's id |\n\nEach value goes through the same coercion and column `valueParser` as a\ncell edit, so a custom field type parses the same in a form. A field left\nblank is not in the record. A field that showed a default and was cleared\nis sent empty (`''`, `null` or `[]`, as its editor leaves it): the person\nremoved the default, so it does not come back.\n\n## 4. Put the form on a public page\n\nCandidates should not open your base. Give them a page that draws only the\nform and posts what they send to your server, while the team keeps working\nin the base.\n\n`SvBaseForm` is the form the view draws, as a component. It reads its fields\nfrom a grid through that grid's api, so the page mounts a grid with the\nCandidates columns and no rows, out of sight:\n\n```svelte\n<!-- src/routes/apply/+page.svelte -->\n<script lang=\"ts\">\n import { SvGrid } from '@svgrid/grid'\n import { SvBaseForm, enableBase, registerLinkedTable } from '@svgrid/enterprise/base'\n import { APPLY_FIELDS, candidateColumns } from '$lib/hiring'\n\n enableBase()\n\n let { data }: { data: { roles: Array<{ id: string; name: string }> } } = $props()\n\n // The record picker for Role lists the open roles, and only those. In an\n // effect: it runs in the browser only (the list is page-wide, so a server\n // render must not set it for every visitor), and it unregisters on leave.\n $effect(() => registerLinkedTable({ id: 'roles', name: 'Roles', primaryField: 'name', rows: () => data.roles }))\n\n // Raw: the form finds the grid by the api object itself.\n let api = $state.raw<any>(null)\n\n // The form waits on the Promise: thanks when it resolves, the message when it rejects.\n async function send(row: Record<string, unknown>) {\n const res = await fetch('/apply', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify(row),\n })\n if (!res.ok) throw new Error('Your application did not reach us. Press Send application again.')\n }\n</script>\n\n<div class=\"store\" aria-hidden=\"true\">\n <SvGrid data={[]} columns={candidateColumns} onApiReady={(a) => (api = a)} />\n</div>\n\n{#if api}\n <SvBaseForm\n {api}\n fields={APPLY_FIELDS}\n required={['name', 'email', 'role', 'resume']}\n title=\"Apply to Acme\"\n description=\"Tell us about yourself. We reply to every application within a week.\"\n submitLabel=\"Send application\"\n onSubmit={send}\n />\n{/if}\n\n<style>\n .store { position: absolute; width: 1px; height: 1px; overflow: hidden; visibility: hidden; }\n</style>\n```\n\n```ts\n// src/routes/apply/+page.server.ts\ndeclare const db: { openRoles: () => Promise<Array<{ id: string; name: string }>> }\n\nexport async function load() {\n return { roles: await db.openRoles() }\n}\n```\n\nA required field shows a red asterisk after its label. Press \"Send\napplication\" with Email empty and its box turns red, with \"Email is\nrequired\" under it; nothing is sent. Type `ana@` and the line reads \"Not a\nvalid email address\". The message goes away as soon as the field gets a new\nvalue.\n\n`send` returns a Promise, so the form waits for the server, with the button\ndisabled. When the Promise resolves, the form shows \"Thank you\". When it\nrejects, the form takes the row back out of the hidden grid, keeps every\nfield as it was, and shows the error's message above the button; pressing\nthe button again sends the same record. An error with no message shows \"The\nrecord could not be sent. Try again.\" An `onSubmit` that returns nothing\nshows \"Thank you\" at once.\n\nThe form draws with the `--sg-*` tokens (`--sg-bg`, `--sg-fg`,\n`--sg-border`, `--sg-muted`, `--sg-accent`, `--sg-accent-fg`,\n`--sg-danger`, `--sg-font`), so the page's theme styles it.\n\n## 5. Prefill hidden values from the URL\n\nA job post links to `/apply?role=r2&source=Referral`. The candidate should\nnot pick the role again, and should never see Source. Read both in `load`,\ncheck them, and hand them to the hidden grid as its `rowAdder.defaults`:\nthe form starts every record from them, and what is typed wins over them.\nThis `load` replaces the one in step 4:\n\n```ts\n// src/routes/apply/+page.server.ts\nimport { SOURCES } from '$lib/hiring'\n\ndeclare const db: { openRoles: () => Promise<Array<{ id: string; name: string }>> }\n\nexport async function load({ url }: { url: URL }) {\n const roles = await db.openRoles()\n const role = roles.find((r) => r.id === url.searchParams.get('role'))?.id ?? null\n const asked = url.searchParams.get('source')\n const source = SOURCES.some((s) => s.value === asked) ? asked : 'Careers page'\n return { roles, role, source }\n}\n```\n\nIn the page, leave the role out of the fields when the link named one, and\ngive the hidden grid the defaults. Source is not among the fields, so it\nstays hidden and still lands in the record. The rest of the page is as in\nstep 4:\n\n```svelte\n<script lang=\"ts\">\n import { APPLY_FIELDS } from '$lib/hiring'\n // ...the other imports, registerLinkedTable, api and send from step 4\n\n let { data }: { data: { roles: Array<{ id: string; name: string }>; role: string | null; source: string } } = $props()\n\n const fields = $derived(data.role ? APPLY_FIELDS.filter((f) => f !== 'role') : APPLY_FIELDS)\n const rowAdder = $derived({\n defaults: () => ({ source: data.source, ...(data.role ? { role: [data.role] } : {}) }),\n })\n</script>\n\n<div class=\"store\" aria-hidden=\"true\">\n <SvGrid data={[]} columns={candidateColumns} {rowAdder} onApiReady={(a) => (api = a)} />\n</div>\n\n{#if api}\n <SvBaseForm {api} {fields} required={['name', 'email', 'resume']} submitLabel=\"Send application\" onSubmit={send} />\n{/if}\n```\n\nA link value is an array of ids, so the default is `[data.role]`. Drop\n`'role'` from `required` too: a required id that is not among the fields is\nignored, but leaving it there reads as if the role were still asked for.\n\n## 6. Upload the resume\n\nWith no uploader, a file added in the form stays in the browser as a `blob:`\nURL, and the server receives a link it cannot open. Set an uploader on the\npublic page:\n\n```ts\nimport { setAttachmentUploader } from '@svgrid/enterprise/base'\n\nsetAttachmentUploader(async (file, { signal, onProgress }) => {\n const res = await fetch(`/apply/upload?name=${encodeURIComponent(file.name)}`, {\n method: 'PUT',\n body: file,\n signal,\n headers: { 'content-type': file.type || 'application/octet-stream' },\n })\n if (!res.ok) throw new Error(res.status === 413 ? 'Larger than 10 MB' : `Upload failed (${res.status})`)\n onProgress(1)\n const { url } = (await res.json()) as { url: string }\n return { id: url, url, name: file.name, type: file.type, size: file.size }\n})\n```\n\n```ts\n// src/routes/apply/upload/+server.ts\nimport { error, json } from '@sveltejs/kit'\n\n// Returns the stored file's URL, under https://files.example.com/resumes/.\ndeclare const storage: { put: (key: string, body: ArrayBuffer, type: string) => Promise<string> }\n\nconst TYPES = new Set([\n 'application/pdf',\n 'application/msword',\n 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',\n])\n\nexport async function PUT({ request, url }: { request: Request; url: URL }) {\n const type = request.headers.get('content-type') ?? ''\n if (!TYPES.has(type)) error(415, 'Send a PDF or a Word file')\n const body = await request.arrayBuffer()\n if (body.byteLength > 10 * 1024 * 1024) error(413, 'Larger than 10 MB')\n const name = (url.searchParams.get('name') ?? 'resume').replace(/[^\\w.-]+/g, '_').slice(0, 100)\n return json({ url: await storage.put(`resumes/${crypto.randomUUID()}-${name}`, body, type) })\n}\n```\n\nClick the Resume box (\"Add files\") and the attachment dialog opens: pick,\ndrop or paste a file, or paste a URL. Before uploading, the dialog checks\nthe field's `maxFiles` (default 20), `maxSize` (default 25 MB) and\n`accept`, and lists each refused file with its name and the reason:\n\"At most 1 file\", \"Larger than 10 MB\", \"Not an accepted type\". A file added\nby URL gets the `maxFiles` and `accept` checks; its type comes from the\nname's extension, so with `accept: '.pdf,.doc,.docx'` a link to `cv.pdf` is\ntaken and a link with no extension is refused. A file that fails to upload\nstays in the dialog with Retry. The upload runs when the file is added, not\nwhen the form is sent, and Done waits for uploads still running.\n\nAn uploader for one column only goes in that column's `fieldProps.upload`;\nit wins over the app-wide one. Both get the file, an abort signal (aborted\nwhen the candidate removes the file or cancels the dialog), `onProgress`,\nthe column id and `row`, which in a form is what the fields show so far,\nwith no record id yet.\n\n## 7. Check it again on the server\n\nThe form's checks help a person filling it in, and `formRequired` is one of them:\nnothing on a server knows of it. A table served by `createBaseEndpoint` is checked\nonly if you pass `validate` or `hooks` ([how](./quick-start.md#add-it-to-an-app-you-have)).\nAnyone can post to `/apply` without the form, so the endpoint checks every field again with the same\n`linkHref` the form uses for email, URL and phone, keeps only the fields a\ncandidate may set, and sets the team's fields itself:\n\n```ts\n// src/routes/apply/+server.ts\nimport { error, json } from '@sveltejs/kit'\nimport { linkHref } from '@svgrid/enterprise/base'\nimport { SOURCES } from '$lib/hiring'\nimport { automations } from '$lib/server/automations'\n\ndeclare const db: {\n roleIsOpen: (id: string) => Promise<boolean>\n insertCandidate: (row: Record<string, unknown>) => Promise<string>\n}\n\n// Where the upload endpoint in step 6 stores resumes.\nconst FILES = 'https://files.example.com/resumes/'\n\nexport async function POST({ request }: { request: Request }) {\n const body = (await request.json()) as Record<string, unknown>\n const text = (k: string, max = 200) => {\n const v = body[k]\n return typeof v === 'string' ? v.trim().slice(0, max) : ''\n }\n\n const name = text('name')\n if (!name) error(400, 'Candidate is required')\n const email = text('email')\n if (!linkHref('email', email)) error(400, 'Not a valid email address')\n const phone = text('phone', 40)\n if (phone && !linkHref('phone', phone)) error(400, 'Not a valid phone number')\n const portfolio = text('portfolio', 500)\n if (portfolio && !linkHref('url', portfolio)) error(400, 'Not a valid web address')\n\n const role = Array.isArray(body.role) ? String(body.role[0] ?? '') : ''\n if (!(await db.roleIsOpen(role))) error(400, 'Pick an open role')\n\n const resume = Array.isArray(body.resume) ? body.resume.slice(0, 1) : []\n if (!resume.length || !resume.every((a) => typeof a?.url === 'string' && a.url.startsWith(FILES))) error(400, 'Upload a resume')\n\n const years = body.years == null ? null : Number(body.years)\n if (years != null && !(Number.isInteger(years) && years >= 0 && years <= 60)) error(400, 'Years is not a whole number')\n\n const start = text('start', 10)\n if (start && !/^\\d{4}-\\d{2}-\\d{2}$/.test(start)) error(400, 'Earliest start is not a date')\n\n const source = SOURCES.some((s) => s.value === body.source) ? body.source : 'Careers page'\n\n const id = await db.insertCandidate({\n name, email, phone, role: [role], resume, portfolio, years, start, source,\n notes: text('notes', 5000),\n // Never from the request: these belong to the team.\n stage: 'Applied', recruiter: null, applied: new Date().toISOString(),\n })\n // Step 8: the \"A form is sent\" automations that run on the server.\n await automations.formSubmitted('candidates', id, 'apply')\n return json({ id })\n}\n```\n\nThe form shows the `error()` message only if `send` passes it on; the one\nin step 4 shows its own line for any failure.\n\nTo see new applications in the base without a reload, give the Candidates\ntable a `source` with `realtime`:\n[Keep a base in a database](./data.md#changes-made-elsewhere).\n\n## 8. Run an automation when a form is sent\n\nIn the Automations dialog the trigger is \"A form is sent\", with a Form\npicker: \"Any form of this table\" or one form view. In code it is\n`formSubmitted`, and `view` names the form:\n\n```ts\nimport type { BaseAutomation } from '@svgrid/enterprise/base'\n\nexport const candidateAutomations: BaseAutomation[] = [\n {\n id: 'new-application',\n name: 'Announce a new application',\n enabled: true,\n trigger: { type: 'formSubmitted', view: 'apply' },\n actions: [{ type: 'notify', message: 'New application from {Candidate}', severity: 'info' }],\n },\n {\n id: 'thank-you-email',\n name: 'Thank the candidate',\n enabled: true,\n runOn: 'server',\n trigger: { type: 'formSubmitted', view: 'apply' },\n actions: [\n {\n type: 'email',\n to: '{Email}',\n subject: 'We got your application',\n body: 'Hi {Candidate}, thank you for applying. We reply within a week.',\n },\n ],\n },\n]\n```\n\nPut them on the table (`automations: candidateAutomations`). A form on its own\nneeds one `<SvToaster />` from `@svgrid/grid` for the notice; inside a base it\nshows without one. In the base, a form view\nsends its record to the table's automations with the view's `id`. They need\n`<SvBase tables>`: with `data` and `columns` a form still adds records, but\nno automation runs.\n\nThe public page has no base and no browser runner, so the endpoint in step 7\ntells the [automation server](./automations.md#on-the-server) after the\ninsert. The view id there is whatever string your automations name. Only\nautomations with `runOn: 'server'` run on the server. If it has not seen\nthe record yet, it reads the table again first, and that reading also runs\nthe table's \"A record is created\" server automations for the new record.\n\n## Show a field only for some answers\n\n<div data-docs-demo=\"711-base-form-logic\" data-height=\"720\"></div>\n\nIn the demo, pick Bug as the Topic and App version appears; switch to\nBilling and it gives way to Invoice number. The buttons on the right open\nthe form from prefilled links.\n\nA field can wait for an answer before it shows. `conditions` maps a column id\nto a [view bar filter](./views.md) over the other answers, the same\n`FieldFilter` the Filter button saves. On a form view the key is\n`formConditions`:\n\n```ts\nimport type { FieldFilter } from '@svgrid/enterprise/base'\n\nconst is = (column: string, value: string): FieldFilter => ({\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [{ column, kind: 'select', op: 'is', value }],\n})\n\nconst apply = {\n id: 'apply',\n name: 'Apply',\n type: 'form',\n formFields: ['name', 'email', 'employment', 'company', 'reason', 'otherReason'],\n formRequired: ['name', 'email', 'company', 'otherReason'],\n formConditions: {\n company: is('employment', 'Employed'),\n otherReason: is('reason', 'Other'),\n },\n}\n```\n\nWith `SvBaseForm` it is `conditions={{ company: is('employment', 'Employed') }}`.\n\nThe form checks the conditions each time an answer changes. While a\nfield's condition does not hold:\n\n- the field is not drawn, and Tab skips it;\n- it is not required and not checked, so `formRequired` can name it;\n- what was typed in it is cleared, and a field whose condition reads it\n hides too;\n- the record does not get it, not even its `fieldProps.default`.\n\nWhen the field shows again it starts with the value a new record gets. A\ncondition reads the answers by column id; a field the form does not ask\nfor is read as the new record would have it.\n\n## Fill the form from a link\n\n`prefill` fills fields from a link, the convention people already paste\ninto emails: `?prefill_<Field name>=value`. The name is the field's\n`header` or its column id, URL-encoded. `hide_<Field name>=true` keeps a\nfilled field out of sight and still sends it:\n\n```\nhttps://example.com/apply?prefill_Role=Product%20designer&prefill_Source=Referral&hide_Role=true\n```\n\nOn a form view, `formPrefill: true` reads the page's own URL. On a page,\npass it to `SvBaseForm`:\n\n```svelte\n<SvBaseForm {api} fields={APPLY_FIELDS} prefill />\n<SvBaseForm {api} fields={APPLY_FIELDS} prefill={page.url.searchParams} />\n<SvBaseForm {api} fields={APPLY_FIELDS} prefill={{ Role: 'r2', Source: 'Referral' }} />\n```\n\n`prefill` takes `true` (the page's URL, nothing during a server render), a\nURL or query string, `URLSearchParams`, or values by field name or column\nid. When it changes to other answers, the form starts a new record.\n\nEach value is read the way a pasted cell is:\n\n| Field type | `prefill_` value |\n|---|---|\n| text, email, URL, phone | As written |\n| number, currency, percent | The number as typed, `1,200` included; text that is no number is dropped |\n| checkbox | `true`, `1`, `yes`, `on` check it; anything else unchecks it |\n| date | `2026-11-02` |\n| single select | An option's value or label, any case |\n| multiple select | Values or labels, comma-separated |\n| user | A person's id, name or email |\n| link | Record ids or names, comma-separated |\n\nAn option the select does not have, a person nobody is, or a record that\ndoes not exist is dropped: a link never adds an option. Files and computed\nfields cannot be filled. A link's value goes over the field's default.\n`hide_` works only on a field the link filled; if a hidden value fails a\ncheck on Submit, the field shows with its message.\n\n`formPrefillLink` builds such a link from values by column id:\n\n```ts\nimport { formPrefillLink } from '@svgrid/enterprise/base'\n\nformPrefillLink('https://example.com/apply', { role: ['r2'], source: 'Referral' }, candidateColumns, { hide: ['role'] })\n// https://example.com/apply?prefill_Role=r2&prefill_Source=Referral&hide_Role=true\n```\n\nWith the columns, each parameter carries the field's `header`. A list is\njoined with commas, a `Date` written as `YYYY-MM-DD`, and the base URL's own\nquery and `#hash` are kept.\n\nThe link is typed by whoever sends it. On a public form, say which fields a\nlink may fill: `prefillFields` on `SvBaseForm`, or a list for `formPrefill`\non a form view. A `prefill_` or `hide_` for any other field is ignored, so a\nlink cannot set the Source or the Owner you meant to fill yourself:\n\n```ts\nimport type { FieldView } from '@svgrid/enterprise/base'\n\nconst apply: FieldView = {\n id: 'apply',\n name: 'Apply',\n type: 'form',\n formFields: ['name', 'email', 'role', 'source'],\n // A link may pick the role and say where the candidate came from, nothing else.\n formPrefill: ['Role', 'source'],\n formFooter: 'We keep your answers for 12 months. Write to jobs@example.com to have them removed.',\n}\n```\n\nCheck every value on the server as in\n[step 7](#7-check-it-again-on-the-server) all the same.\n\n## A footer under the button\n\n`formFooter` on a form view is a line of plain text under the submit button:\nwho reads the answers, how long they are kept. For more than a line (a logo,\nlinks to your terms), give `<SvBase>` a `formFooter` snippet; it gets the\nform view, so one snippet can serve every form:\n\n```svelte\n<SvBase bind:tables editable>\n {#snippet formFooter(view)}\n <p>By sending {view.name.toLowerCase()} you agree to our <a href=\"/terms\">terms</a>.</p>\n {/snippet}\n</SvBase>\n```\n\nOn a page of your own, `SvBaseForm` takes the same as `footerText` and a\n`footer` snippet.\n\n## One question at a time\n\n`layout=\"steps\"` asks one question at a time, as a conversation: a progress\nbar, \"Question 2 of 6\", Back and Next. Each answer is checked before the next\nquestion comes (a required field left empty, or an e-mail that is not one,\nstays with its message). Enter after an answer goes on, and on the last\nquestion sends the form. Shift+Enter, or Enter in a long text, starts a new\nline. A send that finds a problem goes back to the question it is on.\n\nThe next question slides in from the side it is on (`transition=\"slide\"`),\nfades in (`\"fade\"`) or just appears (`\"none\"`). A visitor who asks the system\nfor less motion gets none, whatever the form says.\n\n```svelte\n<SvBaseForm {api} fields={['name', 'email', 'role', 'note']} required={['name', 'email']}\n layout=\"steps\" transition=\"slide\" title=\"Apply\" />\n```\n\nConditions work as in the list: a question whose condition fails is skipped,\nand the count follows.\n\n## Suggest answers before it is sent\n\nA help desk's request form can show the help articles that may already\nanswer the question, before anyone sends it. `setFormSuggestions` gives every\nform that: once the first text field (the subject) holds a few words, `list`\nis asked with the table, that text and the answers so far, and up to five\nsuggestions show under the field. Each opens in place; **This solved it** calls\n`solved` and ends the form with nothing added, and **Ask something else**\nstarts again.\n\n```ts\nimport { setFormSuggestions } from '@svgrid/enterprise/base'\n\nsetFormSuggestions({\n list: async (tableId, text) => {\n const res = await fetch(`/articles?q=${encodeURIComponent(text)}`)\n return (await res.json()) as Array<{ id: string; title: string; text: string }>\n },\n solved: (tableId, id) => {\n void fetch(`/articles/${id}/solved`, { method: 'POST' })\n },\n})\n```\n\nA text field takes its value when it is left (Tab, Enter, or a click\nelsewhere), so the suggestions come then, not on every key.\n\n## SvBaseForm props\n\n| Prop | Type | Default | What it does |\n|---|---|---|---|\n| `api` | grid api | required | The api of the grid the record is added to, from its `onApiReady`. Nothing draws until that grid has drawn once. |\n| `fields` | `ReadonlyArray<string>` | every field a person can fill in | Column ids, in order. An id that is not such a field is skipped. |\n| `required` | `ReadonlyArray<string>` | `[]` | Column ids that must have a value before the record is added. |\n| `title` | `string` | `'New record'` | The heading. |\n| `description` | `string` | `''` | The line under the heading. |\n| `submitLabel` | `string` | `'Submit'` | The button's text. |\n| `defaults` | `() => Record<string, unknown>` | | Values each record from this form starts with. The grid's `rowAdder.defaults()` wins over them. Called once per record. `<SvBase tables>` passes one that gives an `id`. |\n| `conditions` | `Record<string, FieldFilter>` | | Column id -> when that field shows. A hidden field is not required, not checked and not sent ([Show a field only for some answers](#show-a-field-only-for-some-answers)). |\n| `prefill` | `boolean \\| string \\| URLSearchParams \\| Record<string, unknown>` (`FormPrefill`) | | Answers to start with: `true` reads the page's URL, a string or `URLSearchParams` is read for `prefill_` and `hide_`, an object gives values by field name or column id ([Fill the form from a link](#fill-the-form-from-a-link)). |\n| `prefillFields` | `ReadonlyArray<string>` | every field asked for | The fields `prefill` may fill or hide, by field name or column id. |\n| `footerText` | `string` | | A line under the submit button. |\n| `labels` | `Record<string, string>` | | Column id -> the question this form asks for that field, in place of the field's name. The required message uses it too. |\n| `help` | `Record<string, string>` | | Column id -> the help under that field on this form, in place of its description. An empty string shows none. |\n| `footer` | `Snippet` | | What goes under the submit button, after `footerText`. |\n| `layout` | `'list' \\| 'steps'` | `'list'` | `steps` asks one question at a time, with Back and Next ([One question at a time](#one-question-at-a-time)). |\n| `transition` | `'slide' \\| 'fade' \\| 'none'` | `'slide'` | How the next question comes in, with `layout=\"steps\"`. None for visitors who ask for less motion. |\n| `onSubmit` | `(row: Record<string, unknown>) => void \\| Promise<unknown>` | | Called after the row was appended to the grid and the grid's `onRowAdd` ran. A Promise keeps the button disabled until it settles: resolved shows \"Thank you\", rejected takes the row back out of the grid, keeps the fields and shows the error's message. |\n\n## Form view keys\n\n| Key | Read as |\n|---|---|\n| `type` | `'form'` |\n| `name` | The view's name in the menu; the heading when there is no `formTitle` |\n| `formFields` | The fields it asks for, in order |\n| `formTitle` | The heading |\n| `formDescription` | The line under it |\n| `formRequired` | Column ids that must have a value, as `required` on `SvBaseForm` |\n| `formSubmitLabel` | The button's text (default `'Submit'`) |\n| `formConditions` | Column id -> when that field shows, as `conditions` on `SvBaseForm` |\n| `formPrefill` | `true` fills fields from the page's URL, as `prefill` on `SvBaseForm`; a list of field names or column ids lets the link fill only those |\n| `formFooter` | A line of plain text under the submit button |\n| `formLabels` | Column id -> the question asked for that field, as `labels` on `SvBaseForm` |\n| `formHelp` | Column id -> the help under that field, as `help` on `SvBaseForm` |\n\nA record the view sends reaches `onRowAdd`, `onTablesChange` and the\n`formSubmitted` automations, which get the view's `id`.\n\n## What a screen reader and a browser get\n\nA field that takes typed text (text, long text, number, email, URL, phone) is a\nreal `<input>` or `<textarea>` with a `<label>` from the start, and a checkbox a\nreal checkbox. A required field has `aria-required`. Fields with a picker (a\nselect, a date, a file, a link) are a labelled button until opened, and their\nname says when they are required.\n\nA field in error gets `aria-invalid` and its message through `aria-describedby`.\nA submit that fails says how many fields need attention, and focus goes to the\nfirst of them.\n\nEmail, phone and URL fields carry their `autocomplete` purpose, so a browser can\nfill them in. A text field gets one from an English name (Name, First name, Last\nname, Company, Address, City, Zip, Country). For any other name or language, set\nit on the field:\n\n```ts\n{ field: 'nombre', header: 'Nombre', fieldType: 'text', fieldProps: { autocomplete: 'name' } }\n```\n\n## What the form checks\n\n- **Required**: empty means no value, an empty string or an empty list. A\n checkbox that is off and a number that is 0 count as filled. The message\n is \"{header} is required\".\n- **Number and duration**: the editor refuses text that is not a number\n (\"Not a number\") and a negative where `allowNegative: false` (\"Negative\n numbers are not allowed\"), and keeps the box open. A click outside the\n box while it shows the error drops what was typed. A value is stored as\n typed; precision is how it shows, and only an integer field rounds.\n- **Attachment**: `maxFiles`, `maxSize` and `accept`, file by file, before\n uploading. A file added by URL is checked against `maxFiles` and `accept`\n (by the name's extension); its size is not known, so `maxSize` does not\n apply.\n- **Email, URL, phone**: on submit, a value must be one the cell can link:\n an address for `mailto:`, an http or https address (a bare host such as\n `svgrid.com/docs` counts), or 3 to 20 digits with an optional leading `+`\n and spaces, dots, dashes or parentheses. The messages are \"Not a valid\n email address\", \"Not a valid web address\" and \"Not a valid phone number\".\n An empty field is not checked.\n- **The column's `validate`**: on submit, the form calls it as the grid\n does, with `value`, `row` (what the fields show), `rowIndex: -1` and\n `column`. `false` shows \"{header} is not valid\"; a string shows that\n string. It runs on empty fields too, and it blocks the submit even\n without `rejectInvalid`.\n- **Select**: only the field's options. Text that matches none shows \"No\n option matches\"; a form never offers \"Add option\".\n- **Link**: only records of the linked table, plus `Create \"...\"` for the\n typed name when that table has `create`.\n\nA failed check shows its message under the field and nothing is sent. The\nmessage goes away when that field gets a new value.\n\n## Pitfalls\n\n- **\"Thank you\" waits only for a Promise.** If `onSubmit` posts but does\n not return the Promise (or throw), the form thanks the person before the\n server answers. Return it, as `send` in step 4 does.\n- **A rejected `onSubmit` comes after `onRowAdd`.** On a rejection the form\n takes the row back out of the grid, but anything your `onRowAdd` did with\n it stays done. Save in one of the two, not both.\n- **Automatic values come from the browser.** On the public page the hidden\n grid has no rows, so an autonumber is always 1, and a created time is the\n visitor's clock. Set them on the server.\n- **One form sets off two triggers.** In `<SvBase tables>`, a sent form runs\n the \"A record is created\" automations, then the \"A form is sent\" ones. An\n automation on each that does the same thing does it twice.\n- **Uploads outlive abandoned forms.** A file is uploaded when it is added,\n so a candidate who adds a resume and leaves leaves a file behind. Remove\n stored files no record points to.\n\n## Next\n\n- [Automations](./automations.md): the other triggers, and the server\n runner the public page reports to.\n- [Keep a base in a database](./data.md): give Candidates a source so\n applications show up for the team.\n- [Saved views](./views.md): the Kanban the recruiters work in, its stacks\n and colors.\n- [Linked records](./linked-records.md): the Role link and the Candidates\n list on each role.\n- [Field types](../fields.md#declare-columns-by-type): every type's\n `fieldProps`, including `default` and `defaultToday`.\n"
|
|
5210
5210
|
},
|
|
5211
5211
|
{
|
|
5212
5212
|
"slug": "help/base/formulas",
|
|
@@ -5227,7 +5227,7 @@ export const docs = [
|
|
|
5227
5227
|
"path": "docs/help/base/linked-records.md",
|
|
5228
5228
|
"title": "Link tables: lookups, rollups and counts",
|
|
5229
5229
|
"section": "SvGrid Base",
|
|
5230
|
-
"markdown": "# Link tables: lookups, rollups and counts\n\nA base holds several tables, and a link field relates their records: a deal\nnames its account, the account lists its deals. Lookups, rollups and counts\nthen read through the link, so an account can show the value of its pipeline\nwithout anyone typing it. This page builds a small sales CRM with Accounts,\nContacts and Deals, one step at a time.\n\n\n\n<div data-docs-demo=\"512-base-sales-crm\" data-height=\"680\"></div>\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\nThe demo above is the finished CRM. Step 1 is a complete page; the later\nsteps add a table and fields to it.\n\n## 1. Two tables and a link\n\nGive `SvBase` a list of tables instead of `data` and `columns`. Each table\nhas an `id`, its records, its fields and its views. A link field names the\ntable it points at in `fieldProps.table`, and the field there that links back\nin `fieldProps.inverse`.\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, type BaseTable } from '@svgrid/enterprise/base'\n\n enableBase()\n\n const STAGES = [\n { value: 'Lead', color: '#94a3b8' },\n { value: 'Qualified', color: '#18bfff' },\n { value: 'Proposal', color: '#2d7ff9' },\n { value: 'Won', color: '#20c933' },\n { value: 'Lost', color: '#f82b60' },\n ]\n const INDUSTRIES = [\n { value: 'Wholesale', color: '#ff6f2c' },\n { value: 'Manufacturing', color: '#2d7ff9' },\n { value: 'Healthcare', color: '#20c933' },\n ]\n\n const deals = [\n { id: 'd1', deal: 'Northwind: Platform license', account: ['a1'], stage: 'Proposal', value: 48000 },\n { id: 'd2', deal: 'Contoso: Pilot', account: ['a2'], stage: 'Qualified', value: 12000 },\n { id: 'd3', deal: 'Northwind: Renewal', account: ['a1'], stage: 'Won', value: 30000 },\n ]\n const accounts = [\n { id: 'a1', name: 'Northwind Traders', industry: 'Wholesale', deals: ['d1', 'd3'] },\n { id: 'a2', name: 'Contoso', industry: 'Manufacturing', deals: ['d2'] },\n { id: 'a3', name: 'Litware', industry: 'Healthcare', deals: [] },\n ]\n\n let tables = $state.raw<BaseTable[]>([\n {\n id: 'deals',\n name: 'Deals',\n primaryField: 'deal',\n data: deals,\n columns: [\n { field: 'deal', header: 'Deal', width: 260, fieldType: 'text' },\n { field: 'account', header: 'Account', width: 180, fieldType: 'link', fieldProps: { table: 'accounts', multiple: false, inverse: 'deals' } },\n { field: 'stage', header: 'Stage', fieldType: 'singleSelect', fieldProps: { options: STAGES } },\n { field: 'value', header: 'Value', fieldType: 'number', fieldProps: { format: 'currency', symbol: '$', precision: 0 } },\n ],\n views: [{ id: 'all', name: 'All deals', type: 'grid' }],\n },\n {\n id: 'accounts',\n name: 'Accounts',\n primaryField: 'name',\n data: accounts,\n columns: [\n { field: 'name', header: 'Account', width: 220, fieldType: 'text' },\n { field: 'industry', header: 'Industry', fieldType: 'singleSelect', fieldProps: { options: INDUSTRIES } },\n { field: 'deals', header: 'Deals', width: 260, fieldType: 'link', fieldProps: { table: 'deals', multiple: true, inverse: 'account' } },\n ],\n views: [{ id: 'all', name: 'All accounts', type: 'grid' }],\n },\n ])\n\n function save(next: BaseTable[]) {\n // Every change to records, fields, views or tables lands here.\n console.log(next)\n }\n</script>\n\n<SvBase bind:tables editable sortable expandRows columnAdder fieldMenu\n containerHeight={600} onTablesChange={save} />\n```\n\nOn screen there are two tabs, Deals and Accounts. The Account column shows\none chip per linked record, with the account's name (its primary field). On\nthe Accounts tab, Northwind Traders shows two chips in Deals.\n\nWhat the link needs:\n\n- **Record ids.** A link stores ids, so every record needs an `id` (or the\n table needs a `getRowId`).\n- **Both sides declared.** `account.inverse` names the `deals` field of\n Accounts, and `deals.inverse` names `account`. The `inverse` value is the\n other field's `id`, or its `field` when it has no `id`.\n- **Both sides agree in the data you load.** The base keeps the two in step\n from the first change on, but it does not rewrite loaded data, so\n `accounts[0].deals` has to list `d1` and `d3` because those deals name\n `a1`. A mismatch is reported in the console when SvBase mounts (see\n [Pitfalls](#pitfalls)).\n\n`multiple: false` lets a deal pick one account. Leave it out and the field\nlinks many records; that is the type's default.\n\n## 2. Pick linked records\n\nSelect an Account cell and press Enter, or double-click it. A dialog titled\n\"Link to Accounts\" lists the accounts by name under a \"Search Accounts\" box.\nClick a row to tick it; in a single link a click on another row moves the\ntick, and a click on the ticked row clears it. The footer counts what is\nticked (\"1 linked\"). Done writes the ids, Cancel or Escape leaves the cell\nas it was. Typing on a selected link cell does not open the dialog.\n\nSearch matches the primary field and the linked table's text fields (text,\nlong text, email, URL, phone and the selects), anywhere in the value. A\nrecord found by another field shows where, for example \"Email:\nmaya@northwind.example.com\". The list shows the first 200 matches; when more\nmatch, a line under it says how many (\"Showing 200 of 1,240. Type to\nnarrow.\"). When no account is named exactly what you typed, the list ends\nwith + Create \"Initech\": it adds an account called Initech to the Accounts\ntable, with a new id, and ticks it. The account is added at once; Cancel\nleaves the link as it was but does not take the account back.\n\nEnter in the search box takes the row that is lit, which is the first match, or\n+ Create when nothing matches: typed text and Enter makes the record. On a table a\nserver searches, Enter waits for the answer to what was typed.\n\nCopy and paste work on names. Ctrl+C on a link cell copies \"Northwind\nTraders\", not `a1`. Pasting text into a link cell splits it at commas and\nlinks each part that matches a record's name or id, ignoring case; parts that\nmatch nothing are left out and the page says so, and a single link keeps the\nfirst match. With no part matching, the cell keeps the links it has.\n\nA name with a comma or a double quote is copied in quotes, CSV style:\n`\"Acme, Inc.\", Contoso`, with an inner quote doubled (`\"The \"\"Big\"\" Shop\"`).\nThe paste reads a quoted part as one name, so the copy pastes back to the\nsame records. A user field with several people copies and pastes its names\nthe same way. A copy on the same page keeps the very records when two share a\nname. A file's column can go to a link field too: it is read the same way, and\nthe import says how many names it could not find.\n\nPick Litware for \"Contoso: Pilot\", press Done, and switch to Accounts:\nContoso no longer lists the pilot and Litware does. The base rewrites the\nother side after every link edit, from either side. Link a deal from an\naccount's Deals cell and the deal's Account cell changes; because a deal has\none account, the account that listed it before lets go of it. Records\ndeleted on one side drop out of the links on the other. A record added with\n\"+ Add row\", a form or a group's \"+\" is linked on both sides as soon as it\nexists.\n\nAutomations hear these changes too: linking a deal from Accounts counts as a\nchange to the deal's Account field. See [Automations](./automations.md#when).\n\n## 3. Open and preview a linked record\n\nRest the pointer on a chip for a moment and a card opens under it: the\nrecord's name, its table, and the first four of its other fields that have a\nvalue, written as their cells write them. Empty fields are skipped and do not\ncount toward the four. Move onto the card to\nread it; it closes when the pointer leaves. Touch input skips the preview.\n\nSelect the cell and click a chip to open the record in a dialog. It shows every field of the\nlinked record with the field's icon and name, drawn the way its cells draw\nthem: a select as its pill, a link as chips. The record is read here, not\nedited. A chip inside it opens that record over this one, so you can walk\nfrom a deal to its account to the account's other deals.\n\nFor a table of the same base the dialog has \"Open in Accounts\" next to\nClose. It closes every open linked record, switches to the Accounts tab and\nexpands the record there, where it can be edited. If the record was deleted\nin the meantime, the dialog says \"This record is not in its table any\nmore.\"\n\n## 4. Add a third table\n\nContacts link to an account and to their deals. Add the table and one link\nfield on each side of each pair.\n\n```ts\nconst contacts = [\n { id: 'c1', name: 'Maya Lindqvist', title: 'Head of Operations', email: 'maya@northwind.example.com', account: ['a1'], deals: ['d1'] },\n { id: 'c2', name: 'Priya Raman', title: 'CFO', email: 'priya@contoso.example.com', account: ['a2'], deals: ['d2'] },\n]\n\nconst contactsTable: BaseTable = {\n id: 'contacts',\n name: 'Contacts',\n primaryField: 'name',\n data: contacts,\n columns: [\n { field: 'name', header: 'Name', width: 190, fieldType: 'text' },\n { field: 'title', header: 'Title', fieldType: 'text' },\n { field: 'email', header: 'Email', width: 240, fieldType: 'email' },\n { field: 'account', header: 'Account', fieldType: 'link', fieldProps: { table: 'accounts', multiple: false, inverse: 'contacts' } },\n { field: 'deals', header: 'Deals', fieldType: 'link', fieldProps: { table: 'deals', multiple: true, inverse: 'contact' } },\n ],\n}\n```\n\nThen the new fields in the other two tables, each naming its partner:\n\n```ts\n// In Deals' columns, with contact: ['c1'] on d1 and ['c2'] on d2\nconst contact = { field: 'contact', header: 'Contact', fieldType: 'link', fieldProps: { table: 'contacts', multiple: false, inverse: 'deals' } }\n// In Accounts' columns, with contacts: ['c1'] on a1 and ['c2'] on a2\nconst accountContacts = { field: 'contacts', header: 'Contacts', fieldType: 'link', fieldProps: { table: 'contacts', multiple: true, inverse: 'account' } }\n```\n\nTwo fields in different tables can share a name (Deals and Contacts both\nhave `account`); `inverse` names a field of the table the link points at.\n\nYou can build the same links without code. On the Contacts tab press \"+\" at\nthe end of the header, pick \"Link to records\" and choose Accounts under\nTable. Accounts gets a field back at once, a link to many named after the\ntable it comes from (\"Contacts\", or \"Contacts 2\" when that name is taken),\nand both fields name each other in `inverse`.\n\n## 5. Show a field of the linked record: lookups\n\nA lookup shows a field of the records a link field points at. On Deals,\nshow the account's industry and the contact's email:\n\n```ts\nconst accountIndustry = { field: 'accountIndustry', header: 'Industry', fieldType: 'lookup', fieldProps: { linkField: 'account', field: 'industry' } }\nconst contactEmail = { field: 'contactEmail', header: 'Contact email', width: 240, fieldType: 'lookup', fieldProps: { linkField: 'contact', field: 'email' } }\n```\n\n`linkField` is the link field of this table; `field` is a field of the linked\ntable. The lookup's value is a list, one entry per linked record, and the\ncell writes it as text joined with commas, each value the way its own field\nwrites it: an amount with its symbol, a date in its format. \"Manufacturing\"\nshows as text, not as the colored pill, and the email is not a mailto link.\n\nA lookup is read-only and is never stored in the records. When the linked\nfield is itself computed (a formula, a rollup, another lookup), the lookup\nworks it out. In the field editor, pick the link under \"Link field\" and the\nfield under \"Field in the linked table\".\n\n## 6. Sum and count the linked records: rollups and counts\n\nA rollup reduces one field over the linked records to a single value. A count\nsays how many records a link points at. On Accounts:\n\n```ts\nconst pipeline = { field: 'pipeline', header: 'Pipeline value', width: 160, fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'SUM' } }\nconst largest = { field: 'largest', header: 'Largest deal', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'MAX' } }\nconst stages = { field: 'stages', header: 'Stages', width: 200, fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'stage', aggregation: 'ARRAYUNIQUE' } }\nconst dealCount = { field: 'dealCount', header: 'Deal count', fieldType: 'count', fieldProps: { linkField: 'deals' } }\n```\n\nNorthwind Traders shows \"$78,000\", \"$48,000\", \"Proposal, Won\" and 2. Edit a\ndeal's value on the Deals tab and the account's numbers follow.\n\n| `aggregation` | Result |\n|---|---|\n| `SUM` | The total; values that are not numbers count as 0. The default |\n| `AVERAGE`, `MIN`, `MAX` | Over the values that read as numbers; empty when there are none |\n| `COUNT` | How many values are numbers |\n| `COUNTA` | How many values are not empty |\n| `COUNTALL` | How many linked records, empty values included |\n| `ARRAYJOIN` | The non-empty values as text, joined with \", \" |\n| `ARRAYUNIQUE` | The same, each value once |\n| `CONCATENATE` | Every value as text, joined with nothing between |\n| `AND`, `OR` | Whether every value, or any value, is truthy |\n\nA `SUM`, `AVERAGE`, `MIN` or `MAX` writes its result the way the linked field\nwrites its values, so a sum of dollar amounts shows \"$78,000\". Set\n`precision` (0 to 8) on the rollup and it keeps the symbol at that many\ndecimals: \"$78,000.00\". A rollup with one of these four or with `COUNT`, `COUNTA`\nor `COUNTALL` is a number column: it right-aligns, and its footer offers Sum,\nAverage and the other number summaries (step 7).\n\nA count field takes only `linkField` and is the number of linked records\nthat exist. That differs from a `COUNT` rollup, which counts the linked\nrecords whose field holds a number.\n\nRollups, lookups and counts are read-only. The [field types\ntable](../fields.md#declare-columns-by-type) lists their `fieldProps` with\nevery other type's.\n\n## 7. Formulas and footers over linked values\n\nA formula can name a rollup or a count like any other field, by its header\nin braces. The formula works the computed field out when it reads it. On\nAccounts, the average deal size:\n\n```ts\nconst avgDeal = {\n field: 'avgDeal',\n header: 'Average deal',\n fieldType: 'formula',\n fieldProps: { formula: 'IF({Deal count} > 0, {Pipeline value} / {Deal count}, 0)', result: 'currency', symbol: '$', precision: 0 },\n}\n```\n\nThe other direction works too: a rollup can add up a formula of the linked\ntable. Give Deals a probability and a weighted value, then sum the weighted\nvalue per account:\n\n```ts\n// In Deals' columns, with probability: 0.5 on d1, 0.25 on d2, 1 on d3\nconst probability = { field: 'probability', header: 'Probability', fieldType: 'number', fieldProps: { format: 'percent', precision: 0 } }\nconst weighted = { field: 'weighted', header: 'Weighted', fieldType: 'formula', fieldProps: { formula: '{Value} * {Probability}', result: 'currency', symbol: '$', precision: 0 } }\n\n// In Accounts' columns\nconst forecast = { field: 'forecast', header: 'Forecast', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'weighted', aggregation: 'SUM' } }\n```\n\nNorthwind's forecast is $54,000: $24,000 from the proposal and $30,000 from\nthe renewal. The OKR base does the same with an `AVERAGE` of each key\nresult's progress formula:\n\n<div data-docs-demo=\"522-base-okrs\" data-height=\"620\"></div>\n\nWith the `summary` prop on `SvBase`, every field gets a footer cell. Click\nthe Pipeline value footer and pick Sum, or set the choice in\n`fieldProps.summary`: the footer adds up the rollup's values over the shown\nrecords and writes the total the way the rollup writes it (\"Sum $90,000\").\nA count's footer offers the same choices.\n\n```ts\nconst pipelineWithTotal = { field: 'pipeline', header: 'Pipeline value', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'SUM', summary: 'sum' } }\n```\n\n\n\n[Summaries at the bottom](../fields.md#summaries-at-the-bottom) lists every\nsummary.\n\n## 8. Filter and group by a link\n\nThe view bar's Filter compares a link by the linked records' names: contains,\ndoes not contain, is, is not, is empty and is not empty. \"Account is\nContoso\" keeps the deals linked to Contoso. Counts filter as numbers, and so\ndo rollups that are numbers (`SUM`, `AVERAGE`, `MIN`, `MAX`, `COUNT`,\n`COUNTA`, `COUNTALL`). An `ARRAYJOIN`, `ARRAYUNIQUE` or `CONCATENATE` rollup\nfilters as text, an `AND` or `OR` rollup as a checkbox (is checked or\nunchecked). Lookups filter as text.\n\nGrouping by a link field puts the records linked to the same records in one\ngroup. The group's header shows the link as chips, the record count and the\nsummaries the fields picked. Its \"+\" adds a deal already linked to that\naccount, and the account lists the new deal at once.\n\nBoth can be saved in a view:\n\n```ts\nimport type { FieldView } from '@svgrid/enterprise/base'\n\nconst dealViews: FieldView[] = [\n { id: 'all', name: 'All deals', type: 'grid' },\n { id: 'by-account', name: 'By account', type: 'grid', state: { grouping: ['account'], sorting: [{ id: 'value', desc: true }] } },\n {\n id: 'contoso',\n name: 'Contoso deals',\n type: 'grid',\n state: {\n advancedFilter: {\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [{ column: 'account', kind: 'link', op: 'is', value: 'Contoso', table: 'accounts' }],\n },\n },\n },\n]\n```\n\nA link condition needs `table`, the linked table's id: that is how it turns\nids into names. The Filter panel fills it in; in code, write it yourself.\nWithout it the condition compares the ids as text.\n\n## 9. Link to a table outside the base\n\nA link field can point at a table your app owns and the base does not show:\na product catalog from your API, a list of regions. Register it with\n`registerLinkedTable`:\n\n```ts\nimport { registerLinkedTable } from '@svgrid/enterprise/base'\n\nlet products = [\n { sku: 'PLT-1', name: 'Platform license', price: 24000 },\n { sku: 'TEAM-1', name: 'Team plan', price: 6000 },\n { sku: 'SUP-1', name: 'Premium support', price: 4800 },\n]\n\nregisterLinkedTable({\n id: 'products',\n name: 'Products',\n primaryField: 'name',\n getRowId: (row) => String(row.sku),\n // A function is read every time, so the list can change.\n rows: () => products,\n fields: [\n { field: 'name', header: 'Product' },\n { field: 'price', header: 'List price', fieldType: 'number', fieldProps: { format: 'currency', symbol: '$', precision: 0 } },\n ],\n})\n```\n\nDeals then link to it and roll it up like any table of the base:\n\n```ts\n// In Deals' columns, with products: ['PLT-1', 'SUP-1'] on d1\nconst dealProducts = { field: 'products', header: 'Products', width: 220, fieldType: 'link', fieldProps: { table: 'products', multiple: true } }\nconst listPrice = { field: 'listPrice', header: 'List price', fieldType: 'rollup', fieldProps: { linkField: 'products', field: 'price', aggregation: 'SUM' } }\n```\n\nWhat differs from a table of the base:\n\n- There is no field back and no `inverse`: the catalog is yours, and the\n base never writes to it.\n- The picker offers \"+ Create\" only when the table has a `create(name)` that\n adds the record and returns it with its id.\n- The linked record dialog has \"Open in Products\" only when the table has an\n `open(rowId)` that shows the record somewhere in your app.\n- `fields` is what the field editor offers a lookup or rollup under \"Field\n in the linked table\", and its types decide how a lookup, a rollup, the\n preview and the record dialog write each value (\"$24,000\", not 24000).\n Without `fields` the editor offers only the primary field and the dialog\n shows every key of the record. A lookup or rollup declared in code can\n read any key either way. The picker's search reads the text fields in\n `fields`, or every text value of the record without them.\n\nThe table appears under Table in the field editor of every link field on the\npage. `unregisterLinkedTable('products')` removes it, and so does calling the\nfunction `registerLinkedTable` returns.\n\n## How links are stored\n\nA link field's value is an array of record ids, in the order they were\npicked. A single link is an array of one. Here is \"Northwind: Platform\nlicense\" and its account, as `onTablesChange` hands them over after steps 1\nto 9:\n\n```json\n{\n \"id\": \"d1\",\n \"deal\": \"Northwind: Platform license\",\n \"account\": [\"a1\"],\n \"contact\": [\"c1\"],\n \"products\": [\"PLT-1\", \"SUP-1\"],\n \"stage\": \"Proposal\",\n \"value\": 48000,\n \"probability\": 0.5\n}\n```\n\n```json\n{\n \"id\": \"a1\",\n \"name\": \"Northwind Traders\",\n \"industry\": \"Wholesale\",\n \"deals\": [\"d1\", \"d3\"],\n \"contacts\": [\"c1\"]\n}\n```\n\nLookups, rollups, counts and formulas are not in the records. They are\nworked out from the links each time they are drawn, so there is nothing to\nkeep in step. An id that names no record is skipped when the cell draws.\n\nIn a database, a link to one record is usually a foreign key column and a\nlink to many a junction table, and the field back is not stored at all. See\n[Keep a base in a database](./data.md#link-fields).\n\n## Change or delete a link field\n\n- **Point it at another table.** Change Table in the field editor. The field\n back is removed from the old table, values included; the link's own\n values are cleared (they were ids of the old table), and the new table\n gets a field back.\n- **Turn it into another type.** The field back goes, and the values become\n the linked records' names. A link turned into text holds \"Northwind\n Traders, Contoso\". A multiple select gets every name, a single select the\n first, and the select's options are made from those names. A cell that\n held several records keeps only one name in a single select, so the field\n editor counts it in its warning (\"2 cells will be cleared or cut\n short.\").\n- **Turn text, a select or a lookup into a link.** Each name becomes the\n record of the new table with that name or id, ignoring case, as a paste\n does. Text splits at commas; a quoted part is one name (`\"Acme, Inc.\"`).\n Names that match no record are dropped. The field editor counts the cells\n that end up empty or lose a name before it applies (\"3 cells will be\n cleared or cut short.\").\n- **Make it single.** Untick \"Allow linking to multiple records\" in the\n field editor (`multiple: false`) on a link that holds several ids: each\n record keeps the first one, and the field back drops the rest.\n- **Delete it.** With `fieldMenu`, Delete field on a link that has a field\n back, or that lookups, rollups or counts read, asks first. The dialog\n names the field back (\"Account links to Accounts. The field there that\n links back, Deals, is deleted with it. The links between the records go\n too.\") and lists the lookups, rollups and counts on either side that read\n it, the other table's in brackets (\"These fields read it and are deleted\n too: Industry, Pipeline value (Accounts), ...\"). They are deleted with the\n link.\n- **Duplicate it.** The copy gets its own field back in the other table.\n- **Delete a table.** Delete table in the tab's menu asks first: the\n table's records and views go, and so do the link fields of other tables\n that point at it (\"Deals: Account\") and the lookups, rollups and counts\n that read them (\"Deals: Industry (reads Account)\"), values included. A\n base keeps at least one table.\n- **Duplicate a table.** The copy's link fields point at the same records,\n each with a new field back in the other table.\n\n## Record ids\n\nRecords added through the base get an id from `newRecordId()`: \"+ Add row\",\na form, a group's \"+\", the picker's \"+ Create\". The id is text starting with\n`rec`, 19 letters and digits, and ids sort in the order they were made: the time,\nthen a count within the millisecond, then four random characters. Use it for records you add in code, so they can be linked like the\nothers.\n\nOn a database, a text id column must hold at least 19 characters: `varchar(19)` or\nwider, or `text`. Earlier versions made ids of 12 characters, so a column sized for those\n(`varchar(12)`, `varchar(16)`) refuses every record the base adds. The base then says \"Record\nids need 19 characters; this table's id column holds 16.\" and adds nothing. Widen the id\ncolumn, and the columns of other tables that hold its ids; the records already there keep\ntheir ids.\n\n```ts\nimport { blankTable, newRecordId, type BaseTable } from '@svgrid/enterprise/base'\n\nfunction addAccount(list: BaseTable[], name: string): BaseTable[] {\n return list.map((t) => (t.id === 'accounts' ? { ...t, data: [...t.data, { id: newRecordId(), name, deals: [] }] } : t))\n}\n\n// A new table as \"Add table\" makes one: Name, Notes and Status, three empty\n// records with ids, a grid view, and an id made from the name (\"meetings\").\nfunction addMeetings(list: BaseTable[]): BaseTable[] {\n return [...list, blankTable(list, 'Meetings')]\n}\n```\n\nIf your records already carry a key under another name, set `getRowId` on\nthe table, for example `getRowId: (row) => String(row.uuid)`. Links store\nwhatever it returns.\n\n## Pitfalls\n\n- **Loaded data is not repaired.** The base does not reconcile the two\n sides of a link when it mounts. It warns once in the console instead:\n \"The two sides of the link ... disagree in the loaded data\". The mismatch\n stays until the next change that syncs that link: a link edit, or a\n record added to or deleted from one of its tables. The base then rebuilds\n the other side from the table where the change was made. It does not fix\n the data on load because that would be a write nobody made:\n `onTablesChange` would fire, a table with a `source` would save to the\n database, and automations would run on records the app just loaded. It\n also cannot tell which side is right. Fix the data at its source, or sync\n it yourself before you pass it in.\n- **A missing field back means no syncing.** `inverse` must name a link field\n that exists in the other table. If it names nothing, links on one side\n never reach the other. SvBase warns once in the console, naming the link\n field and the missing one. Fields made in the field editor get both sides\n automatically; fields declared in code do not.\n- **Table ids are global.** Every table of a base is registered under its\n `id`, the same registry `registerLinkedTable` writes to. When two\n registrations share an id (a base and your app, or two bases on one page),\n link fields on the whole page see only the newest one. The older one is\n not lost: when the newer base unmounts or deletes that table, the older\n one shows again. Give every table on a page its own id.\n- **A record without an id cannot be linked.** Records you load need an `id`\n or a `getRowId` that returns one. The base gives an id only to the records\n it adds itself (see [Record ids](#record-ids)).\n\n## Next\n\n- [Formulas](./formulas.md): the formula language, and formulas over\n rollups and counts.\n- [Views](./views.md): saved filters, groups, Kanban and calendar views of\n the same records.\n- [Forms](./forms.md): a form view whose link fields open the same picker.\n- [Keep a base in a database](./data.md): links as foreign keys and junction\n tables.\n- [Automations](./automations.md): create a record in another table and\n link it back.\n- [Field types](../fields.md#tables-and-links): the reference for tables and\n links.\n"
|
|
5230
|
+
"markdown": "# Link tables: lookups, rollups and counts\n\nA base holds several tables, and a link field relates their records: a deal\nnames its account, the account lists its deals. Lookups, rollups and counts\nthen read through the link, so an account can show the value of its pipeline\nwithout anyone typing it. This page builds a small sales CRM with Accounts,\nContacts and Deals, one step at a time.\n\n\n\n<div data-docs-demo=\"512-base-sales-crm\" data-height=\"680\"></div>\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\nThe demo above is the finished CRM. Step 1 is a complete page; the later\nsteps add a table and fields to it.\n\n## 1. Two tables and a link\n\nGive `SvBase` a list of tables instead of `data` and `columns`. Each table\nhas an `id`, its records, its fields and its views. A link field names the\ntable it points at in `fieldProps.table`, and the field there that links back\nin `fieldProps.inverse`.\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, type BaseTable } from '@svgrid/enterprise/base'\n\n enableBase()\n\n const STAGES = [\n { value: 'Lead', color: '#94a3b8' },\n { value: 'Qualified', color: '#18bfff' },\n { value: 'Proposal', color: '#2d7ff9' },\n { value: 'Won', color: '#20c933' },\n { value: 'Lost', color: '#f82b60' },\n ]\n const INDUSTRIES = [\n { value: 'Wholesale', color: '#ff6f2c' },\n { value: 'Manufacturing', color: '#2d7ff9' },\n { value: 'Healthcare', color: '#20c933' },\n ]\n\n const deals = [\n { id: 'd1', deal: 'Northwind: Platform license', account: ['a1'], stage: 'Proposal', value: 48000 },\n { id: 'd2', deal: 'Contoso: Pilot', account: ['a2'], stage: 'Qualified', value: 12000 },\n { id: 'd3', deal: 'Northwind: Renewal', account: ['a1'], stage: 'Won', value: 30000 },\n ]\n const accounts = [\n { id: 'a1', name: 'Northwind Traders', industry: 'Wholesale', deals: ['d1', 'd3'] },\n { id: 'a2', name: 'Contoso', industry: 'Manufacturing', deals: ['d2'] },\n { id: 'a3', name: 'Litware', industry: 'Healthcare', deals: [] },\n ]\n\n let tables = $state.raw<BaseTable[]>([\n {\n id: 'deals',\n name: 'Deals',\n primaryField: 'deal',\n data: deals,\n columns: [\n { field: 'deal', header: 'Deal', width: 260, fieldType: 'text' },\n { field: 'account', header: 'Account', width: 180, fieldType: 'link', fieldProps: { table: 'accounts', multiple: false, inverse: 'deals' } },\n { field: 'stage', header: 'Stage', fieldType: 'singleSelect', fieldProps: { options: STAGES } },\n { field: 'value', header: 'Value', fieldType: 'number', fieldProps: { format: 'currency', symbol: '$', precision: 0 } },\n ],\n views: [{ id: 'all', name: 'All deals', type: 'grid' }],\n },\n {\n id: 'accounts',\n name: 'Accounts',\n primaryField: 'name',\n data: accounts,\n columns: [\n { field: 'name', header: 'Account', width: 220, fieldType: 'text' },\n { field: 'industry', header: 'Industry', fieldType: 'singleSelect', fieldProps: { options: INDUSTRIES } },\n { field: 'deals', header: 'Deals', width: 260, fieldType: 'link', fieldProps: { table: 'deals', multiple: true, inverse: 'account' } },\n ],\n views: [{ id: 'all', name: 'All accounts', type: 'grid' }],\n },\n ])\n\n function save(next: BaseTable[]) {\n // Every change to records, fields, views or tables lands here.\n console.log(next)\n }\n</script>\n\n<SvBase bind:tables editable sortable expandRows columnAdder fieldMenu\n containerHeight={600} onTablesChange={save} />\n```\n\nOn screen there are two tabs, Deals and Accounts. The Account column shows\none chip per linked record, with the account's name (its primary field). On\nthe Accounts tab, Northwind Traders shows two chips in Deals.\n\nWhat the link needs:\n\n- **Record ids.** A link stores ids, so every record needs an `id` (or the\n table needs a `getRowId`).\n- **Both sides declared.** `account.inverse` names the `deals` field of\n Accounts, and `deals.inverse` names `account`. The `inverse` value is the\n other field's `id`, or its `field` when it has no `id`.\n- **Both sides agree in the data you load.** The base keeps the two in step\n from the first change on, but it does not rewrite loaded data, so\n `accounts[0].deals` has to list `d1` and `d3` because those deals name\n `a1`. A mismatch is reported in the console when SvBase mounts (see\n [Pitfalls](#pitfalls)).\n\n`multiple: false` lets a deal pick one account. Leave it out and the field\nlinks many records; that is the type's default.\n\n## 2. Pick linked records\n\nSelect an Account cell and press Enter, or double-click it. A dialog titled\n\"Link to Accounts\" lists the accounts by name under a \"Search Accounts\" box.\nClick a row to tick it; in a single link a click on another row moves the\ntick, and a click on the ticked row clears it. The footer counts what is\nticked (\"1 linked\"). Done writes the ids, Cancel or Escape leaves the cell\nas it was. Typing on a selected link cell does not open the dialog.\n\nSearch matches the primary field and the linked table's text fields (text,\nlong text, email, URL, phone and the selects), anywhere in the value. A\nrecord found by another field shows where, for example \"Email:\nmaya@northwind.example.com\". The list shows the first 200 matches; when more\nmatch, a line under it says how many (\"Showing 200 of 1,240. Type to\nnarrow.\"). When no account is named exactly what you typed, the list ends\nwith + Create \"Initech\": it adds an account called Initech to the Accounts\ntable, with a new id, and ticks it. The account is added at once; Cancel\nleaves the link as it was but does not take the account back.\n\nEnter in the search box takes the row that is lit, which is the first match, or\n+ Create when nothing matches: typed text and Enter makes the record. On a table a\nserver searches, Enter waits for the answer to what was typed.\n\nCopy and paste work on names. Ctrl+C on a link cell copies \"Northwind\nTraders\", not `a1`. Pasting text into a link cell splits it at commas and\nlinks each part that matches a record's name or id, ignoring case; parts that\nmatch nothing are left out and the page says so, and a single link keeps the\nfirst match. With no part matching, the cell keeps the links it has.\n\nA name with a comma or a double quote is copied in quotes, CSV style:\n`\"Acme, Inc.\", Contoso`, with an inner quote doubled (`\"The \"\"Big\"\" Shop\"`).\nThe paste reads a quoted part as one name, so the copy pastes back to the\nsame records. A user field with several people copies and pastes its names\nthe same way. A copy on the same page keeps the very records when two share a\nname. A file's column can go to a link field too: it is read the same way, and\nthe import says how many names it could not find.\n\nPick Litware for \"Contoso: Pilot\", press Done, and switch to Accounts:\nContoso no longer lists the pilot and Litware does. The base rewrites the\nother side after every link edit, from either side. Link a deal from an\naccount's Deals cell and the deal's Account cell changes; because a deal has\none account, the account that listed it before lets go of it. Records\ndeleted on one side drop out of the links on the other. A record added with\n\"+ Add row\", a form or a group's \"+\" is linked on both sides as soon as it\nexists.\n\nAutomations hear these changes too: linking a deal from Accounts counts as a\nchange to the deal's Account field. See [Automations](./automations.md#when).\n\n### Pick only from a view\n\n\"Pick records from\" in the link field's settings names a view of the linked\ntable: the picker then lists only the records that view's filter keeps, and\nsays which view (\"Records of the view \"Active clients\"\"). In code it is the\nfield's `pickFrom`, a view id:\n\n```ts\n{ id: 'client', field: 'client', header: 'Client', fieldType: 'link', fieldProps: { table: 'clients', multiple: false, pickFrom: 'active' } }\n```\n\nA table read from a server searches with the view's filter\n(`filterModel.expression`); a source that cannot apply it answers as before\nand the picker keeps that page to the view itself. A link written another\nway (a paste, the API, an automation) is not held to the view, as in\nAirtable. `baseFromAirtable` brings Airtable's \"Limit record selection to a\nview\" over as `pickFrom`; Airtable's API does not say a view's filter, so\nset it again on the imported view.\n\n## 3. Open and preview a linked record\n\nRest the pointer on a chip for a moment and a card opens under it: the\nrecord's name, its table, and the first four of its other fields that have a\nvalue, written as their cells write them. Empty fields are skipped and do not\ncount toward the four. Move onto the card to\nread it; it closes when the pointer leaves. Touch input skips the preview.\n\nSelect the cell and click a chip to open the record in a dialog. It shows every field of the\nlinked record with the field's icon and name, drawn the way its cells draw\nthem: a select as its pill, a link as chips. The record is read here, not\nedited. A chip inside it opens that record over this one, so you can walk\nfrom a deal to its account to the account's other deals.\n\nFor a table of the same base the dialog has \"Open in Accounts\" next to\nClose. It closes every open linked record, switches to the Accounts tab and\nexpands the record there, where it can be edited. If the record was deleted\nin the meantime, the dialog says \"This record is not in its table any\nmore.\"\n\n## 4. Add a third table\n\nContacts link to an account and to their deals. Add the table and one link\nfield on each side of each pair.\n\n```ts\nconst contacts = [\n { id: 'c1', name: 'Maya Lindqvist', title: 'Head of Operations', email: 'maya@northwind.example.com', account: ['a1'], deals: ['d1'] },\n { id: 'c2', name: 'Priya Raman', title: 'CFO', email: 'priya@contoso.example.com', account: ['a2'], deals: ['d2'] },\n]\n\nconst contactsTable: BaseTable = {\n id: 'contacts',\n name: 'Contacts',\n primaryField: 'name',\n data: contacts,\n columns: [\n { field: 'name', header: 'Name', width: 190, fieldType: 'text' },\n { field: 'title', header: 'Title', fieldType: 'text' },\n { field: 'email', header: 'Email', width: 240, fieldType: 'email' },\n { field: 'account', header: 'Account', fieldType: 'link', fieldProps: { table: 'accounts', multiple: false, inverse: 'contacts' } },\n { field: 'deals', header: 'Deals', fieldType: 'link', fieldProps: { table: 'deals', multiple: true, inverse: 'contact' } },\n ],\n}\n```\n\nThen the new fields in the other two tables, each naming its partner:\n\n```ts\n// In Deals' columns, with contact: ['c1'] on d1 and ['c2'] on d2\nconst contact = { field: 'contact', header: 'Contact', fieldType: 'link', fieldProps: { table: 'contacts', multiple: false, inverse: 'deals' } }\n// In Accounts' columns, with contacts: ['c1'] on a1 and ['c2'] on a2\nconst accountContacts = { field: 'contacts', header: 'Contacts', fieldType: 'link', fieldProps: { table: 'contacts', multiple: true, inverse: 'account' } }\n```\n\nTwo fields in different tables can share a name (Deals and Contacts both\nhave `account`); `inverse` names a field of the table the link points at.\n\nYou can build the same links without code. On the Contacts tab press \"+\" at\nthe end of the header, pick \"Link to records\" and choose Accounts under\nTable. Accounts gets a field back at once, a link to many named after the\ntable it comes from (\"Contacts\", or \"Contacts 2\" when that name is taken),\nand both fields name each other in `inverse`.\n\n## 5. Show a field of the linked record: lookups\n\nA lookup shows a field of the records a link field points at. On Deals,\nshow the account's industry and the contact's email:\n\n```ts\nconst accountIndustry = { field: 'accountIndustry', header: 'Industry', fieldType: 'lookup', fieldProps: { linkField: 'account', field: 'industry' } }\nconst contactEmail = { field: 'contactEmail', header: 'Contact email', width: 240, fieldType: 'lookup', fieldProps: { linkField: 'contact', field: 'email' } }\n```\n\n`linkField` is the link field of this table; `field` is a field of the linked\ntable. The lookup's value is a list, one entry per linked record, and the\ncell writes it as text joined with commas, each value the way its own field\nwrites it: an amount with its symbol, a date in its format. \"Manufacturing\"\nshows as text, not as the colored pill, and the email is not a mailto link.\n\nA lookup is read-only and is never stored in the records. When the linked\nfield is itself computed (a formula, a rollup, another lookup), the lookup\nworks it out. In the field editor, pick the link under \"Link field\" and the\nfield under \"Field in the linked table\".\n\n## 6. Sum and count the linked records: rollups and counts\n\nA rollup reduces one field over the linked records to a single value. A count\nsays how many records a link points at. On Accounts:\n\n```ts\nconst pipeline = { field: 'pipeline', header: 'Pipeline value', width: 160, fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'SUM' } }\nconst largest = { field: 'largest', header: 'Largest deal', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'MAX' } }\nconst stages = { field: 'stages', header: 'Stages', width: 200, fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'stage', aggregation: 'ARRAYUNIQUE' } }\nconst dealCount = { field: 'dealCount', header: 'Deal count', fieldType: 'count', fieldProps: { linkField: 'deals' } }\n```\n\nNorthwind Traders shows \"$78,000\", \"$48,000\", \"Proposal, Won\" and 2. Edit a\ndeal's value on the Deals tab and the account's numbers follow.\n\n| `aggregation` | Result |\n|---|---|\n| `SUM` | The total; values that are not numbers count as 0. The default |\n| `AVERAGE`, `MIN`, `MAX` | Over the values that read as numbers; empty when there are none |\n| `COUNT` | How many values are numbers |\n| `COUNTA` | How many values are not empty |\n| `COUNTALL` | How many linked records, empty values included |\n| `ARRAYJOIN` | The non-empty values as text, joined with \", \" |\n| `ARRAYUNIQUE` | The same, each value once |\n| `CONCATENATE` | Every value as text, joined with nothing between |\n| `AND`, `OR` | Whether every value, or any value, is truthy |\n\nA `SUM`, `AVERAGE`, `MIN` or `MAX` writes its result the way the linked field\nwrites its values, so a sum of dollar amounts shows \"$78,000\". Set\n`precision` (0 to 8) on the rollup and it keeps the symbol at that many\ndecimals: \"$78,000.00\". A rollup with one of these four or with `COUNT`, `COUNTA`\nor `COUNTALL` is a number column: it right-aligns, and its footer offers Sum,\nAverage and the other number summaries (step 7).\n\nA count field takes only `linkField` and is the number of linked records\nthat exist. That differs from a `COUNT` rollup, which counts the linked\nrecords whose field holds a number.\n\nRollups, lookups and counts are read-only. The [field types\ntable](../fields.md#declare-columns-by-type) lists their `fieldProps` with\nevery other type's.\n\n## 7. Formulas and footers over linked values\n\nA formula can name a rollup or a count like any other field, by its header\nin braces. The formula works the computed field out when it reads it. On\nAccounts, the average deal size:\n\n```ts\nconst avgDeal = {\n field: 'avgDeal',\n header: 'Average deal',\n fieldType: 'formula',\n fieldProps: { formula: 'IF({Deal count} > 0, {Pipeline value} / {Deal count}, 0)', result: 'currency', symbol: '$', precision: 0 },\n}\n```\n\nThe other direction works too: a rollup can add up a formula of the linked\ntable. Give Deals a probability and a weighted value, then sum the weighted\nvalue per account:\n\n```ts\n// In Deals' columns, with probability: 0.5 on d1, 0.25 on d2, 1 on d3\nconst probability = { field: 'probability', header: 'Probability', fieldType: 'number', fieldProps: { format: 'percent', precision: 0 } }\nconst weighted = { field: 'weighted', header: 'Weighted', fieldType: 'formula', fieldProps: { formula: '{Value} * {Probability}', result: 'currency', symbol: '$', precision: 0 } }\n\n// In Accounts' columns\nconst forecast = { field: 'forecast', header: 'Forecast', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'weighted', aggregation: 'SUM' } }\n```\n\nNorthwind's forecast is $54,000: $24,000 from the proposal and $30,000 from\nthe renewal. The OKR base does the same with an `AVERAGE` of each key\nresult's progress formula:\n\n<div data-docs-demo=\"522-base-okrs\" data-height=\"620\"></div>\n\nWith the `summary` prop on `SvBase`, every field gets a footer cell. Click\nthe Pipeline value footer and pick Sum, or set the choice in\n`fieldProps.summary`: the footer adds up the rollup's values over the shown\nrecords and writes the total the way the rollup writes it (\"Sum $90,000\").\nA count's footer offers the same choices.\n\n```ts\nconst pipelineWithTotal = { field: 'pipeline', header: 'Pipeline value', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'SUM', summary: 'sum' } }\n```\n\n\n\n[Summaries at the bottom](../fields.md#summaries-at-the-bottom) lists every\nsummary.\n\n## 8. Filter and group by a link\n\nThe view bar's Filter compares a link by the linked records' names: contains,\ndoes not contain, is, is not, is empty and is not empty. \"Account is\nContoso\" keeps the deals linked to Contoso. Counts filter as numbers, and so\ndo rollups that are numbers (`SUM`, `AVERAGE`, `MIN`, `MAX`, `COUNT`,\n`COUNTA`, `COUNTALL`). An `ARRAYJOIN`, `ARRAYUNIQUE` or `CONCATENATE` rollup\nfilters as text, an `AND` or `OR` rollup as a checkbox (is checked or\nunchecked). Lookups filter as text.\n\nGrouping by a link field puts the records linked to the same records in one\ngroup. The group's header shows the link as chips, the record count and the\nsummaries the fields picked. Its \"+\" adds a deal already linked to that\naccount, and the account lists the new deal at once.\n\nBoth can be saved in a view:\n\n```ts\nimport type { FieldView } from '@svgrid/enterprise/base'\n\nconst dealViews: FieldView[] = [\n { id: 'all', name: 'All deals', type: 'grid' },\n { id: 'by-account', name: 'By account', type: 'grid', state: { grouping: ['account'], sorting: [{ id: 'value', desc: true }] } },\n {\n id: 'contoso',\n name: 'Contoso deals',\n type: 'grid',\n state: {\n advancedFilter: {\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [{ column: 'account', kind: 'link', op: 'is', value: 'Contoso', table: 'accounts' }],\n },\n },\n },\n]\n```\n\nA link condition needs `table`, the linked table's id: that is how it turns\nids into names. The Filter panel fills it in; in code, write it yourself.\nWithout it the condition compares the ids as text.\n\n## 9. Link to a table outside the base\n\nA link field can point at a table your app owns and the base does not show:\na product catalog from your API, a list of regions. Register it with\n`registerLinkedTable`:\n\n```ts\nimport { registerLinkedTable } from '@svgrid/enterprise/base'\n\nlet products = [\n { sku: 'PLT-1', name: 'Platform license', price: 24000 },\n { sku: 'TEAM-1', name: 'Team plan', price: 6000 },\n { sku: 'SUP-1', name: 'Premium support', price: 4800 },\n]\n\nregisterLinkedTable({\n id: 'products',\n name: 'Products',\n primaryField: 'name',\n getRowId: (row) => String(row.sku),\n // A function is read every time, so the list can change.\n rows: () => products,\n fields: [\n { field: 'name', header: 'Product' },\n { field: 'price', header: 'List price', fieldType: 'number', fieldProps: { format: 'currency', symbol: '$', precision: 0 } },\n ],\n})\n```\n\nDeals then link to it and roll it up like any table of the base:\n\n```ts\n// In Deals' columns, with products: ['PLT-1', 'SUP-1'] on d1\nconst dealProducts = { field: 'products', header: 'Products', width: 220, fieldType: 'link', fieldProps: { table: 'products', multiple: true } }\nconst listPrice = { field: 'listPrice', header: 'List price', fieldType: 'rollup', fieldProps: { linkField: 'products', field: 'price', aggregation: 'SUM' } }\n```\n\nWhat differs from a table of the base:\n\n- There is no field back and no `inverse`: the catalog is yours, and the\n base never writes to it.\n- The picker offers \"+ Create\" only when the table has a `create(name)` that\n adds the record and returns it with its id.\n- The linked record dialog has \"Open in Products\" only when the table has an\n `open(rowId)` that shows the record somewhere in your app.\n- `fields` is what the field editor offers a lookup or rollup under \"Field\n in the linked table\", and its types decide how a lookup, a rollup, the\n preview and the record dialog write each value (\"$24,000\", not 24000).\n Without `fields` the editor offers only the primary field and the dialog\n shows every key of the record. A lookup or rollup declared in code can\n read any key either way. The picker's search reads the text fields in\n `fields`, or every text value of the record without them.\n\nThe table appears under Table in the field editor of every link field on the\npage. `unregisterLinkedTable('products')` removes it, and so does calling the\nfunction `registerLinkedTable` returns.\n\n## How links are stored\n\nA link field's value is an array of record ids, in the order they were\npicked. A single link is an array of one. Here is \"Northwind: Platform\nlicense\" and its account, as `onTablesChange` hands them over after steps 1\nto 9:\n\n```json\n{\n \"id\": \"d1\",\n \"deal\": \"Northwind: Platform license\",\n \"account\": [\"a1\"],\n \"contact\": [\"c1\"],\n \"products\": [\"PLT-1\", \"SUP-1\"],\n \"stage\": \"Proposal\",\n \"value\": 48000,\n \"probability\": 0.5\n}\n```\n\n```json\n{\n \"id\": \"a1\",\n \"name\": \"Northwind Traders\",\n \"industry\": \"Wholesale\",\n \"deals\": [\"d1\", \"d3\"],\n \"contacts\": [\"c1\"]\n}\n```\n\nLookups, rollups, counts and formulas are not in the records. They are\nworked out from the links each time they are drawn, so there is nothing to\nkeep in step. An id that names no record is skipped when the cell draws.\n\nIn a database, a link to one record is usually a foreign key column and a\nlink to many a junction table, and the field back is not stored at all. See\n[Keep a base in a database](./data.md#link-fields).\n\n## Change or delete a link field\n\n- **Point it at another table.** Change Table in the field editor. The field\n back is removed from the old table, values included; the link's own\n values are cleared (they were ids of the old table), and the new table\n gets a field back.\n- **Turn it into another type.** The field back goes, and the values become\n the linked records' names. A link turned into text holds \"Northwind\n Traders, Contoso\". A multiple select gets every name, a single select the\n first, and the select's options are made from those names. A cell that\n held several records keeps only one name in a single select, so the field\n editor counts it in its warning (\"2 cells will be cleared or cut\n short.\").\n- **Turn text, a select or a lookup into a link.** Each name becomes the\n record of the new table with that name or id, ignoring case, as a paste\n does. Text splits at commas; a quoted part is one name (`\"Acme, Inc.\"`).\n Names that match no record are dropped. The field editor counts the cells\n that end up empty or lose a name before it applies (\"3 cells will be\n cleared or cut short.\").\n- **Make it single.** Untick \"Allow linking to multiple records\" in the\n field editor (`multiple: false`) on a link that holds several ids: each\n record keeps the first one, and the field back drops the rest.\n- **Delete it.** With `fieldMenu`, Delete field on a link that has a field\n back, or that lookups, rollups or counts read, asks first. The dialog\n names the field back (\"Account links to Accounts. The field there that\n links back, Deals, is deleted with it. The links between the records go\n too.\") and lists the lookups, rollups and counts on either side that read\n it, the other table's in brackets (\"These fields read it and are deleted\n too: Industry, Pipeline value (Accounts), ...\"). They are deleted with the\n link.\n- **Duplicate it.** The copy gets its own field back in the other table.\n- **Delete a table.** Delete table in the tab's menu asks first: the\n table's records and views go, and so do the link fields of other tables\n that point at it (\"Deals: Account\") and the lookups, rollups and counts\n that read them (\"Deals: Industry (reads Account)\"), values included. A\n base keeps at least one table.\n- **Duplicate a table.** The copy's link fields point at the same records,\n each with a new field back in the other table.\n\n## Record ids\n\nRecords added through the base get an id from `newRecordId()`: \"+ Add row\",\na form, a group's \"+\", the picker's \"+ Create\". The id is text starting with\n`rec`, 19 letters and digits, and ids sort in the order they were made: the time,\nthen a count within the millisecond, then four random characters. Use it for records you add in code, so they can be linked like the\nothers.\n\nOn a database, a text id column must hold at least 19 characters: `varchar(19)` or\nwider, or `text`. Earlier versions made ids of 12 characters, so a column sized for those\n(`varchar(12)`, `varchar(16)`) refuses every record the base adds. The base then says \"Record\nids need 19 characters; this table's id column holds 16.\" and adds nothing. Widen the id\ncolumn, and the columns of other tables that hold its ids; the records already there keep\ntheir ids.\n\n```ts\nimport { blankTable, newRecordId, type BaseTable } from '@svgrid/enterprise/base'\n\nfunction addAccount(list: BaseTable[], name: string): BaseTable[] {\n return list.map((t) => (t.id === 'accounts' ? { ...t, data: [...t.data, { id: newRecordId(), name, deals: [] }] } : t))\n}\n\n// A new table as \"Add table\" makes one: Name, Notes and Status, three empty\n// records with ids, a grid view, and an id made from the name (\"meetings\").\nfunction addMeetings(list: BaseTable[]): BaseTable[] {\n return [...list, blankTable(list, 'Meetings')]\n}\n```\n\nIf your records already carry a key under another name, set `getRowId` on\nthe table, for example `getRowId: (row) => String(row.uuid)`. Links store\nwhatever it returns.\n\n## Pitfalls\n\n- **Loaded data is not repaired.** The base does not reconcile the two\n sides of a link when it mounts. It warns once in the console instead:\n \"The two sides of the link ... disagree in the loaded data\". The mismatch\n stays until the next change that syncs that link: a link edit, or a\n record added to or deleted from one of its tables. The base then rebuilds\n the other side from the table where the change was made. It does not fix\n the data on load because that would be a write nobody made:\n `onTablesChange` would fire, a table with a `source` would save to the\n database, and automations would run on records the app just loaded. It\n also cannot tell which side is right. Fix the data at its source, or sync\n it yourself before you pass it in.\n- **A missing field back means no syncing.** `inverse` must name a link field\n that exists in the other table. If it names nothing, links on one side\n never reach the other. SvBase warns once in the console, naming the link\n field and the missing one. Fields made in the field editor get both sides\n automatically; fields declared in code do not.\n- **Table ids are global.** Every table of a base is registered under its\n `id`, the same registry `registerLinkedTable` writes to. When two\n registrations share an id (a base and your app, or two bases on one page),\n link fields on the whole page see only the newest one. The older one is\n not lost: when the newer base unmounts or deletes that table, the older\n one shows again. Give every table on a page its own id.\n- **A record without an id cannot be linked.** Records you load need an `id`\n or a `getRowId` that returns one. The base gives an id only to the records\n it adds itself (see [Record ids](#record-ids)).\n\n## Next\n\n- [Formulas](./formulas.md): the formula language, and formulas over\n rollups and counts.\n- [Views](./views.md): saved filters, groups, Kanban and calendar views of\n the same records.\n- [Forms](./forms.md): a form view whose link fields open the same picker.\n- [Keep a base in a database](./data.md): links as foreign keys and junction\n tables.\n- [Automations](./automations.md): create a record in another table and\n link it back.\n- [Field types](../fields.md#tables-and-links): the reference for tables and\n links.\n"
|
|
5231
5231
|
},
|
|
5232
5232
|
{
|
|
5233
5233
|
"slug": "help/base/permissions",
|
|
@@ -5304,14 +5304,14 @@ export const docs = [
|
|
|
5304
5304
|
"path": "docs/help/base/views.md",
|
|
5305
5305
|
"title": "Views for every team",
|
|
5306
5306
|
"section": "SvGrid Base",
|
|
5307
|
-
"markdown": "# Views for every team\n\nOne table of records, many ways to look at it. Product reads the roadmap\ngrouped by quarter, engineering works off a status board, the leads check a\ntimeline, and anyone in the company files a request through a form. Each of\nthose is a saved view: a name, a type, and the filter, sorts, groups, hidden\nfields, row height and colors it had when someone last left it.\n\n\n\n<div data-docs-demo=\"513-base-product-roadmap\" data-height=\"680\"></div>\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\nThis page builds the Features table of that roadmap one view at a time. Each\nstep adds to the `views` list from the step before and works on its own.\n\n## 1. The table\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, setFieldUsers, type FieldView } from '@svgrid/enterprise/base'\n\n enableBase()\n setFieldUsers([\n { id: 'u1', name: 'Ana Ruiz' },\n { id: 'u2', name: 'Ben Okafor' },\n { id: 'u3', name: 'Cleo Park' },\n ])\n\n type Feature = {\n id: number; feature: string; quarter: string; status: string; teams: string[]\n lead: string; impact: number; effort: number; start: string; target: string; votes: number\n }\n\n const QUARTERS = [\n { value: 'Q4 2026', color: '#2d7ff9' },\n { value: 'Q1 2027', color: '#18bfff' },\n { value: 'Later', color: '#94a3b8' },\n ]\n const STATUS = [\n { value: 'Planned', color: '#94a3b8' },\n { value: 'In progress', color: '#2d7ff9' },\n { value: 'In beta', color: '#8b46ff' },\n { value: 'Shipped', color: '#20c933' },\n { value: 'Blocked', color: '#f82b60' },\n ]\n const TEAMS = [\n { value: 'Web', color: '#2d7ff9' },\n { value: 'Mobile', color: '#ff6f2c' },\n { value: 'Platform', color: '#8b46ff' },\n ]\n\n let rows = $state.raw<Feature[]>([\n { id: 1, feature: 'Single sign-on with SAML', quarter: 'Q4 2026', status: 'In progress', teams: ['Platform'], lead: 'u2', impact: 5, effort: 12, start: '2026-10-05', target: '2026-11-13', votes: 182 },\n { id: 2, feature: 'Offline mode for the mobile app', quarter: 'Q4 2026', status: 'Blocked', teams: ['Mobile'], lead: 'u3', impact: 4, effort: 13, start: '2026-10-12', target: '2026-12-04', votes: 96 },\n { id: 3, feature: 'Dark mode', quarter: 'Q4 2026', status: 'Shipped', teams: ['Web'], lead: 'u1', impact: 2, effort: 4, start: '2026-10-01', target: '2026-10-16', votes: 154 },\n { id: 4, feature: 'Audit log export', quarter: 'Q1 2027', status: 'Planned', teams: ['Platform', 'Web'], lead: 'u1', impact: 3, effort: 5, start: '2027-01-11', target: '2027-01-29', votes: 41 },\n ])\n\n const columns = [\n { field: 'feature', header: 'Feature', width: 260, fieldType: 'text' },\n { field: 'quarter', header: 'Quarter', fieldType: 'singleSelect', fieldProps: { options: QUARTERS } },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: STATUS } },\n { field: 'teams', header: 'Teams', fieldType: 'multiSelect', fieldProps: { options: TEAMS } },\n { field: 'lead', header: 'Lead', fieldType: 'user' },\n { field: 'impact', header: 'Impact', fieldType: 'rating', fieldProps: { max: 5 } },\n { field: 'effort', header: 'Effort (days)', fieldType: 'number', fieldProps: { format: 'integer', summary: 'sum' } },\n { field: 'start', header: 'Start', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'target', header: 'Target', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'votes', header: 'Votes', fieldType: 'number', fieldProps: { format: 'integer', summary: 'sum' } },\n ]\n\n let views = $state<FieldView[]>([{ id: 'all', name: 'All features', type: 'grid' }])\n</script>\n\n<SvBase data={rows} {columns} bind:views primaryField=\"feature\"\n editable sortable showRowNumbers expandRows summary containerHeight={640}\n rowAdder={{ label: 'Add feature', defaults: () => ({ id: Date.now(), status: 'Planned', quarter: 'Later', teams: [] }) }} />\n```\n\nThe view bar over the grid has \"All features\" on the left, then Hide\nfields, Filter, Group, Sort, Color and a row height button, and \"4 records\"\nwith a search button on the right. The footer row shows \"Sum 34\" under Effort\nand \"Sum 473\" under Votes, because those fields set `fieldProps.summary`.\n\nEvery view key that names a field (`stackBy`, `dateField`, a filter\ncondition's `column`, a chart's `x`) takes the column id. A column without an\n`id` uses its `field`, so in this table the two are the same.\n\n## 2. A roadmap grouped by quarter\n\nA view can start with settings. `state` is the grid's own state, the same\nobject `api.getState()` returns; `color` says how rows are colored.\n\n```ts\nconst roadmap: FieldView = {\n id: 'roadmap',\n name: 'Roadmap by quarter',\n type: 'grid',\n color: { mode: 'field', field: 'status' },\n rowHeight: 56,\n state: {\n grouping: ['quarter'],\n sorting: [{ id: 'quarter', desc: false }, { id: 'impact', desc: true }],\n hiddenColumns: ['lead'],\n },\n}\n```\n\nGroups and sorts share the grid's `sorting` list: a grouped field's\ndirection is an entry ahead of the sorts. The view bar writes them that way,\nso write them that way too. Here the bar reads \"1 hidden field\", \"Grouped by\n1 field\" and \"Sorted by 1 field\": the `quarter` entry belongs to the group,\nnot to Sort.\n\nEach group header shows \"Quarter\" over the option's pill, the number of\nrecords, the summaries the fields picked for that group (\"Effort (days) 29\",\n\"Votes 432\"), and \"+\" to add a feature that already has that quarter. Groups\ncome in the select's option order, not alphabetically. Group rows are at\nleast 52px tall so the field's name fits over the value; with\n`rowHeight: 56` they match the records. Each row has a status color stripe\non its row header. 56 is the row height menu's \"Medium\": from 48px, text and\nselect pills wrap.\n\n## 3. A view that starts filtered\n\nThe filter is the grid's advanced filter with its own kind, `fieldFilter`.\nPut it in `state.advancedFilter`:\n\n```ts\nimport { describeFieldFilter, type FieldFilter } from '@svgrid/enterprise/base'\n\nconst activeWork: FieldFilter = {\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [\n { column: 'status', kind: 'select', op: 'isAnyOf', value: ['In progress', 'In beta', 'Blocked'] },\n {\n conjunction: 'or',\n conditions: [\n { column: 'target', kind: 'date', op: 'isWithin', value: { span: 'nextDays', days: 30 } },\n { column: 'impact', kind: 'number', op: 'gte', value: 4 },\n ],\n },\n ],\n}\n\nconst now: FieldView = {\n id: 'now',\n name: 'Now',\n type: 'grid',\n state: { sorting: [{ id: 'target', desc: false }], advancedFilter: activeWork },\n}\n\nconst header = (id: string) => columns.find((c) => c.field === id)?.header ?? id\ndescribeFieldFilter(activeWork, header)\n// \"Status is any of In progress, In beta, Blocked and (Target is within the next 30 days or Impact ≥ 4)\"\n```\n\nThe Filter button reads \"Filtered by 3 fields\" (one field reads \"Filtered by\nStatus\") and the record count drops to what the filter keeps.\n`describeFieldFilter` writes a filter in the words the panel uses, for a page\nsubtitle or an audit line. It returns `\"every record\"` for a filter with no\ncomplete conditions.\n\nA condition is a field, an operator and a value; a group is one level deep.\n[Filters in code](#filters-in-code) below lists the operators per kind.\n\nOne view can serve every lead. `ME` (the string `'@me'`) in a person\ncondition stands for whoever `setCurrentUser` names when the filter runs; the\nFilter panel lists it as \"Me\", first among the people.\n\n```ts\nimport { ME, setCurrentUser } from '@svgrid/enterprise/base'\n\nsetCurrentUser({ id: 'u2', name: 'Ben Okafor' })\n\nconst mine: FieldView = {\n id: 'mine',\n name: 'My features',\n type: 'grid',\n state: {\n advancedFilter: {\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [{ column: 'lead', kind: 'select', op: 'is', value: ME }],\n },\n },\n}\n```\n\nBen sees \"Single sign-on with SAML\"; Ana, signed in, sees her two. With\nnobody signed in the condition matches no one. `describeFieldFilter` writes\nit as \"Lead is me\".\n\n## 4. A status board\n\n```ts\nconst board: FieldView = { id: 'board', name: 'Status board', type: 'kanban', stackBy: 'status' }\n```\n\n\n\n`stackBy` takes a single select or a user field that holds one person. You\nget one lane per option, in option order and color, plus \"Uncategorized\",\nwhich shows only while a record has no status. Stack by `lead` instead and\nthe lanes are the people from `setFieldUsers`.\n\nSort the view by a number field and a card dropped elsewhere in its lane takes\na number between its neighbours', so the order is the table's and lasts.\n\nDrop a card in another lane and the status changes through the grid's edit\npath, so undo, validation and `onCellValueChange` all see it. \"+ Add a card\"\nadds a record already in that lane, named by the primary field.\n\nA card shows the record's name, then the next three fields the view shows,\nin column order (the stacked field left out), each drawn as its cell draws\nit. Hide a field in Hide fields and it leaves the cards; drag it up there to\nput it on them. Cards are read, not edited: a rating shows its stars\nbut does not take a click. Double-click a card or press F2 to open the\nrecord. Right-click it for its menu: Expand record, Comment, and, when the\nbase is `editable`, Move to (a submenu of the lanes), Duplicate record and\nDelete record, which asks \"Delete record?\" first. A card with comments shows\ntheir count; click it to open the record at its comment box.\n\n## 5. A timeline\n\n```ts\nconst timeline: FieldView = {\n id: 'timeline',\n name: 'Timeline',\n type: 'gantt',\n dateField: 'start',\n endField: 'target',\n color: { mode: 'field', field: 'status' },\n}\n```\n\nEach feature is a bar from its start to its target date, beside a table of\nnames and dates. Drag a bar to move both dates; drag its edge to change the\ntarget. One drag is one Ctrl+Z. `type: 'calendar'` with the same fields shows\nthe features on a month instead: a date field without a time shows as all-day\nevents. The end of a bar or an event is exclusive, so the record keeps the last\nday: a feature dragged to cover the 19th to the 21st gets\n`target: '2026-10-21'`.\n\nWith only `dateField`, events move but cannot be resized. Pick a day (or a\nrange) on the calendar and a new record lands on it, opened with its name\nready to type. Colored by a single select, the events take the option colors\nand the options appear above the calendar as a legend that hides and shows\nthem.\n\nMoving and resizing need `editable` on the base. Without it the calendar is\nread-only.\n\n## 6. Effort by team\n\n```ts\nconst effort: FieldView = { id: 'effort', name: 'Effort by team', type: 'chart', chart: { kind: 'barH', x: 'teams', y: 'effort' } }\nconst mix: FieldView = { id: 'mix', name: 'Features per quarter', type: 'chart', chart: { kind: 'donut', x: 'quarter' } }\n```\n\nA chart groups the records the view shows by `x` and adds up `y` (or counts\nrecords when there is no `y`). `aggregation: 'avg'` averages instead of\nsumming. Kinds are `'bar'`, `'barH'`, `'line'`, `'pie'` and `'donut'`.\n\nHow `x` groups:\n\n- A single or multiple select keeps its options' order and colors. A\n multiple select counts a record in each of its options, so \"Audit log\n export\" adds 5 days to both Platform and Web.\n- A person or a linked record shows by name.\n- A date groups by month (\"Oct 2026\").\n- Records with no value go in an \"Empty\" bar, last.\n\nValues read as the summed field writes them, and a count as a whole number.\nThe series is labeled \"Sum of Effort (days)\", \"Average of ...\" or \"Records\".\nThe bar shows Filter, which narrows what is charted, and \"Customize chart\",\nwhose Type, Group by, Value and Combine (sum or average) are kept in `chart`.\nA chart view declared without `chart` draws \"Choose a field to chart in\nCustomize chart.\" until a field is picked there.\n\n## 7. A gallery of mockups\n\nAdd an attachment field, then a gallery view with it as the cover:\n\n```ts\nconst mockupField = { field: 'mockups', header: 'Mockups', fieldType: 'attachment' }\nconst gallery: FieldView = { id: 'mockups', name: 'Mockups', type: 'gallery', coverField: 'mockups' }\n```\n\nEach card shows the first image of `mockups`, the primary field as its title,\nthen the fields the grid shows, each drawn as its cell draws it. Hide a field\nin this view and it leaves the cards; drag fields in Hide fields to reorder\nthem. A click on a card opens the record. Without `coverField` the cards have\nno cover.\n\n## 8. A request form\n\n```ts\nconst request: FieldView = {\n id: 'request',\n name: 'Request a feature',\n type: 'form',\n formFields: ['feature', 'teams', 'impact'],\n formRequired: ['feature'],\n formTitle: 'Request a feature',\n formDescription: 'What should we build, and who is it for? Product reviews requests every Friday.',\n formSubmitLabel: 'Send request',\n}\n```\n\nThe form asks for the fields in `formFields` (column ids, in order), each with\nthe editor its cell uses. Without it, the form asks for every field a person\ncan fill in, the primary field first; computed fields are left out. A field\nin `formRequired` must be filled before the form sends. `formTitle` defaults\nto the view's name, `formSubmitLabel` to \"Submit\". A sent form adds a record\nthe way \"+ Add row\" does: `rowAdder.defaults` first, so a request starts as\nPlanned in Later, then what was typed, then `onRowAdd`. The bar shows only\nthe view switcher on a form.\n\nAll the views so far, in one list:\n\n```ts\nlet views = $state<FieldView[]>([roadmap, board, timeline, effort, now, mine, gallery, request])\n```\n\n## 9. A dashboard\n\n```ts\nconst OPEN: FieldFilter = { kind: 'fieldFilter', conjunction: 'and', conditions: [{ column: 'status', kind: 'select', op: 'isNot', value: 'Shipped' }] }\nconst SHIPPED: FieldFilter = { kind: 'fieldFilter', conjunction: 'and', conditions: [{ column: 'status', kind: 'select', op: 'is', value: 'Shipped' }] }\n\nconst overview: FieldView = {\n id: 'overview',\n name: 'Overview',\n type: 'dashboard',\n dashboard: [\n { id: 'open', kind: 'number', title: 'Open features', filter: OPEN },\n { id: 'days', kind: 'number', title: 'Days of work left', aggregation: 'sum', field: 'effort', filter: OPEN, caption: 'Team capacity 40 days' },\n { id: 'shipped', kind: 'progress', title: 'Shipped', filter: SHIPPED },\n { id: 'status', kind: 'chart', chart: { kind: 'bar', x: 'status' } },\n { id: 'wanted', kind: 'list', title: 'Most wanted', sortBy: 'votes', sortDesc: true, limit: 3 },\n ],\n}\n```\n\nA dashboard is a grid of tiles. Each tile reads the records of one table,\nkeeps the ones its `filter` matches (the same `FieldFilter` as a view's\nfilter), and shows one of four things:\n\n- **`'number'`** counts the records, or with `aggregation: 'sum' | 'avg' |\n 'min' | 'max'` and a number `field`, adds them up. The number is written the\n way the field writes it, so a currency field shows \"$42,000\". Here \"Open\n features\" reads 3 and \"Days of work left\" reads 30. `caption` is a line\n under the number.\n- **`'chart'`** takes a chart view's `chart` setting (`kind`, `x`, `y`,\n `aggregation`) and groups the tile's records the same way.\n- **`'list'`** shows the first `limit` records (5 by default) sorted by\n `sortBy`, with that field's value beside each name (\"Single sign-on with\n SAML 182\"); `detail` shows another field instead. A click opens the record.\n- **`'progress'`** shows how many of all the table's records match the filter:\n \"25%, 1 of 4 records\" for Shipped.\n\n`size` is `'1x1'`, `'2x1'` or `'2x2'` (columns by rows). A number or progress\ntile is `'1x1'` by default, a chart or list `'2x2'`. Below about 450px the\ntiles stack in one column. A tile without `title` is named after what it\nshows (\"Total Effort (days)\", \"Status is Shipped\").\n\nWith several tables (`<SvBase bind:tables>`), a tile's `table` names any\ntable of the base, so a dashboard on Deals can count Accounts and list the\nActivities due this week. A tile without `table` reads the table the view is\non. Its filter and fields are that table's.\n\nA number or progress tile is a button: a click, or Enter, lists the records\nit counts (\"Open the 3 records\") in a dialog, each with its name and a few\nof its fields. On a chart, a click on a bar or a slice lists the records in\nit: the records the tile's filter keeps that fall in that bucket. A click on a record in the dialog opens it, in its\nown table's tab when the tile reads another table. While the dashboard is\nbeing edited, the tiles open nothing.\n\n\"Edit dashboard\" at the top of the view adds a tile, and on each tile sets its\nsize, moves it (drag it, or the arrows), edits it in a dialog (kind, table,\nvalue, filter, title, size) or removes it. Every change is saved in the view's\n`dashboard` at once and reaches `onViewsChange` and `onTablesChange`. A locked\nview has no \"Edit dashboard\". The view bar shows only the view switcher on a\ndashboard.\n\n<div data-docs-demo=\"721-base-dashboard\" data-height=\"680\"></div>\n\n### Text, buttons, images, dividers and a record picker\n\nA dashboard can also say, show and link to things, which makes it a page of\nan app rather than only a summary (Airtable's \"blank\" interface layout):\n\n```ts\nconst home: FieldView = {\n id: 'home',\n name: 'Home',\n type: 'dashboard',\n dashboard: [\n { id: 'hello', kind: 'text', text: '# Welcome\\nYour open requests are below. See [the guide](https://example.com/guide).' },\n { id: 'help', kind: 'button', label: 'Ask for help', url: 'https://example.com/help' },\n { id: 'logo', kind: 'image', url: '/img/office.jpg', alt: 'Our office', fit: 'cover' },\n { id: 'sec', kind: 'divider', title: 'By account' },\n { id: 'account', kind: 'picker', table: 'accounts', title: 'Account', fields: ['city', 'owner'] },\n { id: 'deals', kind: 'number', title: 'Deals', pickedBy: { tile: 'account', field: 'account' } },\n ],\n}\n```\n\n- **`'text'`**: `text` in a small part of Markdown: a line starting with `#`\n is a heading, a blank line starts a paragraph, `**bold**` and\n `[words](https://...)` links inside lines. It is drawn as text, never as\n HTML, so what anyone types shows as typed.\n- **`'button'`**: `label` (default \"Open\") and `url`. An address on another\n site opens in a new tab; a path (`/...`) in the same one.\n- **`'image'`**: `url` and `alt` (said to people who cannot see it); `fit` is\n `'contain'` (the whole picture, default) or `'cover'` (the tile filled).\n- **`'divider'`**: a line across the whole dashboard with its `title` over\n it, to start a section.\n- **`'picker'`**: the records of its `table` to choose from by name; the one\n picked shows its `fields` (default: the next four after its name) and an\n \"Open the record\" button.\n\nLinks and pictures go only to `https:`, `http:`, `mailto:` (a link) or a path\non the site: a `javascript:` or `data:` address is shown as words, not\nfollowed.\n\nA number, chart, list or progress tile with `pickedBy: { tile, field }` is\nnarrowed by that picker: once a record is picked, it counts only the records\nwhose link field `field` holds it (\"the deals of the account picked\"), and\n\"Every record\" counts them all again. The pick is the viewer's and is not\nsaved. Under the hood the tile's filter gains a condition of the kind\n`'linked'`:\n\n```ts\nconst narrowing = { column: 'account', kind: 'linked', op: 'hasAnyOf', value: ['a1'] } // the link holds record a1, by id\n```\n\nFor a table the page holds, the page applies it. For a table read from a\nserver (`serverRows`), the server must apply it too: `fieldFilterToSql` and\n`fieldFilterToPostgrest` answer that they cannot (the tile then shows what\nthe server sends), so a server of your own reads `kind: 'linked'` and matches\nthe link's record ids.\n\nIn the tile dialog, \"Shows\" offers these kinds too; a picker's tile picks its\nfields, and the tiles it can narrow offer \"Narrowed by\" with each picker the\ntile's table links to. Dividers take one row across the dashboard; the other\ntiles keep their sizes.\n\n## 10. A list for the phone\n\n```ts\nconst list: FieldView = {\n id: 'list',\n name: 'Feature list',\n type: 'list',\n listFields: ['status', 'teams', 'votes'],\n state: { sorting: [{ id: 'quarter', desc: false }, { id: 'votes', desc: true }], grouping: ['quarter'], hiddenColumns: [], advancedFilter: null },\n}\n```\n\nA list shows one record per entry: the primary field in bold, and under it\nthe fields in `listFields` (column ids, in order), each drawn as its cell\ndraws it, so Status is a colored pill and Teams are tags. An empty value is\nleft out. Without `listFields` the list shows the next three fields the grid\nshows. Long names stay readable at phone width, where a grid would cut them.\n\nThe list keeps the view's filter, sorts and groups. Here it is grouped by\nQuarter: a header per quarter with the field's name, its value and the\nnumber of records, \"Quarter Q4 2026 3\", and a click on the header folds the\ngroup. Within each quarter the most voted feature comes first. Grouped by\nmore fields (`grouping: ['quarter', 'status']`), each quarter holds a header\nper status, indented under it, with its own count and its own fold.\n\nA click on a record, or Enter, opens it. The list is one tab stop: Up and\nDown move between records and group headers at every level, Home and End\njump, Left and Right fold and unfold a group, and Left on a record or a\nfolded group moves to the group it is in. A record someone else changed and nobody here\nopened yet has a dot before its name.\n\nThe view bar has Hide fields, Filter, Group, Sort and \"Customize list\", which\nturns the fields under the name on and off and saves them in `listFields`.\n\n<div data-docs-demo=\"719-base-list-view\" data-height=\"620\"></div>\n\n## 11. An inbox of changes\n\n```ts\nconst inbox: FieldView = {\n id: 'inbox',\n name: 'Inbox',\n type: 'inbox',\n inboxDateField: 'start',\n listFields: ['status', 'lead'],\n}\n```\n\nAn inbox shows the records on the left and the picked one on the right: its\nfields, each one editable in place with the editor its cell uses, and its\nlatest changes, \"Cleo Park changed Status: Planned → In progress\". \"Expand\"\nopens the full record with its comments.\n\nThe list is newest first by `inboxDateField` (a date field's column id), so\n\"Audit log export\", which starts on January 11, is on top.\nRecords without a date go last. Without `inboxDateField` the inbox keeps the\nview's sort. The view's filter applies either way.\n\nA record someone else changed and nobody here has opened is unread: its name\nis bold and it has a dot. The changes come from a table with a `source` that\nhears of writes made elsewhere ([Changes made\nelsewhere](./data.md#changes-made-elsewhere)). Picking a record marks it read,\nas opening it in any view does, and \"Mark all read\" marks the rest. The count\nat the top says \"2 unread\" or \"All read\".\n\nDown or j picks the next record and Up or k the previous one; Enter opens the\nfull record. Narrower than 640px the inbox shows the list, and a picked record\nfills it with a Back button (Escape goes back too).\n\nThe view bar has Hide fields, Filter, Sort and \"Customize inbox\": the date\nfield it lists by and the fields under each name. A field hidden in the view\nleaves the record on the right too.\n\n<div data-docs-demo=\"720-base-inbox-view\" data-height=\"620\"></div>\n\n## 12. Keep the views\n\n`onViewsChange` fires with the whole list when a view is created, renamed,\nduplicated or deleted, and about 400ms after the shown view's settings stop\nchanging. Switching views stores the one being left first. Store the list\nwherever the app stores things.\n\nIn the browser:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, type FieldView } from '@svgrid/enterprise/base'\n\n enableBase()\n const KEY = 'roadmap:views'\n const DEFAULT_VIEWS: FieldView[] = [{ id: 'all', name: 'All features', type: 'grid' }]\n\n function read<T>(key: string, fallback: T): T {\n try {\n const raw = localStorage.getItem(key)\n return raw ? (JSON.parse(raw) as T) : fallback\n } catch {\n return fallback\n }\n }\n function write(key: string, value: unknown) {\n try {\n localStorage.setItem(key, JSON.stringify(value))\n } catch {\n // Private mode or a full quota: the views still work, unsaved.\n }\n }\n\n let views = $state<FieldView[]>(read(KEY, DEFAULT_VIEWS))\n let activeView = $state<string>(read(`${KEY}:active`, ''))\n\n $effect(() => write(`${KEY}:active`, activeView))\n</script>\n\n<SvBase data={rows} {columns} primaryField=\"feature\" editable\n bind:views bind:activeView onViewsChange={(v: FieldView[]) => write(KEY, v)} />\n```\n\nOn a server, decide who owns a list.\n\n- **Per user.** Each person keeps their own list, so one lead's filter does\n not change another's. Seed it from the team's defaults the first time.\n- **Shared.** One list per table that everyone reads. Write it only for the\n people you allow; for everyone else, keep their changes in memory or in\n their own list. A shared \"My features\" view built on `ME` still shows each\n person their own records.\n\n```ts\ntype Scope = 'me' | 'team'\n\nasync function loadViews(scope: Scope): Promise<FieldView[]> {\n const res = await fetch(`/api/tables/features/views?scope=${scope}`)\n return res.ok ? ((await res.json()) as FieldView[]) : DEFAULT_VIEWS\n}\n\nfunction saveViews(scope: Scope, next: FieldView[]) {\n void fetch(`/api/tables/features/views?scope=${scope}`, {\n method: 'PUT',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify(next),\n })\n}\n```\n\n```svelte\n{#await loadViews('me') then loaded}\n <SvBase data={rows} {columns} primaryField=\"feature\" editable\n views={loaded} onViewsChange={(v: FieldView[]) => saveViews('me', v)} />\n{/await}\n```\n\nOr mount at once and swap the list in when it arrives. When `views` or\n`activeView` changes from outside and the shown view is not the one the grid\nhas, the bar applies it. It never stores the grid's settings into a view it\nhas not applied yet.\n\n```svelte\n<script lang=\"ts\">\n let views = $state<FieldView[]>(DEFAULT_VIEWS)\n let loaded = false\n loadViews('me').then((v) => {\n views = v\n loaded = true\n })\n</script>\n\n<SvBase data={rows} {columns} primaryField=\"feature\" editable\n bind:views onViewsChange={(v: FieldView[]) => loaded && saveViews('me', v)} />\n```\n\nThe `loaded` check matters: about 400ms after mount the bar stores the\ndefault view's settings, and that save must not replace the list on the\nserver before the real one is in.\n\nWith several tables (`<SvBase bind:tables>`), each table keeps its own\n`views`, and `onTablesChange` hands back the whole list of tables, views\nincluded.\n\n## Personal and locked views\n\nOnce several people share a table, two more keys on a view matter:\n\n```ts\nconst views: FieldView[] = [\n // Only Ana sees it, under \"My views\" in the views menu.\n { id: 'ana-open', name: 'My open tasks', type: 'grid', personal: 'u1', state: { /* ... */ } },\n // Everyone sees it; nobody changes its settings until someone unlocks it.\n { id: 'report', name: 'Leadership report', type: 'grid', locked: true, lockedBy: 'u2', state: { /* ... */ } },\n]\n```\n\n- **`personal: userId`** lists the view only for that person, read from\n `setCurrentUser`. With nobody signed in every view is listed. \"Create\" in\n the views menu has a \"Personal view: only I see it\" box once someone is\n signed in.\n- **`locked: true`** keeps the view's filter, sorts, groups, hidden fields,\n colors and row height as saved. Its settings buttons are off, nothing is\n saved into it, and the bar shows \"Locked\" with who locked it. A sort from a\n column header still works for the moment; the bar then says \"Locked, not\n saved\" with a Reset. Records stay editable. A locked view cannot be\n deleted, and a copy of it starts unlocked.\n\nThe lock button in the views menu locks the view as the grid shows it now,\nor unlocks it. `lockViews={false}` on `SvBase` removes it for people who may\nnot lock views. Both keys come back through `onViewsChange` and\n`onTablesChange`, so the app stores a personal view with its owner the same\nway as the others.\n\n<div data-docs-demo=\"710-base-personal-locked-views\" data-height=\"620\"></div>\n\n## On a phone\n\nWhen a table is narrower than 600px (its own width, not the window's), a\ngrid view shows each record as a card: the primary field, then the next four\nfields the view shows, in the view's filter and sort. A tap opens the\nrecord, \"+\" adds one, and on a phone screen the opened record fills it. The\nview bar keeps its icons and the tab bar its tabs.\n\nA card keeps what a row can do. A long press, the button on the card, a\nright-click, the Menu key or Shift+F10 opens the record's menu: expand, comment,\nselect, insert above or below, duplicate and delete. A record selected this way\nshows on its card, as a ring on its list row, and in the selection bar. Copy and\npaste work on a cell, so they stay with the table. A gallery view and a list view\nhave the same menu.\n\nA Kanban lane takes the table's width, the next lane a swipe away and\nsnapped into place. A calendar opens in its agenda, the days listed one under\nanother, since a month of seven columns has no room for a title; Month, Week\nand Day are a tap away. Gallery cards stand one per row, and a form is one\ncolumn at any width.\n\n`phoneLayout` on `SvBase` moves the breakpoint (`phoneLayout={480}`), turns\nthe cards on at every width (`true`) or keeps the grid (`false`).\n\n<div data-docs-demo=\"713-base-phone-layout\" data-height=\"720\"></div>\n\n## Search across tables\n\nThe view bar's search finds records in the view on screen. The box at the\nend of the tab bar searches every table of the base. With the focus in the\nbase, Ctrl+K puts the cursor in it, and so does \"/\" outside the grid and any\ntext box. Neither is taken from the rest of the page.\n\nIt reads a field the way its cell shows it: a single select by its option's\nlabel, a person by name, a date as the field writes it, a link by the names\nof the records it links to, a formula or lookup by its result. Numbers,\ncurrency, percents, durations, ratings, checkboxes, buttons, rollups and\ncounts are not searched. Case and accents do not count: \"tomas\" finds\n\"Tomás\".\n\nEvery word of the query has to be in the record, in one field or another.\nThe results are grouped by table, five records each with \"N more in Deals\"\nunder them, each with its name, the field the words were found in and the\nwords marked. Records rank by:\n\n1. the whole query in one field, before words spread over several;\n2. the primary field, before the others;\n3. a field that is the query, then one that starts with it, then one with a\n word that starts with it, then one that holds it anywhere.\n\nTables are listed by their best record. Up and Down move through the list,\nEnter or a click shows the record's table and opens the record, and Escape\ncloses the list, then clears the box. `search={false}` on `SvBase` leaves the\nbox out. A shared base (`readOnly`) keeps it, over the tables and fields the\nshare shows.\n\nThe same search runs without the box, for a command palette of your own or\non a server:\n\n```ts\nimport { searchBase } from '@svgrid/enterprise/base'\n\nconst groups = searchBase(tables, 'northwind proposal', { limit: 10 })\nfor (const g of groups) {\n console.log(g.name, g.total)\n for (const hit of g.hits) console.log(hit.rowId, hit.title, `${hit.fieldName}: ${hit.text}`, hit.marks)\n}\n```\n\nEach hit has the table and record ids, the record's name (`title`), the\nfield that matched (`field`, `fieldName`, `primary`), its text cut around\nthe match when it is long, and `marks`, the `[start, end)` spans of the\nwords in that text. `field: (table, column) => boolean` in the options picks\nthe fields to search. To open a hit in `SvBase`, show its table\n(`bind:activeTable`) and call `openRecord({ api, rowId })` once that table's\ngrid has called `onApiReady`; the box does this for you.\n\n<div data-docs-demo=\"718-base-search-all-tables\" data-height=\"620\"></div>\n\n## View types and the keys they read\n\n| Type | Keys | View bar buttons |\n|---|---|---|\n| `'grid'` | `state`, `rowHeight`, `color` | Hide fields, Filter, Group, Sort, Color, Row height |\n| `'kanban'` | `stackBy`: a single select, or a user field with one person | Hide fields, Filter, Sort |\n| `'calendar'` | `dateField`, `endField` (optional), `color` | Hide fields, Filter, Sort, Color |\n| `'gantt'` | `dateField`, `endField`, `progressField`, `dependencyField`, `zoom`, `color` | Hide fields, Filter, Sort, Color, Customize timeline |\n| `'gallery'` | `coverField`: an attachment field | Hide fields, Filter, Sort |\n| `'chart'` | `chart`: `kind`, `x`, `y`, `aggregation` | Filter, Customize chart |\n| `'list'` | `listFields`: the fields under each name | Hide fields, Filter, Group, Sort, Customize list |\n| `'inbox'` | `inboxDateField`: a date field, newest first; `listFields` | Hide fields, Filter, Sort, Customize inbox |\n| `'form'` | `formFields`, `formRequired`, `formTitle`, `formDescription`, `formSubmitLabel`, `formConditions`, `formPrefill` | none |\n| `'dashboard'` | `dashboard`: the tiles, in order | none |\n| any type | `personal`, `locked`, `lockedBy` | off while `locked` |\n\nEvery type also keeps `state` (filter, sorts, groups, hidden fields, column\norder, widths, pinning) and switches with the grid's own state, so a filter\nset on the board is still there when you come back to it. The search text is\nnot part of it. The views menu's \"Create\" offers each type `SvBase` can show\nand greys out one the table cannot: a Kanban needs a single select, a\ncalendar a date field, a chart a field to group by. A new view starts with no\nfilter, sorts or groups and every field shown.\n`viewTypes={['grid', 'kanban', 'calendar']}` on `SvBase` limits what\n\"Create\" offers.\n\nA timeline (`type: 'gantt'`) is a calendar with a task table beside the bars.\n\"Create\" offers it as Timeline in every base, and its renderer loads the first\ntime one is shown. Its bars take the view's colors, `progressField` is a percent field drawn as each\nbar's fill, and `dependencyField` is a link field to the same table naming\nwhat each record waits for, drawn as arrows.\n\nA record's dates are its own: a drop on a Sunday stays on the Sunday. By keyboard a\nbar works as a calendar event does: Space picks it up, Left and Right carry it a day\n(Shift, a week), Space puts it down and Escape puts it back. Enter opens the record,\nShift+F10 opens its menu, and Delete asks first, as a row's menu does.\n\n## When an edit changes where a record belongs\n\nA view's filter, sort and groups apply again after an edit, with one pause. In a\ngrid the row you are working in stays where it is while it is the active row, so\nit does not leap away under the cursor; it takes its place when you move to\nanother row, click outside the grid, or close its record. The record count follows\nat the same moment. An undo, a paste and a fill apply at once. A board, a calendar,\na timeline, a gallery and a list show the change as soon as it is made, or when a\nrecord dialog closes. On a table read a page at a time the database is asked again\nat that moment, once it has the edit.\n\n## The view bar, panel by panel\n\n- **Views menu** (the view's name): switch, rename, duplicate (\"Roadmap by\n quarter copy\") and delete. Delete asks in the view's own row, and nothing moves\n until the answer. A deleted view goes to the trash and is one step of undo. The\n last view cannot be deleted.\n- **Hide fields**: a switch per field, a search, hide all and show all, and\n drag to reorder. The list keeps its order while you switch fields, and hidden\n fields sit where they are in the table. The primary field is always shown.\n- **Filter**: \"Where [field] [operator] [value]\" rows joined by \"and\" or\n \"or\", and condition groups. Each change filters at once. A condition still\n missing its value filters nothing.\n- **Group**: up to three fields, each with a direction.\n- **Sort**: fields in order, each with a direction labeled for its type (\"1\n → 9\", \"A → Z\", \"first → last\" for a single select). Attachment and button\n fields are not offered.\n- **Color**: None, Select field (a single select's option colors) or\n Conditions in order.\n- **Row height**: Short 34, Medium 56, Tall 88, Extra tall 128.\n `rowHeights` on `SvBase` or `SvBaseViewBar` sets the list.\n- **Search**: in a grid view, the grid's find bar (Ctrl+F) that marks every\n match. In a board, calendar, gallery, list or inbox, a \"Find a record\" box\n that narrows the records. Switching views clears it.\n- **Search all tables**: the box in the tab bar (below).\n\nA button with something set says so and is tinted. With `fieldMenu` on, each\ncolumn's menu adds \"Filter by this field\" and \"Group by this field\", which\nopen the bar's panel with the new condition or group in it.\n\n## Filters in code\n\n`filterKindOf(columnDef)` gives the kind a field filters as, and\n`operatorsFor(kind)` the operators the panel offers for it, in menu order.\n[Filter conditions](../fields.md#filter-conditions) maps each field type to\nits kind.\n\n| `kind` | `op` values | `value` |\n|---|---|---|\n| `'text'`, `'link'` | `contains`, `notContains`, `is`, `isNot` | a string; a link compares the linked records' names |\n| `'number'` | `eq`, `neq`, `lt`, `gt`, `lte`, `gte` | a number |\n| `'select'` | `is`, `isNot` | one option value, or a person's id (or `ME`) for a user field |\n| `'select'` | `isAnyOf`, `isNoneOf` | an array of them |\n| `'multi'` | `hasAnyOf`, `hasAllOf`, `isExactly`, `hasNoneOf` | an array of option values or ids |\n| `'checkbox'` | `is` | `true` or `false` |\n| `'date'` | `is`, `isBefore`, `isAfter`, `isOnOrBefore`, `isOnOrAfter` | `{ mode: 'today' }`, with `mode` also `'tomorrow'`, `'yesterday'`, `'oneWeekAgo'`, `'oneWeekFromNow'`, `'oneMonthAgo'`, `'oneMonthFromNow'`; or `{ mode: 'exactDate', date: '2026-11-01' }` |\n| `'date'` | `isWithin` | `{ span: 'pastWeek' }`, with `span` also `'pastMonth'`, `'pastYear'`, `'nextWeek'`, `'nextMonth'`, `'nextYear'`; or `{ span: 'pastDays', days: 14 }`, `{ span: 'nextDays', days: 14 }` |\n| `'files'` | `contains` (file name contains) | a string |\n\nEvery kind except checkbox also takes `isEmpty` and `isNotEmpty`, with no\nvalue. A few rules from the code:\n\n- An empty number cell is no number: it matches only `neq`.\n- Dates compare whole days. A bare `'2026-11-01'` is that day where the user\n is, and \"within the past week\" runs from 7 days ago to today.\n- A user condition holds the person's id (`'u2'`), not the name, or `ME`\n for whoever is signed in.\n- A link condition sets `table` to the linked table's id, so it can match\n records by name.\n\nSet a filter on the shown view with `api.setAdvancedFilter(filter)`; the\nview keeps it like one set in the panel.\n\n## Row colors: by field or by conditions\n\n```ts\nimport type { ColorSetting } from '@svgrid/enterprise/base'\n\nconst byStatus: ColorSetting = { mode: 'field', field: 'status' }\nconst byRisk: ColorSetting = {\n mode: 'conditions',\n rules: [\n { color: '#f82b60', condition: { column: 'status', kind: 'select', op: 'is', value: 'Blocked' } },\n { color: '#fcb400', condition: { column: 'target', kind: 'date', op: 'isBefore', value: { mode: 'today' } } },\n ],\n}\n```\n\nBy field, each row takes its option's color, and the row header's title says\nthe option, so the color is never the only signal. A multiple select colors\nby its first value. By conditions, the first rule that matches wins: a\nblocked feature is red even when it is also late. A condition is tested as\nthe filter tests it: on the value the cell shows, so a formula, lookup,\nrollup or count field works, and a condition still missing its value colors\nnothing. A calendar colors its events by a single select only; a Gantt's bars\ntake either kind.\n\nThe color is a 3px stripe on the row header, unless the `rowColor` prop on\n`SvBase` sets a `target` (`'bar'` or `'row'`): a view's colors use it too. A\nview without `color` shows the `rowColor` prop's colors until someone picks\ncolors for it in Color. `{ mode: 'none' }` turns the colors off in that view.\n\n## Summaries in the footer and in group headers\n\nWith `summary` on, a click on a field's footer cell picks its summary: sum,\naverage, median, min, max or range for numbers; checked, unchecked or percent\nchecked for a checkbox; earliest, latest or the date range in days for dates;\nempty, filled, unique, percent empty or percent filled for any field. The\nresult is written as the field writes values. The choice is stored in the\nfield's `fieldProps.summary` and reported through `onColumnChange`; see\n[Summaries at the bottom](../fields.md#summaries-at-the-bottom).\n\nGroup headers show the same summaries over that group's records. Both leave\nout records the filter hides, even in a collapsed group.\n\n## The view bar over your own grid\n\n`SvBaseViewBar` is the bar alone, for a page that lays out its own\n`<SvGrid>`:\n\n```svelte\n<script lang=\"ts\">\n import { SvGrid } from '@svgrid/grid'\n import { SvBaseViewBar, enableBase, type FieldView } from '@svgrid/enterprise/base'\n\n enableBase()\n // Raw: the bar finds its grid by the api object itself, and a proxy is another object.\n let api = $state.raw<any>(null)\n let views = $state<FieldView[]>([\n { id: 'all', name: 'All features', type: 'grid' },\n { id: 'board', name: 'Status board', type: 'kanban', stackBy: 'status' },\n ])\n let activeView = $state('all')\n</script>\n\n{#if api}\n <SvBaseViewBar {api} bind:views bind:activeView\n rowHeights={[{ label: 'Compact', height: 32 }, { label: 'Roomy', height: 64 }]} />\n{/if}\n<SvGrid data={rows} {columns} primaryField=\"feature\" editable containerHeight={600}\n onApiReady={(a) => (api = a)} />\n```\n\nIts \"Create\" offers grid, Kanban and calendar (and Gantt once enabled). It\nloads the board, calendar and gallery renderers the first time a view of\nthat type is shown, and opens the record and the \"Delete record?\" question\nfor a card's menu. Chart and form views are drawn by `SvBase`, not by the\nbar, so leave them out of `viewTypes` here, or draw `SvBaseForm` yourself\nwhen a form view is active.\n\n## Pitfalls\n\n- **A new view from \"Create\" starts with `color: { mode: 'none' }`**, so it\n hides the `rowColor` prop's colors. A new calendar or Gantt is the\n exception: it starts colored by the first single select. Pick colors in\n Color, or declare the view in code without `color`.\n- **`color.field` is the data field; the other keys are column ids.** They\n differ only when a column sets an `id`.\n- **Summaries belong to the field, not the view.** Picking \"Average\" in one\n view changes every view's footer and group headers.\n- **Save views only after they load.** See the `loaded` check in step 12.\n\n## Next\n\n- [Linked records](./linked-records.md): link Features to Feedback and chart\n or filter by the linked names.\n- [Formulas](./formulas.md): computed fields a view can sort, group and chart\n by.\n- [Forms](./forms.md): required fields, the thank-you screen and forms\n outside the base.\n- [Collaboration](./collaboration.md): comments, people and who changed what.\n- [Automations](./automations.md): conditions written with this same filter.\n- [Keep a base in a database](./data.md): load the tables from Postgres,\n Supabase or your API and write every change back.\n"
|
|
5307
|
+
"markdown": "# Views for every team\n\nOne table of records, many ways to look at it. Product reads the roadmap\ngrouped by quarter, engineering works off a status board, the leads check a\ntimeline, and anyone in the company files a request through a form. Each of\nthose is a saved view: a name, a type, and the filter, sorts, groups, hidden\nfields, row height and colors it had when someone last left it.\n\n\n\n<div data-docs-demo=\"513-base-product-roadmap\" data-height=\"680\"></div>\n\n> SvGrid Base is part of the **Suite edition** of `@svgrid/enterprise`. Without a key it runs with a watermark.\n\nThis page builds the Features table of that roadmap one view at a time. Each\nstep adds to the `views` list from the step before and works on its own.\n\n## 1. The table\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, setFieldUsers, type FieldView } from '@svgrid/enterprise/base'\n\n enableBase()\n setFieldUsers([\n { id: 'u1', name: 'Ana Ruiz' },\n { id: 'u2', name: 'Ben Okafor' },\n { id: 'u3', name: 'Cleo Park' },\n ])\n\n type Feature = {\n id: number; feature: string; quarter: string; status: string; teams: string[]\n lead: string; impact: number; effort: number; start: string; target: string; votes: number\n }\n\n const QUARTERS = [\n { value: 'Q4 2026', color: '#2d7ff9' },\n { value: 'Q1 2027', color: '#18bfff' },\n { value: 'Later', color: '#94a3b8' },\n ]\n const STATUS = [\n { value: 'Planned', color: '#94a3b8' },\n { value: 'In progress', color: '#2d7ff9' },\n { value: 'In beta', color: '#8b46ff' },\n { value: 'Shipped', color: '#20c933' },\n { value: 'Blocked', color: '#f82b60' },\n ]\n const TEAMS = [\n { value: 'Web', color: '#2d7ff9' },\n { value: 'Mobile', color: '#ff6f2c' },\n { value: 'Platform', color: '#8b46ff' },\n ]\n\n let rows = $state.raw<Feature[]>([\n { id: 1, feature: 'Single sign-on with SAML', quarter: 'Q4 2026', status: 'In progress', teams: ['Platform'], lead: 'u2', impact: 5, effort: 12, start: '2026-10-05', target: '2026-11-13', votes: 182 },\n { id: 2, feature: 'Offline mode for the mobile app', quarter: 'Q4 2026', status: 'Blocked', teams: ['Mobile'], lead: 'u3', impact: 4, effort: 13, start: '2026-10-12', target: '2026-12-04', votes: 96 },\n { id: 3, feature: 'Dark mode', quarter: 'Q4 2026', status: 'Shipped', teams: ['Web'], lead: 'u1', impact: 2, effort: 4, start: '2026-10-01', target: '2026-10-16', votes: 154 },\n { id: 4, feature: 'Audit log export', quarter: 'Q1 2027', status: 'Planned', teams: ['Platform', 'Web'], lead: 'u1', impact: 3, effort: 5, start: '2027-01-11', target: '2027-01-29', votes: 41 },\n ])\n\n const columns = [\n { field: 'feature', header: 'Feature', width: 260, fieldType: 'text' },\n { field: 'quarter', header: 'Quarter', fieldType: 'singleSelect', fieldProps: { options: QUARTERS } },\n { field: 'status', header: 'Status', fieldType: 'singleSelect', fieldProps: { options: STATUS } },\n { field: 'teams', header: 'Teams', fieldType: 'multiSelect', fieldProps: { options: TEAMS } },\n { field: 'lead', header: 'Lead', fieldType: 'user' },\n { field: 'impact', header: 'Impact', fieldType: 'rating', fieldProps: { max: 5 } },\n { field: 'effort', header: 'Effort (days)', fieldType: 'number', fieldProps: { format: 'integer', summary: 'sum' } },\n { field: 'start', header: 'Start', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'target', header: 'Target', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'votes', header: 'Votes', fieldType: 'number', fieldProps: { format: 'integer', summary: 'sum' } },\n ]\n\n let views = $state<FieldView[]>([{ id: 'all', name: 'All features', type: 'grid' }])\n</script>\n\n<SvBase data={rows} {columns} bind:views primaryField=\"feature\"\n editable sortable showRowNumbers expandRows summary containerHeight={640}\n rowAdder={{ label: 'Add feature', defaults: () => ({ id: Date.now(), status: 'Planned', quarter: 'Later', teams: [] }) }} />\n```\n\nThe view bar over the grid has \"All features\" on the left, then Hide\nfields, Filter, Group, Sort, Color and a row height button, and \"4 records\"\nwith a search button on the right. The footer row shows \"Sum 34\" under Effort\nand \"Sum 473\" under Votes, because those fields set `fieldProps.summary`.\n\nEvery view key that names a field (`stackBy`, `dateField`, a filter\ncondition's `column`, a chart's `x`) takes the column id. A column without an\n`id` uses its `field`, so in this table the two are the same.\n\n## 2. A roadmap grouped by quarter\n\nA view can start with settings. `state` is the grid's own state, the same\nobject `api.getState()` returns; `color` says how rows are colored.\n\n```ts\nconst roadmap: FieldView = {\n id: 'roadmap',\n name: 'Roadmap by quarter',\n type: 'grid',\n color: { mode: 'field', field: 'status' },\n rowHeight: 56,\n state: {\n grouping: ['quarter'],\n sorting: [{ id: 'quarter', desc: false }, { id: 'impact', desc: true }],\n hiddenColumns: ['lead'],\n },\n}\n```\n\nGroups and sorts share the grid's `sorting` list: a grouped field's\ndirection is an entry ahead of the sorts. The view bar writes them that way,\nso write them that way too. Here the bar reads \"1 hidden field\", \"Grouped by\n1 field\" and \"Sorted by 1 field\": the `quarter` entry belongs to the group,\nnot to Sort.\n\nEach group header shows \"Quarter\" over the option's pill, the number of\nrecords, the summaries the fields picked for that group (\"Effort (days) 29\",\n\"Votes 432\"), and \"+\" to add a feature that already has that quarter. Groups\ncome in the select's option order, not alphabetically. Group rows are at\nleast 52px tall so the field's name fits over the value; with\n`rowHeight: 56` they match the records. Each row has a status color stripe\non its row header. 56 is the row height menu's \"Medium\": from 48px, text and\nselect pills wrap.\n\n## 3. A view that starts filtered\n\nThe filter is the grid's advanced filter with its own kind, `fieldFilter`.\nPut it in `state.advancedFilter`:\n\n```ts\nimport { describeFieldFilter, type FieldFilter } from '@svgrid/enterprise/base'\n\nconst activeWork: FieldFilter = {\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [\n { column: 'status', kind: 'select', op: 'isAnyOf', value: ['In progress', 'In beta', 'Blocked'] },\n {\n conjunction: 'or',\n conditions: [\n { column: 'target', kind: 'date', op: 'isWithin', value: { span: 'nextDays', days: 30 } },\n { column: 'impact', kind: 'number', op: 'gte', value: 4 },\n ],\n },\n ],\n}\n\nconst now: FieldView = {\n id: 'now',\n name: 'Now',\n type: 'grid',\n state: { sorting: [{ id: 'target', desc: false }], advancedFilter: activeWork },\n}\n\nconst header = (id: string) => columns.find((c) => c.field === id)?.header ?? id\ndescribeFieldFilter(activeWork, header)\n// \"Status is any of In progress, In beta, Blocked and (Target is within the next 30 days or Impact ≥ 4)\"\n```\n\nThe Filter button reads \"Filtered by 3 fields\" (one field reads \"Filtered by\nStatus\") and the record count drops to what the filter keeps.\n`describeFieldFilter` writes a filter in the words the panel uses, for a page\nsubtitle or an audit line. It returns `\"every record\"` for a filter with no\ncomplete conditions.\n\nA condition is a field, an operator and a value; a group is one level deep.\n[Filters in code](#filters-in-code) below lists the operators per kind.\n\nOne view can serve every lead. `ME` (the string `'@me'`) in a person\ncondition stands for whoever `setCurrentUser` names when the filter runs; the\nFilter panel lists it as \"Me\", first among the people.\n\n```ts\nimport { ME, setCurrentUser } from '@svgrid/enterprise/base'\n\nsetCurrentUser({ id: 'u2', name: 'Ben Okafor' })\n\nconst mine: FieldView = {\n id: 'mine',\n name: 'My features',\n type: 'grid',\n state: {\n advancedFilter: {\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [{ column: 'lead', kind: 'select', op: 'is', value: ME }],\n },\n },\n}\n```\n\nBen sees \"Single sign-on with SAML\"; Ana, signed in, sees her two. With\nnobody signed in the condition matches no one. `describeFieldFilter` writes\nit as \"Lead is me\".\n\n## 4. A status board\n\n```ts\nconst board: FieldView = { id: 'board', name: 'Status board', type: 'kanban', stackBy: 'status' }\n```\n\n\n\n`stackBy` takes a single select or a user field that holds one person. You\nget one lane per option, in option order and color, plus \"Uncategorized\",\nwhich shows only while a record has no status. Stack by `lead` instead and\nthe lanes are the people from `setFieldUsers`.\n\nSort the view by a number field and a card dropped elsewhere in its lane takes\na number between its neighbours', so the order is the table's and lasts.\n\nDrop a card in another lane and the status changes through the grid's edit\npath, so undo, validation and `onCellValueChange` all see it. \"+ Add a card\"\nadds a record already in that lane, named by the primary field.\n\nA card shows the record's name, then the next three fields the view shows,\nin column order (the stacked field left out), each drawn as its cell draws\nit. Hide a field in Hide fields and it leaves the cards; drag it up there to\nput it on them. Cards are read, not edited: a rating shows its stars\nbut does not take a click. Double-click a card or press F2 to open the\nrecord. Right-click it for its menu: Expand record, Comment, and, when the\nbase is `editable`, Move to (a submenu of the lanes), Duplicate record and\nDelete record, which asks \"Delete record?\" first. A card with comments shows\ntheir count; click it to open the record at its comment box.\n\n## 5. A Gantt chart, and a timeline in lanes\n\n```ts\nconst plan: FieldView = {\n id: 'gantt',\n name: 'Gantt',\n type: 'gantt',\n dateField: 'start',\n endField: 'target',\n color: { mode: 'field', field: 'status' },\n}\n```\n\nEach feature is a bar from its start to its target date, beside a table of\nnames and dates. Drag a bar to move both dates; drag its edge to change the\ntarget. One drag is one Ctrl+Z. `type: 'calendar'` with the same fields shows\nthe features on a month instead: a date field without a time shows as all-day\nevents. The end of a bar or an event is exclusive, so the record keeps the last\nday: a feature dragged to cover the 19th to the 21st gets\n`target: '2026-10-21'`.\n\nWith only `dateField`, events move but cannot be resized. Pick a day (or a\nrange) on the calendar and a new record lands on it, opened with its name\nready to type. Colored by a single select, the events take the option colors\nand the options appear above the calendar as a legend that hides and shows\nthem.\n\nMoving and resizing need `editable` on the base. Without it the calendar is\nread-only.\n\nA timeline puts the same bars in lanes: one row per value of `laneField`, so\nrecords that share a person, a property or a channel share a row, and the gaps\nbetween them show where there is room.\n\n```ts\nconst occupancy: FieldView = {\n id: 'occupancy',\n name: 'Occupancy',\n type: 'timeline',\n dateField: 'checkIn',\n endField: 'checkOut',\n laneField: 'property',\n zoom: 'month',\n}\n```\n\nDay, Week, Month and Year at the top right set the span. A bar dragged along\nits lane changes its dates; dragged to another lane it changes `laneField` too,\nin the same step, so one Ctrl+Z takes both back. For a link field with several\nrecords the record of the lane it left is swapped for the one it lands on, and\nthe others stay. A double-click in a lane adds a record there, in that lane.\nWith a single select or a person field every option or person is a lane, empty\nor not; with a link field the lanes are the records the rows link to, named by\nthe linked table's primary field.\n\n## 6. Effort by team\n\n```ts\nconst effort: FieldView = { id: 'effort', name: 'Effort by team', type: 'chart', chart: { kind: 'barH', x: 'teams', y: 'effort' } }\nconst mix: FieldView = { id: 'mix', name: 'Features per quarter', type: 'chart', chart: { kind: 'donut', x: 'quarter' } }\n```\n\nA chart groups the records the view shows by `x` and adds up `y` (or counts\nrecords when there is no `y`). `aggregation: 'avg'` averages instead of\nsumming. Kinds are `'bar'`, `'barH'`, `'line'`, `'pie'` and `'donut'`.\n\nHow `x` groups:\n\n- A single or multiple select keeps its options' order and colors. A\n multiple select counts a record in each of its options, so \"Audit log\n export\" adds 5 days to both Platform and Web.\n- A person or a linked record shows by name.\n- A date groups by month (\"Oct 2026\").\n- Records with no value go in an \"Empty\" bar, last.\n\nValues read as the summed field writes them, and a count as a whole number.\nThe series is labeled \"Sum of Effort (days)\", \"Average of ...\" or \"Records\".\nThe bar shows Filter, which narrows what is charted, and \"Customize chart\",\nwhose Type, Group by, Value and Combine (sum or average) are kept in `chart`.\nA chart view declared without `chart` draws \"Choose a field to chart in\nCustomize chart.\" until a field is picked there.\n\n## 7. A gallery of mockups\n\nAdd an attachment field, then a gallery view with it as the cover:\n\n```ts\nconst mockupField = { field: 'mockups', header: 'Mockups', fieldType: 'attachment' }\nconst gallery: FieldView = { id: 'mockups', name: 'Mockups', type: 'gallery', coverField: 'mockups' }\n```\n\nEach card shows the first image of `mockups`, the primary field as its title,\nthen the fields the grid shows, each drawn as its cell draws it. Hide a field\nin this view and it leaves the cards; drag fields in Hide fields to reorder\nthem. A click on a card opens the record. Without `coverField` the cards have\nno cover.\n\n## 8. A request form\n\n```ts\nconst request: FieldView = {\n id: 'request',\n name: 'Request a feature',\n type: 'form',\n formFields: ['feature', 'teams', 'impact'],\n formRequired: ['feature'],\n formTitle: 'Request a feature',\n formDescription: 'What should we build, and who is it for? Product reviews requests every Friday.',\n formSubmitLabel: 'Send request',\n}\n```\n\nThe form asks for the fields in `formFields` (column ids, in order), each with\nthe editor its cell uses. Without it, the form asks for every field a person\ncan fill in, the primary field first; computed fields are left out. A field\nin `formRequired` must be filled before the form sends. `formTitle` defaults\nto the view's name, `formSubmitLabel` to \"Submit\". A sent form adds a record\nthe way \"+ Add row\" does: `rowAdder.defaults` first, so a request starts as\nPlanned in Later, then what was typed, then `onRowAdd`. The bar shows only\nthe view switcher on a form.\n\nAll the views so far, in one list:\n\n```ts\nlet views = $state<FieldView[]>([roadmap, board, plan, effort, now, mine, gallery, request])\n```\n\n## 9. A dashboard\n\n```ts\nconst OPEN: FieldFilter = { kind: 'fieldFilter', conjunction: 'and', conditions: [{ column: 'status', kind: 'select', op: 'isNot', value: 'Shipped' }] }\nconst SHIPPED: FieldFilter = { kind: 'fieldFilter', conjunction: 'and', conditions: [{ column: 'status', kind: 'select', op: 'is', value: 'Shipped' }] }\n\nconst overview: FieldView = {\n id: 'overview',\n name: 'Overview',\n type: 'dashboard',\n dashboard: [\n { id: 'open', kind: 'number', title: 'Open features', filter: OPEN },\n { id: 'days', kind: 'number', title: 'Days of work left', aggregation: 'sum', field: 'effort', filter: OPEN, caption: 'Team capacity 40 days' },\n { id: 'shipped', kind: 'progress', title: 'Shipped', filter: SHIPPED },\n { id: 'status', kind: 'chart', chart: { kind: 'bar', x: 'status' } },\n { id: 'wanted', kind: 'list', title: 'Most wanted', sortBy: 'votes', sortDesc: true, limit: 3 },\n ],\n}\n```\n\nA dashboard is a grid of tiles. Each tile reads the records of one table,\nkeeps the ones its `filter` matches (the same `FieldFilter` as a view's\nfilter), and shows one of four things:\n\n- **`'number'`** counts the records, or with `aggregation: 'sum' | 'avg' |\n 'min' | 'max'` and a number `field`, adds them up. The number is written the\n way the field writes it, so a currency field shows \"$42,000\". Here \"Open\n features\" reads 3 and \"Days of work left\" reads 30. `caption` is a line\n under the number.\n- **`'chart'`** takes a chart view's `chart` setting (`kind`, `x`, `y`,\n `aggregation`) and groups the tile's records the same way.\n- **`'list'`** shows the first `limit` records (5 by default) sorted by\n `sortBy`, with that field's value beside each name (\"Single sign-on with\n SAML 182\"); `detail` shows another field instead. A click opens the record.\n- **`'progress'`** shows how many of all the table's records match the filter:\n \"25%, 1 of 4 records\" for Shipped.\n\n`size` is `'1x1'`, `'2x1'` or `'2x2'` (columns by rows). A number or progress\ntile is `'1x1'` by default, a chart or list `'2x2'`. Below about 450px the\ntiles stack in one column. A tile without `title` is named after what it\nshows (\"Total Effort (days)\", \"Status is Shipped\").\n\nWith several tables (`<SvBase bind:tables>`), a tile's `table` names any\ntable of the base, so a dashboard on Deals can count Accounts and list the\nActivities due this week. A tile without `table` reads the table the view is\non. Its filter and fields are that table's.\n\nA number or progress tile is a button: a click, or Enter, lists the records\nit counts (\"Open the 3 records\") in a dialog, each with its name and a few\nof its fields. On a chart, a click on a bar or a slice lists the records in\nit: the records the tile's filter keeps that fall in that bucket. A click on a record in the dialog opens it, in its\nown table's tab when the tile reads another table. While the dashboard is\nbeing edited, the tiles open nothing.\n\n\"Edit dashboard\" at the top of the view adds a tile, and on each tile sets its\nsize, moves it (drag it, or the arrows), edits it in a dialog (kind, table,\nvalue, filter, title, size) or removes it. Every change is saved in the view's\n`dashboard` at once and reaches `onViewsChange` and `onTablesChange`. A locked\nview has no \"Edit dashboard\". The view bar shows only the view switcher on a\ndashboard.\n\n<div data-docs-demo=\"721-base-dashboard\" data-height=\"680\"></div>\n\n### Text, buttons, images, dividers and a record picker\n\nA dashboard can also say, show and link to things, which makes it a page of\nan app rather than only a summary (Airtable's \"blank\" interface layout):\n\n```ts\nconst home: FieldView = {\n id: 'home',\n name: 'Home',\n type: 'dashboard',\n dashboard: [\n { id: 'hello', kind: 'text', text: '# Welcome\\nYour open requests are below. See [the guide](https://example.com/guide).' },\n { id: 'help', kind: 'button', label: 'Ask for help', url: 'https://example.com/help' },\n { id: 'logo', kind: 'image', url: '/img/office.jpg', alt: 'Our office', fit: 'cover' },\n { id: 'sec', kind: 'divider', title: 'By account' },\n { id: 'account', kind: 'picker', table: 'accounts', title: 'Account', fields: ['city', 'owner'] },\n { id: 'deals', kind: 'number', title: 'Deals', pickedBy: { tile: 'account', field: 'account' } },\n ],\n}\n```\n\n- **`'text'`**: `text` in a small part of Markdown: a line starting with `#`\n is a heading, a blank line starts a paragraph, `**bold**` and\n `[words](https://...)` links inside lines. It is drawn as text, never as\n HTML, so what anyone types shows as typed.\n- **`'button'`**: `label` (default \"Open\") and `url`. An address on another\n site opens in a new tab; a path (`/...`) in the same one.\n- **`'image'`**: `url` and `alt` (said to people who cannot see it); `fit` is\n `'contain'` (the whole picture, default) or `'cover'` (the tile filled).\n- **`'divider'`**: a line across the whole dashboard with its `title` over\n it, to start a section.\n- **`'picker'`**: the records of its `table` to choose from by name; the one\n picked shows its `fields` (default: the next four after its name) and an\n \"Open the record\" button.\n\nLinks and pictures go only to `https:`, `http:`, `mailto:` (a link) or a path\non the site: a `javascript:` or `data:` address is shown as words, not\nfollowed.\n\nA number, chart, list or progress tile with `pickedBy: { tile, field }` is\nnarrowed by that picker: once a record is picked, it counts only the records\nwhose link field `field` holds it (\"the deals of the account picked\"), and\n\"Every record\" counts them all again. The pick is the viewer's and is not\nsaved. Under the hood the tile's filter gains a condition of the kind\n`'linked'`:\n\n```ts\nconst narrowing = { column: 'account', kind: 'linked', op: 'hasAnyOf', value: ['a1'] } // the link holds record a1, by id\n```\n\nFor a table the page holds, the page applies it. For a table read from a\nserver (`serverRows`), the server must apply it too: `fieldFilterToSql` and\n`fieldFilterToPostgrest` answer that they cannot (the tile then shows what\nthe server sends), so a server of your own reads `kind: 'linked'` and matches\nthe link's record ids.\n\nIn the tile dialog, \"Shows\" offers these kinds too; a picker's tile picks its\nfields, and the tiles it can narrow offer \"Narrowed by\" with each picker the\ntile's table links to. Dividers take one row across the dashboard; the other\ntiles keep their sizes.\n\n## 10. A list for the phone\n\n```ts\nconst list: FieldView = {\n id: 'list',\n name: 'Feature list',\n type: 'list',\n listFields: ['status', 'teams', 'votes'],\n state: { sorting: [{ id: 'quarter', desc: false }, { id: 'votes', desc: true }], grouping: ['quarter'], hiddenColumns: [], advancedFilter: null },\n}\n```\n\nA list shows one record per entry: the primary field in bold, and under it\nthe fields in `listFields` (column ids, in order), each drawn as its cell\ndraws it, so Status is a colored pill and Teams are tags. An empty value is\nleft out. Without `listFields` the list shows the next three fields the grid\nshows. Long names stay readable at phone width, where a grid would cut them.\n\nThe list keeps the view's filter, sorts and groups. Here it is grouped by\nQuarter: a header per quarter with the field's name, its value and the\nnumber of records, \"Quarter Q4 2026 3\", and a click on the header folds the\ngroup. Within each quarter the most voted feature comes first. Grouped by\nmore fields (`grouping: ['quarter', 'status']`), each quarter holds a header\nper status, indented under it, with its own count and its own fold.\n\nA click on a record, or Enter, opens it. The list is one tab stop: Up and\nDown move between records and group headers at every level, Home and End\njump, Left and Right fold and unfold a group, and Left on a record or a\nfolded group moves to the group it is in. A record someone else changed and nobody here\nopened yet has a dot before its name.\n\nThe view bar has Hide fields, Filter, Group, Sort and \"Customize list\", which\nturns the fields under the name on and off and saves them in `listFields`.\n\n<div data-docs-demo=\"719-base-list-view\" data-height=\"620\"></div>\n\n## 11. An inbox of changes\n\n```ts\nconst inbox: FieldView = {\n id: 'inbox',\n name: 'Inbox',\n type: 'inbox',\n inboxDateField: 'start',\n listFields: ['status', 'lead'],\n}\n```\n\nAn inbox shows the records on the left and the picked one on the right: its\nfields, each one editable in place with the editor its cell uses, and its\nlatest changes, \"Cleo Park changed Status: Planned → In progress\". \"Expand\"\nopens the full record with its comments.\n\nThe list is newest first by `inboxDateField` (a date field's column id), so\n\"Audit log export\", which starts on January 11, is on top.\nRecords without a date go last. Without `inboxDateField` the inbox keeps the\nview's sort. The view's filter applies either way.\n\nA record someone else changed and nobody here has opened is unread: its name\nis bold and it has a dot. The changes come from a table with a `source` that\nhears of writes made elsewhere ([Changes made\nelsewhere](./data.md#changes-made-elsewhere)). Picking a record marks it read,\nas opening it in any view does, and \"Mark all read\" marks the rest. The count\nat the top says \"2 unread\" or \"All read\".\n\nDown or j picks the next record and Up or k the previous one; Enter opens the\nfull record. Narrower than 640px the inbox shows the list, and a picked record\nfills it with a Back button (Escape goes back too).\n\nThe view bar has Hide fields, Filter, Sort and \"Customize inbox\": the date\nfield it lists by and the fields under each name. A field hidden in the view\nleaves the record on the right too.\n\n<div data-docs-demo=\"720-base-inbox-view\" data-height=\"620\"></div>\n\n## 12. A tree of tasks\n\n```ts\nconst tree: FieldView = {\n id: 'tree',\n name: 'Work breakdown',\n type: 'tree',\n parentField: 'parent',\n}\n```\n\nA tree is a grid whose records nest under their parent: `parentField` is a\nlink field to the same table, and a record sits under the one record it\nnames, with an expander on the primary field. It opens unfolded. A record\nwhose link names several records is at the top level, so no record goes\nmissing. The records stay records: every cell edits as in a grid, and the\nfooter and the view bar count them all, folded or not.\n\nBuilding it by hand, every change is a write to `parentField`, so undo, the\ndatabase and automations see a plain edit:\n\n- **Add subtask** on a row's menu, and the \"+\" at the end of its name: a record\n under it, last, opened for its name. **Enter** on that name keeps it and\n starts the next one beside it; **Escape**, or Enter with no name, ends the\n list and the empty record goes.\n- **Insert record above** and **below** keep the row's parent: a sibling.\n- **Alt+Shift+Right** puts the record under the one above it at its level;\n **Alt+Shift+Left** moves it up a level.\n- A row dragged by its number onto the middle of another goes under it;\n between two rows, beside them; below the last, to the top level.\n\nA record never goes under itself or one of its own subtasks: the move is\nrefused with a notice.\n\nThe first time the view is kept, `parentField` gets its field back in the same\ntable, **Subtasks** (`addSubtasks(tables, tableId, fieldId)` from\n`@svgrid/enterprise/base` does the same in code). It lists the records under\neach one, so a count or rollup of it adds them up: subtasks, their hours,\ntheir progress. It reads one level, the records directly under a record.\n\nA filter or a search keeps each matching record under its parents: the\nparents that do not match stay in the tree, greyed, and are not counted (the\ngrid's `treeData.keepAncestors`). A sort orders each level and keeps\nsubtasks under their parent.\n\nCreating a tree view asks for the link field. A table without a link to\nitself cannot have one: the type is greyed out, and says why. A table read a\npart at a time (`serverRows`) has no tree, since a tree needs every record at\nonce: an existing tree view shows its records as a list.\n\n## 13. A pivot of effort\n\n```ts\nconst pivot: FieldView = {\n id: 'pivot',\n name: 'Hours by status and team',\n type: 'pivot',\n pivot: {\n rows: ['status'],\n cols: ['team'],\n values: [{ agg: 'count' }, { agg: 'sum', field: 'hours' }],\n },\n}\n```\n\nA pivot adds up the records the view shows (its filter applies) by the fields\ndown the side (`rows`, outermost first) and the one across the top (`cols`):\na count of records, or a number field's `'sum'`, `'avg'`, `'min'` or `'max'`.\nFields are grouped as a chart groups them: options in their order, people and\nlinked records by name, dates by month, and a record with two options counts\nunder each. Subtotals, a total row and, with a field across the top, a total\ncolumn come with it.\n\nIts own bar, over the table, changes the rows, the column field and the\nvalues; the view keeps them (`onViewsChange`). On a table read from a server\na page at a time, it adds up the records loaded and says how many of how many.\n\n## 14. Keep the views\n\n`onViewsChange` fires with the whole list when a view is created, renamed,\nduplicated or deleted, and about 400ms after the shown view's settings stop\nchanging. Switching views stores the one being left first. Store the list\nwherever the app stores things.\n\nIn the browser:\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, enableBase, type FieldView } from '@svgrid/enterprise/base'\n\n enableBase()\n const KEY = 'roadmap:views'\n const DEFAULT_VIEWS: FieldView[] = [{ id: 'all', name: 'All features', type: 'grid' }]\n\n function read<T>(key: string, fallback: T): T {\n try {\n const raw = localStorage.getItem(key)\n return raw ? (JSON.parse(raw) as T) : fallback\n } catch {\n return fallback\n }\n }\n function write(key: string, value: unknown) {\n try {\n localStorage.setItem(key, JSON.stringify(value))\n } catch {\n // Private mode or a full quota: the views still work, unsaved.\n }\n }\n\n let views = $state<FieldView[]>(read(KEY, DEFAULT_VIEWS))\n let activeView = $state<string>(read(`${KEY}:active`, ''))\n\n $effect(() => write(`${KEY}:active`, activeView))\n</script>\n\n<SvBase data={rows} {columns} primaryField=\"feature\" editable\n bind:views bind:activeView onViewsChange={(v: FieldView[]) => write(KEY, v)} />\n```\n\nOn a server, decide who owns a list.\n\n- **Per user.** Each person keeps their own list, so one lead's filter does\n not change another's. Seed it from the team's defaults the first time.\n- **Shared.** One list per table that everyone reads. Write it only for the\n people you allow; for everyone else, keep their changes in memory or in\n their own list. A shared \"My features\" view built on `ME` still shows each\n person their own records.\n\n```ts\ntype Scope = 'me' | 'team'\n\nasync function loadViews(scope: Scope): Promise<FieldView[]> {\n const res = await fetch(`/api/tables/features/views?scope=${scope}`)\n return res.ok ? ((await res.json()) as FieldView[]) : DEFAULT_VIEWS\n}\n\nfunction saveViews(scope: Scope, next: FieldView[]) {\n void fetch(`/api/tables/features/views?scope=${scope}`, {\n method: 'PUT',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify(next),\n })\n}\n```\n\n```svelte\n{#await loadViews('me') then loaded}\n <SvBase data={rows} {columns} primaryField=\"feature\" editable\n views={loaded} onViewsChange={(v: FieldView[]) => saveViews('me', v)} />\n{/await}\n```\n\nOr mount at once and swap the list in when it arrives. When `views` or\n`activeView` changes from outside and the shown view is not the one the grid\nhas, the bar applies it. It never stores the grid's settings into a view it\nhas not applied yet.\n\n```svelte\n<script lang=\"ts\">\n let views = $state<FieldView[]>(DEFAULT_VIEWS)\n let loaded = false\n loadViews('me').then((v) => {\n views = v\n loaded = true\n })\n</script>\n\n<SvBase data={rows} {columns} primaryField=\"feature\" editable\n bind:views onViewsChange={(v: FieldView[]) => loaded && saveViews('me', v)} />\n```\n\nThe `loaded` check matters: about 400ms after mount the bar stores the\ndefault view's settings, and that save must not replace the list on the\nserver before the real one is in.\n\nWith several tables (`<SvBase bind:tables>`), each table keeps its own\n`views`, and `onTablesChange` hands back the whole list of tables, views\nincluded.\n\n## Personal and locked views\n\nOnce several people share a table, two more keys on a view matter:\n\n```ts\nconst views: FieldView[] = [\n // Only Ana sees it, under \"My views\" in the views menu.\n { id: 'ana-open', name: 'My open tasks', type: 'grid', personal: 'u1', state: { /* ... */ } },\n // Everyone sees it; nobody changes its settings until someone unlocks it.\n { id: 'report', name: 'Leadership report', type: 'grid', locked: true, lockedBy: 'u2', state: { /* ... */ } },\n]\n```\n\n- **`personal: userId`** lists the view only for that person, read from\n `setCurrentUser`. With nobody signed in every view is listed. \"Create\" in\n the views menu has a \"Personal view: only I see it\" box once someone is\n signed in.\n- **`locked: true`** keeps the view's filter, sorts, groups, hidden fields,\n colors and row height as saved. Its settings buttons are off, nothing is\n saved into it, and the bar shows \"Locked\" with who locked it. A sort from a\n column header still works for the moment; the bar then says \"Locked, not\n saved\" with a Reset. Records stay editable. A locked view cannot be\n deleted, and a copy of it starts unlocked.\n\nThe lock button in the views menu locks the view as the grid shows it now,\nor unlocks it. `lockViews={false}` on `SvBase` removes it for people who may\nnot lock views. Both keys come back through `onViewsChange` and\n`onTablesChange`, so the app stores a personal view with its owner the same\nway as the others.\n\n<div data-docs-demo=\"710-base-personal-locked-views\" data-height=\"620\"></div>\n\n## On a phone\n\nWhen a table is narrower than 600px (its own width, not the window's), a\ngrid view shows each record as a card: the primary field, then the next four\nfields the view shows, each name beside its value so several records fit on\nthe screen, in the view's filter and sort. A tap opens the\nrecord, \"+\" adds one, and on a phone screen the opened record fills it. The\nview bar keeps its icons and the tab bar its tabs.\n\nA card keeps what a row can do. A long press, the button on the card, a\nright-click, the Menu key or Shift+F10 opens the record's menu: expand, comment,\nselect, insert above or below, duplicate and delete. A record selected this way\nshows on its card, as a ring on its list row, and in the selection bar. Copy and\npaste work on a cell, so they stay with the table. A gallery view and a list view\nhave the same menu.\n\nFields are added and changed from the fields button (Hide fields), since the\ncards have no column headers: \"Add a field\" at the foot of its list, and a\npencil on each field to rename it or change its type. Both are there wherever\nfields may be changed (`columnAdder`, off without `canEditSchema`), on any\nscreen, and open the same field editor as the header's \"+\" and field menu.\n\nA Kanban lane takes the table's width, the next lane a swipe away and\nsnapped into place. A calendar opens in its agenda, the days listed one under\nanother, since a month of seven columns has no room for a title; Month, Week\nand Day are a tap away. Gallery cards stand one per row, and a form is one\ncolumn at any width.\n\n`phoneLayout` on `SvBase` moves the breakpoint (`phoneLayout={480}`), turns\nthe cards on at every width (`true`) or keeps the grid (`false`).\n`phoneGrid=\"grid\"` keeps a grid view a grid on a phone while the other views\nkeep their phone layouts: a spreadsheet to scroll both ways, its first field\npinned and drawn at most about two fifths of the width\n(`maxPinnedColumnWidth` on the grid, the field's own width kept), with \"+\"\nto add a record. A tap selects a cell and a second tap edits it.\n\n<div data-docs-demo=\"713-base-phone-layout\" data-height=\"720\"></div>\n\n## Search across tables\n\nThe view bar's search finds records in the view on screen. The box at the\nend of the tab bar searches every table of the base. With the focus in the\nbase, Ctrl+K puts the cursor in it, and so does \"/\" outside the grid and any\ntext box. Neither is taken from the rest of the page.\n\nIt reads a field the way its cell shows it: a single select by its option's\nlabel, a person by name, a date as the field writes it, a link by the names\nof the records it links to, a formula or lookup by its result. Numbers,\ncurrency, percents, durations, ratings, checkboxes, buttons, rollups and\ncounts are not searched. Case and accents do not count: \"tomas\" finds\n\"Tomás\".\n\nEvery word of the query has to be in the record, in one field or another.\nThe results are grouped by table, five records each with \"N more in Deals\"\nunder them, each with its name, the field the words were found in and the\nwords marked. Records rank by:\n\n1. the whole query in one field, before words spread over several;\n2. the primary field, before the others;\n3. a field that is the query, then one that starts with it, then one with a\n word that starts with it, then one that holds it anywhere.\n\nTables are listed by their best record. Up and Down move through the list,\nEnter or a click shows the record's table and opens the record, and Escape\ncloses the list, then clears the box. `search={false}` on `SvBase` leaves the\nbox out. A shared base (`readOnly`) keeps it, over the tables and fields the\nshare shows.\n\nThe same search runs without the box, for a command palette of your own or\non a server:\n\n```ts\nimport { searchBase } from '@svgrid/enterprise/base'\n\nconst groups = searchBase(tables, 'northwind proposal', { limit: 10 })\nfor (const g of groups) {\n console.log(g.name, g.total)\n for (const hit of g.hits) console.log(hit.rowId, hit.title, `${hit.fieldName}: ${hit.text}`, hit.marks)\n}\n```\n\nEach hit has the table and record ids, the record's name (`title`), the\nfield that matched (`field`, `fieldName`, `primary`), its text cut around\nthe match when it is long, and `marks`, the `[start, end)` spans of the\nwords in that text. `field: (table, column) => boolean` in the options picks\nthe fields to search. To open a hit in `SvBase`, show its table\n(`bind:activeTable`) and call `openRecord({ api, rowId })` once that table's\ngrid has called `onApiReady`; the box does this for you.\n\n<div data-docs-demo=\"718-base-search-all-tables\" data-height=\"620\"></div>\n\n## View types and the keys they read\n\n| Type | Keys | View bar buttons |\n|---|---|---|\n| `'grid'` | `state`, `rowHeight`, `color` | Hide fields, Filter, Group, Sort, Color, Row height |\n| `'kanban'` | `stackBy`: a single select, or a user field with one person | Hide fields, Filter, Sort |\n| `'calendar'` | `dateField`, `endField` (optional), `color` | Hide fields, Filter, Sort, Color |\n| `'timeline'` | `dateField`, `endField`, `laneField` (a single select, person or link field), `zoom` (`day`, `week`, `month`, `year`), `color` | Hide fields, Filter, Sort, Color, Customize timeline |\n| `'gantt'` | `dateField`, `endField`, `progressField`, `dependencyField`, `zoom`, `color` | Hide fields, Filter, Sort, Color, Customize Gantt |\n| `'tree'` | `parentField`: a link field to the same table | Hide fields, Filter, Sort, Color, Row height |\n| `'gallery'` | `coverField`: an attachment field | Hide fields, Filter, Sort |\n| `'chart'` | `chart`: `kind`, `x`, `y`, `aggregation` | Filter, Customize chart |\n| `'pivot'` | `pivot`: `rows`, `cols`, `values` (`{ agg, field }`) | Filter; its own bar for rows, columns and values |\n| `'list'` | `listFields`: the fields under each name | Hide fields, Filter, Group, Sort, Customize list |\n| `'inbox'` | `inboxDateField`: a date field, newest first; `listFields` | Hide fields, Filter, Sort, Customize inbox |\n| `'form'` | `formFields`, `formRequired`, `formTitle`, `formDescription`, `formSubmitLabel`, `formConditions`, `formPrefill` | none |\n| `'dashboard'` | `dashboard`: the tiles, in order | none |\n| any type | `personal`, `locked`, `lockedBy` | off while `locked` |\n\nEvery type also keeps `state` (filter, sorts, groups, hidden fields, column\norder, widths, pinning) and switches with the grid's own state, so a filter\nset on the board is still there when you come back to it. The search text is\nnot part of it. The views menu's \"Create\" offers each type `SvBase` can show\nand greys out one the table cannot: a Kanban needs a single select, a\ncalendar a date field, a chart a field to group by. A new view starts with no\nfilter, sorts or groups and every field shown.\n`viewTypes={['grid', 'kanban', 'calendar']}` on `SvBase` limits what\n\"Create\" offers.\n\nA Gantt chart (`type: 'gantt'`) is one bar per record with a task table beside the bars.\n\"Create\" offers it as Gantt in every base, and its renderer loads the first\ntime one is shown. A timeline (`type: 'timeline'`) is the other kind of plan:\nrecords in lanes by `laneField`, several to a lane, as Airtable's Timeline view\ndraws them; an Airtable Timeline view converts to it, and an Airtable Gantt to a Gantt. Its bars take the view's colors, `progressField` is a percent field drawn as each\nbar's fill, and `dependencyField` is a link field to the same table naming\nwhat each record waits for, drawn as arrows.\n\nA record's dates are its own: a drop on a Sunday stays on the Sunday. By keyboard a\nbar works as a calendar event does: Space picks it up, Left and Right carry it a day\n(Shift, a week), Space puts it down and Escape puts it back. Enter opens the record,\nShift+F10 opens its menu, and Delete asks first, as a row's menu does.\n\n## When an edit changes where a record belongs\n\nA view's filter, sort and groups apply again after an edit, with one pause. In a\ngrid the row you are working in stays where it is while it is the active row, so\nit does not leap away under the cursor; it takes its place when you move to\nanother row, click outside the grid, or close its record. The record count follows\nat the same moment. An undo, a paste and a fill apply at once. A board, a calendar,\na timeline, a gallery and a list show the change as soon as it is made, or when a\nrecord dialog closes. On a table read a page at a time the database is asked again\nat that moment, once it has the edit.\n\n## The view bar, panel by panel\n\n- **Views menu** (the view's name): switch, rename, duplicate (\"Roadmap by\n quarter copy\") and delete. Delete asks in the view's own row, and nothing moves\n until the answer. A deleted view goes to the trash and is one step of undo. The\n last view cannot be deleted.\n- **Hide fields**: a switch per field, a search, hide all and show all, and\n drag to reorder. The list keeps its order while you switch fields, and hidden\n fields sit where they are in the table. The primary field is always shown.\n- **Filter**: \"Where [field] [operator] [value]\" rows joined by \"and\" or\n \"or\", and condition groups. Each change filters at once. A condition still\n missing its value filters nothing.\n- **Group**: up to three fields, each with a direction.\n- **Sort**: fields in order, each with a direction labeled for its type (\"1\n → 9\", \"A → Z\", \"first → last\" for a single select). Attachment and button\n fields are not offered.\n- **Color**: None, Select field (a single select's option colors) or\n Conditions in order.\n- **Row height**: Short 34, Medium 56, Tall 88, Extra tall 128.\n `rowHeights` on `SvBase` or `SvBaseViewBar` sets the list.\n- **Search**: in a grid view, the grid's find bar (Ctrl+F) that marks every\n match. In a board, calendar, gallery, list or inbox, a \"Find a record\" box\n that narrows the records. Switching views clears it.\n- **Search all tables**: the box in the tab bar (below).\n\nA button with something set says so and is tinted. With `fieldMenu` on, each\ncolumn's menu adds \"Filter by this field\" and \"Group by this field\", which\nopen the bar's panel with the new condition or group in it.\n\n## Filters in code\n\n`filterKindOf(columnDef)` gives the kind a field filters as, and\n`operatorsFor(kind)` the operators the panel offers for it, in menu order.\n[Filter conditions](../fields.md#filter-conditions) maps each field type to\nits kind.\n\n| `kind` | `op` values | `value` |\n|---|---|---|\n| `'text'`, `'link'` | `contains`, `notContains`, `is`, `isNot` | a string; a link compares the linked records' names |\n| `'number'` | `eq`, `neq`, `lt`, `gt`, `lte`, `gte` | a number |\n| `'select'` | `is`, `isNot` | one option value, or a person's id (or `ME`) for a user field |\n| `'select'` | `isAnyOf`, `isNoneOf` | an array of them |\n| `'multi'` | `hasAnyOf`, `hasAllOf`, `isExactly`, `hasNoneOf` | an array of option values or ids |\n| `'checkbox'` | `is` | `true` or `false` |\n| `'date'` | `is`, `isBefore`, `isAfter`, `isOnOrBefore`, `isOnOrAfter` | `{ mode: 'today' }`, with `mode` also `'tomorrow'`, `'yesterday'`, `'oneWeekAgo'`, `'oneWeekFromNow'`, `'oneMonthAgo'`, `'oneMonthFromNow'`; or `{ mode: 'exactDate', date: '2026-11-01' }` |\n| `'date'` | `isWithin` | `{ span: 'pastWeek' }`, with `span` also `'pastMonth'`, `'pastYear'`, `'nextWeek'`, `'nextMonth'`, `'nextYear'`; or `{ span: 'pastDays', days: 14 }`, `{ span: 'nextDays', days: 14 }` |\n| `'files'` | `contains` (file name contains) | a string |\n\nEvery kind except checkbox also takes `isEmpty` and `isNotEmpty`, with no\nvalue. A few rules from the code:\n\n- An empty number cell is no number: it matches only `neq`.\n- Dates compare whole days. A bare `'2026-11-01'` is that day where the user\n is, and \"within the past week\" runs from 7 days ago to today.\n- A user condition holds the person's id (`'u2'`), not the name, or `ME`\n for whoever is signed in.\n- A link condition sets `table` to the linked table's id, so it can match\n records by name.\n\nSet a filter on the shown view with `api.setAdvancedFilter(filter)`; the\nview keeps it like one set in the panel.\n\n## Row colors: by field or by conditions\n\n```ts\nimport type { ColorSetting } from '@svgrid/enterprise/base'\n\nconst byStatus: ColorSetting = { mode: 'field', field: 'status' }\nconst byRisk: ColorSetting = {\n mode: 'conditions',\n rules: [\n { color: '#f82b60', condition: { column: 'status', kind: 'select', op: 'is', value: 'Blocked' } },\n { color: '#fcb400', condition: { column: 'target', kind: 'date', op: 'isBefore', value: { mode: 'today' } } },\n ],\n}\n```\n\nBy field, each row takes its option's color, and the row header's title says\nthe option, so the color is never the only signal. A multiple select colors\nby its first value. By conditions, the first rule that matches wins: a\nblocked feature is red even when it is also late. A condition is tested as\nthe filter tests it: on the value the cell shows, so a formula, lookup,\nrollup or count field works, and a condition still missing its value colors\nnothing. A calendar colors its events by a single select only; a Gantt's bars\ntake either kind.\n\nThe color is a 3px stripe on the row header, unless the `rowColor` prop on\n`SvBase` sets a `target` (`'bar'` or `'row'`): a view's colors use it too. A\nview without `color` shows the `rowColor` prop's colors until someone picks\ncolors for it in Color. `{ mode: 'none' }` turns the colors off in that view.\n\n## Summaries in the footer and in group headers\n\nWith `summary` on, a click on a field's footer cell picks its summary: sum,\naverage, median, min, max or range for numbers; checked, unchecked or percent\nchecked for a checkbox; earliest, latest or the date range in days for dates;\nempty, filled, unique, percent empty or percent filled for any field. The\nresult is written as the field writes values. The choice is stored in the\nfield's `fieldProps.summary` and reported through `onColumnChange`; see\n[Summaries at the bottom](../fields.md#summaries-at-the-bottom).\n\nGroup headers show the same summaries over that group's records. Both leave\nout records the filter hides, even in a collapsed group.\n\n## The view bar over your own grid\n\n`SvBaseViewBar` is the bar alone, for a page that lays out its own\n`<SvGrid>`:\n\n```svelte\n<script lang=\"ts\">\n import { SvGrid } from '@svgrid/grid'\n import { SvBaseViewBar, enableBase, type FieldView } from '@svgrid/enterprise/base'\n\n enableBase()\n // Raw: the bar finds its grid by the api object itself, and a proxy is another object.\n let api = $state.raw<any>(null)\n let views = $state<FieldView[]>([\n { id: 'all', name: 'All features', type: 'grid' },\n { id: 'board', name: 'Status board', type: 'kanban', stackBy: 'status' },\n ])\n let activeView = $state('all')\n</script>\n\n{#if api}\n <SvBaseViewBar {api} bind:views bind:activeView\n rowHeights={[{ label: 'Compact', height: 32 }, { label: 'Roomy', height: 64 }]} />\n{/if}\n<SvGrid data={rows} {columns} primaryField=\"feature\" editable containerHeight={600}\n onApiReady={(a) => (api = a)} />\n```\n\nIts \"Create\" offers grid, Kanban and calendar (and Gantt once enabled). It\nloads the board, calendar and gallery renderers the first time a view of\nthat type is shown, and opens the record and the \"Delete record?\" question\nfor a card's menu. Chart and form views are drawn by `SvBase`, not by the\nbar, so leave them out of `viewTypes` here, or draw `SvBaseForm` yourself\nwhen a form view is active.\n\n## Sections in the views menu\n\nA table with many views groups them in sections, as Airtable does: a shared\nview's `section` lists it under that heading in the views menu, after the\nviews with none and before \"My views\". A heading folds its views, except the\none on screen. Whoever may manage views moves one into a section, or out of\nit, with the folder button on its row; the box offers the sections there are.\n\n```ts\nviews: [\n { id: 'all', name: 'All tasks', type: 'grid' },\n { id: 'q1', name: 'Q1 plan', type: 'grid', section: 'Planning' },\n { id: 'late', name: 'Late', type: 'grid', section: 'Reports' },\n]\n```\n\n## Your own actions on a view\n\n`setViewActions` adds buttons of the app's to each saved view in the views\nmenu, beside rename and duplicate, for everyone who sees the view: \"Subscribe\nin your calendar app\" on a calendar view, \"Copy a link\", \"Export\". The\nfunction is called for each view with its table's id and answers the\nview's actions (none: `[]`).\n\n```ts\nimport { setViewActions } from '@svgrid/enterprise/base'\n\nsetViewActions((view, tableId) =>\n view.type === 'calendar'\n ? [{ id: 'feed', label: 'Subscribe in your calendar app', icon: 'M4 6h16v14H4zM4 10h16M8 3v4M16 3v4', run: () => openFeed(tableId, view.id) }]\n : [],\n)\n```\n\n`icon` is an SVG path on a 24 by 24 box. `setViewActions(null)` takes them\naway; a function that throws gives none.\n\n## Your own actions on a record\n\n`setRecordActions` does the same for records: the app's actions show in a\nrecord's right-click menu (a grid row, a card) and at the top of the record\nview, and run with the table's id, the record's id and the record.\n\n```ts\nimport { setRecordActions } from '@svgrid/enterprise/base'\n\nsetRecordActions((tableId) => [\n { id: 'print', label: 'Print', icon: 'M4.5 6V2.5h7V6M4.5 12H3V7.5h10V12h-1.5M5 10h6v4H5z', run: ({ tableId, rowId }) => window.open(`/print/${tableId}/${rowId}`) },\n])\n```\n\n`icon` is an SVG path on a 16 by 16 box. `setRecordActions(null)` takes them away.\n\nIn the record view the function is also told the record it shows, so an\naction can depend on it: \"Stop notifications\" on a record you follow, \"Notify\nme\" on one you do not. The right-click menu tells it no record; return none\nthere for actions that need one.\n\n```ts\nsetRecordActions((tableId, record) =>\n record ? [{ id: 'follow', label: followed.has(record.rowId) ? 'Stop notifications' : 'Notify me', run: ({ rowId }) => toggleFollow(rowId) }] : [],\n)\n```\n\n## Pitfalls\n\n- **A new view from \"Create\" starts with `color: { mode: 'none' }`**, so it\n hides the `rowColor` prop's colors. A new calendar or Gantt is the\n exception: it starts colored by the first single select. Pick colors in\n Color, or declare the view in code without `color`.\n- **`color.field` is the data field; the other keys are column ids.** They\n differ only when a column sets an `id`.\n- **Summaries belong to the field, not the view.** Picking \"Average\" in one\n view changes every view's footer and group headers.\n- **Save views only after they load.** See the `loaded` check in step 12.\n\n## Next\n\n- [Linked records](./linked-records.md): link Features to Feedback and chart\n or filter by the linked names.\n- [Formulas](./formulas.md): computed fields a view can sort, group and chart\n by.\n- [Forms](./forms.md): required fields, the thank-you screen and forms\n outside the base.\n- [Collaboration](./collaboration.md): comments, people and who changed what.\n- [Automations](./automations.md): conditions written with this same filter.\n- [Keep a base in a database](./data.md): load the tables from Postgres,\n Supabase or your API and write every change back.\n"
|
|
5308
5308
|
},
|
|
5309
5309
|
{
|
|
5310
5310
|
"slug": "help/benchmarks",
|
|
5311
5311
|
"path": "docs/help/benchmarks.md",
|
|
5312
5312
|
"title": "Performance benchmarks",
|
|
5313
5313
|
"section": "Help",
|
|
5314
|
-
"markdown": "# Performance benchmarks\n\nEvery number on this page is produced by a checked-in script:\n\n| Table | Command | Where it runs |\n| -------------------------- | --------------- | ------------- |\n| Bundle size | `pnpm size` | Node |\n| Sort / filter / group, memory | `pnpm bench` | Node |\n| First paint, scroll | `pnpm bench:dom` | Chromium |\n\nAn earlier version of this page published a table of timings that no\nscript produced, and told readers to reproduce them with a `pnpm bench`\ncommand that did not exist. Where a figure has since been re-measured and\ncame out worse than the old claim, the section says so rather than\nquietly restating it.\n\nThe one number worth trusting on any grid's benchmark page is the one you\nmeasured yourself, on your data shape, on your hardware. The\n[benchmark harness recipe](../recipes/benchmark-harness.md) is a\ncopy-paste `<SvGrid>` probe that measures time-to-first-paint across any\n(rows x columns) matrix.\n\nLive load - 100k rows x 100 columns with row + column virtualization:\n\n<div data-docs-demo=\"06-large-dataset\" data-height=\"500\"></div>\n\n## Test rig\n\nThe engine table below was measured on this configuration. Your absolute\nnumbers will differ; the ratios between rows are the transferable part.\n\n| Component | Spec |\n| --------- | ------------------------------------------------ |\n| Machine | Developer workstation, win32 x64. Not a dedicated bench rig |\n| Engine | Node v24.18.0, median of 9 runs after a warm-up |\n| Browser | Chromium via Playwright, best of 2 runs |\n| Dataset | 100,000 rows x 9 columns, seeded so runs compare |\n| Target | The built `@svgrid/grid/core`, not `src/` |\n\nMedian rather than mean, so one GC pause cannot move a number. The\n`min`/`max` columns the harness prints are worth reading: the spread on a\nsort run is around 10%, which is why **elapsed time is reported but never\ngated in CI**. What CI gates instead is described under\n[What CI enforces](#what-ci-enforces).\n\n## Bundle size\n\nProduction build, gzipped, Svelte excluded as a peer. The table is\ngenerated from `docs/_data/svgrid-size.json` by `node tools/sync-guide-facts.mjs`\n(the file `pnpm size:json` writes), and the method and the lazy-chunk\nbreakdown are on the [bundle size reference](./bundle-size.md). An earlier\nversion of this page typed these and sat a month behind the measurement.\n\n<!-- size:start -->\nRe-measured **10 Nov 2026** at `@svgrid/grid` 3.0.34 with the script that ships in the repo (`pnpm size:json`):\n\n| Target | Base JS (gzip) | CSS (gzip) | Loaded on demand |\n| --- | ---: | ---: | ---: |\n| Headless core (`createSvGrid`) | **3.2 KB** | - | - |\n| Headless subpath (`@svgrid/grid/core`) | **10.2 KB** | - | - |\n| Full render component (`<SvGrid>`) | **99.6 KB** | **11.4 KB** | **206.3 KB** |\n| Standalone chart (`<SvChart>`) | **71.9 KB** | - | **16.0 KB** |\n<!-- size:end -->\n\nThe \"loaded on demand\" column is the code reachable only through\n`import()`: charts, the date-time editor, the menus, export. Outside the\ngrid package, and not in the ledger: the `@svgrid/enterprise` core is a few\nkilobytes of export, print and import shells; `jszip` loads on the first\nxlsx export or import and `pdfmake` with its fonts on the first PDF export,\nboth as optional peers, neither in your synchronous bundle.\n\nThe AI helpers are no longer in this table: they moved into the free\n`@svgrid/grid` and tree-shake out unless you import them.\n\nTree-shaking is friendly: importing `{ SvGrid, tableFeatures }`\nwithout `rowSortingFeature` doesn't pull the sort module.\n\n## First paint\n\n**Measured.** Run `pnpm bench:dom`. Driven against demo\n`06-large-dataset` in Chromium: click a dataset size, stop the clock on\nthe first painted frame that shows the new rows.\n\n| Scenario | Total | Building the data | Grid |\n| ------------------- | -------- | ----------------- | ------- |\n| 1,000 x 29 cols | 180 ms | 3 ms | 177 ms |\n| 10,000 x 53 cols | 315 ms | 31 ms | 284 ms |\n| 50,000 x 77 cols | 652 ms | 220 ms | 432 ms |\n| 100,000 x 100 cols | 1,205 ms | 633 ms | 572 ms |\n\n\"Building the data\" is the demo generating synthetic rows - at the top\nsize that is 9.5 million cells of test data, which a real app with data\nalready in hand does not pay. \"Grid\" is the remainder.\n\n**\"Grid\" overstates the grid's own cost, and by a lot.** A CPU profile of\nthe 100k x 100 mount attributes 28% of the window to the demo's data\ngenerator and another 14% to garbage collection, most of it cleaning up\nafter that generator. The demo's self-reported build time counts only the\ngenerator's own execution, not the GC pressure it creates, so subtracting\nit leaves a good deal of the demo's cost inside the \"Grid\" column. Roughly\nhalf the total is the harness rather than the component.\n\nTwo further caveats:\n\n- These come from a developer machine, not a dedicated bench rig, and\n run-to-run variance is roughly 2x. Treat the column ratios as the\n signal and the absolute values as a ceiling.\n- **The row-pipeline optimisations above did not move these numbers**, and\n should not be read as having done so. Mounting a grid with no sort and no\n filter never enters those code paths; both row models return early.\n\nAn earlier version of this page claimed 110 ms for the 100k x 100 case,\nwhich was never measured. Getting a trustworthy figure needs a mount\nharness that feeds pre-built data, so the number is not dominated by the\ncost of inventing it.\n\n## Scroll performance\n\n**Measured.** Run `pnpm bench:dom`. Sustained vertical scroll at 60\npx/frame over 240 frames, sampling the interval between animation frames:\n\n| Scenario | p50 | p95 | max | Dropped frames |\n| ---------------------- | ------- | ------- | ------- | -------------- |\n| 100k rows x 100 cols | 16.7 ms | 17.7 ms | 18.8 ms | 0 of 240 |\n| 1,000,000 rows x 9 cols | 16.7 ms | 18.1 ms | 19.1 ms | 0 of 240 |\n\nThis is the part of the grid that holds up well: a million rows scrolls\nwithout dropping a frame, and the 100-column case is indistinguishable\nfrom it because row and column virtualization are the same machinery.\n\nRead the numbers correctly, though. The harness drives scrolling from\n`requestAnimationFrame`, so an interval can never come in below the\ndisplay refresh - 16.7 ms on a 60 Hz panel is the floor, not a\nmeasurement of how cheap a frame is. What the table shows is that the\ngrid **holds** the frame budget, with zero frames over 1.5x the median.\nIt cannot show headroom above 60 fps.\n\nAn earlier version of this page claimed a p95 of 8 ms and \"~120 fps\".\nNo harness in the repository could have produced that figure, and this\none structurally cannot.\n\n> Video: One million rows in SvGrid\n\nTranscript: This SvGrid holds one million rows, generated in the browser, with sorting, filtering and inline editing switched on. Rows are virtualized, so only the ones in view are drawn. Scroll, and the frame rate stays flat. Jump anywhere in the set. The row numbers show the scale, and the grid keeps every row reachable. Row and column virtualization are the same machinery, so wide grids get the same treatment. Nothing to configure.\n\n## Sort, filter, group\n\n**Measured.** Run `pnpm bench` to reproduce. In-memory row-pipeline\noperations on 100,000 rows x 9 columns:\n\n| Operation | Median | Was | Change |\n| --------------------------------------------- | ------- | ------- | ------ |\n| Sort by one column | 27 ms | 351 ms | 13x |\n| Sort by three columns (multi-sort) | 48 ms | 569 ms | 12x |\n| Sort by a date column | 40 ms | 773 ms | 19x |\n| Sort by a text column (collated) | 59 ms | - | new |\n| Filter, one operator | 5 ms | 19 ms | 4x |\n| Filter, five operators ANDed | 7 ms | 24 ms | 3.5x |\n| Filter via the compiled Excel filter | 3 ms | - | new |\n| ... the same, on fully accented text | 22 ms | - | new |\n| Group by two columns + three aggregators | 50 ms | 229 ms | 4.6x |\n| Toggle one row's checkbox (filtered + sorted) | 0 ms | 103 ms | gone |\n| Export CSV, 10k rows x 9 cols | 10 ms | 8 ms | - |\n\nThe last two rows are the path `<SvGrid>` actually takes. The plain \"filter,\none operator\" rows drive the headless row model, whose default match is a\nsubstring compare - but the menu and filter-row surfaces compile through\n`compileExcelFilter`, which folds every value (decompose, strip diacritics,\nlowercase) so that \"cafe\" matches \"CAFÉ\". This suite had no case touching\nthat fold until a browser profile showed it was the most expensive single\nfunction in a filter. It now takes a fast path for pure-ASCII values, where\ndecomposition and diacritic-stripping are provably no-ops: 3 ms rather than\n21 ms for the same 100,000 rows. Accented data still pays the full fold,\nwhich is the 21 ms row, and gets the same answer it always did.\n\nEach case runs in a **fresh process**. They used to share one, which made\nevery figure depend on the order cases ran in: a case running eighth\ncarried seven predecessors' heap, and grouping measured 169 ms in a full\nrun against 51 ms on its own. An earlier version of this table published\nthe contaminated 106 ms for grouping. Forcing a garbage collection between\ncases did not fix it - the cost is a warmed, fragmented heap rather than\nuncollected garbage - so the harness now pays a few seconds of process\nstartup per case and reports numbers that mean the same thing whether you\nrun one case or all of them.\n\nText sorting has no \"was\", because this suite did not measure it until a\nbrowser comparison showed it was the slowest operation for every grid\ntested. Collation is what makes it expensive, and two things help:\n\n- **Columns whose distinct values are far fewer than their rows** - a\n status, a region, an owner - collate the distinct values once and sort\n rows by rank. That is what took the three-column case to 48 ms. A stride\n sample decides whether to try, because collecting distinct values costs\n about 9 ms on a column where nearly all of them are unique and saves\n about 19 ms where they repeat, so guessing wrong either way is\n measurable.\n- **`localeCompare` rather than a hoisted `Intl.Collator`.** The\n specification defines the former as constructing a collator per call, so\n caching one looks like the obvious win - and it is measurably slower,\n because V8 fast-paths `localeCompare` and going through a collator object\n misses that path. 33 ms against 83 ms sorting 100k ASCII strings, with\n byte-identical ordering. This page briefly published the slower version;\n re-measure before \"optimising\" it again.\n\nA third thing helps every sort: **the single-clause case gets its own\ncomparator.** Most sorts are one column, and the comparator runs O(n log n)\ntimes - 1.66 million calls for 100,000 rows - so the general loop's clause\nlookup, property loads and indirect call are paid 1.66 million times for\nvalues that never change. Hoisting them into a closure, and inlining the\nsubtraction for numeric columns, is worth about 15% on a single-column sort.\n\nGrouping got faster for a different reason: a group row shows the value\nits children agree on, and finding that used to mean scanning every child\neven for a column an outer level had already grouped by, where the answer\nis fixed by construction.\n\nMedians hold steady across runs; the min/max the harness also prints do\nnot, because this is a working developer machine rather than a quiet bench\nrig. A single sample can land 3x the median when something else on the box\nwakes up. That noise is the whole reason CI gates counters instead.\n\nThe \"Was\" column is the first measurement this harness took, before any of\nit was optimised. Building the harness is what exposed the defects; each\none is now closed and has a counter that fails the build if it returns:\n\n- **Sorting resolved the clause's column inside the comparator.** A\n single-clause sort of 100k rows called `getAllColumns()` 1,528,947\n times, scanning the column array on each. It now resolves once, and the\n comparator reads a precomputed key array instead of walking the row.\n- **The date comparator allocated two `Date` objects per comparison.**\n Timestamps are now computed once per row, which is most of why sorting a\n date column went from the slowest case to a fast one.\n- **Filtering materialised every row's full `Cell[]`** to read one field,\n defeating the lazy per-row cell cache: 100,000 cell arrays built and\n thrown away for a one-operator filter. Now zero.\n- **Toggling a checkbox re-ran the whole pipeline.** `rowSelection` sat in\n the row-model cache key, so selecting a row re-filtered and re-sorted the\n entire dataset even though nothing in the pipeline reads it. Selection is\n now free.\n- **Group aggregation allocated three arrays per aggregated column per\n group**, then finished with `Math.min(...values)`. It is a single pass\n now. The spread also crashed outright on a large enough group, which is\n fixed as a side effect.\n- **Text sorting collated on every comparison.** Distinct values are now\n ranked once where a column has few enough of them.\n\nNumbers here will move; the command that produces them will not.\n\n## Streaming updates\n\n**Measured.** Run `pnpm bench --case=tick-1k-of-100k-sorted` to reproduce.\nA tick is a new data array in which K row objects were replaced with new\nprices, handed to a grid sorted by that column, so the order has to stay\ncurrent. 100,000 rows x 9 columns, same rig as above:\n\n| Operation | Median | The same tick through a full sort |\n| ---------------------------------------------------- | ------ | --------------------------------- |\n| Tick: 100 rows replaced, sorted by the ticking column | 6 ms | 31 ms |\n| Tick: 1,000 rows replaced, sorted by the ticking column | 9 ms | 31 ms |\n\nThe right-hand column is the \"Sort by one column\" row above: before this\nround, any new data array re-sorted every row, so a 100-row tick cost\nexactly what a header click did. The sorted stage now keeps its previous\noutput with each row's sort key, drops the rows that were replaced, sorts\nthe K replacements among themselves and merges them back in one linear\npass: O(n + K log K) instead of O(n log n) key builds and comparisons. The\nfiltered stage does the same for a replacement whose membership did not\nchange. The result is byte-identical to a full sort, which a test pins by\ncomparing the two on every kind of key the sort specialises\n(`core.tick-repair.test.ts`).\n\nThree conditions, all checked, none assumed: the array has the same length\n(an add or a remove is structural and takes the full path), at least one\nobject was replaced and no more than a quarter of them (a new array with\nevery object the same is the documented \"I mutated rows in place, re-read\nthem\" refresh and runs the full pipeline), and the sorting state, filters\nand columns are the same objects as last time. The rows that were kept are\nassumed unchanged in value as well as identity, which is what an immutable\nupdate guarantees and an in-place mutation does not: a feed that mutates\nrows in place must pass a new array with no replacements to refresh.\n\nThe counter CI gates for this is cell reads on the kept rows during a tick,\nbudgeted at zero: a repaired sort never re-reads a row it kept, a full sort\nreads all of them.\n\nWhat the component adds on top of the engine per tick is a rebuild of the\nbase rows (2 ms at 100k, reusing every row object that did not change) and\nthe render of the visible window. Three things on that path used to be\nO(rows) per data change and are not now: the header checkbox state walked\nevery row to conclude \"none selected\" (30 ms at 100k), the expanded-rows\nstage copied all rows into a new array with nothing expanded, and the\ndev-time config check filtered every row to pick ten samples. The browser\nharness in the [comparison](./comparison.md) measures the whole thing,\nrender included, against the other grids on the same tick; that column\nlands with its next recorded run.\n\n## Spreadsheet engine\n\n**Measured.** Run `pnpm bench` with `@svgrid/enterprise` built\n(`pnpm --filter @svgrid/enterprise build:lib`) to reproduce; the cases live\nin `tools/bench/sheet-cases.mjs`. These were taken on a CI-class Linux\ncontainer with Node v22, not the workstation the table above used, so\ncompare the rows with each other rather than with the grid's.\n\nTwo different questions, because a spreadsheet is asked both: what does\nopening a workbook full of formulas cost once, and what does one keystroke\ncost all day.\n\n| Case | Median | Cells evaluated | Retained |\n| -------------------------------------------------------- | ------- | --------------- | -------- |\n| Open 1,000 rows, one `SUM` per row | 8 ms | 1,000 | 1.6 MB |\n| Open 10,000 rows, one `SUM` per row | 91 ms | 10,000 | 16.5 MB |\n| Open 50,000 rows, one `SUM` per row | 547 ms | 50,000 | 84.2 MB |\n| Type in one cell of a 10,000-row sheet | 0 ms | 1 | - |\n| Type in a column a single `SUM` of 10,000 cells reads | 14 ms | 1 | - |\n| Type at the top of a 10,000-row dependency chain | 71 ms | 10,000 | - |\n\nRead the third column first: it is the one CI gates, and the one that says\nwhat the engine is doing. A keystroke costs **one evaluation**, not a\nsheet's worth, because the dependency graph recomputes what read the cell\nand nothing else. The column-`SUM` row is the interesting pair: one\nevaluation, 14 ms, because that single `SUM` re-reads its 10,000 cells. The\nchain row is the worst case a sheet can have, a running balance where every\nrow reads the row above it: 10,000 evaluations for one keystroke, which is\nthe true cost of that shape and not a bug.\n\nSo the practical ceiling, on this container: **a sheet of tens of thousands\nof formula rows opens in well under a second and edits instantly**, and the\nthing that changes that is not the sheet's size but how much of it one cell\nfeeds. 50,000 formula rows retain about 84 MB, roughly 1.7 KB per row for\nthe text, the cached value and the graph edges.\n\nA chain longer than about a thousand rows used to overflow the JavaScript\nstack on the first keystroke and land `#NUM!` in the cell. The workbook now\nprimes a deep chain from its far end instead of recursing through it, so\nthe only limit left is the sheet's own size.\n\n## What CI enforces\n\nElapsed time is too noisy on a shared runner to fail a build on, and a\nflaky performance gate gets switched off within a month. So `pnpm\nbench:check` gates **work counters** instead - counts of algorithmic work,\nidentical on every machine:\n\n| Counter | Budget | Actual |\n| --------------------------------------------- | ------ | ------ |\n| `getAllColumns` calls inside a 1-clause sort | 8 | 1 |\n| `getAllColumns` calls inside a 3-clause sort | 24 | 1 |\n| `getAllCells` materialisations while filtering | 0 | 0 |\n| Filter re-runs caused by a selection change | 0 | 0 |\n| Sort re-runs caused by a selection change | 0 | 0 |\n| Cells evaluated opening a 10,000-row sheet | 10,004 | 10,000 |\n| Cells evaluated by one keystroke in that sheet | 4 | 1 |\n| Cells evaluated when a 10,000-cell `SUM` reads the edit | 3 | 1 |\n\nA count is a claim about the algorithm; a millisecond is a claim about the\nhardware. Only the first belongs in CI. Budgets live beside each case in\n`tools/bench/cases.mjs`, and the spreadsheet's in\n`tools/bench/sheet-cases.mjs`.\n\nEach case also declares which counters must be *present*, not just within\nbudget. Without that, a stage that stopped running altogether would satisfy\nevery budget by doing no work, which is the failure mode a gate like this\nis most likely to develop.\n\n## Memory\n\n**Measured** (`pnpm bench`, Node heap): building the row model for\n100,000 rows x 9 columns with no sort, filter or grouping retains\n**0.8 MB**, with no renderer attached. A row object is made the first time\nsomething reads it, so a grid showing twenty rows makes a screenful of\nthem, not 100,000.\n\nThe first sort, filter or grouping reads every row and makes them all. The\nbrowser harness measures that as the \"after sorting and filtering\" row in\nthe [comparison](./comparison.md#measured-performance): 17.8 MB at\n100,000 rows, and 128 MB at 1,000,000 (27 Oct 2026,\n`BENCH_ROWS=1000000 BENCH_GRIDS=svgrid pnpm bench:compare`), so about 130\nbytes a row: the row object, its id, and the sort key it keeps so a live\nupdate can be merged in without re-reading the rows. The 1,000,000-row\nfigure was 196 MB the day before. Reading one column used to build an\narray of every column's value on every row and keep it there, which only\nthe rows on screen use; a plain `field` column is now read from the data,\nand only a computed (`fieldFn`) column still builds the array.\n\nThe fully built row model was 16.0 MB at 100,000 rows before rows became\nlazy, and 64.9 MB before that. Each row was an object literal whose seven\nmethods were closures, so a 100k-row grid allocated 700k closures and a\nclosure scope per row before painting anything. The methods are now\ndefined once and shared, reading their row through `this`: 4x less memory\nand about 7x faster to build. They are still assigned as own properties\nrather than put on a prototype, because `Row` is public and several row\nmodels legitimately do `{ ...row, depth }` - a spread copies own\nproperties but not a prototype, so a class would silently strip the\nmethods off a cloned row.\n\nAn earlier version of this page said \"~22 MB\". That figure was not\nmeasured. Node's heap accounting is not the same as a browser's, so read\nthis as the engine's own cost rather than what a tab will show.\n\nTwo claims here are structural rather than measured, and both hold:\n\n- Virtualization keeps the rendered DOM to the visible window regardless\n of dataset size, so `<td>` count does not scale with row count.\n- No retained references when the grid unmounts - the cleanup path is\n exercised by the unmount test in `svgrid.behavior.test.ts`.\n\n## Server-side / chunked loading\n\nDemo [33. Server-side infinite scroll](https://svgrid.com/demos/33-server-infinite/) covers the chunked-load path. Numbers from that demo:\n\n| Scenario | Result |\n| ------------------------------------------------ | --------------------------------------- |\n| Initial paint, sparse 100k-row dataset | 110 ms to first chunk visible |\n| Scroll 50,000 rows in 1.5 s (fast wheel-flick) | 16 chunk requests cancelled mid-flight |\n| Sort 100k server-side rows | round-trip dominated by the mock latency (50-140 ms) |\n\n### The Server-Side Row Model over one million rows\n\nDemo [467](https://svgrid.com/demos/467-server-row-model-1m/) runs the\nEnterprise row model over a columnar in-memory warehouse of a million rows,\ngrouped Region > Country. `tests/perf/server-row-model.spec.ts` drives it in\nheadless Chromium (a developer workstation, 17 September 2026; a release\nritual, not a gate):\n\n| Scenario | Result |\n| ------------------------------------------------------------- | --------------------------------------------- |\n| First paint, navigation to the first group row (includes building the warehouse in the page) | 2.4 s |\n| Scroll 60,000 px through an open country of 62,000 leaves | 17 leaf requests, 0.28 per 1,000 px (one block of 100 rows is 3,400 px) |\n| Worst frame while blocks streamed in | 83 ms (layout of the changed rows; the grid keeps the row objects a block did not touch) |\n| Heap before / after streaming 700,000 px with `maxBlocksInCache: 24` | 225 MB / 225 MB - evicted blocks are collected |\n| Warehouse: a million rows as typed arrays | 22 MB; a cold sort on a new column 0.8 to 1.1 s, cached after; a grouped level 140 ms; a pivot with a grand total 330 ms |\n\n## AI helpers\n\nEnd-to-end timings against the bundled `mockAIProvider`:\n\n| Helper | Median time (ms) |\n| --------------- | ---------------- |\n| `aiFilter` | 350-750 (mock latency dominated) |\n| `aiSmartFill` (50 rows) | 400-900 |\n| `aiSummarize` | 350-750 |\n| `aiClassify` (20 rows) | 400-750 |\n\nAgainst a real model the latency is provider-side. The grid's own\nprompt-build + result-parse work stays under ~6 ms even for 1000-row\nclassify jobs.\n\n## Import / export\n\n| Operation | Time |\n| ------------------------------------ | ------ |\n| Parse CSV, 10k rows × 9 cols | 28 ms |\n| Parse xlsx, 10k rows × 9 cols | 140 ms (jszip unzip-dominated) |\n| Export CSV, 10k rows × 9 cols | 18 ms |\n| Export xlsx, 10k rows × 9 cols | 220 ms |\n| Export PDF, 1k rows × 9 cols (pdfmake) | 700 ms |\n\n## Reproducing locally\n\n```bash\ngit clone https://github.com/sv-grid/sv-grid\ncd sv-grid\npnpm install\npnpm --filter @svgrid/grid build # the bench runs the BUILT engine\npnpm bench # engine + memory tables\npnpm size # bundle table\npnpm bench:dom # first paint + scroll, in Chromium\n```\n\nThe bench takes a few options:\n\n```bash\npnpm bench --json # machine-readable, for trend tracking\npnpm bench --baseline=tools/bench/baseline.json # adds a delta column\npnpm bench --case=sort-1col # one case\npnpm bench:check # the work-counter gate CI runs\n```\n\n`pnpm bench` runs against the built `@svgrid/grid/core` rather than\n`src/`, so it also smoke-tests the entry a consumer actually imports.\n\n`pnpm bench:dom` drives Chromium through Playwright against the examples\ngallery, which lives in this repository, so it needs no private\nsubmodule. It is a Playwright project rather than part of `pnpm test:e2e`,\nand it is deliberately not in CI - see below.\n\nFor your own workload, the [benchmark harness\nrecipe](../recipes/benchmark-harness.md) and the [FPS HUD\nrecipe](../recipes/profiling-with-fps-hud.md) are copy-paste probes you\ncan drop into your app.\n\n## What we *don't* claim\n\n- That we are faster than any other grid. Nothing on *this* page is a\n head-to-head measurement. Everything here is sv-grid measured against\n sv-grid, which supports \"this got 10x faster\" and not \"this is faster\n than X\". For a real comparison there is a separate grid-agnostic\n harness - `pnpm bench:compare`, results and caveats in\n [Comparison](./comparison.md) - and it does not say we win everything.\n- That first paint is good. The grid half of the 100k x 100 case is still\n the worst number on this page, and this round did not touch it.\n- Any scroll figure above 60 fps. The harness is rAF-driven and cannot\n observe headroom past the display refresh. \"Zero dropped frames\" is the\n claim; \"120 fps\" is not.\n- Lab-grade first-paint numbers. Those come from a developer machine with\n roughly 2x run-to-run variance, not a dedicated rig.\n- \"Smoothest grid on the market\" - that depends entirely on what your\n cells render. A sparkline + currency formatter in every cell costs\n more than a number, and we don't pretend otherwise.\n- \"Zero allocations during scroll\" - the virtualizer recycles DOM\n nodes but cell snippets still allocate. The numbers above include\n real-world snippets (status pills, mini-bars).\n- Single-thread performance > 1M rows. For >1M, do the heavy lifting\n on the server and feed chunks through the [server-side infinite\n scroll pattern](https://svgrid.com/demos/33-server-infinite/).\n\n## Frequently asked questions\n\n### How fast is SvGrid?\n\nIt virtualizes both rows and columns, so only the visible window is in the DOM,\nand a million rows scrolls without dropping a frame. On the data side, a\nsingle-column sort of 100,000 rows takes about 27 ms and a one-operator filter\nabout 5 ms. Every table on this page comes from a checked-in script you can run\nyourself, and the numbers moved because the harness exposed real defects rather\nthan because the prose was rewritten.\n\n### How many rows can SvGrid handle?\n\nClient-side, 100k+ rows scroll smoothly thanks to virtualization. For millions\nof rows, page or chunk from the server (see Server-side data). The DOM only ever\nholds the visible window regardless of total row count.\n\n### How fast is SvGrid, and how big is it?\n\nIt ships a small bundle (the measured figures for the full render component\nand for the headless core alone are in the table above) and virtualizes by\ndefault. Raw scroll\nperformance is comparable for typical workloads; the bigger practical win is\nbundle size and a Svelte-native runtime with no framework bridge.\n\n## See also\n\n- [Browser support](./browser-support.md) - the matrix the benchmarks\n ran against.\n- [Testing and quality](./testing-and-quality.md) - the coverage\n thresholds that gate every release.\n"
|
|
5314
|
+
"markdown": "# Performance benchmarks\n\nEvery number on this page is produced by a checked-in script:\n\n| Table | Command | Where it runs |\n| -------------------------- | --------------- | ------------- |\n| Bundle size | `pnpm size` | Node |\n| Sort / filter / group, memory | `pnpm bench` | Node |\n| First paint, scroll | `pnpm bench:dom` | Chromium |\n\nAn earlier version of this page published a table of timings that no\nscript produced, and told readers to reproduce them with a `pnpm bench`\ncommand that did not exist. Where a figure has since been re-measured and\ncame out worse than the old claim, the section says so rather than\nquietly restating it.\n\nThe one number worth trusting on any grid's benchmark page is the one you\nmeasured yourself, on your data shape, on your hardware. The\n[benchmark harness recipe](../recipes/benchmark-harness.md) is a\ncopy-paste `<SvGrid>` probe that measures time-to-first-paint across any\n(rows x columns) matrix.\n\nLive load - 100k rows x 100 columns with row + column virtualization:\n\n<div data-docs-demo=\"06-large-dataset\" data-height=\"500\"></div>\n\n## Test rig\n\nThe engine table below was measured on this configuration. Your absolute\nnumbers will differ; the ratios between rows are the transferable part.\n\n| Component | Spec |\n| --------- | ------------------------------------------------ |\n| Machine | Developer workstation, win32 x64. Not a dedicated bench rig |\n| Engine | Node v24.18.0, median of 9 runs after a warm-up |\n| Browser | Chromium via Playwright, best of 2 runs |\n| Dataset | 100,000 rows x 9 columns, seeded so runs compare |\n| Target | The built `@svgrid/grid/core`, not `src/` |\n\nMedian rather than mean, so one GC pause cannot move a number. The\n`min`/`max` columns the harness prints are worth reading: the spread on a\nsort run is around 10%, which is why **elapsed time is reported but never\ngated in CI**. What CI gates instead is described under\n[What CI enforces](#what-ci-enforces).\n\n## Bundle size\n\nProduction build, gzipped, Svelte excluded as a peer. The table is\ngenerated from `docs/_data/svgrid-size.json` by `node tools/sync-guide-facts.mjs`\n(the file `pnpm size:json` writes), and the method and the lazy-chunk\nbreakdown are on the [bundle size reference](./bundle-size.md). An earlier\nversion of this page typed these and sat a month behind the measurement.\n\n<!-- size:start -->\nRe-measured **17 Nov 2026** at `@svgrid/grid` 3.0.36 with the script that ships in the repo (`pnpm size:json`):\n\n| Target | Base JS (gzip) | CSS (gzip) | Loaded on demand |\n| --- | ---: | ---: | ---: |\n| Headless core (`createSvGrid`) | **3.2 KB** | - | - |\n| Headless subpath (`@svgrid/grid/core`) | **10.4 KB** | - | - |\n| Full render component (`<SvGrid>`) | **97.8 KB** | **11.7 KB** | **209.8 KB** |\n| Standalone chart (`<SvChart>`) | **71.9 KB** | - | **16.2 KB** |\n<!-- size:end -->\n\nThe \"loaded on demand\" column is the code reachable only through\n`import()`: charts, the date-time editor, the menus, export. Outside the\ngrid package, and not in the ledger: the `@svgrid/enterprise` core is a few\nkilobytes of export, print and import shells; `jszip` loads on the first\nxlsx export or import and `pdfmake` with its fonts on the first PDF export,\nboth as optional peers, neither in your synchronous bundle.\n\nThe AI helpers are no longer in this table: they moved into the free\n`@svgrid/grid` and tree-shake out unless you import them.\n\nTree-shaking is friendly: importing `{ SvGrid, tableFeatures }`\nwithout `rowSortingFeature` doesn't pull the sort module.\n\n## First paint\n\n**Measured.** Run `pnpm bench:dom`. Driven against demo\n`06-large-dataset` in Chromium: click a dataset size, stop the clock on\nthe first painted frame that shows the new rows.\n\n| Scenario | Total | Building the data | Grid |\n| ------------------- | -------- | ----------------- | ------- |\n| 1,000 x 29 cols | 180 ms | 3 ms | 177 ms |\n| 10,000 x 53 cols | 315 ms | 31 ms | 284 ms |\n| 50,000 x 77 cols | 652 ms | 220 ms | 432 ms |\n| 100,000 x 100 cols | 1,205 ms | 633 ms | 572 ms |\n\n\"Building the data\" is the demo generating synthetic rows - at the top\nsize that is 9.5 million cells of test data, which a real app with data\nalready in hand does not pay. \"Grid\" is the remainder.\n\n**\"Grid\" overstates the grid's own cost, and by a lot.** A CPU profile of\nthe 100k x 100 mount attributes 28% of the window to the demo's data\ngenerator and another 14% to garbage collection, most of it cleaning up\nafter that generator. The demo's self-reported build time counts only the\ngenerator's own execution, not the GC pressure it creates, so subtracting\nit leaves a good deal of the demo's cost inside the \"Grid\" column. Roughly\nhalf the total is the harness rather than the component.\n\nTwo further caveats:\n\n- These come from a developer machine, not a dedicated bench rig, and\n run-to-run variance is roughly 2x. Treat the column ratios as the\n signal and the absolute values as a ceiling.\n- **The row-pipeline optimisations above did not move these numbers**, and\n should not be read as having done so. Mounting a grid with no sort and no\n filter never enters those code paths; both row models return early.\n\nAn earlier version of this page claimed 110 ms for the 100k x 100 case,\nwhich was never measured. Getting a trustworthy figure needs a mount\nharness that feeds pre-built data, so the number is not dominated by the\ncost of inventing it.\n\n## Scroll performance\n\n**Measured.** Run `pnpm bench:dom`. Sustained vertical scroll at 60\npx/frame over 240 frames, sampling the interval between animation frames:\n\n| Scenario | p50 | p95 | max | Dropped frames |\n| ---------------------- | ------- | ------- | ------- | -------------- |\n| 100k rows x 100 cols | 16.7 ms | 17.7 ms | 18.8 ms | 0 of 240 |\n| 1,000,000 rows x 9 cols | 16.7 ms | 18.1 ms | 19.1 ms | 0 of 240 |\n\nThis is the part of the grid that holds up well: a million rows scrolls\nwithout dropping a frame, and the 100-column case is indistinguishable\nfrom it because row and column virtualization are the same machinery.\n\nRead the numbers correctly, though. The harness drives scrolling from\n`requestAnimationFrame`, so an interval can never come in below the\ndisplay refresh - 16.7 ms on a 60 Hz panel is the floor, not a\nmeasurement of how cheap a frame is. What the table shows is that the\ngrid **holds** the frame budget, with zero frames over 1.5x the median.\nIt cannot show headroom above 60 fps.\n\nAn earlier version of this page claimed a p95 of 8 ms and \"~120 fps\".\nNo harness in the repository could have produced that figure, and this\none structurally cannot.\n\n> Video: One million rows in SvGrid\n\nTranscript: This SvGrid holds one million rows, generated in the browser, with sorting, filtering and inline editing switched on. Rows are virtualized, so only the ones in view are drawn. Scroll, and the frame rate stays flat. Jump anywhere in the set. The row numbers show the scale, and the grid keeps every row reachable. Row and column virtualization are the same machinery, so wide grids get the same treatment. Nothing to configure.\n\n## Sort, filter, group\n\n**Measured.** Run `pnpm bench` to reproduce. In-memory row-pipeline\noperations on 100,000 rows x 9 columns:\n\n| Operation | Median | Was | Change |\n| --------------------------------------------- | ------- | ------- | ------ |\n| Sort by one column | 27 ms | 351 ms | 13x |\n| Sort by three columns (multi-sort) | 48 ms | 569 ms | 12x |\n| Sort by a date column | 40 ms | 773 ms | 19x |\n| Sort by a text column (collated) | 59 ms | - | new |\n| Filter, one operator | 5 ms | 19 ms | 4x |\n| Filter, five operators ANDed | 7 ms | 24 ms | 3.5x |\n| Filter via the compiled Excel filter | 3 ms | - | new |\n| ... the same, on fully accented text | 22 ms | - | new |\n| Group by two columns + three aggregators | 50 ms | 229 ms | 4.6x |\n| Toggle one row's checkbox (filtered + sorted) | 0 ms | 103 ms | gone |\n| Export CSV, 10k rows x 9 cols | 10 ms | 8 ms | - |\n\nThe last two rows are the path `<SvGrid>` actually takes. The plain \"filter,\none operator\" rows drive the headless row model, whose default match is a\nsubstring compare - but the menu and filter-row surfaces compile through\n`compileExcelFilter`, which folds every value (decompose, strip diacritics,\nlowercase) so that \"cafe\" matches \"CAFÉ\". This suite had no case touching\nthat fold until a browser profile showed it was the most expensive single\nfunction in a filter. It now takes a fast path for pure-ASCII values, where\ndecomposition and diacritic-stripping are provably no-ops: 3 ms rather than\n21 ms for the same 100,000 rows. Accented data still pays the full fold,\nwhich is the 21 ms row, and gets the same answer it always did.\n\nEach case runs in a **fresh process**. They used to share one, which made\nevery figure depend on the order cases ran in: a case running eighth\ncarried seven predecessors' heap, and grouping measured 169 ms in a full\nrun against 51 ms on its own. An earlier version of this table published\nthe contaminated 106 ms for grouping. Forcing a garbage collection between\ncases did not fix it - the cost is a warmed, fragmented heap rather than\nuncollected garbage - so the harness now pays a few seconds of process\nstartup per case and reports numbers that mean the same thing whether you\nrun one case or all of them.\n\nText sorting has no \"was\", because this suite did not measure it until a\nbrowser comparison showed it was the slowest operation for every grid\ntested. Collation is what makes it expensive, and two things help:\n\n- **Columns whose distinct values are far fewer than their rows** - a\n status, a region, an owner - collate the distinct values once and sort\n rows by rank. That is what took the three-column case to 48 ms. A stride\n sample decides whether to try, because collecting distinct values costs\n about 9 ms on a column where nearly all of them are unique and saves\n about 19 ms where they repeat, so guessing wrong either way is\n measurable.\n- **`localeCompare` rather than a hoisted `Intl.Collator`.** The\n specification defines the former as constructing a collator per call, so\n caching one looks like the obvious win - and it is measurably slower,\n because V8 fast-paths `localeCompare` and going through a collator object\n misses that path. 33 ms against 83 ms sorting 100k ASCII strings, with\n byte-identical ordering. This page briefly published the slower version;\n re-measure before \"optimising\" it again.\n\nA third thing helps every sort: **the single-clause case gets its own\ncomparator.** Most sorts are one column, and the comparator runs O(n log n)\ntimes - 1.66 million calls for 100,000 rows - so the general loop's clause\nlookup, property loads and indirect call are paid 1.66 million times for\nvalues that never change. Hoisting them into a closure, and inlining the\nsubtraction for numeric columns, is worth about 15% on a single-column sort.\n\nGrouping got faster for a different reason: a group row shows the value\nits children agree on, and finding that used to mean scanning every child\neven for a column an outer level had already grouped by, where the answer\nis fixed by construction.\n\nMedians hold steady across runs; the min/max the harness also prints do\nnot, because this is a working developer machine rather than a quiet bench\nrig. A single sample can land 3x the median when something else on the box\nwakes up. That noise is the whole reason CI gates counters instead.\n\nThe \"Was\" column is the first measurement this harness took, before any of\nit was optimised. Building the harness is what exposed the defects; each\none is now closed and has a counter that fails the build if it returns:\n\n- **Sorting resolved the clause's column inside the comparator.** A\n single-clause sort of 100k rows called `getAllColumns()` 1,528,947\n times, scanning the column array on each. It now resolves once, and the\n comparator reads a precomputed key array instead of walking the row.\n- **The date comparator allocated two `Date` objects per comparison.**\n Timestamps are now computed once per row, which is most of why sorting a\n date column went from the slowest case to a fast one.\n- **Filtering materialised every row's full `Cell[]`** to read one field,\n defeating the lazy per-row cell cache: 100,000 cell arrays built and\n thrown away for a one-operator filter. Now zero.\n- **Toggling a checkbox re-ran the whole pipeline.** `rowSelection` sat in\n the row-model cache key, so selecting a row re-filtered and re-sorted the\n entire dataset even though nothing in the pipeline reads it. Selection is\n now free.\n- **Group aggregation allocated three arrays per aggregated column per\n group**, then finished with `Math.min(...values)`. It is a single pass\n now. The spread also crashed outright on a large enough group, which is\n fixed as a side effect.\n- **Text sorting collated on every comparison.** Distinct values are now\n ranked once where a column has few enough of them.\n\nNumbers here will move; the command that produces them will not.\n\n## Streaming updates\n\n**Measured.** Run `pnpm bench --case=tick-1k-of-100k-sorted` to reproduce.\nA tick is a new data array in which K row objects were replaced with new\nprices, handed to a grid sorted by that column, so the order has to stay\ncurrent. 100,000 rows x 9 columns, same rig as above:\n\n| Operation | Median | The same tick through a full sort |\n| ---------------------------------------------------- | ------ | --------------------------------- |\n| Tick: 100 rows replaced, sorted by the ticking column | 6 ms | 31 ms |\n| Tick: 1,000 rows replaced, sorted by the ticking column | 9 ms | 31 ms |\n\nThe right-hand column is the \"Sort by one column\" row above: before this\nround, any new data array re-sorted every row, so a 100-row tick cost\nexactly what a header click did. The sorted stage now keeps its previous\noutput with each row's sort key, drops the rows that were replaced, sorts\nthe K replacements among themselves and merges them back in one linear\npass: O(n + K log K) instead of O(n log n) key builds and comparisons. The\nfiltered stage does the same for a replacement whose membership did not\nchange. The result is byte-identical to a full sort, which a test pins by\ncomparing the two on every kind of key the sort specialises\n(`core.tick-repair.test.ts`).\n\nThree conditions, all checked, none assumed: the array has the same length\n(an add or a remove is structural and takes the full path), at least one\nobject was replaced and no more than a quarter of them (a new array with\nevery object the same is the documented \"I mutated rows in place, re-read\nthem\" refresh and runs the full pipeline), and the sorting state, filters\nand columns are the same objects as last time. The rows that were kept are\nassumed unchanged in value as well as identity, which is what an immutable\nupdate guarantees and an in-place mutation does not: a feed that mutates\nrows in place must pass a new array with no replacements to refresh.\n\nThe counter CI gates for this is cell reads on the kept rows during a tick,\nbudgeted at zero: a repaired sort never re-reads a row it kept, a full sort\nreads all of them.\n\nWhat the component adds on top of the engine per tick is a rebuild of the\nbase rows (2 ms at 100k, reusing every row object that did not change) and\nthe render of the visible window. Three things on that path used to be\nO(rows) per data change and are not now: the header checkbox state walked\nevery row to conclude \"none selected\" (30 ms at 100k), the expanded-rows\nstage copied all rows into a new array with nothing expanded, and the\ndev-time config check filtered every row to pick ten samples. The browser\nharness in the [comparison](./comparison.md) measures the whole thing,\nrender included, against the other grids on the same tick; that column\nlands with its next recorded run.\n\n## Spreadsheet engine\n\n**Measured.** Run `pnpm bench` with `@svgrid/enterprise` built\n(`pnpm --filter @svgrid/enterprise build:lib`) to reproduce; the cases live\nin `tools/bench/sheet-cases.mjs`. These were taken on a CI-class Linux\ncontainer with Node v22, not the workstation the table above used, so\ncompare the rows with each other rather than with the grid's.\n\nTwo different questions, because a spreadsheet is asked both: what does\nopening a workbook full of formulas cost once, and what does one keystroke\ncost all day.\n\n| Case | Median | Cells evaluated | Retained |\n| -------------------------------------------------------- | ------- | --------------- | -------- |\n| Open 1,000 rows, one `SUM` per row | 8 ms | 1,000 | 1.6 MB |\n| Open 10,000 rows, one `SUM` per row | 91 ms | 10,000 | 16.5 MB |\n| Open 50,000 rows, one `SUM` per row | 547 ms | 50,000 | 84.2 MB |\n| Type in one cell of a 10,000-row sheet | 0 ms | 1 | - |\n| Type in a column a single `SUM` of 10,000 cells reads | 14 ms | 1 | - |\n| Type at the top of a 10,000-row dependency chain | 71 ms | 10,000 | - |\n\nRead the third column first: it is the one CI gates, and the one that says\nwhat the engine is doing. A keystroke costs **one evaluation**, not a\nsheet's worth, because the dependency graph recomputes what read the cell\nand nothing else. The column-`SUM` row is the interesting pair: one\nevaluation, 14 ms, because that single `SUM` re-reads its 10,000 cells. The\nchain row is the worst case a sheet can have, a running balance where every\nrow reads the row above it: 10,000 evaluations for one keystroke, which is\nthe true cost of that shape and not a bug.\n\nSo the practical ceiling, on this container: **a sheet of tens of thousands\nof formula rows opens in well under a second and edits instantly**, and the\nthing that changes that is not the sheet's size but how much of it one cell\nfeeds. 50,000 formula rows retain about 84 MB, roughly 1.7 KB per row for\nthe text, the cached value and the graph edges.\n\nA chain longer than about a thousand rows used to overflow the JavaScript\nstack on the first keystroke and land `#NUM!` in the cell. The workbook now\nprimes a deep chain from its far end instead of recursing through it, so\nthe only limit left is the sheet's own size.\n\n## What CI enforces\n\nElapsed time is too noisy on a shared runner to fail a build on, and a\nflaky performance gate gets switched off within a month. So `pnpm\nbench:check` gates **work counters** instead - counts of algorithmic work,\nidentical on every machine:\n\n| Counter | Budget | Actual |\n| --------------------------------------------- | ------ | ------ |\n| `getAllColumns` calls inside a 1-clause sort | 8 | 1 |\n| `getAllColumns` calls inside a 3-clause sort | 24 | 1 |\n| `getAllCells` materialisations while filtering | 0 | 0 |\n| Filter re-runs caused by a selection change | 0 | 0 |\n| Sort re-runs caused by a selection change | 0 | 0 |\n| Cells evaluated opening a 10,000-row sheet | 10,004 | 10,000 |\n| Cells evaluated by one keystroke in that sheet | 4 | 1 |\n| Cells evaluated when a 10,000-cell `SUM` reads the edit | 3 | 1 |\n\nA count is a claim about the algorithm; a millisecond is a claim about the\nhardware. Only the first belongs in CI. Budgets live beside each case in\n`tools/bench/cases.mjs`, and the spreadsheet's in\n`tools/bench/sheet-cases.mjs`.\n\nEach case also declares which counters must be *present*, not just within\nbudget. Without that, a stage that stopped running altogether would satisfy\nevery budget by doing no work, which is the failure mode a gate like this\nis most likely to develop.\n\n## Memory\n\n**Measured** (`pnpm bench`, Node heap): building the row model for\n100,000 rows x 9 columns with no sort, filter or grouping retains\n**0.8 MB**, with no renderer attached. A row object is made the first time\nsomething reads it, so a grid showing twenty rows makes a screenful of\nthem, not 100,000.\n\nThe first sort, filter or grouping reads every row and makes them all. The\nbrowser harness measures that as the \"after sorting and filtering\" row in\nthe [comparison](./comparison.md#measured-performance): 17.8 MB at\n100,000 rows, and 128 MB at 1,000,000 (27 Oct 2026,\n`BENCH_ROWS=1000000 BENCH_GRIDS=svgrid pnpm bench:compare`), so about 130\nbytes a row: the row object, its id, and the sort key it keeps so a live\nupdate can be merged in without re-reading the rows. The 1,000,000-row\nfigure was 196 MB the day before. Reading one column used to build an\narray of every column's value on every row and keep it there, which only\nthe rows on screen use; a plain `field` column is now read from the data,\nand only a computed (`fieldFn`) column still builds the array.\n\nThe fully built row model was 16.0 MB at 100,000 rows before rows became\nlazy, and 64.9 MB before that. Each row was an object literal whose seven\nmethods were closures, so a 100k-row grid allocated 700k closures and a\nclosure scope per row before painting anything. The methods are now\ndefined once and shared, reading their row through `this`: 4x less memory\nand about 7x faster to build. They are still assigned as own properties\nrather than put on a prototype, because `Row` is public and several row\nmodels legitimately do `{ ...row, depth }` - a spread copies own\nproperties but not a prototype, so a class would silently strip the\nmethods off a cloned row.\n\nAn earlier version of this page said \"~22 MB\". That figure was not\nmeasured. Node's heap accounting is not the same as a browser's, so read\nthis as the engine's own cost rather than what a tab will show.\n\nTwo claims here are structural rather than measured, and both hold:\n\n- Virtualization keeps the rendered DOM to the visible window regardless\n of dataset size, so `<td>` count does not scale with row count.\n- No retained references when the grid unmounts - the cleanup path is\n exercised by the unmount test in `svgrid.behavior.test.ts`.\n\n## Server-side / chunked loading\n\nDemo [33. Server-side infinite scroll](https://svgrid.com/demos/33-server-infinite/) covers the chunked-load path. Numbers from that demo:\n\n| Scenario | Result |\n| ------------------------------------------------ | --------------------------------------- |\n| Initial paint, sparse 100k-row dataset | 110 ms to first chunk visible |\n| Scroll 50,000 rows in 1.5 s (fast wheel-flick) | 16 chunk requests cancelled mid-flight |\n| Sort 100k server-side rows | round-trip dominated by the mock latency (50-140 ms) |\n\n### The Server-Side Row Model over one million rows\n\nDemo [467](https://svgrid.com/demos/467-server-row-model-1m/) runs the\nEnterprise row model over a columnar in-memory warehouse of a million rows,\ngrouped Region > Country. `tests/perf/server-row-model.spec.ts` drives it in\nheadless Chromium (a developer workstation, 17 September 2026; a release\nritual, not a gate):\n\n| Scenario | Result |\n| ------------------------------------------------------------- | --------------------------------------------- |\n| First paint, navigation to the first group row (includes building the warehouse in the page) | 2.4 s |\n| Scroll 60,000 px through an open country of 62,000 leaves | 17 leaf requests, 0.28 per 1,000 px (one block of 100 rows is 3,400 px) |\n| Worst frame while blocks streamed in | 83 ms (layout of the changed rows; the grid keeps the row objects a block did not touch) |\n| Heap before / after streaming 700,000 px with `maxBlocksInCache: 24` | 225 MB / 225 MB - evicted blocks are collected |\n| Warehouse: a million rows as typed arrays | 22 MB; a cold sort on a new column 0.8 to 1.1 s, cached after; a grouped level 140 ms; a pivot with a grand total 330 ms |\n\n## AI helpers\n\nEnd-to-end timings against the bundled `mockAIProvider`:\n\n| Helper | Median time (ms) |\n| --------------- | ---------------- |\n| `aiFilter` | 350-750 (mock latency dominated) |\n| `aiSmartFill` (50 rows) | 400-900 |\n| `aiSummarize` | 350-750 |\n| `aiClassify` (20 rows) | 400-750 |\n\nAgainst a real model the latency is provider-side. The grid's own\nprompt-build + result-parse work stays under ~6 ms even for 1000-row\nclassify jobs.\n\n## Import / export\n\n| Operation | Time |\n| ------------------------------------ | ------ |\n| Parse CSV, 10k rows × 9 cols | 28 ms |\n| Parse xlsx, 10k rows × 9 cols | 140 ms (jszip unzip-dominated) |\n| Export CSV, 10k rows × 9 cols | 18 ms |\n| Export xlsx, 10k rows × 9 cols | 220 ms |\n| Export PDF, 1k rows × 9 cols (pdfmake) | 700 ms |\n\n## Reproducing locally\n\n```bash\ngit clone https://github.com/sv-grid/sv-grid\ncd sv-grid\npnpm install\npnpm --filter @svgrid/grid build # the bench runs the BUILT engine\npnpm bench # engine + memory tables\npnpm size # bundle table\npnpm bench:dom # first paint + scroll, in Chromium\n```\n\nThe bench takes a few options:\n\n```bash\npnpm bench --json # machine-readable, for trend tracking\npnpm bench --baseline=tools/bench/baseline.json # adds a delta column\npnpm bench --case=sort-1col # one case\npnpm bench:check # the work-counter gate CI runs\n```\n\n`pnpm bench` runs against the built `@svgrid/grid/core` rather than\n`src/`, so it also smoke-tests the entry a consumer actually imports.\n\n`pnpm bench:dom` drives Chromium through Playwright against the examples\ngallery, which lives in this repository, so it needs no private\nsubmodule. It is a Playwright project rather than part of `pnpm test:e2e`,\nand it is deliberately not in CI - see below.\n\nFor your own workload, the [benchmark harness\nrecipe](../recipes/benchmark-harness.md) and the [FPS HUD\nrecipe](../recipes/profiling-with-fps-hud.md) are copy-paste probes you\ncan drop into your app.\n\n## What we *don't* claim\n\n- That we are faster than any other grid. Nothing on *this* page is a\n head-to-head measurement. Everything here is sv-grid measured against\n sv-grid, which supports \"this got 10x faster\" and not \"this is faster\n than X\". For a real comparison there is a separate grid-agnostic\n harness - `pnpm bench:compare`, results and caveats in\n [Comparison](./comparison.md) - and it does not say we win everything.\n- That first paint is good. The grid half of the 100k x 100 case is still\n the worst number on this page, and this round did not touch it.\n- Any scroll figure above 60 fps. The harness is rAF-driven and cannot\n observe headroom past the display refresh. \"Zero dropped frames\" is the\n claim; \"120 fps\" is not.\n- Lab-grade first-paint numbers. Those come from a developer machine with\n roughly 2x run-to-run variance, not a dedicated rig.\n- \"Smoothest grid on the market\" - that depends entirely on what your\n cells render. A sparkline + currency formatter in every cell costs\n more than a number, and we don't pretend otherwise.\n- \"Zero allocations during scroll\" - the virtualizer recycles DOM\n nodes but cell snippets still allocate. The numbers above include\n real-world snippets (status pills, mini-bars).\n- Single-thread performance > 1M rows. For >1M, do the heavy lifting\n on the server and feed chunks through the [server-side infinite\n scroll pattern](https://svgrid.com/demos/33-server-infinite/).\n\n## Frequently asked questions\n\n### How fast is SvGrid?\n\nIt virtualizes both rows and columns, so only the visible window is in the DOM,\nand a million rows scrolls without dropping a frame. On the data side, a\nsingle-column sort of 100,000 rows takes about 27 ms and a one-operator filter\nabout 5 ms. Every table on this page comes from a checked-in script you can run\nyourself, and the numbers moved because the harness exposed real defects rather\nthan because the prose was rewritten.\n\n### How many rows can SvGrid handle?\n\nClient-side, 100k+ rows scroll smoothly thanks to virtualization. For millions\nof rows, page or chunk from the server (see Server-side data). The DOM only ever\nholds the visible window regardless of total row count.\n\n### How fast is SvGrid, and how big is it?\n\nIt ships a small bundle (the measured figures for the full render component\nand for the headless core alone are in the table above) and virtualizes by\ndefault. Raw scroll\nperformance is comparable for typical workloads; the bigger practical win is\nbundle size and a Svelte-native runtime with no framework bridge.\n\n## See also\n\n- [Browser support](./browser-support.md) - the matrix the benchmarks\n ran against.\n- [Testing and quality](./testing-and-quality.md) - the coverage\n thresholds that gate every release.\n"
|
|
5315
5315
|
},
|
|
5316
5316
|
{
|
|
5317
5317
|
"slug": "help/bolt-new",
|
|
@@ -5332,7 +5332,7 @@ export const docs = [
|
|
|
5332
5332
|
"path": "docs/help/bundle-size.md",
|
|
5333
5333
|
"title": "Bundle size",
|
|
5334
5334
|
"section": "Help",
|
|
5335
|
-
"markdown": "# Bundle size\n\nWhat SvGrid costs in your bundle, how to reproduce the number on your\nbranch, and what to do if size matters.\n\n## Measured\n\nThe table below is generated from `docs/_data/svgrid-size.json`, the file\n`pnpm size:json` writes; `node tools/sync-guide-facts.mjs` rewrites it and\n`tools/competitor-facts.test.ts` fails when it is stale or when a size is\ntyped anywhere else on this page. An earlier version of this page typed its\nnumbers and sat a month behind the measurement.\n\n<!-- size:start -->\nRe-measured **
|
|
5335
|
+
"markdown": "# Bundle size\n\nWhat SvGrid costs in your bundle, how to reproduce the number on your\nbranch, and what to do if size matters.\n\n## Measured\n\nThe table below is generated from `docs/_data/svgrid-size.json`, the file\n`pnpm size:json` writes; `node tools/sync-guide-facts.mjs` rewrites it and\n`tools/competitor-facts.test.ts` fails when it is stale or when a size is\ntyped anywhere else on this page. An earlier version of this page typed its\nnumbers and sat a month behind the measurement.\n\n<!-- size:start -->\nRe-measured **17 Nov 2026** at `@svgrid/grid` 3.0.36 with the script that ships in the repo (`pnpm size:json`):\n\n| Target | Base JS (gzip) | CSS (gzip) | Loaded on demand |\n| --- | ---: | ---: | ---: |\n| Headless core (`createSvGrid`) | **3.2 KB** | - | - |\n| Headless subpath (`@svgrid/grid/core`) | **10.4 KB** | - | - |\n| Full render component (`<SvGrid>`) | **97.8 KB** | **11.7 KB** | **209.8 KB** |\n| Standalone chart (`<SvChart>`) | **71.9 KB** | - | **16.2 KB** |\n<!-- size:end -->\n\nThe two headless rows measure different things on purpose. `createSvGrid` is\nthe engine plus the row model it needs, which is what you pay when you import\njust that symbol. The subpath row is every export on `@svgrid/grid/core`\npulled in at once with nothing tree-shaken, so it is the ceiling rather than\nthe typical cost - a real consumer importing `createSvGrid` and two row models\nsits near the lower number.\n\nSvelte is a peer dependency and is excluded from every figure. Builds are\nminified and gzipped at level 9.\n\nThe \"loaded on demand\" column is code that is reachable only through\n`import()`, so it never lands in your initial bundle. The script prints the\nper-chunk breakdown; the chunks and what triggers each of them:\n\n| Chunk | Loads when |\n| --- | --- |\n| `SvDateTimePicker` | a date / datetime / time cell editor opens |\n| `chart` (engine) | charting is enabled |\n| `SvGridChart`, `SvGridChartPanel`, `SvGridChartView` | a chart renders, the chart panel opens, the grid switches to chart view |\n| `GridMenus` | a header or context menu opens |\n| `SvGridCellEditor` | editing is enabled (loads at mount, before the first edit) |\n| `SvGridDropdown` | a list / chips cell editor or the page-size picker opens |\n| `dismissable`, `popover`, `focus-trap` | any popover, menu or dropdown layer opens |\n| `export-format` | CSV / TSV / JSON export or clipboard copy runs |\n| `date-format` | a date column formats a value |\n| `column-resize`, `row-resize`, `row-drag-touch` | the first resize drag or touch row drag |\n\nThe Kanban board and the scheduler / calendar view are not in either\nfigure: their renderers live in `@svgrid/enterprise` and register into the\nfree grid through the board and scheduler view seams.\n\n## Reproduce on your branch\n\n`measure-size.mjs` runs one isolated Vite library build per target above,\nwith Svelte marked external, then gzips each emitted chunk and classifies\nit as `base` (statically reachable from the entry) or `lazy` (reachable\nonly via `import()`).\n\n```bash\nnode packages/grid/scripts/measure-size.mjs\n# or, from the repo root:\npnpm size\n```\n\nTo see where the weight sits inside the base bundle:\n\n```bash\ncorepack pnpm --filter @svgrid/grid build\nnpx source-map-explorer packages/grid/dist/index.js\n```\n\nA treemap opens in your browser. Each block is a source file scaled by its\nbyte cost in the final bundle.\n\n## @svgrid/enterprise\n\nThe Enterprise pack is a separate install and a separate bundle. `xlsx`\nexport pulls JSZip and PDF export pulls pdfmake as optional peer\ndependencies, imported on the first `api.exportData(...)` call rather than\nat module load, so neither is in your synchronous bundle.\n\n## What to do if size matters\n\n1. **Use the headless engine for read-only views.** When you only need to\n display server-side data with no interaction, `createGrid` plus a short\n `<table>` renderer costs the headless-core row of the table above rather\n than the full-component row. See the\n [headless engine reference](../reference/headless-engine.md).\n2. **Register only the features you use.** The grid is feature-gated:\n sorting, filtering, grouping, pagination, expansion, and selection are\n each opt-in and tree-shake out when not imported. See the\n [features reference](../reference/features.md).\n3. **Let the lazy chunks stay lazy.** Charts, date/time editors, menus,\n and export already split themselves. Importing their modules directly\n at the top level pulls them back into your base bundle.\n4. **Code-split the Enterprise pack.** `installEnterprise(api)` is\n async-safe, so import it in the route that needs export rather than at\n module load:\n `const { installEnterprise } = await import('@svgrid/enterprise')`.\n\n## See also\n\n- [Features reference](../reference/features.md) - what each feature does\n- [Headless engine reference](../reference/headless-engine.md) - skip the renderer entirely\n- [Going to production guide](../getting-started/6-going-to-production.md)\n"
|
|
5336
5336
|
},
|
|
5337
5337
|
{
|
|
5338
5338
|
"slug": "help/cells/cell-components",
|
|
@@ -5647,7 +5647,7 @@ export const docs = [
|
|
|
5647
5647
|
"path": "docs/help/comparison.md",
|
|
5648
5648
|
"title": "Comparison: SvGrid vs AG Grid vs TanStack Table",
|
|
5649
5649
|
"section": "Help",
|
|
5650
|
-
"markdown": "\n# Comparison: SvGrid vs AG Grid vs TanStack Table\n\nThe three projects solve overlapping problems, and the right choice\ndepends on the framework you ship on, how much of the grid you want to\nbuild yourself, and your budget. Every number on this page is read from\nnpm or measured by a script in this repository on the date shown; the\nblock below is regenerated by `node tools/sync-guide-facts.mjs` and the\nper-competitor pages under [/compare/](https://svgrid.com/compare/) list\nthe sources for every feature claim.\n\n<!-- facts:start ag-grid,tanstack-table -->\n> **Facts, checked 9 Nov 2026.** `ag-grid-community` 36.3.0, MIT, last published 4 Nov 2026, 16,400,000 npm downloads in the 30 days to 8 Nov 2026. `@tanstack/svelte-table` 9.3.1, MIT, last published 12 Oct 2026, 539,000 npm downloads in the same window. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `ag-grid-community` 36.3.0 346.4 KB JS, no separate stylesheet (measured 9 Nov 2026); `@tanstack/svelte-table` 9.3.1 36.5 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). AG Grid pricing, as its site states it: AG Grid Community is free under MIT. AG Grid Enterprise is listed at $999 USD per developer with one year of updates and Zendesk support; the Enterprise Bundle with AG Charts Enterprise is $1,498 USD per developer (https://www.ag-grid.com/license-pricing/, read 12 Sep 2026). TanStack Table pricing, as its site states it: TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table (https://tanstack.com/table/latest, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/), [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/).\n<!-- facts:end -->\n\n## TL;DR\n\n| Project | Lives in | Ships | Licence |\n| --------------------- | ---------------------------------------- | ---------------------------------------------------------- | ----------------------------------------- |\n| **SvGrid** | Svelte 5 | Headless core + Svelte render component + Enterprise pack | MIT (Community) / commercial (Enterprise) |\n| **AG Grid Community** | React, Angular, Vue, plain JS | Full grid + renderer; Svelte through community integrations | MIT |\n| **AG Grid Enterprise**| same | Adds the set filter, range selection, master/detail, tree, grouping, pivot, charts, Excel export, server-side row model | Commercial, per developer |\n| **TanStack Table** | React, Vue, Svelte, Solid, Qwik, Lit, JS | Headless engine **only**; the Svelte adapter is Svelte 5 | MIT |\n\nThe bundle sizes and prices are in the facts block above, with the date\nthey were read and the method behind the sizes.\n\n## When SvGrid is the right choice\n\n- You're on **Svelte 5** and want a grid that uses the runtime's idioms\n (snippets for cells, `$state` for data, `$derived` for aggregates) -\n not a React-port pretending to be Svelte.\n- You want a **headless core you can render yourself** AND a\n default-styled component for the 80% case. Most \"headless\" libraries\n make you write the markup; most \"monolith\" libraries make you fight\n the markup. SvGrid does both in one package.\n- You need **clean theming via CSS custom properties** and a documented\n `--sg-*` token surface, not a hard-coded class soup.\n- You ship under **strict CSP** (no `eval`, no `new Function`, no\n inline scripts). SvGrid runs clean; AG Grid Community does too.\n TanStack Table is engine-only so the question doesn't apply.\n- You want **SSR markup that is meaningful before hydration** (good\n first paint, SEO, SvelteKit `+page.server` integration). SvGrid +\n TanStack Table both qualify. AG Grid renders client-side.\n- You want the features AG Grid sells as Enterprise - the set filter,\n range selection, master/detail, tree data, grouping with aggregation,\n integrated charts, flat server-side infinite scroll - **in the MIT\n core**. (Server-side grouping, tree, pivot and transactions are\n Enterprise in both.)\n\n## When AG Grid is the right choice\n\n- You're on **React, Angular, or Vue**, not Svelte. SvGrid is\n Svelte-only, and ag-grid.com points Svelte users to community-built\n integrations rather than an official package.\n- You need a push-based **viewport row model** for a real-time trading\n blotter, where the server streams the visible window over a socket.\n SvGrid's server-side row model covers sort, filter, grouping, tree,\n pivot, transactions and select-all across unloaded rows, and its\n real-time page merges deltas into loaded rows, but it does not have the\n viewport model.\n- You need **custom tool panels**. SvGrid's tool panel is a fixed\n Columns + Filters pair. Custom filter components are covered by a\n column's `customFilter`.\n- You need **AG Charts** for maps, network graphs, 3D or a canvas renderer.\n SvGrid's chart is SVG with decimation, and it ships 29 types, a configurable\n axis model, synchronized charts, a financial toolkit with indicator panes\n and drawing tools, a builder and PDF export in the MIT core; it does not\n draw maps.\n- You want a vendor with **a decade of enterprise procurement paperwork**\n already on file.\n\n## When TanStack Table is the right choice\n\n- You want a **rendering-framework-agnostic engine** so the same\n business logic powers React + Svelte + Solid surfaces in your\n monorepo.\n- You're already in the TanStack ecosystem (Query, Router, Form,\n Virtual) and want one mental model.\n- You're happy writing **all the markup yourself** - the row recycling,\n the keyboard map, the ARIA roles, the focus management, the\n drag-to-resize. That's the cost of \"engine only\".\n\n## Feature parity at a glance\n\nYes: shipped in that edition. Partial: needs extra work or a companion\npackage. No: not available. The AG Grid columns follow ag-grid.com's\nCommunity vs Enterprise page and its Set Filter, Tree Data and CSV export\npages; the dated list of those sources is on the\n[SvGrid vs AG Grid](https://svgrid.com/compare/ag-grid/) page, and the\nTanStack sources on [SvGrid vs TanStack Table](https://svgrid.com/compare/tanstack-table/).\n\n| | SvGrid Community | SvGrid Enterprise | AG Grid Community | AG Grid Enterprise | TanStack Table |\n| ------------------------------- | ---------------- | ----------------- | ----------------- | ------------------ | -------------- |\n| Headless core (engine only) | Yes | Yes | No | No | Yes |\n| Default render component | Yes (Svelte 5) | Yes | Yes (each framework) | Yes | No |\n| Sort (multi-column) | Yes | Yes | Yes | Yes | Yes (engine) |\n| Filter menu (operator + facet) | Yes | Yes | Partial (text and number filters; the set filter is Enterprise) | Yes | No |\n| Filter row | Yes | Yes | Yes | Yes | No |\n| Pagination | Yes | Yes | Yes | Yes | Yes (engine) |\n| Grouping + aggregation | Yes | Yes | No (Enterprise) | Yes | Yes (engine) |\n| Tree / expand-collapse rows | Yes | Yes | No (Enterprise) | Yes | Yes (engine) |\n| Master/detail | Yes | Yes | No (Enterprise) | Yes | No |\n| Cell range selection + copy/paste | Yes | Yes | No (Enterprise) | Yes | No |\n| Fill handle | Yes | Yes | No (Enterprise) | Yes | No |\n| Inline editing (typed editors) | Yes | Yes | Yes | Yes | No |\n| Column virtualization | Yes | Yes | Yes | Yes | No |\n| Row virtualization | Yes | Yes | Yes | Yes | Partial (pair with TanStack Virtual) |\n| Column pinning (left/right) | Yes | Yes | Yes | Yes | No |\n| Column tool panel | Yes | Yes | No (Enterprise) | Yes | No |\n| Context menu | Yes | Yes | No (Enterprise) | Yes | No |\n| Fit-to-width with shrink | Yes | Yes | Partial | Yes | No |\n| WAI-ARIA grid pattern | Yes | Yes | Yes | Yes | No (your markup) |\n| Server-side data, flat (sort / filter / paging / infinite scroll) | Yes (built in) | Yes (built in) | Yes (infinite row model) | Yes (built in) | Partial (manual flags) |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | No (Enterprise) | Yes (built in) | No (Enterprise) | Yes (built in) | No |\n| Global search over server-side data | Yes (`filterModel.global`) | Yes | No (the quick filter is client-side only) | No | n/a |\n| CSP-clean (no eval, no inline) | Yes | Yes | Yes | Yes | n/a |\n| Meaningful SSR markup | Yes | Yes | No | No | depends on your markup |\n| CSV / TSV / JSON export | Yes | Yes | Yes (CSV) | Yes | No |\n| Excel (.xlsx) / PDF export | No | Yes | No | Yes (Excel) | No |\n| Print | No | Yes | No | No | No |\n| Excel / CSV import | No | Yes | No | No | No |\n| In-grid AI helpers (bring your own model) | Yes | Yes | No | No | No |\n| MCP server for AI assistants | Yes (`@svgrid/mcp`) | Yes | Yes (`ag-mcp`) | Yes | No (agent skills ship in the package) |\n| Pivot table | No | Yes | No | Yes | No (custom) |\n| Integrated charts | Yes (29 types, builder, financial toolkit) | Yes | No | Yes (AG Charts) | No |\n| Support response time | GitHub (best-effort) | 1 business day; 1h sev-1 on Enterprise | GitHub (best-effort) | no number published | GitHub; paid Enterprise Support offered |\n| Theming via CSS variables | Yes (`--sg-*`) | Yes | Yes (theme builder) | Yes | n/a |\n| Source button per demo | Yes (gallery) | Yes | No | No | No |\n\n## Bundle size\n\nThe facts block at the top of the page has the gzipped size of each\npackage, measured by the same method: each package built alone with Vite\nin library mode, minified, gzip level 9, Svelte external because it is a\npeer dependency. SvGrid's own number comes from `pnpm size:json`\n(`packages/grid/scripts/measure-size.mjs`), the competitors' from\n`pnpm competitors:measure`; both write `docs/_data` and the block is\nregenerated from there, so the page cannot quote a size nobody measured.\n\nWhat the SvGrid number contains: the whole render component -\nvirtualization, Excel-style filters, inline editing, grouping, tree,\nmaster/detail, cell selection and accessibility - in one import, plus a\nseparate stylesheet. Charts, date and time editors, menus and export split\ninto `import()` chunks that load on demand rather than shipping in the\ninitial bundle; the headless core on its own is a small fraction of the\nrender component, and `@svgrid/enterprise` features are separate subpath\nimports. The per-entry breakdown, including the headless core and the\nlazy chunks, is in the [bundle size reference](./bundle-size.md).\n\nWhat the AG Grid number contains: `createGrid` with every Community\nmodule registered and the Quartz theme, whose CSS ships inside the script\nunder the theming API, so there is no separate stylesheet to add. The\nTanStack number is the whole Svelte adapter with its engine: no\nvirtualizer, filter UI or editors, because a headless library has none.\n\n## Measured performance\n\nA vendor's own benchmark is worth nothing unless you can rerun it, so the\nharness is in the repository and takes an adapter per grid. Adding another\ngrid is about forty lines in `examples/src/bench/adapters.ts` and nothing\nelse.\n\n```bash\n# headless, prints the table and writes tests/perf/.last-compare.json\nBENCH_REPEATS=7 BENCH_GRIDS=svgrid,aggrid,svar,tanstack pnpm bench:compare\n\n# move that run into docs/_data/competitors.json, then regenerate this page\nnode tools/record-benchmarks.mjs && node tools/sync-guide-facts.mjs\n\n# or drive it by hand\npnpm --filter @svgrid/grid-example-gallery dev # then open /bench.html\n```\n\nEach operation is timed until the grid's DOM reflects it, plus one frame:\n\n- **Mount** - fresh container, create the grid, until rows are painted.\n- **Sort** - change the sort on one column, until the new order is painted.\n Text sorts `name` (tens of thousands of distinct values), numeric sorts\n `amount`.\n- **Filter** - apply a `contains` filter to one column.\n- **Scroll** - 180 frames at 60 px/frame, sampling frame intervals.\n\n### Results\n\nThe table is generated from the ledger by `tools/sync-guide-facts.mjs`;\nthe versions and the date are part of it.\n\n<!-- bench:start -->\nMeasured 28 Oct 2026 with `pnpm bench:compare` (tests/perf/compare.spec.ts, recorded by tools/record-benchmarks.mjs): 100,000 rows x 9 columns; 1000 x 520 px container, 32 px rows, 140 px columns, each grid with its default theme; fastest of 3 samples per operation, each grid in a fresh page; Chromium through Playwright, headless; win32 10.0.26200 x64, Intel(R) Core(TM) Ultra 7 255U; a developer workstation, not a dedicated bench rig; tick: 1,000 of the rows replaced per tick with a new amount, the grid sorted by amount, on the update path each grid provides, timed until the changed cells paint; 180 ticks after 10 to warm up. Lower is better.\n\n| Operation | SvGrid | AG Grid Community | SVAR Svelte DataGrid | TanStack Table, minimal DOM |\n| --- | --- | --- | --- | --- |\n| Mount | 30.7 ms | 67 ms | 11.4 ms | 170.2 ms |\n| Sort, text column | 77.4 ms | 213.9 ms | 135.4 ms | 360.9 ms |\n| Sort, numeric column | 32.8 ms | 216.7 ms | 141.7 ms | 178.2 ms |\n| Filter, one column (indicative only, see below) | 34.5 ms | 148.8 ms | 26.1 ms | 51.1 ms |\n| Scroll, p95 frame | 34.3 ms | 34.5 ms | 34.6 ms | 34.3 ms |\n| Live tick, 1,000 rows replaced, sorted by that column, p95 | 48.6 ms | 259.2 ms | 152.2 ms | 563.4 ms |\n| Main-thread work per 60 px scroll step, mean | 3.5 ms | 4.5 ms | 3 ms | 2.9 ms |\n| Frames dropped while scrolling, of 180 | 0 | 0 | 0 | 0 |\n| Ticks over one 60 Hz frame, of 180 | 115 | 180 | 180 | 180 |\n| Rows kept in the DOM (virtualization on) | 36 | 36 | 19 | 27 |\n| JS heap the grid adds, mounted, after GC | 5.7 MB | 42.1 MB | 2.3 MB | 109.9 MB |\n| JS heap the grid adds, after sorting and filtering, after GC | 17.6 MB | 26.2 MB | 3.9 MB | 113.3 MB |\n| Elements created per scroll frame | 0 | 30.1 | 16.8 | 18.7 |\n| Elements re-inserted per scroll frame (rows recycled) | 37.3 | 35.8 | 0 | 0 |\n\nVersions: `@svgrid/grid` 3.0.25, `ag-grid-community` 36.1.0, `wx-svelte-grid` 2.7.0, `@tanstack/svelte-table` 9.2.4.\n<!-- bench:end -->\n\nRead that as: **SvGrid sorts and keeps a live sort current faster than the\nother three, scrolling is level across all four, and SVAR is ahead on mount\nand memory** - it paints its first rows in under half of SvGrid's time and\nholds the least heap. Every grid scrolls at the display rate here, so the\np95 frame reads the same for all four; the work row under it is what a\nslower machine or a 120 Hz display would feel. There TanStack and SVAR do\nthe least per scroll step, about half a millisecond under SvGrid, and AG\nGrid the most. The row varies from run to run, so read the order of the\nfirst three as close, not settled. SvGrid makes its row objects the first time a\nsort or filter reads every row rather than at mount, which is why its two\nheap rows differ. The TanStack renderer pays for building a row object per\nrecord before it can draw anything. Anyone claiming a single headline\nnumber for a grid comparison is selling something.\n\n**The heap rows are the JS heap after a forced garbage collection, less the\nsame page with the data built and no grid,** so the 100,000 rows themselves\ncount against no one. The two DOM rows are counted over 60 untimed scroll\nframes after the timed ones. \"Created\" is elements that did not exist\nbefore; \"re-inserted\" is elements the grid already had and moved, which is\nhow a keyed list recycles a row from one end of the window to the other.\nSvGrid creates none and moves the two rows that cross the edge each frame;\na grid that rewrote its rows in place would score 0 on both.\n\n**The filter row is not a like-for-like comparison and is shown only because\nhiding a number we win looks worse than explaining it.** The grids' single-\ncolumn filter APIs differ: the harness drives AG Grid's quick filter, which\nsearches every column and is strictly more work than the single-column\n`contains` SvGrid performs, while SVAR and TanStack run a predicate over the\none column. Do not read a ratio into that row.\n\n**The TanStack column is an engine plus the least DOM an app could draw.**\nTanStack Table renders nothing, so its adapter draws the row model through\na fixed-height windowed table with no virtualizer library, no filter UI and\nno editors. Its mount and sort numbers include creating the engine's row\nobjects for every record; the grids around it do the same work inside their\nown models.\n\nSorting is where SvGrid's distance comes from, and it is not subtle: SvGrid\nresolves each sort clause once and precomputes a key array, and for a\ncolumn whose distinct values are far fewer than its rows it collates the\ndistinct values once and sorts by rank. Mounting is the other direction -\nsee the accounting in [benchmarks](./benchmarks.md).\n\nAt 1,000,000 rows the harness runs one grid per invocation\n(`BENCH_ROWS=1000000 BENCH_GRIDS=<one> BENCH_TICKS=30`); TanStack's\nadapter does not finish at that size. Those runs are not in the table\nbecause only a run that measured every grid together is comparable.\n\nTwo methodology notes, both of which were bugs in this harness before they\nwere notes, and both of which changed the numbers by more than any code\nchange did:\n\n- **Each grid runs in a fresh page.** They used to run one after another in\n the same one, where the first warmed the JIT, fragmented the heap and\n left a hundred thousand rows of garbage for the next. Back-to-back runs\n on an idle machine disagreed with themselves by a factor of two.\n That order effect is gone, but this workstation still varies by about\n 2x between whole runs taken minutes apart, for every grid at once, so\n compare the columns of one run and not one run against another.\n- **Operations are timed until the DOM changes, not for a fixed two\n frames.** The old fixed wait put a two-frame floor under every number -\n an operation that recomputed nothing at all measured the floor, and a\n mount whose rows were already in the DOM measured pure waiting - which\n flattered whichever grid was slower.\n- **Each figure is the fastest of the samples, not the median.** Noise\n only ever adds time, so the minimum is the cleanest estimate of what the\n machine can do, and medians on this box drifted by a third between\n consecutive runs - more than most of the differences being measured.\n Applied identically to every grid.\n\nWhat this table deliberately does not include:\n\n- **Features the grids do not measure the same way.** Grouping, pivot,\n editing and export all differ enough in shape that a single timing would\n compare two different amounts of work. The filter row above is the one\n case we publish anyway, labelled, rather than quietly dropping a result\n that happens to favour us.\n- **Any grid we cannot license for this.** The harness is grid-agnostic on\n purpose, but some commercial grids licence their software in ways that\n restrict using it to produce competitive claims. Where that is the case\n we do not ship an adapter, and we would rather have an obviously\n incomplete table than a legally dubious one. Run your own shortlist.\n- **Your workload.** One dataset shape, one machine, one browser, default\n configuration for every grid. If a grid decision rides on this, clone the\n harness and put your own data in it.\n\n## Migrating from AG Grid\n\nThe most common starting point. See\n[Migrating from AG Grid](./migrating-from-ag-grid.md) for a side-by-side\ntranslation of column defs, features, filtering, editing, and the\nimperative API. The example that guide is built around runs here:\n\n<div data-docs-demo=\"139-migration-from-ag-grid\" data-height=\"560\"></div>\n\n## Migrating from TanStack Table\n\nThe map is one-to-one - SvGrid's headless core speaks the vocabulary\nTanStack Table v9 introduced. The big differences:\n\n- Replace `createTable(opts)` with `createSvGrid(opts)`. Same state\n machine, same features object.\n- Replace the row-model factories with the same names from\n `@svgrid/grid`.\n- The render layer changes - TanStack hands you `FlexRender` + the\n row model; SvGrid lets you keep that headless approach OR drop in\n the default `<SvGrid>` component.\n\nThe headless demo below drives a plain `<table>` from `createSvGrid`, the\nway a TanStack app would:\n\n<div data-docs-demo=\"186-headless-table\" data-height=\"520\"></div>\n\nAnd the same rows through the render component, which is the part TanStack\nleaves to you. The example runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Order = {\n id: number\n customer: string\n region: string\n status: string\n amount: number\n }\n\n const orders: Order[] = [\n { id: 1, customer: 'Ada Lovelace', region: 'EMEA', status: 'open', amount: 1240 },\n { id: 2, customer: 'Grace Hopper', region: 'AMER', status: 'shipped', amount: 860 },\n { id: 3, customer: 'Linus Torvalds', region: 'EMEA', status: 'closed', amount: 2210 },\n { id: 4, customer: 'Radia Perlman', region: 'APAC', status: 'open', amount: 430 },\n { id: 5, customer: 'Barbara Liskov', region: 'AMER', status: 'pending', amount: 1780 },\n ]\n\n let rows = $state<Order[]>(orders)\n\n const columns: GridColumns<Order> = [\n { field: 'customer', header: 'Customer', width: 180 },\n { field: 'region', header: 'Region', width: 110 },\n { field: 'status', header: 'Status', width: 110 },\n { field: 'amount', header: 'Amount', width: 120, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable selectable />\n```\n\n## Pricing\n\nSvGrid Community is MIT - free for commercial use, no attribution\nrequired at runtime. SvGrid Enterprise is a per-developer licence: $599\nper developer per year for the enterprise grid or $999 with the\nspreadsheet and Studio, both for unlimited applications; see\n<https://svgrid.com/pricing/> for what each tier adds.\n\nAG Grid Community is MIT. AG Grid Enterprise is priced per developer with\none year of updates; the figure ag-grid.com listed on the date we read it\nis in the facts block at the top of this page, and the\n[SvGrid vs AG Grid](https://svgrid.com/compare/ag-grid/) page carries the\nlink. Compare what each paid tier adds before comparing prices: most of\nwhat AG Grid sells as Enterprise is in SvGrid's free core.\n\nTanStack Table is MIT and sponsor-funded; tanstack.com offers paid\nEnterprise Support as private consulting.\n\n## Frequently asked questions\n\n### What is the best data grid for Svelte 5?\n\nFor a Svelte-5-native grid with a batteries-included render component, SvGrid is\nbuilt around runes and snippets. TanStack Table is a strong headless-only\nchoice if you want to build the DOM layer yourself across frameworks, and its\nv9 Svelte adapter targets Svelte 5. AG Grid is the most feature-complete but\nlives in React, Angular and Vue first and reaches Svelte through\ncommunity-built integrations.\n\n### Is SvGrid a good AG Grid alternative?\n\nYes, for Svelte projects. SvGrid is a fraction of AG Grid Community's\nmeasured size on a Svelte page (the facts block has both numbers and the\nmethod), is MIT-licensed for commercial use, and offers `@svgrid/enterprise`\nfor export, print, import and pivot at a per-developer price. On the\nbenchmark above it sorts a hundred-thousand-row column faster on both\ncolumn types and scrolls level; AG Grid mounts quicker. It does not match\nevery AG Grid Enterprise feature - see the\n[missing-features list](./missing-features.md) for the gaps.\n\n### SvGrid vs TanStack Table - which should I pick?\n\nPick SvGrid if you want virtualization, Excel-style filters, selection, and\ninline editing working out of the box on Svelte 5. Pick TanStack Table if you\nwant a framework-agnostic headless engine and are happy to build the rendering,\nvirtualization, and editing UI yourself. Both are MIT-licensed.\n\n### Does the TanStack Svelte adapter support Svelte 5?\n\nYes. The `@tanstack/svelte-table` v9 line declares a Svelte 5 peer range\nand passes data through getters rather than stores; the facts block above\nshows the version read from npm. The earlier `createSvelteTable` constructor\nis gone in v9.\n\n### Does AG Grid have an MCP server like SvGrid?\n\nYes. `ag-mcp` (MIT) gives an assistant AG Grid's docs, examples and\nversion-specific upgrade prompts. `@svgrid/mcp` does the same for SvGrid\nand adds a code checker that validates props and imports against the real\nAPI surface, a scaffold tool and a preview. Neither is an in-grid feature;\nSvGrid's natural-language filter, smart fill and summarise helpers are, and\nthey ship free in `@svgrid/grid` with a model provider you register.\n\n### How big is the SvGrid bundle?\n\nThe facts block at the top of this page has the measured gzipped size of the\nfull `<SvGrid>` render component and its stylesheet, read from\n`docs/_data/svgrid-size.json`, which `pnpm size:json` writes. The\n[bundle size reference](./bundle-size.md) breaks it down by entry:\nthe headless core on its own, the core subpath, the charts, and the lazy\nchunks that load on demand.\n\n## See also\n\n- [Why headless?](../why-headless.md) - the design decision behind\n SvGrid's two-layer architecture.\n- [Migrating from AG Grid](./migrating-from-ag-grid.md) - the\n practical recipe.\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - the\n one-to-one API map.\n- [Benchmarks](./benchmarks.md) - how the numbers are produced and what\n they leave out.\n- [Enterprise feature pack](../enterprise/README.md) - what SvGrid charges for.\n- [Missing features](./missing-features.md) - the honest gap list\n versus AG Grid Enterprise.\n- [All comparisons](https://svgrid.com/compare/) - one page per grid, with\n dated sources for every claim.\n"
|
|
5650
|
+
"markdown": "\n# Comparison: SvGrid vs AG Grid vs TanStack Table\n\nThe three projects solve overlapping problems, and the right choice\ndepends on the framework you ship on, how much of the grid you want to\nbuild yourself, and your budget. Every number on this page is read from\nnpm or measured by a script in this repository on the date shown; the\nblock below is regenerated by `node tools/sync-guide-facts.mjs` and the\nper-competitor pages under [/compare/](https://svgrid.com/compare/) list\nthe sources for every feature claim.\n\n<!-- facts:start ag-grid,tanstack-table -->\n> **Facts, checked 9 Nov 2026.** `ag-grid-community` 36.3.0, MIT, last published 4 Nov 2026, 16,400,000 npm downloads in the 30 days to 8 Nov 2026. `@tanstack/svelte-table` 9.3.1, MIT, last published 12 Oct 2026, 539,000 npm downloads in the same window. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `ag-grid-community` 36.3.0 346.4 KB JS, no separate stylesheet (measured 9 Nov 2026); `@tanstack/svelte-table` 9.3.1 36.5 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). AG Grid pricing, as its site states it: AG Grid Community is free under MIT. AG Grid Enterprise is listed at $999 USD per developer with one year of updates and Zendesk support; the Enterprise Bundle with AG Charts Enterprise is $1,498 USD per developer (https://www.ag-grid.com/license-pricing/, read 12 Sep 2026). TanStack Table pricing, as its site states it: TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table (https://tanstack.com/table/latest, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/), [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/).\n<!-- facts:end -->\n\n## TL;DR\n\n| Project | Lives in | Ships | Licence |\n| --------------------- | ---------------------------------------- | ---------------------------------------------------------- | ----------------------------------------- |\n| **SvGrid** | Svelte 5 | Headless core + Svelte render component + Enterprise pack | MIT (Community) / commercial (Enterprise) |\n| **AG Grid Community** | React, Angular, Vue, plain JS | Full grid + renderer; Svelte through community integrations | MIT |\n| **AG Grid Enterprise**| same | Adds the set filter, range selection, master/detail, tree, grouping, pivot, charts, Excel export, server-side row model | Commercial, per developer |\n| **TanStack Table** | React, Vue, Svelte, Solid, Qwik, Lit, JS | Headless engine **only**; the Svelte adapter is Svelte 5 | MIT |\n\nThe bundle sizes and prices are in the facts block above, with the date\nthey were read and the method behind the sizes.\n\n## When SvGrid is the right choice\n\n- You're on **Svelte 5** and want a grid that uses the runtime's idioms\n (snippets for cells, `$state` for data, `$derived` for aggregates) -\n not a React-port pretending to be Svelte.\n- You want a **headless core you can render yourself** AND a\n default-styled component for the 80% case. Most \"headless\" libraries\n make you write the markup; most \"monolith\" libraries make you fight\n the markup. SvGrid does both in one package.\n- You need **clean theming via CSS custom properties** and a documented\n `--sg-*` token surface, not a hard-coded class soup.\n- You ship under **strict CSP** (no `eval`, no `new Function`, no\n inline scripts). SvGrid runs clean; AG Grid Community does too.\n TanStack Table is engine-only so the question doesn't apply.\n- You want **SSR markup that is meaningful before hydration** (good\n first paint, SEO, SvelteKit `+page.server` integration). SvGrid +\n TanStack Table both qualify. AG Grid renders client-side.\n- You want the features AG Grid sells as Enterprise - the set filter,\n range selection, master/detail, tree data, grouping with aggregation,\n integrated charts, flat server-side infinite scroll - **in the MIT\n core**. (Server-side grouping, tree, pivot and transactions are\n Enterprise in both.)\n\n## When AG Grid is the right choice\n\n- You're on **React, Angular, or Vue**, not Svelte. SvGrid is\n Svelte-only, and ag-grid.com points Svelte users to community-built\n integrations rather than an official package.\n- You need a push-based **viewport row model** for a real-time trading\n blotter, where the server streams the visible window over a socket.\n SvGrid's server-side row model covers sort, filter, grouping, tree,\n pivot, transactions and select-all across unloaded rows, and its\n real-time page merges deltas into loaded rows, but it does not have the\n viewport model.\n- You need **custom tool panels**. SvGrid's tool panel is a fixed\n Columns + Filters pair. Custom filter components are covered by a\n column's `customFilter`.\n- You need **AG Charts** for maps, network graphs, 3D or a canvas renderer.\n SvGrid's chart is SVG with decimation, and it ships 29 types, a configurable\n axis model, synchronized charts, a financial toolkit with indicator panes\n and drawing tools, a builder and PDF export in the MIT core; it does not\n draw maps.\n- You want a vendor with **a decade of enterprise procurement paperwork**\n already on file.\n\n## When TanStack Table is the right choice\n\n- You want a **rendering-framework-agnostic engine** so the same\n business logic powers React + Svelte + Solid surfaces in your\n monorepo.\n- You're already in the TanStack ecosystem (Query, Router, Form,\n Virtual) and want one mental model.\n- You're happy writing **all the markup yourself** - the row recycling,\n the keyboard map, the ARIA roles, the focus management, the\n drag-to-resize. That's the cost of \"engine only\".\n\n## Feature parity at a glance\n\nYes: shipped in that edition. Partial: needs extra work or a companion\npackage. No: not available. The AG Grid columns follow ag-grid.com's\nCommunity vs Enterprise page and its Set Filter, Tree Data and CSV export\npages; the dated list of those sources is on the\n[SvGrid vs AG Grid](https://svgrid.com/compare/ag-grid/) page, and the\nTanStack sources on [SvGrid vs TanStack Table](https://svgrid.com/compare/tanstack-table/).\n\n| | SvGrid Community | SvGrid Enterprise | AG Grid Community | AG Grid Enterprise | TanStack Table |\n| ------------------------------- | ---------------- | ----------------- | ----------------- | ------------------ | -------------- |\n| Headless core (engine only) | Yes | Yes | No | No | Yes |\n| Default render component | Yes (Svelte 5) | Yes | Yes (each framework) | Yes | No |\n| Sort (multi-column) | Yes | Yes | Yes | Yes | Yes (engine) |\n| Filter menu (operator + facet) | Yes | Yes | Partial (text and number filters; the set filter is Enterprise) | Yes | No |\n| Filter row | Yes | Yes | Yes | Yes | No |\n| Pagination | Yes | Yes | Yes | Yes | Yes (engine) |\n| Grouping + aggregation | Yes | Yes | No (Enterprise) | Yes | Yes (engine) |\n| Tree / expand-collapse rows | Yes | Yes | No (Enterprise) | Yes | Yes (engine) |\n| Master/detail | Yes | Yes | No (Enterprise) | Yes | No |\n| Cell range selection + copy/paste | Yes | Yes | No (Enterprise) | Yes | No |\n| Fill handle | Yes | Yes | No (Enterprise) | Yes | No |\n| Inline editing (typed editors) | Yes | Yes | Yes | Yes | No |\n| Column virtualization | Yes | Yes | Yes | Yes | No |\n| Row virtualization | Yes | Yes | Yes | Yes | Partial (pair with TanStack Virtual) |\n| Column pinning (left/right) | Yes | Yes | Yes | Yes | No |\n| Column tool panel | Yes | Yes | No (Enterprise) | Yes | No |\n| Context menu | Yes | Yes | No (Enterprise) | Yes | No |\n| Fit-to-width with shrink | Yes | Yes | Partial | Yes | No |\n| WAI-ARIA grid pattern | Yes | Yes | Yes | Yes | No (your markup) |\n| Server-side data, flat (sort / filter / paging / infinite scroll) | Yes (built in) | Yes (built in) | Yes (infinite row model) | Yes (built in) | Partial (manual flags) |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | No (Enterprise) | Yes (built in) | No (Enterprise) | Yes (built in) | No |\n| Global search over server-side data | Yes (`filterModel.global`) | Yes | No (the quick filter is client-side only) | No | n/a |\n| CSP-clean (no eval, no inline) | Yes | Yes | Yes | Yes | n/a |\n| Meaningful SSR markup | Yes | Yes | No | No | depends on your markup |\n| CSV / TSV / JSON export | Yes | Yes | Yes (CSV) | Yes | No |\n| Excel (.xlsx) / PDF export | No | Yes | No | Yes (Excel) | No |\n| Print | No | Yes | No | No | No |\n| Excel / CSV import | No | Yes | No | No | No |\n| In-grid AI helpers (bring your own model) | Yes | Yes | No | No | No |\n| MCP server for AI assistants | Yes (`@svgrid/mcp`) | Yes | Yes (`ag-mcp`) | Yes | No (agent skills ship in the package) |\n| Pivot table | No | Yes | No | Yes | No (custom) |\n| Integrated charts | Yes (29 types, builder, financial toolkit) | Yes | No | Yes (AG Charts) | No |\n| Support response time | GitHub (best-effort) | 1 business day; 1h sev-1 on Enterprise | GitHub (best-effort) | no number published | GitHub; paid Enterprise Support offered |\n| Theming via CSS variables | Yes (`--sg-*`) | Yes | Yes (theme builder) | Yes | n/a |\n| Source button per demo | Yes (gallery) | Yes | No | No | No |\n\n## Bundle size\n\nThe facts block at the top of the page has the gzipped size of each\npackage, measured by the same method: each package built alone with Vite\nin library mode, minified, gzip level 9, Svelte external because it is a\npeer dependency. SvGrid's own number comes from `pnpm size:json`\n(`packages/grid/scripts/measure-size.mjs`), the competitors' from\n`pnpm competitors:measure`; both write `docs/_data` and the block is\nregenerated from there, so the page cannot quote a size nobody measured.\n\nWhat the SvGrid number contains: the whole render component -\nvirtualization, Excel-style filters, inline editing, grouping, tree,\nmaster/detail, cell selection and accessibility - in one import, plus a\nseparate stylesheet. Charts, date and time editors, menus and export split\ninto `import()` chunks that load on demand rather than shipping in the\ninitial bundle; the headless core on its own is a small fraction of the\nrender component, and `@svgrid/enterprise` features are separate subpath\nimports. The per-entry breakdown, including the headless core and the\nlazy chunks, is in the [bundle size reference](./bundle-size.md).\n\nWhat the AG Grid number contains: `createGrid` with every Community\nmodule registered and the Quartz theme, whose CSS ships inside the script\nunder the theming API, so there is no separate stylesheet to add. The\nTanStack number is the whole Svelte adapter with its engine: no\nvirtualizer, filter UI or editors, because a headless library has none.\n\n## Measured performance\n\nA vendor's own benchmark is worth nothing unless you can rerun it, so the\nharness is in the repository and takes an adapter per grid. Adding another\ngrid is about forty lines in `examples/src/bench/adapters.ts` and nothing\nelse.\n\n```bash\n# headless, prints the table and writes tests/perf/.last-compare.json\nBENCH_REPEATS=7 BENCH_GRIDS=svgrid,aggrid,svar,tanstack pnpm bench:compare\n\n# move that run into docs/_data/competitors.json, then regenerate this page\nnode tools/record-benchmarks.mjs && node tools/sync-guide-facts.mjs\n\n# or drive it by hand\npnpm --filter @svgrid/grid-example-gallery dev # then open /bench.html\n```\n\nEach operation is timed until the grid's DOM reflects it, plus one frame:\n\n- **Mount** - fresh container, create the grid, until rows are painted.\n- **Sort** - change the sort on one column, until the new order is painted.\n Text sorts `name` (tens of thousands of distinct values), numeric sorts\n `amount`.\n- **Filter** - apply a `contains` filter to one column.\n- **Scroll** - 180 frames at 60 px/frame, sampling frame intervals.\n\n### Results\n\nThe table is generated from the ledger by `tools/sync-guide-facts.mjs`;\nthe versions and the date are part of it.\n\n<!-- bench:start -->\nMeasured 28 Oct 2026 with `pnpm bench:compare` (tests/perf/compare.spec.ts, recorded by tools/record-benchmarks.mjs): 100,000 rows x 9 columns; 1000 x 520 px container, 32 px rows, 140 px columns, each grid with its default theme; fastest of 3 samples per operation, each grid in a fresh page; Chromium through Playwright, headless; win32 10.0.26200 x64, Intel(R) Core(TM) Ultra 7 255U; a developer workstation, not a dedicated bench rig; tick: 1,000 of the rows replaced per tick with a new amount, the grid sorted by amount, on the update path each grid provides, timed until the changed cells paint; 180 ticks after 10 to warm up. Lower is better.\n\n| Operation | SvGrid | AG Grid Community | SVAR Svelte DataGrid | TanStack Table, minimal DOM |\n| --- | --- | --- | --- | --- |\n| Mount | 30.7 ms | 67 ms | 11.4 ms | 170.2 ms |\n| Sort, text column | 77.4 ms | 213.9 ms | 135.4 ms | 360.9 ms |\n| Sort, numeric column | 32.8 ms | 216.7 ms | 141.7 ms | 178.2 ms |\n| Filter, one column (indicative only, see below) | 34.5 ms | 148.8 ms | 26.1 ms | 51.1 ms |\n| Scroll, p95 frame | 34.3 ms | 34.5 ms | 34.6 ms | 34.3 ms |\n| Live tick, 1,000 rows replaced, sorted by that column, p95 | 48.6 ms | 259.2 ms | 152.2 ms | 563.4 ms |\n| Main-thread work per 60 px scroll step, mean | 3.5 ms | 4.5 ms | 3 ms | 2.9 ms |\n| Frames dropped while scrolling, of 180 | 0 | 0 | 0 | 0 |\n| Ticks over one 60 Hz frame, of 180 | 115 | 180 | 180 | 180 |\n| Rows kept in the DOM (virtualization on) | 36 | 36 | 19 | 27 |\n| JS heap the grid adds, mounted, after GC | 5.7 MB | 42.1 MB | 2.3 MB | 109.9 MB |\n| JS heap the grid adds, after sorting and filtering, after GC | 17.6 MB | 26.2 MB | 3.9 MB | 113.3 MB |\n| Elements created per scroll frame | 0 | 30.1 | 16.8 | 18.7 |\n| Elements re-inserted per scroll frame (rows recycled) | 37.3 | 35.8 | 0 | 0 |\n\nVersions: `@svgrid/grid` 3.0.25, `ag-grid-community` 36.1.0, `wx-svelte-grid` 2.7.0, `@tanstack/svelte-table` 9.2.4.\n<!-- bench:end -->\n\nRead that as: **SvGrid sorts and keeps a live sort current faster than the\nother three, scrolling is level across all four, and SVAR is ahead on mount\nand memory** - it paints its first rows in under half of SvGrid's time and\nholds the least heap. Every grid scrolls at the display rate here, so the\np95 frame reads the same for all four; the work row under it is what a\nslower machine or a 120 Hz display would feel. There TanStack and SVAR do\nthe least per scroll step, about half a millisecond under SvGrid, and AG\nGrid the most. The row varies from run to run, so read the order of the\nfirst three as close, not settled. SvGrid makes its row objects the first time a\nsort or filter reads every row rather than at mount, which is why its two\nheap rows differ. The TanStack renderer pays for building a row object per\nrecord before it can draw anything. Anyone claiming a single headline\nnumber for a grid comparison is selling something.\n\n**The heap rows are the JS heap after a forced garbage collection, less the\nsame page with the data built and no grid,** so the 100,000 rows themselves\ncount against no one. The two DOM rows are counted over 60 untimed scroll\nframes after the timed ones. \"Created\" is elements that did not exist\nbefore; \"re-inserted\" is elements the grid already had and moved, which is\nhow a keyed list recycles a row from one end of the window to the other.\nSvGrid creates none and moves the two rows that cross the edge each frame;\na grid that rewrote its rows in place would score 0 on both.\n\n**The filter row is not a like-for-like comparison and is shown only because\nhiding a number we win looks worse than explaining it.** The grids' single-\ncolumn filter APIs differ: the harness drives AG Grid's quick filter, which\nsearches every column and is strictly more work than the single-column\n`contains` SvGrid performs, while SVAR and TanStack run a predicate over the\none column. Do not read a ratio into that row.\n\n**The TanStack column is an engine plus the least DOM an app could draw.**\nTanStack Table renders nothing, so its adapter draws the row model through\na fixed-height windowed table with no virtualizer library, no filter UI and\nno editors. Its mount and sort numbers include creating the engine's row\nobjects for every record; the grids around it do the same work inside their\nown models.\n\nSorting is where SvGrid's distance comes from, and it is not subtle: SvGrid\nresolves each sort clause once and precomputes a key array, and for a\ncolumn whose distinct values are far fewer than its rows it collates the\ndistinct values once and sorts by rank. Mounting is the other direction -\nsee the accounting in [benchmarks](./benchmarks.md).\n\nAt 1,000,000 rows the harness runs one grid per invocation\n(`BENCH_ROWS=1000000 BENCH_GRIDS=<one> BENCH_TICKS=30`); TanStack's\nadapter does not finish at that size. Those runs are not in the table\nbecause only a run that measured every grid together is comparable.\n\nTwo methodology notes, both of which were bugs in this harness before they\nwere notes, and both of which changed the numbers by more than any code\nchange did:\n\n- **Each grid runs in a fresh page.** They used to run one after another in\n the same one, where the first warmed the JIT, fragmented the heap and\n left a hundred thousand rows of garbage for the next. Back-to-back runs\n on an idle machine disagreed with themselves by a factor of two.\n That order effect is gone, but this workstation still varies by about\n 2x between whole runs taken minutes apart, for every grid at once, so\n compare the columns of one run and not one run against another.\n- **Operations are timed until the DOM changes, not for a fixed two\n frames.** The old fixed wait put a two-frame floor under every number -\n an operation that recomputed nothing at all measured the floor, and a\n mount whose rows were already in the DOM measured pure waiting - which\n flattered whichever grid was slower.\n- **Each figure is the fastest of the samples, not the median.** Noise\n only ever adds time, so the minimum is the cleanest estimate of what the\n machine can do, and medians on this box drifted by a third between\n consecutive runs - more than most of the differences being measured.\n Applied identically to every grid.\n\nWhat this table deliberately does not include:\n\n- **Features the grids do not measure the same way.** Grouping, pivot,\n editing and export all differ enough in shape that a single timing would\n compare two different amounts of work. The filter row above is the one\n case we publish anyway, labelled, rather than quietly dropping a result\n that happens to favour us.\n- **Any grid we cannot license for this.** The harness is grid-agnostic on\n purpose, but some commercial grids licence their software in ways that\n restrict using it to produce competitive claims. Where that is the case\n we do not ship an adapter, and we would rather have an obviously\n incomplete table than a legally dubious one. Run your own shortlist.\n- **Your workload.** One dataset shape, one machine, one browser, default\n configuration for every grid. If a grid decision rides on this, clone the\n harness and put your own data in it.\n\n## Migrating from AG Grid\n\nThe most common starting point. See\n[Migrating from AG Grid](./migrating-from-ag-grid.md) for a side-by-side\ntranslation of column defs, features, filtering, editing, and the\nimperative API. The example that guide is built around runs here:\n\n<div data-docs-demo=\"139-migration-from-ag-grid\" data-height=\"560\"></div>\n\n## Migrating from TanStack Table\n\nThe map is one-to-one - SvGrid's headless core speaks the vocabulary\nTanStack Table v9 introduced. The big differences:\n\n- Replace `createTable(opts)` with `createSvGrid(opts)`. Same state\n machine, same features object.\n- Replace the row-model factories with the same names from\n `@svgrid/grid`.\n- The render layer changes - TanStack hands you `FlexRender` + the\n row model; SvGrid lets you keep that headless approach OR drop in\n the default `<SvGrid>` component.\n\nThe headless demo below drives a plain `<table>` from `createSvGrid`, the\nway a TanStack app would:\n\n<div data-docs-demo=\"186-headless-table\" data-height=\"520\"></div>\n\nAnd the same rows through the render component, which is the part TanStack\nleaves to you. The example runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Order = {\n id: number\n customer: string\n region: string\n status: string\n amount: number\n }\n\n const orders: Order[] = [\n { id: 1, customer: 'Ada Lovelace', region: 'EMEA', status: 'open', amount: 1240 },\n { id: 2, customer: 'Grace Hopper', region: 'AMER', status: 'shipped', amount: 860 },\n { id: 3, customer: 'Linus Torvalds', region: 'EMEA', status: 'closed', amount: 2210 },\n { id: 4, customer: 'Radia Perlman', region: 'APAC', status: 'open', amount: 430 },\n { id: 5, customer: 'Barbara Liskov', region: 'AMER', status: 'pending', amount: 1780 },\n ]\n\n let rows = $state<Order[]>(orders)\n\n const columns: GridColumns<Order> = [\n { field: 'customer', header: 'Customer', width: 180 },\n { field: 'region', header: 'Region', width: 110 },\n { field: 'status', header: 'Status', width: 110 },\n { field: 'amount', header: 'Amount', width: 120, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable selectable />\n```\n\n## Pricing\n\nSvGrid Community is MIT - free for commercial use, no attribution\nrequired at runtime. SvGrid Enterprise is a per-developer licence: $599\nper developer per year for the enterprise grid or $999 with the\nspreadsheet and Studio, both for unlimited applications; see\n<https://svgrid.com/pricing/> for what each tier adds.\n\nAG Grid Community is MIT. AG Grid Enterprise is priced per developer with\none year of updates; the figure ag-grid.com listed on the date we read it\nis in the facts block at the top of this page, and the\n[SvGrid vs AG Grid](https://svgrid.com/compare/ag-grid/) page carries the\nlink. Compare what each paid tier adds before comparing prices: most of\nwhat AG Grid sells as Enterprise is in SvGrid's free core.\n\nTanStack Table is MIT and sponsor-funded; tanstack.com offers paid\nEnterprise Support as private consulting.\n\n## Frequently asked questions\n\n### What is the best data grid for Svelte 5?\n\nFor a Svelte-5-native grid with a batteries-included render component, SvGrid is\nbuilt around runes and snippets. TanStack Table is a strong headless-only\nchoice if you want to build the DOM layer yourself across frameworks, and its\nv9 Svelte adapter targets Svelte 5. AG Grid is the most feature-complete but\nlives in React, Angular and Vue first and reaches Svelte through\ncommunity-built integrations.\n\n### Is SvGrid a good AG Grid alternative?\n\nYes, for Svelte projects. SvGrid is a fraction of AG Grid Community's\nmeasured size on a Svelte page (the facts block has both numbers and the\nmethod), is MIT-licensed for commercial use, and offers `@svgrid/enterprise`\nfor export, print, import and pivot at a per-developer price. On the\nbenchmark above it sorts a hundred-thousand-row column faster on both\ncolumn types and scrolls level; AG Grid mounts quicker. It does not match\nevery AG Grid Enterprise feature - see the\n[missing-features list](./missing-features.md) for the gaps.\n\n### SvGrid vs TanStack Table - which should I pick?\n\nPick SvGrid if you want virtualization, Excel-style filters, selection, and\ninline editing working out of the box on Svelte 5. Pick TanStack Table if you\nwant a framework-agnostic headless engine and are happy to build the rendering,\nvirtualization, and editing UI yourself. Both are MIT-licensed.\n\n### Does the TanStack Svelte adapter support Svelte 5?\n\nYes. The `@tanstack/svelte-table` v9 line declares a Svelte 5 peer range\nand passes data through getters rather than stores; the facts block above\nshows the version read from npm. The earlier `createSvelteTable` constructor\nis gone in v9.\n\n### Does AG Grid have an MCP server like SvGrid?\n\nYes. `ag-mcp` (MIT) gives an assistant AG Grid's docs, examples and\nversion-specific upgrade prompts. `@svgrid/mcp` does the same for SvGrid\nand adds a code checker that validates props and imports against the real\nAPI surface, a scaffold tool and a preview. Neither is an in-grid feature;\nSvGrid's natural-language filter, smart fill and summarise helpers are, and\nthey ship free in `@svgrid/grid` with a model provider you register.\n\n### How big is the SvGrid bundle?\n\nThe facts block at the top of this page has the measured gzipped size of the\nfull `<SvGrid>` render component and its stylesheet, read from\n`docs/_data/svgrid-size.json`, which `pnpm size:json` writes. The\n[bundle size reference](./bundle-size.md) breaks it down by entry:\nthe headless core on its own, the core subpath, the charts, and the lazy\nchunks that load on demand.\n\n## See also\n\n- [Why headless?](../why-headless.md) - the design decision behind\n SvGrid's two-layer architecture.\n- [Migrating from AG Grid](./migrating-from-ag-grid.md) - the\n practical recipe.\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - the\n one-to-one API map.\n- [Benchmarks](./benchmarks.md) - how the numbers are produced and what\n they leave out.\n- [Enterprise feature pack](../enterprise/README.md) - what SvGrid charges for.\n- [Missing features](./missing-features.md) - the honest gap list\n versus AG Grid Enterprise.\n- [All comparisons](https://svgrid.com/compare/) - one page per grid, with\n dated sources for every claim.\n"
|
|
5651
5651
|
},
|
|
5652
5652
|
{
|
|
5653
5653
|
"slug": "help/conditional-form-schema",
|
|
@@ -5773,7 +5773,7 @@ export const docs = [
|
|
|
5773
5773
|
"path": "docs/help/fields.md",
|
|
5774
5774
|
"title": "Field types",
|
|
5775
5775
|
"section": "SvGrid Base",
|
|
5776
|
-
"markdown": "# Field types\n\nA column can say what it is - a rating, a URL, a single select with colored\noptions, a list of files - with `fieldType`, and set that type's properties\nwith `fieldProps`. The type fills in the editor, the format and the\nalignment, and draws the cell when the type needs a cell of its own (stars,\nlinks, file thumbnails). The same module adds a \"+\" after the last column to\ncreate fields, a \"+ Add row\" line under the last row, status colors on the\nrow header, field actions in the column menu, and a view bar with saved grid,\nKanban, calendar, gallery and form views.\n\n<div data-docs-demo=\"504-project-tracker\" data-height=\"620\"></div>\n\n> **SvGrid Base, part of the Suite edition.** The `fieldType` / `fieldProps`\n> column properties and the `rowAdder`, `rowColor`, `columnAdder`,\n> `fieldMenu`, `expandRows` and `primaryField` props are part of the free\n> `@svgrid/grid` types; what draws them is SvGrid Base\n> (`@svgrid/enterprise/base`, or `@svgrid/enterprise/fields` for the field\n> types alone). Without it a `fieldType` column draws as an ordinary column and\n> the props do nothing. Without a Suite key the grid shows the Enterprise\n> watermark and everything still runs. New here? [Build a project\n> tracker](./base/start.md) first.\n\n## Turn it on\n\n`enableFields()` registers the built-in types for every grid on the page. It is\na separate module: `installEnterprise()` does not load it, so an app that never\ncalls `enableFields()` does not ship it.\n\n```ts\nimport { enableFields } from '@svgrid/enterprise/fields'\n\nenableFields()\n```\n\n## A table with views\n\n`SvBase` is a grid with a view bar over it. Every prop it does not name\ngoes to the grid; `views` are the saved views and `activeView` the one shown.\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, type FieldView } from '@svgrid/enterprise/fields'\n\n let views = $state<FieldView[]>([\n { id: 'all', name: 'All tasks', type: 'grid' },\n { id: 'board', name: 'By status', type: 'kanban', stackBy: 'status' },\n { id: 'due', name: 'Due dates', type: 'calendar', dateField: 'due' },\n { id: 'cards', name: 'Gallery', type: 'gallery', coverField: 'files' },\n { id: 'form', name: 'Request a task', type: 'form' },\n ])\n</script>\n\n<SvBase {data} {columns} bind:views primaryField=\"task\" editable\n showRowNumbers expandRows containerHeight={600} />\n```\n\nA grid, Kanban, calendar, Gantt or gallery view is the grid itself in another\nmode (`board`, `scheduler`, `gantt`, `gallery`), so the filter and the sort\ncarry over; a form view is drawn beside the grid, which stays mounted under\nit. In a board, calendar or gallery the bar's search narrows the records; the\ntext is not saved with the view. The Gantt type is\noffered once the app has enabled the Gantt view; its task table holds the\nprimary field, the two dates and the working days.\n\n`SvBaseViewBar` is the bar on its own, for a page that lays out its own\ngrid:\n\n```svelte\n<SvBaseViewBar {api} bind:views bind:activeView />\n<SvGrid {data} {columns} onApiReady={(a) => (api = a)} />\n```\n\n## The view bar\n\nFrom the left: the view switcher, then Hide fields, Filter, Group, Sort,\nColor and Row height, and at the right the record count and search (the\ngrid's find bar, Ctrl+F). A button with something set says so (\"2 hidden\nfields\", \"Filtered by Status\", \"Sorted by 1 field\") and is tinted. Each\nsetting goes through the grid's own state, so `api.getState()` holds it.\n\n- **Hide fields**: a switch per field, a search, hide all / show all, and\n drag to reorder. The primary field is always shown.\n- **Filter**: conditions on fields (below), joined by \"and\" or \"or\", with\n condition groups one level deep. Each change filters at once.\n- **Group**: up to three fields, each with a direction. Group headers show\n the value as its cell draws it (see [Grouped records](#grouped-records)).\n- **Sort**: fields in order, each with a direction labeled for its type:\n \"1 → 9\" for a number or a date, \"A → Z\" for text, \"☐ → ☑\" for a checkbox.\n- **Color**: none, a single select's option colors, or conditions in order\n with a color each (the first match colors the row, where the `rowColor`\n prop's `target` says; a condition still missing its value colors nothing).\n A view with no color setting shows the `rowColor` prop's colors.\n- **Row height**: short, medium, tall and extra tall (`rowHeights` on\n `SvBase` or `SvBaseViewBar` sets the list).\n\n## Filter conditions\n\nA condition is a field, an operator that fits the field's type and a value in\nthe control the field calls for. A condition without a value yet filters\nnothing. The filter is the grid's advanced filter with its own expression\nkind, `fieldFilter`, so `api.setAdvancedFilter` sets it and a saved view\nkeeps it.\n\n| Field type | Operators |\n|---|---|\n| Text, long text, URL, email, phone, barcode, color, formula, lookup | contains, does not contain, is, is not, is empty, is not empty |\n| Checklist | is complete, is not complete, % done ≥, % done <, has an item containing, is empty, is not empty |\n| Time of day | is, is before, is after, is at or before, is at or after, is empty, is not empty |\n| Number, currency, percent, rating, duration, autonumber, count, rollup | =, ≠, <, >, ≤, ≥, is empty, is not empty |\n| Single select, user | is, is not, is any of, is none of, is empty, is not empty |\n| Multiple select, multiple users | has any of, has all of, is exactly, has none of, is empty, is not empty |\n| Date, created time, last modified time | is, is before, is after, is on or before, is on or after, is within, is empty, is not empty |\n| Checkbox | is checked / unchecked |\n| Attachment | file name contains, is empty, is not empty |\n| Link to another table | contains, does not contain, is, is not (by the records' names), is empty, is not empty |\n\nA date compares days: \"today\", \"tomorrow\", \"one week ago\", \"one month from\nnow\" or an exact date, and \"is within\" takes the past or next week, month or\nyear, or a number of days. A bare `'2026-10-14'` is that day where the user\nis.\n\n```ts\napi.setAdvancedFilter({\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [\n { column: 'status', kind: 'select', op: 'isAnyOf', value: ['Todo', 'Blocked'] },\n { column: 'due', kind: 'date', op: 'isWithin', value: { span: 'nextWeek' } },\n ],\n})\n```\n\n## Saved views\n\nA view is a name, a type and the settings it had when it was last left:\n\n| Key | What it holds |\n|---|---|\n| `id`, `name`, `type` | `'grid'`, `'kanban'`, `'calendar'`, `'gantt'`, `'gallery'`, `'chart'` or `'form'` |\n| `state` | the grid's state: sorts, groups, the filter, hidden fields, order, widths, pinned columns |\n| `rowHeight`, `color` | the row height and how rows are colored |\n| `stackBy` | Kanban: the single select or user field the cards stack by |\n| `dateField`, `endField` | calendar and Gantt: the dates a record starts and ends on |\n| `progressField`, `dependencyField`, `zoom` | Gantt: a percent field the bars fill with, a link field to the same table naming what each record depends on, and the zoom it was left at |\n| `coverField` | gallery: the attachment field whose first image is the cover |\n| `chart` | chart: `kind` (`'bar'`, `'barH'`, `'line'`, `'pie'`, `'donut'`), `x` the field to group by, `y` a number field (else a count), `aggregation` (`'sum'` or `'avg'`) |\n| `formFields`, `formTitle`, `formDescription` | form: the fields it asks for and its heading |\n\nThe view switcher creates a view of any type (a Kanban asks what to stack by,\na calendar which date field), renames, duplicates and deletes. A new view\nstarts plain: no filter, sorts or groups, every field shown. Changes to the\nshown view are kept a moment after they are made, and `onViewsChange` reports\nthe list whenever it changes, so the app can store it. A Kanban card moved to\nanother lane, or a calendar record moved to another day, writes the field\nthrough the grid's edit path (undo, validation, `onCellValueChange`); a date\nfield without a time shows as all-day events. A Kanban card draws its fields as their cells do (pills,\navatars, file thumbnails), and \"+ Add a card\" in a lane adds a record already\nin that lane, named by the primary field. Double-click a card (or F2) to open its record. On\nthe calendar, picking a day adds a record on it and opens it with its name\nready to type.\n\nA Kanban stacked by a field draws an \"Uncategorized\" lane only while a record\nhas no value in that field. A calendar view whose `color` is a single select\n(`{ mode: 'field', field: 'stage' }`) colors each event as the record's\noption, with the options above the calendar as a legend that hides and shows\ntheir events.\n\n## Gallery, chart and form views\n\nA gallery draws each record as a card: the cover image, the primary field as\nthe title, and the fields the grid shows, each drawn as its cell draws it. The\ncards follow the filter, the sort and the hidden fields; a click opens the\nrecord. It is the grid's [gallery view](./rows/gallery.md) (`gallery`), set up\nfrom the view: the cover field, the primary field as the title, the shown\nfields as the card's fields.\n\nA chart groups the records the view shows (its filter applies) by one field\nand counts them, or adds up or averages a number field, as a bar, horizontal\nbar, line, pie or donut chart. A single select keeps its options' order and\ncolors, a person and a linked record show by name, a date groups by month, and\nthe values read as the summed field writes them (\"$480,000\"). \"Customize\nchart\" in the view bar changes the kind, the field and the value; the view\nkeeps them as `chart`:\n\n```ts\n{ id: 'pipeline', name: 'Pipeline value by stage', type: 'chart', chart: { kind: 'bar', x: 'stage', y: 'value' } }\n{ id: 'funnel', name: 'Candidates by stage', type: 'chart', chart: { kind: 'donut', x: 'stage' } }\n```\n\nA form asks for the fields a person can fill in (computed fields are left\nout), each with the editor its cell uses, and adds a row the way \"+ Add row\"\ndoes: field defaults, the next autonumber, then what was typed, and\n`onRowAdd`. `SvBaseForm` takes `fields`, `required`, `title`,\n`description` and `onSubmit`; a field's `description` shows under it.\n\n## The primary field\n\n`primaryField` names the field that is the record's name. It is always the\nfirst column and pinned, it cannot be hidden or deleted (the column menu does\nnot offer it, the pin splitter stops at it), and it titles the expanded\nrecord, a gallery card and a calendar event.\n\n```svelte\n<SvGrid {data} {columns} primaryField=\"task\" />\n```\n\n## Declare columns by type\n\n```ts\nimport type { GridColumns } from '@svgrid/grid'\n\ntype Task = { task: string; status: string; tags: string[]; due: string; score: number; budget: number; spec: string }\n\nconst columns: GridColumns<Task> = [\n { field: 'task', header: 'Task', fieldType: 'text' },\n {\n field: 'status',\n header: 'Status',\n fieldType: 'singleSelect',\n fieldProps: { options: [{ value: 'Todo', color: '#64748b' }, { value: 'Done', color: '#16a34a' }] },\n },\n { field: 'tags', header: 'Tags', fieldType: 'multiSelect', fieldProps: { options: [{ value: 'Design' }, { value: 'Docs' }] } },\n { field: 'due', header: 'Due', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'score', header: 'Score', fieldType: 'rating' },\n { field: 'budget', header: 'Budget', fieldType: 'number', fieldProps: { format: 'currency', symbol: '€', symbolPosition: 'after', precision: 0 } },\n { field: 'spec', header: 'Spec', fieldType: 'url' },\n]\n```\n\nA property the column sets itself wins over its type:\n`{ fieldType: 'number', align: 'left' }` stays left-aligned.\n\n| Type | `fieldProps` |\n| --- | --- |\n| `text` | `default` |\n| `longText` | `richText` (**bold**, *italic*, `code`, [links](https://svgrid.com), \"- \" lists; drawn as elements, never as HTML) |\n| `richText` | `toolbar` (`standard`, `full`); values are HTML, sanitized when stored and again when drawn |\n| `attachment` | `accept`, `maxFiles`, `maxSize`, `upload` |\n| `checkbox` | `icon` (`check`, `x`, `star`, `heart`, `thumbsUp`, `flag`, `dot`), `color`, `default` |\n| `singleSelect`, `multiSelect` | `options` (`{ id?, value, label?, color? }[]`, 40 colors in the editor, sort A to Z), `default` |\n| `user` | `multiple`, `default`; the people come from `setFieldUsers` |\n| `date` | `dateFormat` (`local`, `friendly`, `us`, `european`, `iso`), `time`, `timeFormat` (`12hour`, `24hour`), `gmt` (one time zone for everyone), `showTimeZone`, `defaultToday` |\n| `phone`, `email`, `url` | none |\n| `barcode` | none |\n| `checklist` | none; values are `{ id, text, done }[]` |\n| `color` | `default`; values are `'#rrggbb'` |\n| `button` | `label`, `color`, `url` (`{Field name}` filled from the row), or `onClick` set in code |\n| `number` | `format` (`integer`, `decimal`, `currency`, `percent`), `precision` 0 to 8, `step` (the editor's spinner, default 1), `separators` (`local`, `comma-period`, `period-comma`, `space-comma`, `space-period`), `showThousands`, `abbreviation` (`none`, `thousand`, `million`, `billion`; not for percent), `allowNegative`, `default`; currency: `symbol`, `symbolPosition` (`before`, `after`); percent: `showBar`, `points` (values 0 to 100 instead of fractions) |\n| `duration` | `durationFormat` (`h:mm`, `h:mm:ss`, `h:mm:ss.S`, `h:mm:ss.SS`, `h:mm:ss.SSS`); values are seconds, typed as `1:30` or `1h 30m` |\n| `timeOfDay` | `timeFormat` (`12hour`, `24hour`), `showSeconds`, `default`; values are `'HH:MM'` (24 hour), `'HH:MM:SS'` with seconds |\n| `rating` | `max` 1 to 10, `icon` (`star`, `heart`, `thumbsUp`, `flag`, `dot`), `color` |\n| `vote` | `icon` (`up`, `thumb`, `heart`), `color`; values are the voters' user ids. A click on the selected cell (or Enter, Space) adds the signed-in person's vote or takes it back; it sorts by the count and filters as people |\n| `sparkline` | `chart` (`line`, `area`, `bar`), `color`, `showLast`; values are numbers, typed or pasted as `3, 7, 4, 9`, sorted by the last |\n| `formula` | `formula`, `result` (`auto`, `number`, `currency`, `percent`, `date`) and that format's options |\n| `createdTime`, `lastModifiedTime` | the date options; last modified also `watch` (`all`, `specific`) and `watchFields` |\n| `createdBy`, `lastModifiedBy` | last modified by: `watch`, `watchFields`; the user comes from `setCurrentUser` |\n| `autoNumber` | none |\n| `link` | `table` (from `registerLinkedTable`), `multiple` |\n| `lookup` | `linkField`, `field` |\n| `rollup` | `linkField`, `field`, `aggregation` (`SUM`, `AVERAGE`, `MIN`, `MAX`, `COUNT`, `COUNTA`, `COUNTALL`, `ARRAYJOIN`, `ARRAYUNIQUE`, `CONCATENATE`, `AND`, `OR`), `precision` |\n| `count` | `linkField` |\n\nA number field has one editor for every format. The box shows the plain\nnumber with the field's decimal character, the currency symbol (before or\nafter) or the percent sign right beside it, and a spinner at the cell's\nedge: its arrows, or Up and Down, add or take away `step` (Shift: ten\ntimes). It reads what people type the way the field writes it: its own\nseparators, a pasted symbol or percent sign, `2.5k`, `3M`, `(120)` for -120.\nEnter commits and moves a row down, Tab a column across. The value is stored\nas typed: precision is how the field shows it, and only an `integer` field\nrounds, to whole numbers. A number with more than 15 significant digits stays\nexact as text, in the cell, the box and the write. A box left as it opened\nstores nothing. Text that is not a number, or a\nnegative where the field allows none, keeps the box open and says why under\nthe cell. Pasting `$1,200.50` into the cell is read the same way. Columns\nwith the older `currency` and `percent` field types keep working and open in\nthe field editor as a number in that format.\n\nLong text opens a panel over the cell with room for paragraphs: Enter\nstarts a new line, Ctrl+Enter (Cmd+Enter), Tab or a click outside saves,\nEscape leaves the cell as it was. With its Markdown option (`richText`) on,\nthe panel names the markup the cell draws.\n\nRich text opens the same kind of panel with a formatting toolbar over the\ntext: bold, italic, underline, strikethrough, bullet and numbered lists, links\nand clear formatting. The `full` toolbar adds headings, quotes, code blocks,\nundo and redo. Ctrl+B, Ctrl+I and Ctrl+U format the selection and Ctrl+K adds\na link; the keys that save and cancel are the long text's. A key typed on the\ncell goes on at the end of the text instead of replacing it. The value is HTML.\nIt is sanitized when it is stored and again before a cell draws it: scripts,\nstyles, event attributes and `javascript:` links are removed. In a grid row\nthe paragraphs and list items run on one line, a taller row height shows them\nas lines, and the expanded record and the form show all of it. A link in a\ncell opens in a new tab. Search, the filter, sorting, a copy, a lookup and a\nformula read the words without the markup, so `LEN({Notes})` counts letters.\nConverting a long text to rich text makes each line a paragraph and renders its\nMarkdown; converting back keeps one line per paragraph and list item.\n\n<div data-docs-demo=\"722-base-rich-text\" data-height=\"620\"></div>\n\n```ts\nimport type { GridColumns } from '@svgrid/grid'\n\ntype Post = { title: string; brief: string | null }\n\nconst columns: GridColumns<Post> = [\n { field: 'title', header: 'Title', fieldType: 'text' },\n { field: 'brief', header: 'Brief', fieldType: 'richText', fieldProps: { toolbar: 'full' } },\n]\n```\n\nA duration uses the same editor in its own format: `2:00` in the box,\n`1:30` or `1h 30m` typed, a minute a step (a second when the format shows\nseconds). A date opens with the date written as its cells write it\n(`October 24, 2026` for friendly) and a calendar, with a time tab when the\nfield has a time. It reads `12/24/2026`, `12/24/26`, `12/24` (this year),\n`2026-12-23`, `Dec 22, 2026` and `22 December 2026`, each with a time after it\nif the field has one. Which of `3/4` is the day follows the field's date\nformat, then the viewer's locale; a number that cannot be a month settles it.\nText that is no date says so under the cell and keeps the box open. A date\nwithout time is stored as the calendar date (`'2026-10-24'`), never moved\nacross a day by a time zone.\n\nIn a base, Enter on a selected cell opens its editor (inside a selected block\nit walks the block), a key typed on a date or a link cell starts editing, as it\ndoes on text, and Space or Enter on a checkbox cell ticks it.\n\nRecords keep an option's name. Rename an option in the field editor and every\nrecord that holds it takes the new name, on a board its cards stay in the lane,\nand what names the option follows: a view's filter and condition colors, form\nlogic, dashboard tiles, automations and the field's default. Remove an option and\nthe editor says how many records hold it, next to Save; saving clears it from\nthem, and their cards go to the Uncategorized lane. Ctrl+Z puts it all back. On a\ntable in a database a rename is a write to each record that holds it, a block at\na time, and the tab bar says how far it has got. The option's `id` is how a save\ntells a rename from a remove and an add; the editor gives one to any option\nthat has none.\n\nA select cell opens a panel over itself: the chosen options as pills (each\nwith a remove button), a search box and the options. Typing filters them; a\nvalue that is not an option yet is offered as \"Add option\", which adds it to\nthe field (with a color, through `onColumnChange`) and picks it. A multiple\nselect stays open to pick more; Backspace in the empty search box removes the\nlast choice. On a single select, Delete or Backspace in the empty search box\nempties the cell, as Delete on the closed cell does. A user field opens the same panel with the people from\n`setFieldUsers`, each with the avatar and name its cells show.\n\nA `default` (or a type's own new-row value: today, the next autonumber, the\ncreated time, the current user) fills the rows the row adder adds. Computed\nand automatic fields are read-only; autonumber and created time give every\nexisting row a value when the field is created.\n\nURL, email and phone cells become links only for the schemes they mean\n(`http(s):`, `mailto:`, `tel:`). A value such as `javascript:alert(1)` stays\ntext. A cell takes any text, and one that is not an address shows as plain text\nwith no link; a form refuses it. Give the column a `validate` to hold cells to\nthe same rule.\n\n## Checklists, colors and times of day\n\n<div data-docs-demo=\"715-base-checklist-color-time\" data-height=\"620\"></div>\n\n```ts\nconst columns = [\n { field: 'session', header: 'Session', fieldType: 'text' },\n { field: 'prep', header: 'Prep', fieldType: 'checklist' },\n { field: 'track', header: 'Track', fieldType: 'color' },\n { field: 'starts', header: 'Starts', fieldType: 'timeOfDay', fieldProps: { timeFormat: '12hour' } },\n]\n\nconst row = {\n session: 'Opening keynote',\n prep: [\n { id: 's1', text: 'Slides final', done: true },\n { id: 's2', text: 'Mic check', done: false },\n ],\n track: '#2d7ff9',\n starts: '09:00',\n}\n```\n\nIn a grid a click on a checkbox's box, a star, a vote or a button acts at once, and\nselects the cell too. A click on the rest of the cell only selects it, so a click to\nselect never changes a record. A double-click on a button runs it once.\n\nOn anything else the first click selects the cell and never leaves the page. A click\non the cell already selected then acts: it follows a link (`url`, `email`, `phone`, a\nlink in rich text), opens a linked record from its chip, and opens the panel of a\nchecklist or attachment. Ctrl or Cmd click follows a link at once, and a double-click\nedits the cell. A finger's tap follows the same rules: it selects a link cell, and the\nnext tap follows the link. A card, a form and an open record have no cell to select,\nso a click acts there at once. In a plain grid a\ncheckbox column that wants a click to select first sets `toggleOnSecondClick`; a\nfield's column has it.\n\nA **checklist** holds to-do items in order, each `{ id, text, done }`. The\ncell shows `1/2` and a bar, green once every item is done. A click on them\nin the selected cell (or Enter, a double-click, a typed key, which starts a new\nitem) opens a panel over the cell; the first click only selects it. In the panel, tick\nan item, rename it in place, drag it by its handle or move it with Alt+Up\nand Alt+Down, delete it, and add one in the box at the bottom (Enter adds\nand stays there). Ctrl+Enter, Tab, Done or a click outside saves; Escape\nleaves the cell as it was. It sorts by the share done, and groups into Not\nstarted, In progress and Done, with empty checklists last. Those groups have\nno \"+\", and Insert record above or below leaves the new record's checklist\nempty: a copy would duplicate someone's to-dos. A column of your own groups\nby what its value amounts to with `groupValue: (value) => key`.\n\nAs text a checklist is one item per line, `[x] Done item` or `[ ] Open item`.\nThat is what a type change to long text, an export and a lookup write, and\na paste, a CSV import or a type change from text read: a line with no mark\nis an open item, and `- [x]` (a Markdown task list) works too. A copy\n(Ctrl+C) puts the items on one line, `[x] Slides final [ ] Mic check`; the\nfield reads several marks on one line as several items.\n\nA **color** is stored lower case as `'#rrggbb'`. The cell shows a swatch and\nthe code. The editor offers the 40 option colors (Arrow keys walk them) and\na box for a code. A paste or the box reads `#rgb`, `#rrggbb`, `2d7ff9`\n(without `#` when the code has a digit), `rgb(45, 127, 249)` and these CSS\nnames: black, white, gray, grey, silver, red, maroon, orange, yellow, olive,\nlime, green, teal, cyan, aqua, blue, navy, purple, magenta, fuchsia, pink,\nbrown, gold, indigo, violet. Anything else (another name, `hsl()`, a color\nwith alpha) is refused: a paste keeps the old value and the editor says so.\nColors sort around the color wheel from red, grays last, and filter as text.\n\nA **time of day** has no date. It is stored as `'HH:MM'` on a 24-hour clock\n(`'HH:MM:SS'` when the field shows seconds) rather than seconds since\nmidnight: it reads the same in JSON, a CSV and a SQL `time` column, sorts in\ntime order as text, and cannot be mistaken for a `duration`, which is\nseconds. `timeFormat` only changes what the cell shows (`2:05 PM` or\n`14:05`). Typed or pasted, it reads `14:05`, `9:30 am`, `9.30 p.m.`, `2pm`,\n`0930`, `noon` and `midnight`; without `showSeconds` the seconds are\ndropped. In the editor Up and Down move by 15 minutes (Shift: an hour). A\nfilter compares to the minute (\"is 9:30\" holds 9:30:15) unless its value\nnames seconds.\n\nA CSV import gives a column of times (`9:00 am`, `22:30`) a time of day\nfield, a column of `#` codes a color field, and a column whose every value\nstarts with `[x]` or `[ ]` a checklist. Changing a duration to a time of day\nreads its seconds as the time since midnight; a date with a time gives its\nlocal time. In SQL (`baseToSql`) a checklist is `jsonb` and a time of day\n`time`.\n\n## Attachments\n\nAn attachment cell holds an array of files:\n\n```ts\nimport type { Attachment } from '@svgrid/enterprise/fields'\n\nconst files: Attachment[] = [\n { id: 'a1', url: 'https://cdn.example.com/plan.png', name: 'plan.png', type: 'image/png', size: 48213 },\n { id: 'a2', url: 'https://cdn.example.com/spec.pdf', name: 'spec.pdf', type: 'application/pdf' },\n]\n```\n\nImages show as thumbnails, other files as chips, as many as the column width\nholds and then \"+N\". Enter or a double click opens the dialog: add files with\nthe picker, by dropping them, by pasting them or by URL; remove, reorder (drag,\nor Alt+Left / Alt+Right) and preview (images and PDFs inline). Files dropped on\nthe cell itself are added without the dialog. A view downloaded from a base\nwrites the file names. A\ncopy in `<SvBase>` writes their URLs, and pasting text adds one attachment per\nhttp(s) URL in it, so a copied cell pastes as the same files. In a base, people\nand links copy as names too, and a pasted name finds its person or record. How\nevery field copies, pastes and fills is in\n[Copy, paste and fill in a base](#copy-paste-and-fill-in-a-base).\n\nUploading is yours to decide. Set one uploader for the app, or one per column\nin `fieldProps.upload`; it gets the file, the row and an abort signal, reports\nprogress, and returns the attachment. A failed upload stays in the dialog with\nRetry.\n\n```ts\nimport { setAttachmentUploader } from '@svgrid/enterprise/fields'\n\nsetAttachmentUploader(async (file, { signal, onProgress }) => {\n const res = await fetch(`/api/upload?name=${encodeURIComponent(file.name)}`, { method: 'PUT', body: file, signal })\n if (!res.ok) throw new Error(`Upload failed (${res.status})`)\n onProgress(1)\n const { url } = (await res.json()) as { url: string }\n return { id: url, url, name: file.name, type: file.type, size: file.size }\n})\n```\n\nWith no uploader, added files stay in the page as `blob:` URLs and are gone\non reload. Thumbnails use `http(s):`, `blob:` and raster `data:image` URLs\nonly.\n\n## People, linked tables and formulas\n\nUser fields choose from the people you list; created by and last modified by\nwrite whoever you say is signed in. Link fields point at rows of a table you\nregister; lookup, rollup and count read through a link field.\n\n```ts\nimport { registerLinkedTable, setCurrentUser, setFieldUsers } from '@svgrid/enterprise/fields'\n\nsetFieldUsers([\n { id: 'u1', name: 'Ana Ruiz' },\n { id: 'u2', name: 'Ben Okafor', avatarUrl: 'https://cdn.example.com/ben.png' },\n])\nsetCurrentUser({ id: 'u1', name: 'Ana Ruiz' })\n\nregisterLinkedTable({\n id: 'milestones',\n name: 'Milestones',\n primaryField: 'name',\n rows: () => [{ id: 'm1', name: 'Beta', date: '2026-10-31' }],\n // A field's type, when it has one, is how a lookup shows it.\n fields: [{ field: 'name', header: 'Name' }, { field: 'date', header: 'Date', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } }],\n})\n\nconst columns = [\n { field: 'milestone', header: 'Milestone', fieldType: 'link', fieldProps: { table: 'milestones', multiple: false } },\n { field: 'milestoneDate', header: 'Milestone date', fieldType: 'lookup', fieldProps: { linkField: 'milestone', field: 'date' } },\n { field: 'total', header: 'Total', fieldType: 'formula', fieldProps: { formula: '{Qty} * {Unit price}', result: 'currency', precision: 2 } },\n]\n```\n\nA link cell shows one chip per linked record. The first click selects the cell, as on any cell; a click on a chip of the selected cell opens that\nrecord (its fields, read-only: the table is the app's), and resting the\npointer on one previews it. A table with a `create` function lets the link\npicker add a record: a search that names no record offers \"+ Create\" for it,\npicked at once.\n\n```ts\nlet milestones = [{ id: 'm1', name: 'Beta', date: '2026-10-31' }]\nregisterLinkedTable({\n id: 'milestones',\n name: 'Milestones',\n primaryField: 'name',\n rows: () => milestones,\n create: (name) => {\n const row = { id: `m${milestones.length + 1}`, name, date: '' }\n milestones = [...milestones, row]\n return row\n },\n})\n```\n\nA formula refers to fields by name in braces and supports `+ - * /`, `&` to\njoin text, comparisons, and functions such as `IF`, `SWITCH`, `AND`, `OR`,\n`CONCATENATE`, `LEFT`, `ROUND`, `SUM`, `DATEADD` and `DATETIME_DIFF`\n(the editor lists them all). It is parsed into functions once, never\nevaluated as code; a formula that does not compile shows `#ERROR` in its\ncells and its message in the field editor.\n\n## Tables and links\n\n`<SvBase tables>` holds several tables, one tab each. A table is its records,\nits fields and its views; `id` is what link fields name.\n\n```ts\nimport { SvBase, type BaseTable } from '@svgrid/enterprise/base'\n\nlet tables: BaseTable[] = [\n {\n id: 'deals', name: 'Deals', primaryField: 'deal', data: deals,\n columns: [\n { field: 'deal', header: 'Deal', fieldType: 'text' },\n { field: 'account', header: 'Account', fieldType: 'link', fieldProps: { table: 'accounts', multiple: false, inverse: 'deals' } },\n ],\n views: [{ id: 'all', name: 'All deals', type: 'grid' }],\n },\n {\n id: 'accounts', name: 'Accounts', primaryField: 'name', data: accounts,\n columns: [\n { field: 'name', header: 'Name', fieldType: 'text' },\n { field: 'deals', header: 'Deals', fieldType: 'link', fieldProps: { table: 'deals', inverse: 'account' } },\n { field: 'pipeline', header: 'Pipeline', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'SUM' } },\n ],\n },\n]\n```\n\n```svelte\n<SvBase bind:tables editable columnAdder fieldMenu onTablesChange={save} />\n```\n\nThe tabs take the theme's colors: the tables sit on its muted surface and the\nshown one is marked with its accent. They switch tables; double-click one, or use its menu, to rename it. The\nmenu also duplicates and deletes the table (deleting asks first and lists the\nlink fields that go with it), and \"Add table\" starts a new one with a Name,\nNotes and Status field. A record of a base has an `id`, and the row adder\ngives a new one its own.\n\nEvery table of the base is a table a link field can point at. A link field\nfrom one table to another gets a field in the other table that links back\n(`fieldProps.inverse` on each names the other), and the two stay in step:\n\n- Linking a deal to an account lists the deal on the account, and the other\n way round. Deleting records takes them out of the links on the other side.\n- Pointing the field at another table moves the field back to that table and\n clears the old links. Turning the field into another type, or deleting it,\n takes the field back with it; the delete asks first and names the lookups,\n rollups and counts that read it, which go with it.\n- Deleting a table deletes the link fields that point at it, and the\n lookups, rollups and counts that read those links.\n\nA rollup of amounts shows as the amounts do (\"$482,000\"). A linked record\nopened from a chip has \"Open in {table}\", which switches to that tab with\nthe record expanded. `onTablesChange` hands over every table after each\nchange to records, fields, views or tables, ready to store.\n\nTo keep the records in a database instead, give each table a `source`: the\nbase loads from it and writes every change back, a link to one record as a\nforeign key and a link to many through a junction table. See\n[Keep a base in a database](./base/data.md).\n\n## Automations\n\nA table's `automations` do things on their own when a record is created,\nchanges, starts matching a condition, is sent with a form or has its button\npressed, or at a scheduled time: update the record, create a record in any\ntable and link it back, show a notice, color the record while it matches, or\nrun an action your app adds. \"Automations\" in the view bar edits them and\nlists every run. See [Automations](./base/automations.md).\n\n## Add a row\n\n`rowAdder` draws \"+ Add row\" under the last row. A click appends a row, scrolls\nto it and starts editing its first editable cell, then fires `onRowAdd` with\nthe row so you can store it.\n\n```ts\nimport type { RowAdderConfig } from '@svgrid/grid'\n\nconst rowAdder: RowAdderConfig<{ status: string }> = {\n label: 'Add task',\n defaults: () => ({ status: 'Todo' }),\n}\n```\n\nWith the grid's `rowDragManaged`, rows drag into a new order by their row\nnumber, but only while nothing sorts or groups them: in a sorted table the\norder is the sort's, so the fields module turns dragging off until the sort is\ncleared.\n\n## Expand a row\n\n`expandRows` (with `showRowNumbers`) makes the row number the row's handle:\non hover it turns into a checkbox that selects the row and an expand button.\nExpand opens the row as a record: every field with its name and type icon,\nits value drawn as the cell draws it, and the same editor the cell uses one\nclick away. A value changed there is written the way a cell edit is, so undo,\nvalidation, `onCellValueChange` and last-modified fields behave the same.\nThe arrows step through the rows in the grid's order. Space on a selected\ncell (not a checkbox) opens its row too.\n\nFields the grid hides are listed under the others, folded, and read-only. Beside\nthe fields is the record's activity: the changes made to it in this session\n(who changed which field to what) and its comments. Comments live in memory\nunless the app keeps them:\n\n```svelte\n<SvGrid {data} {columns} showRowNumbers expandRows editable />\n```\n\n```ts\nimport { setRecordComments } from '@svgrid/enterprise/fields'\n\nsetRecordComments({\n list: (rowId) => comments.filter((c) => c.rowId === rowId),\n add: (rowId, comment) => saveComment(comment),\n})\n```\n\n## Drag to pin columns\n\nThe grid's [`pinSplitter`](./columns/column-pinning.md#drag-to-pin) works over\nfield columns too: drag the divider at the edge of the pinned columns to pin\nmore or fewer. With a `primaryField` it stops at the primary field, which\nstays pinned.\n\n```svelte\n<SvGrid {data} {columns} showRowNumbers pinSplitter primaryField=\"task\" />\n```\n\n## Taller rows\n\nRow height is the grid's `rowHeight`; a view can offer it as short, medium,\ntall and extra tall (34, 56, 88, 128 in the demo above). From 48px the field\ncells use the height: content starts at the top, text wraps to as many lines\nas fit (2 to 6), select pills wrap, long text keeps its line breaks and\nattachment thumbnails grow with the row.\n\n## Summaries at the bottom\n\nWith the grid's `summary` prop on, each field's cell in the footer row picks\nits own summary: a click offers what fits the field (sum, average, median,\nmin, max, range for numbers; checked for a checkbox; earliest, latest and the\nspan for dates; empty, filled, unique and their percentages for every field).\nThe result is written as the field writes its values (`Sum $17,700`,\n`Average 42%`). The choice is kept in `fieldProps.summary` and reported\nthrough `onColumnChange`, so it can be set in the column too:\n\n```ts\n{ field: 'budget', header: 'Budget', fieldType: 'number', fieldProps: { format: 'currency', summary: 'sum' } }\n```\n\n## Grouped records\n\nGrouped by a field (the view bar's Group, the column menu, or `groupBy`), each\ngroup's header shows the field's name over its value, drawn as the cell draws\nit (a select's pill, a person's avatar), the number of records, the summaries\nthe fields picked for that group (\"Budget $4,300\"), and \"+\" to add a record\nthat is already in the group: it gets the group's value, and its parent\ngroups' values, before editing starts.\n\nA single select sorts and groups in the order of its options (\"Q4 2026\"\nbefore \"Q1 2027\" before \"Later\"), not alphabetically. With a filter on, the\ngroup's count and summaries, the record count in the view bar and the footer\ntotals leave out the records the filter hides, whether the group is open or\nclosed.\n\n## Act on selected rows\n\nTick rows with the row header's checkbox (`expandRows`) or the selection\ncolumn, and the grid's [selection bar](./rows/selection-bar.md) acts on all of\nthem: `'editFields'` sets fields on every selected row with each field's own\ncontrol, `'deleteRows'` deletes them after an inline confirm.\n\n```svelte\n<SvGrid {data} {columns} showRowNumbers expandRows\n selectionBar={['selectAll', 'editFields', 'deleteRows']}\n onRowsDelete={(e) => (data = e.data)} />\n```\n\n## Color rows by status\n\nWith `fieldMenu`, a single select's column menu has \"Color rows by this\nfield\" (and \"Stop coloring rows\" on the one in use): the rows take that\nfield's option colors at once, and `onRowColorChange` reports the choice so\nthe app can keep it as `rowColor`.\n\n`rowColor` gives each row a color on its row header: a 3px stripe on the\nleading edge, with the row number left as it is. Color by a select field and\neach row takes its option's color; or give rules, first match wins.\n`target: 'bar'` puts the stripe on the first cell (for grids without row\nnumbers), `target: 'row'` tints the whole row. The row header also gets the status as its title, so the color is\nnever the only signal. Only rendered rows are colored, so it costs nothing at\na million rows.\n\n```ts\nimport type { RowColorConfig } from '@svgrid/grid'\n\ntype Task = { status: string; budget: number }\n\nconst byStatus: RowColorConfig<Task> = { field: 'status' }\nconst byRule: RowColorConfig<Task> = {\n target: 'row',\n rules: [{ when: (row) => row.budget > 2500, color: '#f59e0b', label: 'Over budget' }],\n}\n```\n\n## Create and edit fields\n\n`columnAdder` draws a \"+\" after the last column. It opens the field editor: a\nname, a type (`{ types: [...] }` limits the list) and that type's properties.\nA field left unnamed is named after its type (`Number`, then `Number 2`).\nEvery field column shows its type's icon before the header label.\n`fieldMenu` adds Edit field, Insert left, Insert right, Duplicate field, Hide\nfield and Delete field to every column menu; with a view bar over the grid,\nalso \"Filter by this field\" and \"Group by this field\", which add the condition\nor group and open the bar's panel. The menu's sort items are labeled for the\nfield (\"Sort 1 → 9\", \"Sort A → Z\"). A field's description shows as an info\nmark after its name, read on hover.\n\nChanging a field's type converts its values where they can be (a number typed\nas text stays a number, a comma list becomes multiple-select values, URLs in\ntext become attachments); before applying, the editor says how many cells\nwould be cleared. A select made from other values starts with those values as\nits options.\n\nThe grid keeps no schema. Every change fires an event with the whole column\nlist after the change, as you declared it, and the converted rows when values\nchanged. Store them and the grid stays in step:\n\n```ts\ntype Row = Record<string, unknown>\nlet columns: Record<string, unknown>[] = []\nlet rows: Row[] = []\n\nfunction onFieldChange(e: { columns: Record<string, unknown>[]; data?: Row[] }) {\n columns = e.columns\n if (e.data) rows = e.data\n}\n// <SvGrid {columns} data={rows} columnAdder fieldMenu\n// onColumnAdd={onFieldChange} onColumnChange={onFieldChange} onColumnRemove={onFieldChange} />\n```\n\n## Copy, paste and fill in a base\n\nCtrl+C writes what a cell shows, and a paste reads that text back, so a sheet\ngets `$1,200.00`, `50%`, `1:30` and `October 9, 2026`, not the stored number\nor code behind them. People, links and options copy by name, attachments by URL.\n\nA paste of a copy made on the same page brings back the value the cell stored,\nnot only what its text says: 12.5% shown as `13%` stays 12.5%, rich text keeps\nits bold, and a person stays that person when two people share a name. It does\nso in a field of the same type that shows the value as the same text. Text from\nanywhere else is read as written.\n\nA cell holding a line break or a tab is quoted on the clipboard, as Excel writes\none, with an inner quote doubled, and a paste reads it as one cell. Excel's and\nGoogle Sheets' own quoted text reads the same way. A word that only has quote\nmarks around it (`\"hello\"`) stays as it is.\n\nText a field cannot read leaves the cell as it was, and the page says so once for\nthe whole paste.\n\nThe fill handle and Ctrl+D work by the same rule in every field:\n\n- One source cell copies. Text, numbers and dates included: `Call 2` stays\n `Call 2`, and a date repeats.\n- Two or more source cells continue a series in a number or date field, in any\n format: 10, 20 goes on 30, 40, and dates a week apart go on weekly. A run with\n uneven steps follows its trend in a number field and repeats in a date field.\n Every other field repeats the source cells, durations and times of day\n included.\n- A value the field cannot hold is not written: the cell keeps its value and the\n page says so. A series running below zero stops at a field that refuses\n negatives; an integer field rounds.\n- Filling sideways crosses fields, so the value goes as a copy and paste would: as\n the first field shows it, read by the field it lands in.\n\nCtrl+D copies the top row of the selection down it. With one row selected it\ncopies the row above into it. Both are one undo step.\n\nComputed fields (formula, lookup, rollup, count, autonumber, the created and\nmodified stamps, buttons) copy as they show and take no paste or fill.\n\n## Your own field type\n\n`registerFieldType` adds a type, or replaces a built-in one with the same id.\n`fill` sets up the column; `properties` is what the field editor shows for it;\n`cell` (optional) is a Svelte component that draws the cell and receives\n`{ value, props, row, column }`.\n\n```ts\nimport { registerFieldType } from '@svgrid/enterprise/fields'\n\nregisterFieldType({\n id: 'sku',\n label: 'SKU',\n defaults: { prefix: 'SKU-' },\n properties: [{ key: 'prefix', label: 'Prefix', kind: 'text' }],\n fill: (def, props) => ({\n ...def,\n editorType: def.editorType ?? 'text',\n formatter: def.formatter ?? ((ctx: { value: unknown }) => `${String(props.prefix)}${String(ctx.value ?? '')}`),\n }),\n})\n```\n\n## See also\n\n- [Cell data types](./cells/cell-data-types.md)\n- [Cell components](./cells/cell-components.md)\n- [Conditional formatting](./cells/conditional-formatting.md)\n- [Column menu](./columns/column-menu.md)\n"
|
|
5776
|
+
"markdown": "# Field types\n\nA column can say what it is - a rating, a URL, a single select with colored\noptions, a list of files - with `fieldType`, and set that type's properties\nwith `fieldProps`. The type fills in the editor, the format and the\nalignment, and draws the cell when the type needs a cell of its own (stars,\nlinks, file thumbnails). The same module adds a \"+\" after the last column to\ncreate fields, a \"+ Add row\" line under the last row, status colors on the\nrow header, field actions in the column menu, and a view bar with saved grid,\nKanban, calendar, gallery and form views.\n\n<div data-docs-demo=\"504-project-tracker\" data-height=\"620\"></div>\n\n> **SvGrid Base, part of the Suite edition.** The `fieldType` / `fieldProps`\n> column properties and the `rowAdder`, `rowColor`, `columnAdder`,\n> `fieldMenu`, `expandRows` and `primaryField` props are part of the free\n> `@svgrid/grid` types; what draws them is SvGrid Base\n> (`@svgrid/enterprise/base`, or `@svgrid/enterprise/fields` for the field\n> types alone). Without it a `fieldType` column draws as an ordinary column and\n> the props do nothing. Without a Suite key the grid shows the Enterprise\n> watermark and everything still runs. New here? [Build a project\n> tracker](./base/start.md) first.\n\n## Turn it on\n\n`enableFields()` registers the built-in types for every grid on the page. It is\na separate module: `installEnterprise()` does not load it, so an app that never\ncalls `enableFields()` does not ship it.\n\n```ts\nimport { enableFields } from '@svgrid/enterprise/fields'\n\nenableFields()\n```\n\n## A table with views\n\n`SvBase` is a grid with a view bar over it. Every prop it does not name\ngoes to the grid; `views` are the saved views and `activeView` the one shown.\n\n```svelte\n<script lang=\"ts\">\n import { SvBase, type FieldView } from '@svgrid/enterprise/fields'\n\n let views = $state<FieldView[]>([\n { id: 'all', name: 'All tasks', type: 'grid' },\n { id: 'board', name: 'By status', type: 'kanban', stackBy: 'status' },\n { id: 'due', name: 'Due dates', type: 'calendar', dateField: 'due' },\n { id: 'cards', name: 'Gallery', type: 'gallery', coverField: 'files' },\n { id: 'form', name: 'Request a task', type: 'form' },\n ])\n</script>\n\n<SvBase {data} {columns} bind:views primaryField=\"task\" editable\n showRowNumbers expandRows containerHeight={600} />\n```\n\nA grid, Kanban, calendar, Gantt or gallery view is the grid itself in another\nmode (`board`, `scheduler`, `gantt`, `gallery`), so the filter and the sort\ncarry over; a form view is drawn beside the grid, which stays mounted under\nit. In a board, calendar or gallery the bar's search narrows the records; the\ntext is not saved with the view. The Gantt type is\noffered once the app has enabled the Gantt view; its task table holds the\nprimary field, the two dates and the working days.\n\n`SvBaseViewBar` is the bar on its own, for a page that lays out its own\ngrid:\n\n```svelte\n<SvBaseViewBar {api} bind:views bind:activeView />\n<SvGrid {data} {columns} onApiReady={(a) => (api = a)} />\n```\n\n## The view bar\n\nFrom the left: the view switcher, then Hide fields, Filter, Group, Sort,\nColor and Row height, and at the right the record count and search (the\ngrid's find bar, Ctrl+F). A button with something set says so (\"2 hidden\nfields\", \"Filtered by Status\", \"Sorted by 1 field\") and is tinted. Each\nsetting goes through the grid's own state, so `api.getState()` holds it.\n\n- **Hide fields**: a switch per field, a search, hide all / show all, and\n drag to reorder. The primary field is always shown.\n- **Filter**: conditions on fields (below), joined by \"and\" or \"or\", with\n condition groups one level deep. Each change filters at once.\n- **Group**: up to three fields, each with a direction. Group headers show\n the value as its cell draws it (see [Grouped records](#grouped-records)).\n- **Sort**: fields in order, each with a direction labeled for its type:\n \"1 → 9\" for a number or a date, \"A → Z\" for text, \"☐ → ☑\" for a checkbox.\n- **Color**: none, a single select's option colors, or conditions in order\n with a color each (the first match colors the row, where the `rowColor`\n prop's `target` says; a condition still missing its value colors nothing).\n A view with no color setting shows the `rowColor` prop's colors.\n- **Row height**: short, medium, tall and extra tall (`rowHeights` on\n `SvBase` or `SvBaseViewBar` sets the list).\n\n## Filter conditions\n\nA condition is a field, an operator that fits the field's type and a value in\nthe control the field calls for. A condition without a value yet filters\nnothing. The filter is the grid's advanced filter with its own expression\nkind, `fieldFilter`, so `api.setAdvancedFilter` sets it and a saved view\nkeeps it.\n\n| Field type | Operators |\n|---|---|\n| Text, long text, URL, email, phone, barcode, color, formula, lookup | contains, does not contain, is, is not, is empty, is not empty |\n| Checklist | is complete, is not complete, % done ≥, % done <, has an item containing, is empty, is not empty |\n| Time of day | is, is before, is after, is at or before, is at or after, is empty, is not empty |\n| Number, currency, percent, rating, duration, autonumber, count, rollup | =, ≠, <, >, ≤, ≥, is empty, is not empty |\n| Single select, user | is, is not, is any of, is none of, is empty, is not empty |\n| Multiple select, multiple users | has any of, has all of, is exactly, has none of, is empty, is not empty |\n| Date, created time, last modified time | is, is before, is after, is on or before, is on or after, is within, is empty, is not empty |\n| Checkbox | is checked / unchecked |\n| Attachment | file name contains, is empty, is not empty |\n| Link to another table | contains, does not contain, is, is not (by the records' names), is empty, is not empty |\n\nA date compares days: \"today\", \"tomorrow\", \"one week ago\", \"one month from\nnow\" or an exact date, and \"is within\" takes the past or next week, month or\nyear, or a number of days. A bare `'2026-10-14'` is that day where the user\nis.\n\n```ts\napi.setAdvancedFilter({\n kind: 'fieldFilter',\n conjunction: 'and',\n conditions: [\n { column: 'status', kind: 'select', op: 'isAnyOf', value: ['Todo', 'Blocked'] },\n { column: 'due', kind: 'date', op: 'isWithin', value: { span: 'nextWeek' } },\n ],\n})\n```\n\n## Saved views\n\nA view is a name, a type and the settings it had when it was last left:\n\n| Key | What it holds |\n|---|---|\n| `id`, `name`, `type` | `'grid'`, `'tree'`, `'kanban'`, `'calendar'`, `'timeline'`, `'gantt'`, `'gallery'`, `'chart'`, `'pivot'`, `'list'`, `'inbox'`, `'dashboard'` or `'form'` |\n| `state` | the grid's state: sorts, groups, the filter, hidden fields, order, widths, pinned columns |\n| `rowHeight`, `color` | the row height and how rows are colored |\n| `stackBy` | Kanban: the single select or user field the cards stack by |\n| `dateField`, `endField` | calendar and Gantt: the dates a record starts and ends on |\n| `progressField`, `dependencyField`, `zoom` | Gantt: a percent field the bars fill with, a link field to the same table naming what each record depends on, and the zoom it was left at |\n| `coverField` | gallery: the attachment field whose first image is the cover |\n| `chart` | chart: `kind` (`'bar'`, `'barH'`, `'line'`, `'pie'`, `'donut'`), `x` the field to group by, `y` a number field (else a count), `aggregation` (`'sum'` or `'avg'`) |\n| `formFields`, `formTitle`, `formDescription` | form: the fields it asks for and its heading |\n\nThe view switcher creates a view of any type (a Kanban asks what to stack by,\na calendar which date field), renames, duplicates and deletes. A new view\nstarts plain: no filter, sorts or groups, every field shown. Changes to the\nshown view are kept a moment after they are made, and `onViewsChange` reports\nthe list whenever it changes, so the app can store it. A Kanban card moved to\nanother lane, or a calendar record moved to another day, writes the field\nthrough the grid's edit path (undo, validation, `onCellValueChange`); a date\nfield without a time shows as all-day events. A Kanban card draws its fields as their cells do (pills,\navatars, file thumbnails), and \"+ Add a card\" in a lane adds a record already\nin that lane, named by the primary field. Double-click a card (or F2) to open its record. On\nthe calendar, picking a day adds a record on it and opens it with its name\nready to type.\n\nA Kanban stacked by a field draws an \"Uncategorized\" lane only while a record\nhas no value in that field. A calendar view whose `color` is a single select\n(`{ mode: 'field', field: 'stage' }`) colors each event as the record's\noption, with the options above the calendar as a legend that hides and shows\ntheir events.\n\n## Gallery, chart and form views\n\nA gallery draws each record as a card: the cover image, the primary field as\nthe title, and the fields the grid shows, each drawn as its cell draws it. The\ncards follow the filter, the sort and the hidden fields; a click opens the\nrecord. It is the grid's [gallery view](./rows/gallery.md) (`gallery`), set up\nfrom the view: the cover field, the primary field as the title, the shown\nfields as the card's fields.\n\nA chart groups the records the view shows (its filter applies) by one field\nand counts them, or adds up or averages a number field, as a bar, horizontal\nbar, line, pie or donut chart. A single select keeps its options' order and\ncolors, a person and a linked record show by name, a date groups by month, and\nthe values read as the summed field writes them (\"$480,000\"). \"Customize\nchart\" in the view bar changes the kind, the field and the value; the view\nkeeps them as `chart`:\n\n```ts\n{ id: 'pipeline', name: 'Pipeline value by stage', type: 'chart', chart: { kind: 'bar', x: 'stage', y: 'value' } }\n{ id: 'funnel', name: 'Candidates by stage', type: 'chart', chart: { kind: 'donut', x: 'stage' } }\n```\n\nA form asks for the fields a person can fill in (computed fields are left\nout), each with the editor its cell uses, and adds a row the way \"+ Add row\"\ndoes: field defaults, the next autonumber, then what was typed, and\n`onRowAdd`. `SvBaseForm` takes `fields`, `required`, `title`,\n`description` and `onSubmit`; a field's `description` shows under it.\n\n## The primary field\n\n`primaryField` names the field that is the record's name. It is always the\nfirst column and pinned, it cannot be hidden or deleted (the column menu does\nnot offer it, the pin splitter stops at it), and it titles the expanded\nrecord, a gallery card and a calendar event.\n\n```svelte\n<SvGrid {data} {columns} primaryField=\"task\" />\n```\n\n## Declare columns by type\n\n```ts\nimport type { GridColumns } from '@svgrid/grid'\n\ntype Task = { task: string; status: string; tags: string[]; due: string; score: number; budget: number; spec: string }\n\nconst columns: GridColumns<Task> = [\n { field: 'task', header: 'Task', fieldType: 'text' },\n {\n field: 'status',\n header: 'Status',\n fieldType: 'singleSelect',\n fieldProps: { options: [{ value: 'Todo', color: '#64748b' }, { value: 'Done', color: '#16a34a' }] },\n },\n { field: 'tags', header: 'Tags', fieldType: 'multiSelect', fieldProps: { options: [{ value: 'Design' }, { value: 'Docs' }] } },\n { field: 'due', header: 'Due', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } },\n { field: 'score', header: 'Score', fieldType: 'rating' },\n { field: 'budget', header: 'Budget', fieldType: 'number', fieldProps: { format: 'currency', symbol: '€', symbolPosition: 'after', precision: 0 } },\n { field: 'spec', header: 'Spec', fieldType: 'url' },\n]\n```\n\nA property the column sets itself wins over its type:\n`{ fieldType: 'number', align: 'left' }` stays left-aligned.\n\n| Type | `fieldProps` |\n| --- | --- |\n| `text` | `default` |\n| `longText` | `richText` (**bold**, *italic*, `code`, [links](https://svgrid.com), \"- \" lists; drawn as elements, never as HTML) |\n| `richText` | `toolbar` (`standard`, `full`); values are HTML, sanitized when stored and again when drawn |\n| `attachment` | `accept`, `maxFiles`, `maxSize`, `upload` |\n| `checkbox` | `icon` (`check`, `x`, `star`, `heart`, `thumbsUp`, `flag`, `dot`), `color`, `default` |\n| `singleSelect`, `multiSelect` | `options` (`{ id?, value, label?, color? }[]`, 40 colors in the editor, sort A to Z), `default` |\n| `user` | `multiple`, `default`; the people come from `setFieldUsers` |\n| `date` | `dateFormat` (`local`, `friendly`, `us`, `european`, `iso`), `time`, `timeFormat` (`12hour`, `24hour`), `gmt` (one time zone for everyone), `showTimeZone`, `defaultToday` |\n| `phone`, `email`, `url` | none |\n| `barcode` | none |\n| `checklist` | none; values are `{ id, text, done }[]` |\n| `color` | `default`; values are `'#rrggbb'` |\n| `button` | `label`, `color`, `url` (`{Field name}` filled from the row), or `onClick` set in code |\n| `number` | `format` (`integer`, `decimal`, `currency`, `percent`), `precision` 0 to 8, `step` (the editor's spinner, default 1), `separators` (`local`, `comma-period`, `period-comma`, `space-comma`, `space-period`), `showThousands`, `abbreviation` (`none`, `thousand`, `million`, `billion`; not for percent), `allowNegative`, `default`; currency: `symbol`, `symbolPosition` (`before`, `after`); percent: `showBar`, `points` (values 0 to 100 instead of fractions) |\n| `duration` | `durationFormat` (`h:mm`, `h:mm:ss`, `h:mm:ss.S`, `h:mm:ss.SS`, `h:mm:ss.SSS`); values are seconds, typed as `1:30` or `1h 30m` |\n| `timeOfDay` | `timeFormat` (`12hour`, `24hour`), `showSeconds`, `default`; values are `'HH:MM'` (24 hour), `'HH:MM:SS'` with seconds |\n| `rating` | `max` 1 to 10, `icon` (`star`, `heart`, `thumbsUp`, `flag`, `dot`), `color` |\n| `timer` | `durationFormat` (`h:mm`, `h:mm:ss`), `color`; values are seconds once stopped, and `{ total, since }` while running (`since` an ISO time). The cell's button (or Enter, Space) starts or stops it, each run adding to the total, and the time ticks each second while it runs; a typed `1:30` or `45m` sets the time. Formulas, rollups, sums, sorting, filters and exports read it as seconds, a running timer's run so far included (`timerSeconds`) |\n| `vote` | `icon` (`up`, `thumb`, `heart`), `color`; values are the voters' user ids. A click on the selected cell (or Enter, Space) adds the signed-in person's vote or takes it back; it sorts by the count and filters as people |\n| `sparkline` | `chart` (`line`, `area`, `bar`), `color`, `showLast`; values are numbers, typed or pasted as `3, 7, 4, 9`, sorted by the last |\n| `formula` | `formula`, `result` (`auto`, `number`, `currency`, `percent`, `date`) and that format's options |\n| `createdTime`, `lastModifiedTime` | the date options; last modified also `watch` (`all`, `specific`) and `watchFields` |\n| `createdBy`, `lastModifiedBy` | last modified by: `watch`, `watchFields`; the user comes from `setCurrentUser` |\n| `autoNumber` | none |\n| `link` | `table` (from `registerLinkedTable`), `multiple` |\n| `lookup` | `linkField`, `field` |\n| `rollup` | `linkField`, `field`, `aggregation` (`SUM`, `AVERAGE`, `MIN`, `MAX`, `COUNT`, `COUNTA`, `COUNTALL`, `ARRAYJOIN`, `ARRAYUNIQUE`, `CONCATENATE`, `AND`, `OR`), `precision` |\n| `count` | `linkField` |\n\nA number field has one editor for every format. The box shows the plain\nnumber with the field's decimal character, the currency symbol (before or\nafter) or the percent sign right beside it, and a spinner at the cell's\nedge: its arrows, or Up and Down, add or take away `step` (Shift: ten\ntimes). It reads what people type the way the field writes it: its own\nseparators, a pasted symbol or percent sign, `2.5k`, `3M`, `(120)` for -120.\nEnter commits and moves a row down, Tab a column across. The value is stored\nas typed: precision is how the field shows it, and only an `integer` field\nrounds, to whole numbers. A number with more than 15 significant digits stays\nexact as text, in the cell, the box and the write. A box left as it opened\nstores nothing. Text that is not a number, or a\nnegative where the field allows none, keeps the box open and says why under\nthe cell. Pasting `$1,200.50` into the cell is read the same way. Columns\nwith the older `currency` and `percent` field types keep working and open in\nthe field editor as a number in that format.\n\nLong text opens a panel over the cell with room for paragraphs: Enter\nstarts a new line, Ctrl+Enter (Cmd+Enter), Tab or a click outside saves,\nEscape leaves the cell as it was. With its Markdown option (`richText`) on,\nthe panel names the markup the cell draws.\n\nRich text opens the same kind of panel with a formatting toolbar over the\ntext: bold, italic, underline, strikethrough, bullet and numbered lists, links\nand clear formatting. The `full` toolbar adds headings, quotes, code blocks,\nundo and redo. Ctrl+B, Ctrl+I and Ctrl+U format the selection and Ctrl+K adds\na link; the keys that save and cancel are the long text's. A key typed on the\ncell goes on at the end of the text instead of replacing it. The value is HTML.\nIt is sanitized when it is stored and again before a cell draws it: scripts,\nstyles, event attributes and `javascript:` links are removed. In a grid row\nthe paragraphs and list items run on one line, a taller row height shows them\nas lines, and the expanded record and the form show all of it. A link in a\ncell opens in a new tab. Search, the filter, sorting, a copy, a lookup and a\nformula read the words without the markup, so `LEN({Notes})` counts letters.\nConverting a long text to rich text makes each line a paragraph and renders its\nMarkdown; converting back keeps one line per paragraph and list item.\n\n<div data-docs-demo=\"722-base-rich-text\" data-height=\"620\"></div>\n\n```ts\nimport type { GridColumns } from '@svgrid/grid'\n\ntype Post = { title: string; brief: string | null }\n\nconst columns: GridColumns<Post> = [\n { field: 'title', header: 'Title', fieldType: 'text' },\n { field: 'brief', header: 'Brief', fieldType: 'richText', fieldProps: { toolbar: 'full' } },\n]\n```\n\nA duration uses the same editor in its own format: `2:00` in the box,\n`1:30` or `1h 30m` typed, a minute a step (a second when the format shows\nseconds). A date opens with the date written as its cells write it\n(`October 24, 2026` for friendly) and a calendar, with a time tab when the\nfield has a time. It reads `12/24/2026`, `12/24/26`, `12/24` (this year),\n`2026-12-23`, `Dec 22, 2026` and `22 December 2026`, each with a time after it\nif the field has one. Which of `3/4` is the day follows the field's date\nformat, then the viewer's locale; a number that cannot be a month settles it.\nText that is no date says so under the cell and keeps the box open. A date\nwithout time is stored as the calendar date (`'2026-10-24'`), never moved\nacross a day by a time zone.\n\nIn a base, Enter on a selected cell opens its editor (inside a selected block\nit walks the block), a key typed on a date or a link cell starts editing, as it\ndoes on text, and Space or Enter on a checkbox cell ticks it.\n\nRecords keep an option's name. Rename an option in the field editor and every\nrecord that holds it takes the new name, on a board its cards stay in the lane,\nand what names the option follows: a view's filter and condition colors, form\nlogic, dashboard tiles, automations and the field's default. Remove an option and\nthe editor says how many records hold it, next to Save; saving clears it from\nthem, and their cards go to the Uncategorized lane. Ctrl+Z puts it all back. On a\ntable in a database a rename is a write to each record that holds it, a block at\na time, and the tab bar says how far it has got. The option's `id` is how a save\ntells a rename from a remove and an add; the editor gives one to any option\nthat has none.\n\nA select cell opens a panel over itself: the chosen options as pills (each\nwith a remove button), a search box and the options. Typing filters them; a\nvalue that is not an option yet is offered as \"Add option\", which adds it to\nthe field (with a color, through `onColumnChange`) and picks it. A multiple\nselect stays open to pick more; Backspace in the empty search box removes the\nlast choice. On a single select, Delete or Backspace in the empty search box\nempties the cell, as Delete on the closed cell does. A user field opens the same panel with the people from\n`setFieldUsers`, each with the avatar and name its cells show.\n\nA `default` (or a type's own new-row value: today, the next autonumber, the\ncreated time, the current user) fills the rows the row adder adds. Computed\nand automatic fields are read-only; autonumber and created time give every\nexisting row a value when the field is created.\n\nURL, email and phone cells become links only for the schemes they mean\n(`http(s):`, `mailto:`, `tel:`). A value such as `javascript:alert(1)` stays\ntext. A cell takes any text, and one that is not an address shows as plain text\nwith no link; a form refuses it. Give the column a `validate` to hold cells to\nthe same rule.\n\n## Checklists, colors and times of day\n\n<div data-docs-demo=\"715-base-checklist-color-time\" data-height=\"620\"></div>\n\n```ts\nconst columns = [\n { field: 'session', header: 'Session', fieldType: 'text' },\n { field: 'prep', header: 'Prep', fieldType: 'checklist' },\n { field: 'track', header: 'Track', fieldType: 'color' },\n { field: 'starts', header: 'Starts', fieldType: 'timeOfDay', fieldProps: { timeFormat: '12hour' } },\n]\n\nconst row = {\n session: 'Opening keynote',\n prep: [\n { id: 's1', text: 'Slides final', done: true },\n { id: 's2', text: 'Mic check', done: false },\n ],\n track: '#2d7ff9',\n starts: '09:00',\n}\n```\n\nIn a grid a click on a checkbox's box, a star, a vote, a timer's button or a button acts at once, and\nselects the cell too. A click on the rest of the cell only selects it, so a click to\nselect never changes a record. A double-click on a button runs it once.\n\nOn anything else the first click selects the cell and never leaves the page. A click\non the cell already selected then acts: it follows a link (`url`, `email`, `phone`, a\nlink in rich text), opens a linked record from its chip, and opens the panel of a\nchecklist or attachment. Ctrl or Cmd click follows a link at once, and a double-click\nedits the cell. A finger's tap follows the same rules: it selects a link cell, and the\nnext tap follows the link. A card, a form and an open record have no cell to select,\nso a click acts there at once. In a plain grid a\ncheckbox column that wants a click to select first sets `toggleOnSecondClick`; a\nfield's column has it.\n\nA **checklist** holds to-do items in order, each `{ id, text, done }`. The\ncell shows `1/2` and a bar, green once every item is done. A click on them\nin the selected cell (or Enter, a double-click, a typed key, which starts a new\nitem) opens a panel over the cell; the first click only selects it. In the panel, tick\nan item, rename it in place, drag it by its handle or move it with Alt+Up\nand Alt+Down, delete it, and add one in the box at the bottom (Enter adds\nand stays there). Ctrl+Enter, Tab, Done or a click outside saves; Escape\nleaves the cell as it was. It sorts by the share done, and groups into Not\nstarted, In progress and Done, with empty checklists last. Those groups have\nno \"+\", and Insert record above or below leaves the new record's checklist\nempty: a copy would duplicate someone's to-dos. A column of your own groups\nby what its value amounts to with `groupValue: (value) => key`.\n\nAs text a checklist is one item per line, `[x] Done item` or `[ ] Open item`.\nThat is what a type change to long text, an export and a lookup write, and\na paste, a CSV import or a type change from text read: a line with no mark\nis an open item, and `- [x]` (a Markdown task list) works too. A copy\n(Ctrl+C) puts the items on one line, `[x] Slides final [ ] Mic check`; the\nfield reads several marks on one line as several items.\n\nA **color** is stored lower case as `'#rrggbb'`. The cell shows a swatch and\nthe code. The editor offers the 40 option colors (Arrow keys walk them) and\na box for a code. A paste or the box reads `#rgb`, `#rrggbb`, `2d7ff9`\n(without `#` when the code has a digit), `rgb(45, 127, 249)` and these CSS\nnames: black, white, gray, grey, silver, red, maroon, orange, yellow, olive,\nlime, green, teal, cyan, aqua, blue, navy, purple, magenta, fuchsia, pink,\nbrown, gold, indigo, violet. Anything else (another name, `hsl()`, a color\nwith alpha) is refused: a paste keeps the old value and the editor says so.\nColors sort around the color wheel from red, grays last, and filter as text.\n\nA **time of day** has no date. It is stored as `'HH:MM'` on a 24-hour clock\n(`'HH:MM:SS'` when the field shows seconds) rather than seconds since\nmidnight: it reads the same in JSON, a CSV and a SQL `time` column, sorts in\ntime order as text, and cannot be mistaken for a `duration`, which is\nseconds. `timeFormat` only changes what the cell shows (`2:05 PM` or\n`14:05`). Typed or pasted, it reads `14:05`, `9:30 am`, `9.30 p.m.`, `2pm`,\n`0930`, `noon` and `midnight`; without `showSeconds` the seconds are\ndropped. In the editor Up and Down move by 15 minutes (Shift: an hour). A\nfilter compares to the minute (\"is 9:30\" holds 9:30:15) unless its value\nnames seconds.\n\nA CSV import gives a column of times (`9:00 am`, `22:30`) a time of day\nfield, a column of `#` codes a color field, and a column whose every value\nstarts with `[x]` or `[ ]` a checklist. Changing a duration to a time of day\nreads its seconds as the time since midnight; a date with a time gives its\nlocal time. In SQL (`baseToSql`) a checklist is `jsonb` and a time of day\n`time`.\n\n## Attachments\n\nAn attachment cell holds an array of files:\n\n```ts\nimport type { Attachment } from '@svgrid/enterprise/fields'\n\nconst files: Attachment[] = [\n { id: 'a1', url: 'https://cdn.example.com/plan.png', name: 'plan.png', type: 'image/png', size: 48213 },\n { id: 'a2', url: 'https://cdn.example.com/spec.pdf', name: 'spec.pdf', type: 'application/pdf' },\n]\n```\n\nImages show as thumbnails, other files as chips, as many as the column width\nholds and then \"+N\". Enter or a double click opens the dialog: add files with\nthe picker, by dropping them, by pasting them or by URL; remove, reorder (drag,\nor Alt+Left / Alt+Right) and preview (images and PDFs inline). Files dropped on\nthe cell itself are added without the dialog. A view downloaded from a base\nwrites the file names. A\ncopy in `<SvBase>` writes their URLs, and pasting text adds one attachment per\nhttp(s) URL in it, so a copied cell pastes as the same files. In a base, people\nand links copy as names too, and a pasted name finds its person or record. How\nevery field copies, pastes and fills is in\n[Copy, paste and fill in a base](#copy-paste-and-fill-in-a-base).\n\nUploading is yours to decide. Set one uploader for the app, or one per column\nin `fieldProps.upload`; it gets the file, the row and an abort signal, reports\nprogress, and returns the attachment. A failed upload stays in the dialog with\nRetry.\n\n```ts\nimport { setAttachmentUploader } from '@svgrid/enterprise/fields'\n\nsetAttachmentUploader(async (file, { signal, onProgress }) => {\n const res = await fetch(`/api/upload?name=${encodeURIComponent(file.name)}`, { method: 'PUT', body: file, signal })\n if (!res.ok) throw new Error(`Upload failed (${res.status})`)\n onProgress(1)\n const { url } = (await res.json()) as { url: string }\n return { id: url, url, name: file.name, type: file.type, size: file.size }\n})\n```\n\nWith no uploader, added files stay in the page as `blob:` URLs and are gone\non reload. Thumbnails use `http(s):`, `blob:` and raster `data:image` URLs\nonly.\n\n## People, linked tables and formulas\n\nUser fields choose from the people you list; created by and last modified by\nwrite whoever you say is signed in. Link fields point at rows of a table you\nregister; lookup, rollup and count read through a link field.\n\n```ts\nimport { registerLinkedTable, setCurrentUser, setFieldUsers } from '@svgrid/enterprise/fields'\n\nsetFieldUsers([\n { id: 'u1', name: 'Ana Ruiz' },\n { id: 'u2', name: 'Ben Okafor', avatarUrl: 'https://cdn.example.com/ben.png' },\n])\nsetCurrentUser({ id: 'u1', name: 'Ana Ruiz' })\n\nregisterLinkedTable({\n id: 'milestones',\n name: 'Milestones',\n primaryField: 'name',\n rows: () => [{ id: 'm1', name: 'Beta', date: '2026-10-31' }],\n // A field's type, when it has one, is how a lookup shows it.\n fields: [{ field: 'name', header: 'Name' }, { field: 'date', header: 'Date', fieldType: 'date', fieldProps: { dateFormat: 'friendly' } }],\n})\n\nconst columns = [\n { field: 'milestone', header: 'Milestone', fieldType: 'link', fieldProps: { table: 'milestones', multiple: false } },\n { field: 'milestoneDate', header: 'Milestone date', fieldType: 'lookup', fieldProps: { linkField: 'milestone', field: 'date' } },\n { field: 'total', header: 'Total', fieldType: 'formula', fieldProps: { formula: '{Qty} * {Unit price}', result: 'currency', precision: 2 } },\n]\n```\n\nA link cell shows one chip per linked record. The first click selects the cell, as on any cell; a click on a chip of the selected cell opens that\nrecord (its fields, read-only: the table is the app's), and resting the\npointer on one previews it. A table with a `create` function lets the link\npicker add a record: a search that names no record offers \"+ Create\" for it,\npicked at once.\n\n```ts\nlet milestones = [{ id: 'm1', name: 'Beta', date: '2026-10-31' }]\nregisterLinkedTable({\n id: 'milestones',\n name: 'Milestones',\n primaryField: 'name',\n rows: () => milestones,\n create: (name) => {\n const row = { id: `m${milestones.length + 1}`, name, date: '' }\n milestones = [...milestones, row]\n return row\n },\n})\n```\n\nA formula refers to fields by name in braces and supports `+ - * /`, `&` to\njoin text, comparisons, and functions such as `IF`, `SWITCH`, `AND`, `OR`,\n`CONCATENATE`, `LEFT`, `ROUND`, `SUM`, `DATEADD` and `DATETIME_DIFF`\n(the editor lists them all). It is parsed into functions once, never\nevaluated as code; a formula that does not compile shows `#ERROR` in its\ncells and its message in the field editor.\n\n## Tables and links\n\n`<SvBase tables>` holds several tables, one tab each. A table is its records,\nits fields and its views; `id` is what link fields name.\n\n```ts\nimport { SvBase, type BaseTable } from '@svgrid/enterprise/base'\n\nlet tables: BaseTable[] = [\n {\n id: 'deals', name: 'Deals', primaryField: 'deal', data: deals,\n columns: [\n { field: 'deal', header: 'Deal', fieldType: 'text' },\n { field: 'account', header: 'Account', fieldType: 'link', fieldProps: { table: 'accounts', multiple: false, inverse: 'deals' } },\n ],\n views: [{ id: 'all', name: 'All deals', type: 'grid' }],\n },\n {\n id: 'accounts', name: 'Accounts', primaryField: 'name', data: accounts,\n columns: [\n { field: 'name', header: 'Name', fieldType: 'text' },\n { field: 'deals', header: 'Deals', fieldType: 'link', fieldProps: { table: 'deals', inverse: 'account' } },\n { field: 'pipeline', header: 'Pipeline', fieldType: 'rollup', fieldProps: { linkField: 'deals', field: 'value', aggregation: 'SUM' } },\n ],\n },\n]\n```\n\n```svelte\n<SvBase bind:tables editable columnAdder fieldMenu onTablesChange={save} />\n```\n\nThe tabs take the theme's colors: the tables sit on its muted surface and the\nshown one is marked with its accent. They switch tables; double-click one, or use its menu, to rename it. The\nmenu also duplicates and deletes the table (deleting asks first and lists the\nlink fields that go with it), and \"Add table\" starts a new one with a Name,\nNotes and Status field. A record of a base has an `id`, and the row adder\ngives a new one its own.\n\nEvery table of the base is a table a link field can point at. A link field\nfrom one table to another gets a field in the other table that links back\n(`fieldProps.inverse` on each names the other), and the two stay in step:\n\n- Linking a deal to an account lists the deal on the account, and the other\n way round. Deleting records takes them out of the links on the other side.\n- Pointing the field at another table moves the field back to that table and\n clears the old links. Turning the field into another type, or deleting it,\n takes the field back with it; the delete asks first and names the lookups,\n rollups and counts that read it, which go with it.\n- Deleting a table deletes the link fields that point at it, and the\n lookups, rollups and counts that read those links.\n\nA rollup of amounts shows as the amounts do (\"$482,000\"). A linked record\nopened from a chip has \"Open in {table}\", which switches to that tab with\nthe record expanded. `onTablesChange` hands over every table after each\nchange to records, fields, views or tables, ready to store.\n\nTo keep the records in a database instead, give each table a `source`: the\nbase loads from it and writes every change back, a link to one record as a\nforeign key and a link to many through a junction table. See\n[Keep a base in a database](./base/data.md).\n\n## Automations\n\nA table's `automations` do things on their own when a record is created,\nchanges, starts matching a condition, is sent with a form or has its button\npressed, or at a scheduled time: update the record, create a record in any\ntable and link it back, show a notice, color the record while it matches, or\nrun an action your app adds. \"Automations\" in the view bar edits them and\nlists every run. See [Automations](./base/automations.md).\n\n## Add a row\n\n`rowAdder` draws \"+ Add row\" under the last row. A click appends a row, scrolls\nto it and starts editing its first editable cell, then fires `onRowAdd` with\nthe row so you can store it.\n\n```ts\nimport type { RowAdderConfig } from '@svgrid/grid'\n\nconst rowAdder: RowAdderConfig<{ status: string }> = {\n label: 'Add task',\n defaults: () => ({ status: 'Todo' }),\n}\n```\n\nWith the grid's `rowDragManaged`, rows drag into a new order by their row\nnumber, but only while nothing sorts or groups them: in a sorted table the\norder is the sort's, so the fields module turns dragging off until the sort is\ncleared.\n\n## Expand a row\n\n`expandRows` (with `showRowNumbers`) makes the row number the row's handle:\non hover it turns into a checkbox that selects the row and an expand button.\nExpand opens the row as a record: every field with its name and type icon,\nits value drawn as the cell draws it, and the same editor the cell uses one\nclick away. A value changed there is written the way a cell edit is, so undo,\nvalidation, `onCellValueChange` and last-modified fields behave the same.\nThe arrows step through the rows in the grid's order. Space on a selected\ncell (not a checkbox) opens its row too.\n\nFields the grid hides are listed under the others, folded, and read-only. Beside\nthe fields is the record's activity: the changes made to it in this session\n(who changed which field to what) and its comments. Comments live in memory\nunless the app keeps them:\n\n```svelte\n<SvGrid {data} {columns} showRowNumbers expandRows editable />\n```\n\n```ts\nimport { setRecordComments } from '@svgrid/enterprise/fields'\n\nsetRecordComments({\n list: (rowId) => comments.filter((c) => c.rowId === rowId),\n add: (rowId, comment) => saveComment(comment),\n})\n```\n\n## Drag to pin columns\n\nThe grid's [`pinSplitter`](./columns/column-pinning.md#drag-to-pin) works over\nfield columns too: drag the divider at the edge of the pinned columns to pin\nmore or fewer. With a `primaryField` it stops at the primary field, which\nstays pinned.\n\n```svelte\n<SvGrid {data} {columns} showRowNumbers pinSplitter primaryField=\"task\" />\n```\n\n## Taller rows\n\nRow height is the grid's `rowHeight`; a view can offer it as short, medium,\ntall and extra tall (34, 56, 88, 128 in the demo above). From 48px the field\ncells use the height: content starts at the top, text wraps to as many lines\nas fit (2 to 6), select pills wrap, long text keeps its line breaks and\nattachment thumbnails grow with the row.\n\n## Summaries at the bottom\n\nWith the grid's `summary` prop on, each field's cell in the footer row picks\nits own summary: a click offers what fits the field (sum, average, median,\nmin, max, range for numbers; checked for a checkbox; earliest, latest and the\nspan for dates; empty, filled, unique and their percentages for every field).\nThe result is written as the field writes its values (`Sum $17,700`,\n`Average 42%`). The choice is kept in `fieldProps.summary` and reported\nthrough `onColumnChange`, so it can be set in the column too:\n\n```ts\n{ field: 'budget', header: 'Budget', fieldType: 'number', fieldProps: { format: 'currency', summary: 'sum' } }\n```\n\n## Grouped records\n\nGrouped by a field (the view bar's Group, the column menu, or `groupBy`), each\ngroup's header shows the field's name over its value, drawn as the cell draws\nit (a select's pill, a person's avatar), the number of records, the summaries\nthe fields picked for that group (\"Budget $4,300\"), and \"+\" to add a record\nthat is already in the group: it gets the group's value, and its parent\ngroups' values, before editing starts.\n\nA single select sorts and groups in the order of its options (\"Q4 2026\"\nbefore \"Q1 2027\" before \"Later\"), not alphabetically. With a filter on, the\ngroup's count and summaries, the record count in the view bar and the footer\ntotals leave out the records the filter hides, whether the group is open or\nclosed.\n\n## Act on selected rows\n\nTick rows with the row header's checkbox (`expandRows`) or the selection\ncolumn, and the grid's [selection bar](./rows/selection-bar.md) acts on all of\nthem: `'editFields'` sets fields on every selected row with each field's own\ncontrol, `'deleteRows'` deletes them after an inline confirm.\n\n```svelte\n<SvGrid {data} {columns} showRowNumbers expandRows\n selectionBar={['selectAll', 'editFields', 'deleteRows']}\n onRowsDelete={(e) => (data = e.data)} />\n```\n\n## Color rows by status\n\nWith `fieldMenu`, a single select's column menu has \"Color rows by this\nfield\" (and \"Stop coloring rows\" on the one in use): the rows take that\nfield's option colors at once, and `onRowColorChange` reports the choice so\nthe app can keep it as `rowColor`.\n\n`rowColor` gives each row a color on its row header: a 3px stripe on the\nleading edge, with the row number left as it is. Color by a select field and\neach row takes its option's color; or give rules, first match wins.\n`target: 'bar'` puts the stripe on the first cell (for grids without row\nnumbers), `target: 'row'` tints the whole row. The row header also gets the status as its title, so the color is\nnever the only signal. Only rendered rows are colored, so it costs nothing at\na million rows.\n\n```ts\nimport type { RowColorConfig } from '@svgrid/grid'\n\ntype Task = { status: string; budget: number }\n\nconst byStatus: RowColorConfig<Task> = { field: 'status' }\nconst byRule: RowColorConfig<Task> = {\n target: 'row',\n rules: [{ when: (row) => row.budget > 2500, color: '#f59e0b', label: 'Over budget' }],\n}\n```\n\n## Create and edit fields\n\n`columnAdder` draws a \"+\" after the last column. It opens the field editor: a\nname, a type (`{ types: [...] }` limits the list) and that type's properties.\nA field left unnamed is named after its type (`Number`, then `Number 2`).\nEvery field column shows its type's icon before the header label.\n`fieldMenu` adds Edit field, Insert left, Insert right, Duplicate field, Hide\nfield and Delete field to every column menu; with a view bar over the grid,\nalso \"Filter by this field\" and \"Group by this field\", which add the condition\nor group and open the bar's panel. The menu's sort items are labeled for the\nfield (\"Sort 1 → 9\", \"Sort A → Z\"). A field's description shows as an info\nmark after its name, read on hover.\n\nChanging a field's type converts its values where they can be (a number typed\nas text stays a number, a comma list becomes multiple-select values, URLs in\ntext become attachments); before applying, the editor says how many cells\nwould be cleared. A select made from other values starts with those values as\nits options.\n\nThe grid keeps no schema. Every change fires an event with the whole column\nlist after the change, as you declared it, and the converted rows when values\nchanged. Store them and the grid stays in step:\n\n```ts\ntype Row = Record<string, unknown>\nlet columns: Record<string, unknown>[] = []\nlet rows: Row[] = []\n\nfunction onFieldChange(e: { columns: Record<string, unknown>[]; data?: Row[] }) {\n columns = e.columns\n if (e.data) rows = e.data\n}\n// <SvGrid {columns} data={rows} columnAdder fieldMenu\n// onColumnAdd={onFieldChange} onColumnChange={onFieldChange} onColumnRemove={onFieldChange} />\n```\n\n## Copy, paste and fill in a base\n\nCtrl+C writes what a cell shows, and a paste reads that text back, so a sheet\ngets `$1,200.00`, `50%`, `1:30` and `October 9, 2026`, not the stored number\nor code behind them. People, links and options copy by name, attachments by URL.\n\nA paste of a copy made on the same page brings back the value the cell stored,\nnot only what its text says: 12.5% shown as `13%` stays 12.5%, rich text keeps\nits bold, and a person stays that person when two people share a name. It does\nso in a field of the same type that shows the value as the same text. Text from\nanywhere else is read as written.\n\nA cell holding a line break or a tab is quoted on the clipboard, as Excel writes\none, with an inner quote doubled, and a paste reads it as one cell. Excel's and\nGoogle Sheets' own quoted text reads the same way. A word that only has quote\nmarks around it (`\"hello\"`) stays as it is.\n\nText a field cannot read leaves the cell as it was, and the page says so once for\nthe whole paste.\n\nThe fill handle and Ctrl+D work by the same rule in every field:\n\n- One source cell copies. Text, numbers and dates included: `Call 2` stays\n `Call 2`, and a date repeats.\n- Two or more source cells continue a series in a number or date field, in any\n format: 10, 20 goes on 30, 40, and dates a week apart go on weekly. A run with\n uneven steps follows its trend in a number field and repeats in a date field.\n Every other field repeats the source cells, durations and times of day\n included.\n- A value the field cannot hold is not written: the cell keeps its value and the\n page says so. A series running below zero stops at a field that refuses\n negatives; an integer field rounds.\n- Filling sideways crosses fields, so the value goes as a copy and paste would: as\n the first field shows it, read by the field it lands in.\n\nCtrl+D copies the top row of the selection down it. With one row selected it\ncopies the row above into it. Both are one undo step.\n\nComputed fields (formula, lookup, rollup, count, autonumber, the created and\nmodified stamps, buttons) copy as they show and take no paste or fill.\n\n## Your own field type\n\n`registerFieldType` adds a type, or replaces a built-in one with the same id.\n`fill` sets up the column; `properties` is what the field editor shows for it;\n`cell` (optional) is a Svelte component that draws the cell and receives\n`{ value, props, row, column }`.\n\n```ts\nimport { registerFieldType } from '@svgrid/enterprise/fields'\n\nregisterFieldType({\n id: 'sku',\n label: 'SKU',\n defaults: { prefix: 'SKU-' },\n properties: [{ key: 'prefix', label: 'Prefix', kind: 'text' }],\n fill: (def, props) => ({\n ...def,\n editorType: def.editorType ?? 'text',\n formatter: def.formatter ?? ((ctx: { value: unknown }) => `${String(props.prefix)}${String(ctx.value ?? '')}`),\n }),\n})\n```\n\n## See also\n\n- [Cell data types](./cells/cell-data-types.md)\n- [Cell components](./cells/cell-components.md)\n- [Conditional formatting](./cells/conditional-formatting.md)\n- [Column menu](./columns/column-menu.md)\n"
|
|
5777
5777
|
},
|
|
5778
5778
|
{
|
|
5779
5779
|
"slug": "help/figma",
|
|
@@ -6067,7 +6067,7 @@ export const docs = [
|
|
|
6067
6067
|
"path": "docs/help/migrating-from-ag-grid.md",
|
|
6068
6068
|
"title": "Migrating from AG Grid to SvGrid",
|
|
6069
6069
|
"section": "Help",
|
|
6070
|
-
"markdown": "\n# Migrating from AG Grid to SvGrid\n\nIf you tried AG Grid on a Svelte 5 project - via `ag-grid-svelte`, the\nold `ag-grid-community/svelte`, or a hand-rolled wrapper - you probably\nhit the same friction everyone hits: the bridge between AG Grid's\nReact/Angular-first API and Svelte 5 runes is brittle, the bundle is\nheavy, and the Enterprise pricing only makes sense at scale.\n\n<!-- facts:start ag-grid -->\n> **Facts, checked 9 Nov 2026.** `ag-grid-community` 36.3.0, MIT, last published 4 Nov 2026, 16,400,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `ag-grid-community` 36.3.0 346.4 KB JS, no separate stylesheet (measured 9 Nov 2026). AG Grid pricing, as its site states it: AG Grid Community is free under MIT. AG Grid Enterprise is listed at $999 USD per developer with one year of updates and Zendesk support; the Enterprise Bundle with AG Charts Enterprise is $1,498 USD per developer (https://www.ag-grid.com/license-pricing/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/).\n<!-- facts:end -->\n\nThis page is a 30-minute migration recipe from AG Grid to SvGrid. It\ncovers what maps 1:1, what's different by design, and what you'll lose.\nWe tell you when **not** to switch at the bottom.\n\n## TL;DR\n\n| | AG Grid Community | AG Grid Enterprise | SvGrid Community | @svgrid/enterprise |\n| --- | --- | --- | --- | --- |\n| **Licence** | MIT | Commercial, per developer (the price is in the facts box above) | **MIT** | $599/dev/yr (grid) or $999/dev/yr (grid + spreadsheet + Studio) |\n| **Svelte 5 native** | No (community-built integration) | No (community-built integration) | Yes | Yes |\n| **Bundle (gzipped)** | measured, in the facts box above | not measured (licence) | measured, in the facts box above | lazy-loaded subpaths |\n| **Sorting / filtering** | Yes | Yes | Yes | (in Community) |\n| **Row grouping + aggregation** | No (Enterprise) | Yes | Yes (free) | (in Community) |\n| **Master/detail, tree, range select** | No (Enterprise) | Yes | Yes (free) | (in Community) |\n| **Set filter / Excel-style filter menu** | No (Enterprise) | Yes | Yes (free) | (in Community) |\n| **Server-side data, flat (infinite row model)** | Yes | Yes | Yes (free) | (in Community) |\n| **Server-side row model (grouping, tree, pivot, transactions, selection)** | No (Enterprise) | Yes | No | Yes |\n| **Integrated charts** | No (Enterprise) | Yes, AG Charts | Yes (free) | (in Community) |\n| **CSV export** | Yes (API) | Yes | Yes, with TSV and JSON | (in Community) |\n| **Excel export** | No | Yes | No | Yes |\n| **PDF / styled-HTML export, print** | No | No | No | Yes |\n| **Pivot tables** | No | Yes | No | Yes |\n| **MCP server for AI assistants** | Yes, `ag-mcp` | Yes | Yes, `@svgrid/mcp` | (in Community) |\n| **In-grid AI helpers** | No | No | Yes (bring your own model) | (in Community) |\n\n**SvGrid Community gives you most of what AG Grid sells as Enterprise for\nfree**, and `@svgrid/enterprise` adds Excel, PDF and print output, import,\npivot tables and the server-side row model per developer per year. Compare what each paid tier adds\nbefore comparing prices; both are in the facts box. The trade-offs are\nSvelte-only and a much smaller ecosystem. Every AG Grid cell above follows\nag-grid.com's own pages; the dated list is on the\n[SvGrid vs AG Grid](https://svgrid.com/compare/ag-grid/) page.\n\n## Mental model - what changes\n\nAG Grid is one big object you configure declaratively. SvGrid is a\n**headless engine** (`createSvGrid`) with an optional **render\ncomponent** (`<SvGrid>`) on top - the same split TanStack Table made\npopular. You can use either layer; most projects use the render\ncomponent.\n\nEvery example below runs against this setup:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature, type ColumnDef } from '@svgrid/grid'\n\n type Row = { id: number; make: string; model: string; price: number }\n\n const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n\n let rows = $state<Row[]>([\n { id: 1, make: 'Toyota', model: 'Celica', price: 35000 },\n { id: 2, make: 'Ford', model: 'Mondeo', price: 32000 },\n { id: 3, make: 'Porsche', model: 'Boxster', price: 72000 },\n ])\n const data = rows\n\n const columns: ColumnDef<typeof features, Row>[] = [\n { field: 'make', header: 'Make' },\n { field: 'model', header: 'Model' },\n { field: 'price', header: 'Price', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```svelte\n<!-- AG Grid (via a Svelte wrapper) -->\n<AgGridSvelte\n gridOptions={{\n rowData: rows,\n columnDefs: columns,\n onGridReady: (params) => (gridApi = params.api),\n }}\n/>\n\n<!-- SvGrid -->\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n onApiReady={(api) => (gridApi = api)}\n/>\n```\n\nThree things to note:\n\n1. **No giant `gridOptions` blob.** Each capability is a top-level prop.\n2. **Features are opt-in.** You pass a `features` object built with\n `tableFeatures({...})` - only the features you list ship JS.\n3. **`onApiReady`** gives you a typed `SvGridApi` that is roughly the\n AG Grid `gridApi` equivalent (see the API-mapping table below).\n\n## Column definitions - direct translation\n\nThe shapes are similar enough that you can usually translate by hand\nwithout thinking too hard.\n\n```ts\n// AG Grid\nconst columnDefs: ColDef[] = [\n { field: 'name', headerName: 'Name', sortable: true, filter: true, width: 200 },\n { field: 'price', headerName: 'Price', type: 'numericColumn',\n valueFormatter: ({ value }) => `$${value.toFixed(2)}` },\n { field: 'date', headerName: 'Date',\n valueGetter: ({ data }) => new Date(data.date).toISOString().slice(0, 10) },\n { field: 'status', headerName: 'Status',\n cellRenderer: StatusCellRenderer,\n cellRendererParams: { onChange: handleStatusChange } },\n]\n```\n\n```ts\n// SvGrid\nimport { renderComponent, type ColumnDef } from '@svgrid/grid'\nimport StatusCell from './StatusCell.svelte'\n\nconst columns: ColumnDef<typeof features, Row>[] = [\n { field: 'name', header: 'Name', width: 200 }, // sortable + filterable by default\n { field: 'price', header: 'Price',\n format: { type: 'currency', currency: 'USD' } },\n { field: 'date', header: 'Date',\n format: { type: 'date', pattern: 'y-m-d' } },\n { field: 'status', header: 'Status',\n cell: renderComponent(StatusCell, (ctx) => ({\n value: ctx.getValue(),\n onChange: handleStatusChange,\n })),\n },\n]\n```\n\n### Property mapping\n\n| AG Grid | SvGrid | Notes |\n| --- | --- | --- |\n| `field` | `field` | Same. |\n| `headerName` | `header` | Accepts a string or a snippet/component. |\n| `width` | `width` | Same. |\n| `minWidth` / `maxWidth` | `minWidth` / `maxWidth` | Same. |\n| `sortable: true` | (default) | Sorting is on when `rowSortingFeature` is registered. |\n| `filter: true` | (default) | Filtering is on when `columnFilteringFeature` is registered. |\n| `valueFormatter` | `format: { ... }` | Built-in types: `number`, `currency`, `percent`, `date`. For custom, use `cell`. |\n| `valueGetter` | `fieldFn` | Returns the value for sorting/filtering. |\n| `cellRenderer` + `cellRendererParams` | `cell: renderComponent(C, ctx => props)` | One call, type-checked. |\n| `cellEditor: 'agTextCellEditor'` | `editorType: 'text'` | Built-in: `text`, `number`, `checkbox`, `date`. |\n| `editable: true` | `enableInlineEditing` prop on `<SvGrid>` | Per-grid, not per-column. (Per-column control on the roadmap.) |\n| `pinned: 'left'` / `'right'` | Right-click column menu → Pin | Set programmatically via the api. |\n| `rowGroup: true` | Via `setGroupBy([colId])` | See Grouping below. |\n| `aggFunc: 'sum'` | `aggregate: 'sum'` | Built-in: `sum`, `avg`, `min`, `max`, `count`. |\n\n## Feature registration - the one new thing\n\nAG Grid auto-enables most features; you turn them off. SvGrid is the\nopposite - features are opt-in. The result is a smaller bundle.\n\n```ts\nimport {\n tableFeatures,\n rowSortingFeature,\n columnFilteringFeature,\n columnGroupingFeature,\n rowExpandingFeature,\n rowPaginationFeature,\n rowSelectionFeature,\n} from '@svgrid/grid'\n\nconst features = tableFeatures({\n rowSortingFeature,\n columnFilteringFeature,\n rowSelectionFeature,\n // omit any you don't need - their code won't ship\n})\n```\n\nPass `features` to `<SvGrid>` once. From then on the grid behaves like\nAG Grid's `enableSorting`, `enableFilter`, `rowSelection`, etc. are all\non for the registered features.\n\n## API mapping (`gridApi` → `SvGridApi`)\n\nYou get the SvGrid API from `onApiReady` (equivalent to AG Grid's\n`onGridReady`).\n\n| AG Grid `gridApi.X()` | SvGrid `api.X()` |\n| --- | --- |\n| `setRowData(rows)` | (declarative - just update `data` prop) |\n| `addRow(row)` / `applyTransaction({ add: [row] })` | `api.addRow(row)` / `api.addRows(rows)` |\n| `applyTransaction({ remove: [row] })` | `api.removeRow(rowIndex)` |\n| `getValue(colId, rowNode)` | `api.getCellValue(rowIndex, columnId)` |\n| `setValue(...)` | `api.setCellValue(rowIndex, columnId, value)` |\n| `setColumnVisible(colId, visible)` | `api.setColumnVisible(columnId, visible)` |\n| `getSortModel()` / `setSortModel()` | `api.setSort(columnId, 'asc'\\|'desc'\\|null)` |\n| `setFilterModel({...})` | `api.setFilter(columnId, { operator, value })` |\n| `getDisplayedRowAtIndex(i)` / `forEachNodeAfterFilterAndSort(...)` | `api.getDisplayedRows()` |\n| `getModel()` (raw rows) | `api.getData()` |\n\n## Common patterns\n\n### Sorting + filtering + pagination (the 80% case)\n\n```svelte\n<script lang=\"ts\">\n import {\n SvGrid,\n tableFeatures,\n rowSortingFeature,\n columnFilteringFeature,\n rowPaginationFeature,\n } from '@svgrid/grid'\n\n const features = tableFeatures({\n rowSortingFeature,\n columnFilteringFeature,\n rowPaginationFeature,\n })\n</script>\n\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n showPagination\n showColumnFilters\n/>\n```\n\nAG Grid equivalent: `gridOptions: { defaultColDef: { sortable: true, filter: true }, pagination: true }`.\n\n### Cell editing with persistence\n\n```svelte\n<script lang=\"ts\">\n function onCellValueChange(e: { rowIndex: number; columnId: string; value: unknown }) {\n // Persist however you like (fetch to backend, optimistic local update, etc.)\n console.log('cell changed', e)\n }\n</script>\n\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n enableInlineEditing\n onCellValueChange={onCellValueChange}\n/>\n```\n\nAG Grid equivalent: `onCellValueChanged: ({ data, colDef, newValue, oldValue }) => ...`.\nSvGrid's event payload is column-id + row-index based rather than node-based; the row data is yours\nto mutate (or not) on the `rows` array you passed in.\n\n### Grouping + aggregation\n\n```svelte\n<script lang=\"ts\">\n import {\n SvGrid,\n tableFeatures,\n columnGroupingFeature,\n rowSortingFeature,\n rowExpandingFeature,\n } from '@svgrid/grid'\n\n const features = tableFeatures({\n rowSortingFeature,\n columnGroupingFeature,\n rowExpandingFeature,\n })\n\n const columns = [\n { field: 'department', header: 'Department' },\n { field: 'team', header: 'Team' },\n { field: 'salary', header: 'Salary', aggregate: 'sum',\n format: { type: 'currency', currency: 'USD' } },\n ]\n\n function setGroup(api) {\n api.setGroupBy(['department', 'team'])\n }\n</script>\n\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n showGroupingControls\n onApiReady={setGroup}\n/>\n```\n\nAG Grid Enterprise's `rowGroupPanelShow: 'always'` + `aggFunc: 'sum'` translates 1:1.\n\n### Master / detail\n\nAG Grid Enterprise feature; **free in SvGrid Community**. See\n[demo 08](https://svgrid.com/demos/08-tree-and-master-detail/) for the exact pattern.\n\n### Server-side data\n\nAG Grid's Infinite Row Model (Community) and Server-Side Row Model\n(Enterprise) both take an `IServerSideDatasource` with a `getRows(params)`\nthat answers through `params.success({ rowData, rowCount })`. SvGrid has one\n`ServerDataSource` whose `getRows(request)` returns `{ rows, rowCount }`,\nand two controllers over it: `createServerDataSource` (free: paging or\ninfinite block scroll, sort, filter, CRUD) and `createServerRowModel`\n(Enterprise: lazy grouping, tree, pivot, transactions, selection). Both\nmount through one prop, `<SvGrid rowModel={ctl} />`.\n\nAn existing datasource written for AG Grid keeps working behind one call:\n\n```ts\nimport { adaptCallbackDatasource, createServerRowModel } from '@svgrid/enterprise'\n\nconst ctl = createServerRowModel(adaptCallbackDatasource(myServerSideDatasource), {\n groupBy: ['country'],\n aggregations: [{ col: 'amount', fn: 'sum' }],\n})\n```\n\n`adaptCallbackDatasource` maps the request both ways (`rowGroupCols` ->\n`groupBy`, `valueCols` -> `aggregations`, `pivotCols` -> `pivotBy`, the\nsort and filter models, `context`, `parentNode`) and turns `success` /\n`fail` into a resolved or rejected promise.\n\nMore often the datasource is a thin `fetch` and the real investment is the\nendpoint behind it - a Java or Node service that parses AG Grid's\n`IServerSideGetRowsRequest` JSON. That endpoint stays as it is: post\n`toCallbackRequest(request)` and read the answer back.\n\n```ts\nimport { toCallbackRequest } from '@svgrid/enterprise'\n\nconst source = {\n async getRows(request) {\n const res = await fetch('/api/sales', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify(toCallbackRequest(request)),\n })\n const { rowData, rowCount, pivotResultFields } = await res.json()\n return { rows: rowData, rowCount: rowCount ?? -1, pivotResultFields }\n },\n}\n```\n\n`fromCallbackRequest` is the other direction, for a SvelteKit endpoint that\nhas to keep serving an AG Grid client during the switch. A saved selection\nor a bulk endpoint written against `getServerSideSelectionState()` keeps\nits shape the same way: `toCallbackSelectionState(ctl.getSelectionState())`\nproduces `{ selectAll, toggledNodes }` (or the `nodeId` /\n`selectAllChildren` / `toggledNodes` tree), `ctl.setSelectionState` takes\nthat shape as it is when your group node ids are the group keys, and\n`fromCallbackSelectionState(state, { groupKey, isGroup })` maps them when\na `getRowId` gave group rows ids of their own. Option by option:\n\n| AG Grid | SvGrid |\n| --- | --- |\n| `rowModelType: 'infinite'` + `datasource` | `createServerDataSource(source, { mode: 'infinite' })` + `rowModel={ctl}` |\n| `rowModelType: 'serverSide'` + `serverSideDatasource` | `createServerRowModel(source, options)` + `rowModel={ctl}` |\n| `getRows(params)` + `params.success({ rowData, rowCount })` / `params.fail()` | `getRows(request)` returning `{ rows, rowCount }` / throwing |\n| `cacheBlockSize`, `maxBlocksInCache`, `maxConcurrentDatasourceRequests`, `blockLoadDebounceMillis` | `blockSize`, `maxBlocksInCache`, `maxConcurrentRequests`, `blockLoadDebounceMs` |\n| `infiniteInitialRowCount` / `serverSideInitialRowCount` | `initialRowCount` |\n| `rowCount: -1` (unknown) | `rowCount: -1` |\n| `refreshInfiniteCache()` / `purgeInfiniteCache()` | `ctl.refresh()` / `ctl.purge()` |\n| `request.rowGroupCols`, `groupKeys`, `valueCols`, `pivotCols`, `pivotMode` | `request.groupBy`, `groupKeys`, `aggregations`, `pivotBy`, `pivotMode` |\n| `getChildCount(data)` | `childCount: (row) => row.childCount` |\n| `isServerSideGroupOpenByDefault` | `isGroupOpenByDefault(route, row)` |\n| `getServerSideGroupLevelParams` | `levelParams(level, route)` |\n| `isServerSideGroup` / `getServerSideGroupKey` (tree) | `treeData: true` + `hasChildren` / `getRowId` |\n| `grandTotalRow` / `groupTotalRow` | `grandTotalRow` / `groupFooters` |\n| `refreshServerSide({ route, purge })` / `retryServerSideLoads()` | `ctl.refresh({ route, purge })` / `ctl.retryLoads()` |\n| `applyServerSideTransaction` / `applyServerSideTransactionAsync` / `flushServerSideAsyncTransactions` | `ctl.applyTransaction` / `applyTransactionAsync` / `flushAsyncTransactions` |\n| `applyServerSideRowData` | `ctl.applyRowData` |\n| `serverSideSortAllLevels`, `serverSideEnableClientSideSort`, `serverSideOnlyRefreshFilteredGroups` | `sortAllLevels`, `clientSideSort`, `onlyRefreshFilteredGroups` |\n| `getServerSideSelectionState` / `setServerSideSelectionState` | `ctl.getSelectionState()` / `setSelectionState()` (the `toggledNodes` shape is accepted; `toCallbackSelectionState` / `fromCallbackSelectionState` convert) |\n| `ServerSideTransactionResult.status`: `Applied`, `StoreNotFound`, `StoreLoading`, `StoreWaitingToLoad`, `StoreLoadingFailed`, `Cancelled` | `ServerTransactionResult.status`: the same six, lower camel case (`applied`, `storeNotFound`, ...) - a `switch` on the old spelling falls through silently |\n| `groupSelects: 'descendants'` | `selection: { groupSelects: 'descendants' }` |\n| `pivotResultFields` in `success`, `setPivotResultColumns`, `processPivotResultColDef` | `pivotResultFields` / `pivotResultColumns` in the result, `pivotResultColumn(field, def)` |\n| `pagination` + `paginateChildRows` | `pagination: { pageSize, paginateChildRows }` |\n| `getCacheBlockState()` / `getServerSideGroupLevelState()` | `ctl.getCacheState()` / `ctl.levelStates()` |\n| `serverSideDatasource.destroy()` | `source.destroy()` |\n\nTwo differences worth knowing before you start: SvGrid sends the global\nsearch box to the server as `filterModel.global` (AG Grid's quick filter is\nclient-side only and unsupported under its infinite and server-side models),\nand SvGrid has no viewport row model. See\n[Server grouping](./server/server-grouping.md) and\n[demo 467](https://svgrid.com/demos/467-server-row-model-1m/).\n\n### Excel / PDF export\n\nAG Grid: `gridApi.exportDataAsExcel({...})` (Enterprise-only).\nSvGrid: install `@svgrid/enterprise`, call `api.exportData({ format: 'xlsx', ... })`. See [Data export and printing](./export.md).\n\n```ts\nimport { installEnterprise, setLicenseKey } from '@svgrid/enterprise'\nsetLicenseKey('YOUR-LICENSE-KEY') // your Enterprise key\n\n// inside onApiReady:\nconst pro = installEnterprise(api)\nawait pro.exportData({ format: 'xlsx', filename: 'orders' })\n```\n\n## Gotchas - things that don't translate directly\n\n### 1. Per-column `editable: true`\nEditing is switched on at the grid level (`enableInlineEditing`) and\nnarrowed per column with `editable: boolean | (ctx) => boolean` on the\ncolumn definition, so AG Grid's per-column flag and its callback form both\nmap directly. What does not map is AG Grid's `editable` on a column\ngroup: set it on each child column.\n\n### 2. Column drag-to-reorder\nHeader drag is `enableColumnReorder` on `<SvGrid>`; `setColumnOrder`\non the API does the same from code. See\n[column moving](./columns/column-moving.md) for the events.\n\n### 3. AG Grid `valueGetter` chains\nAG Grid's `valueGetter` can read other column values via the API. In\nSvGrid, `fieldFn` only receives the row; if you need cross-column\ncomputed values, do it in the cell renderer with `ctx.row.original` or\ncompute the derived value upstream and store it in the row.\n\n### 4. `cellClass` / `rowClass` callbacks\nOn the roadmap. For now, render a wrapper element in your `cell` snippet\nwith the conditional class.\n\n### 5. The Status Bar / Side Bar / Tool Panels\nAG Grid's chrome (status bar with row count, side bar with filters and\ncolumns panels) doesn't exist in SvGrid - build it as plain Svelte\nmarkup around the grid. Most teams build their own anyway because\nAG Grid's defaults rarely match a polished design system.\n\n### 6. Set filter (the Excel-style funnel popup)\nSvGrid ships an Excel-style filter menu (free in Community). API surface\nis similar but not identical - see [Set filter](./filtering/set-filter.md).\n\n## When NOT to migrate\n\nBe honest. Stay on AG Grid if you:\n\n- **Use multiple frameworks** - AG Grid has React, Angular, Vue, Solid, Qwik, vanilla adapters. SvGrid is Svelte-only.\n- **Need a push-based viewport row model** - SvGrid's server-side row model covers grouping, tree, pivot, transactions and select-all across unloaded rows, and its real-time page merges deltas into loaded rows, but the server cannot push the visible window over a socket the way the viewport model does.\n- **Need custom tool panels** - SvGrid's tool panel is a fixed Columns + Filters pair. (Custom filter components are covered: a column's `customFilter` renders your own control in the filter menu, the floating filter row and the Filters tab.)\n- **Are mid-project and shipping in <2 weeks** - the migration is a few hours per grid, but only do it when you have buffer.\n- **Have a Svelte 4 codebase you can't upgrade** - SvGrid requires Svelte 5 runes. (Consider [htmlelements.com](https://www.htmlelements.com) for vanilla / multi-framework.)\n\nIf none of those apply: switching drops a per-developer Enterprise licence\nfor features that are in SvGrid's MIT core, cuts the bundle by the\ndifference in the facts box above, and gives you a Svelte-native API that\nplays well with runes.\n\n## Step-by-step migration\n\nA typical migration of a single grid takes 1-3 hours:\n\n1. **Install** - `pnpm add @svgrid/grid` (and `@svgrid/enterprise` if you need export).\n2. **Translate columnDefs** - use the mapping table above. Most columns are 1:1.\n3. **Wrap features** - figure out which AG Grid features you actually use; register only those in `tableFeatures({...})`.\n4. **Swap the component** - `<AgGridSvelte gridOptions={...}>` → `<SvGrid data={rows} columns={columns} features={features}>`.\n5. **Move event handlers** - AG Grid `onCellValueChanged` → SvGrid `onCellValueChange` (signature differs slightly, see above).\n6. **Move API calls** - AG Grid `gridApi.X()` → SvGrid `api.X()` per the API table.\n7. **Test interactions** - sort, filter, edit, select. Most \"just works.\"\n8. **Remove `ag-grid-*` packages** - `pnpm remove ag-grid-community ag-grid-svelte` etc. Inspect your bundle to confirm the drop; the facts box above has both measured sizes.\n\n## Need help migrating?\n\nEnterprise customers get **migration help included** with the support plan\n(architecture review, port one grid for you as a reference). Email\n`support@jqwidgets.com` after purchase, or `sales@jqwidgets.com` for\npre-sales questions.\n\n## Frequently asked questions\n\n### Is SvGrid a drop-in replacement for AG Grid in Svelte?\n\nNot a literal drop-in - there is no `ag-grid-svelte` shim to swap. But the\nconcepts map closely: column definitions, row models, sorting, filtering,\ngrouping, and an imperative API all have direct SvGrid equivalents, so most\nteams port a grid in 30 minutes to a day. It is a configuration translation,\nnot a rewrite.\n\n### What is the SvGrid equivalent of AG Grid Enterprise?\n\n`@svgrid/enterprise`. It adds Excel/PDF/styled-HTML export (CSV, TSV and JSON export are already free in the grid), a printable view, pivot\ntables and data import. The in-grid AI helpers are free in `@svgrid/grid`.\nIt is licensed per developer ($599 for the grid, $999 with the spreadsheet\nand Studio, both covering unlimited apps), and the\nCommunity package is MIT-licensed and free for commercial use.\n\n### Does SvGrid use Svelte 5 runes, or is it a wrapper?\n\nIt is Svelte-5-native. State is `$state` / `$derived` / `$effect` and cells\nrender through Svelte snippets - there is no React or Angular core underneath\nand no framework bridge to keep in sync.\n\n### Will my AG Grid bundle size shrink?\n\nAlmost always. The facts box at the top of this page has both packages\nmeasured the same way on the same date: the full SvGrid render component\nwith its stylesheet against `createGrid` with every AG Grid Community\nmodule registered. You add `@svgrid/enterprise` features only where you\nimport them, and the headless core on its own is a small fraction of the\nrender component.\n\n## More examples\n\n### AG Grid ↔ sv-grid side-by-side\n\nTwo real grids over the same dataset: the installed AG Grid Community on the left, sv-grid on the right. Same global filter drives both. Source code panels for either side.\n\n<div data-docs-demo=\"139-migration-from-ag-grid\" data-height=\"460\"></div>\n\n## See also\n\n- [Getting started](../getting-started.md) - full SvGrid walkthrough\n- [Why headless?](../why-headless.md) - the headless / render-component split\n- [Data export and printing](./export.md) - the `@svgrid/enterprise` feature pack\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](./comparison.md) - the\n measured benchmark and the feature matrix\n- [SvGrid vs AG Grid comparison page](https://svgrid.com/compare/ag-grid/) -\n every claim with its source and date\n"
|
|
6070
|
+
"markdown": "\n# Migrating from AG Grid to SvGrid\n\nIf you tried AG Grid on a Svelte 5 project - via `ag-grid-svelte`, the\nold `ag-grid-community/svelte`, or a hand-rolled wrapper - you probably\nhit the same friction everyone hits: the bridge between AG Grid's\nReact/Angular-first API and Svelte 5 runes is brittle, the bundle is\nheavy, and the Enterprise pricing only makes sense at scale.\n\n<!-- facts:start ag-grid -->\n> **Facts, checked 9 Nov 2026.** `ag-grid-community` 36.3.0, MIT, last published 4 Nov 2026, 16,400,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `ag-grid-community` 36.3.0 346.4 KB JS, no separate stylesheet (measured 9 Nov 2026). AG Grid pricing, as its site states it: AG Grid Community is free under MIT. AG Grid Enterprise is listed at $999 USD per developer with one year of updates and Zendesk support; the Enterprise Bundle with AG Charts Enterprise is $1,498 USD per developer (https://www.ag-grid.com/license-pricing/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/).\n<!-- facts:end -->\n\nThis page is a 30-minute migration recipe from AG Grid to SvGrid. It\ncovers what maps 1:1, what's different by design, and what you'll lose.\nWe tell you when **not** to switch at the bottom.\n\n## TL;DR\n\n| | AG Grid Community | AG Grid Enterprise | SvGrid Community | @svgrid/enterprise |\n| --- | --- | --- | --- | --- |\n| **Licence** | MIT | Commercial, per developer (the price is in the facts box above) | **MIT** | $599/dev/yr (grid) or $999/dev/yr (grid + spreadsheet + Studio) |\n| **Svelte 5 native** | No (community-built integration) | No (community-built integration) | Yes | Yes |\n| **Bundle (gzipped)** | measured, in the facts box above | not measured (licence) | measured, in the facts box above | lazy-loaded subpaths |\n| **Sorting / filtering** | Yes | Yes | Yes | (in Community) |\n| **Row grouping + aggregation** | No (Enterprise) | Yes | Yes (free) | (in Community) |\n| **Master/detail, tree, range select** | No (Enterprise) | Yes | Yes (free) | (in Community) |\n| **Set filter / Excel-style filter menu** | No (Enterprise) | Yes | Yes (free) | (in Community) |\n| **Server-side data, flat (infinite row model)** | Yes | Yes | Yes (free) | (in Community) |\n| **Server-side row model (grouping, tree, pivot, transactions, selection)** | No (Enterprise) | Yes | No | Yes |\n| **Integrated charts** | No (Enterprise) | Yes, AG Charts | Yes (free) | (in Community) |\n| **CSV export** | Yes (API) | Yes | Yes, with TSV and JSON | (in Community) |\n| **Excel export** | No | Yes | No | Yes |\n| **PDF / styled-HTML export, print** | No | No | No | Yes |\n| **Pivot tables** | No | Yes | No | Yes |\n| **MCP server for AI assistants** | Yes, `ag-mcp` | Yes | Yes, `@svgrid/mcp` | (in Community) |\n| **In-grid AI helpers** | No | No | Yes (bring your own model) | (in Community) |\n\n**SvGrid Community gives you most of what AG Grid sells as Enterprise for\nfree**, and `@svgrid/enterprise` adds Excel, PDF and print output, import,\npivot tables and the server-side row model per developer per year. Compare what each paid tier adds\nbefore comparing prices; both are in the facts box. The trade-offs are\nSvelte-only and a much smaller ecosystem. Every AG Grid cell above follows\nag-grid.com's own pages; the dated list is on the\n[SvGrid vs AG Grid](https://svgrid.com/compare/ag-grid/) page.\n\n## Mental model - what changes\n\nAG Grid is one big object you configure declaratively. SvGrid is a\n**headless engine** (`createSvGrid`) with an optional **render\ncomponent** (`<SvGrid>`) on top - the same split TanStack Table made\npopular. You can use either layer; most projects use the render\ncomponent.\n\nEvery example below runs against this setup:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature, type ColumnDef } from '@svgrid/grid'\n\n type Row = { id: number; make: string; model: string; price: number }\n\n const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n\n let rows = $state<Row[]>([\n { id: 1, make: 'Toyota', model: 'Celica', price: 35000 },\n { id: 2, make: 'Ford', model: 'Mondeo', price: 32000 },\n { id: 3, make: 'Porsche', model: 'Boxster', price: 72000 },\n ])\n const data = rows\n\n const columns: ColumnDef<typeof features, Row>[] = [\n { field: 'make', header: 'Make' },\n { field: 'model', header: 'Model' },\n { field: 'price', header: 'Price', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```svelte\n<!-- AG Grid (via a Svelte wrapper) -->\n<AgGridSvelte\n gridOptions={{\n rowData: rows,\n columnDefs: columns,\n onGridReady: (params) => (gridApi = params.api),\n }}\n/>\n\n<!-- SvGrid -->\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n onApiReady={(api) => (gridApi = api)}\n/>\n```\n\nThree things to note:\n\n1. **No giant `gridOptions` blob.** Each capability is a top-level prop.\n2. **Features are opt-in.** You pass a `features` object built with\n `tableFeatures({...})` - only the features you list ship JS.\n3. **`onApiReady`** gives you a typed `SvGridApi` that is roughly the\n AG Grid `gridApi` equivalent (see the API-mapping table below).\n\n## Column definitions - direct translation\n\nThe shapes are similar enough that you can usually translate by hand\nwithout thinking too hard.\n\n```ts\n// AG Grid\nconst columnDefs: ColDef[] = [\n { field: 'name', headerName: 'Name', sortable: true, filter: true, width: 200 },\n { field: 'price', headerName: 'Price', type: 'numericColumn',\n valueFormatter: ({ value }) => `$${value.toFixed(2)}` },\n { field: 'date', headerName: 'Date',\n valueGetter: ({ data }) => new Date(data.date).toISOString().slice(0, 10) },\n { field: 'status', headerName: 'Status',\n cellRenderer: StatusCellRenderer,\n cellRendererParams: { onChange: handleStatusChange } },\n]\n```\n\n```ts\n// SvGrid\nimport { renderComponent, type ColumnDef } from '@svgrid/grid'\nimport StatusCell from './StatusCell.svelte'\n\nconst columns: ColumnDef<typeof features, Row>[] = [\n { field: 'name', header: 'Name', width: 200 }, // sortable + filterable by default\n { field: 'price', header: 'Price',\n format: { type: 'currency', currency: 'USD' } },\n { field: 'date', header: 'Date',\n format: { type: 'date', pattern: 'y-m-d' } },\n { field: 'status', header: 'Status',\n cell: renderComponent(StatusCell, (ctx) => ({\n value: ctx.getValue(),\n onChange: handleStatusChange,\n })),\n },\n]\n```\n\n### Property mapping\n\n| AG Grid | SvGrid | Notes |\n| --- | --- | --- |\n| `field` | `field` | Same. |\n| `headerName` | `header` | Accepts a string or a snippet/component. |\n| `width` | `width` | Same. |\n| `minWidth` / `maxWidth` | `minWidth` / `maxWidth` | Same. |\n| `sortable: true` | (default) | Sorting is on when `rowSortingFeature` is registered. |\n| `filter: true` | (default) | Filtering is on when `columnFilteringFeature` is registered. |\n| `valueFormatter` | `format: { ... }` | Built-in types: `number`, `currency`, `percent`, `date`. For custom, use `cell`. |\n| `valueGetter` | `fieldFn` | Returns the value for sorting/filtering. |\n| `cellRenderer` + `cellRendererParams` | `cell: renderComponent(C, ctx => props)` | One call, type-checked. |\n| `cellEditor: 'agTextCellEditor'` | `editorType: 'text'` | Built-in: `text`, `number`, `checkbox`, `date`. |\n| `editable: true` | `enableInlineEditing` prop on `<SvGrid>` | Per-grid, not per-column. (Per-column control on the roadmap.) |\n| `pinned: 'left'` / `'right'` | Right-click column menu → Pin | Set programmatically via the api. |\n| `rowGroup: true` | Via `setGroupBy([colId])` | See Grouping below. |\n| `aggFunc: 'sum'` | `aggregate: 'sum'` | Built-in: `sum`, `avg`, `min`, `max`, `count`. |\n\n## Feature registration - the one new thing\n\nAG Grid auto-enables most features; you turn them off. SvGrid is the\nopposite - features are opt-in. The result is a smaller bundle.\n\n```ts\nimport {\n tableFeatures,\n rowSortingFeature,\n columnFilteringFeature,\n columnGroupingFeature,\n rowExpandingFeature,\n rowPaginationFeature,\n rowSelectionFeature,\n} from '@svgrid/grid'\n\nconst features = tableFeatures({\n rowSortingFeature,\n columnFilteringFeature,\n rowSelectionFeature,\n // omit any you don't need - their code won't ship\n})\n```\n\nPass `features` to `<SvGrid>` once. From then on the grid behaves like\nAG Grid's `enableSorting`, `enableFilter`, `rowSelection`, etc. are all\non for the registered features.\n\n## API mapping (`gridApi` → `SvGridApi`)\n\nYou get the SvGrid API from `onApiReady` (equivalent to AG Grid's\n`onGridReady`).\n\n| AG Grid `gridApi.X()` | SvGrid `api.X()` |\n| --- | --- |\n| `setRowData(rows)` | (declarative - just update `data` prop) |\n| `addRow(row)` / `applyTransaction({ add: [row] })` | `api.addRow(row)` / `api.addRows(rows)` |\n| `applyTransaction({ remove: [row] })` | `api.removeRow(rowIndex)` |\n| `getValue(colId, rowNode)` | `api.getCellValue(rowIndex, columnId)` |\n| `setValue(...)` | `api.setCellValue(rowIndex, columnId, value)` |\n| `setColumnVisible(colId, visible)` | `api.setColumnVisible(columnId, visible)` |\n| `getSortModel()` / `setSortModel()` | `api.setSort(columnId, 'asc'\\|'desc'\\|null)` |\n| `setFilterModel({...})` | `api.setFilter(columnId, { operator, value })` |\n| `getDisplayedRowAtIndex(i)` / `forEachNodeAfterFilterAndSort(...)` | `api.getDisplayedRows()` |\n| `getModel()` (raw rows) | `api.getData()` |\n\n## Common patterns\n\n### Sorting + filtering + pagination (the 80% case)\n\n```svelte\n<script lang=\"ts\">\n import {\n SvGrid,\n tableFeatures,\n rowSortingFeature,\n columnFilteringFeature,\n rowPaginationFeature,\n } from '@svgrid/grid'\n\n const features = tableFeatures({\n rowSortingFeature,\n columnFilteringFeature,\n rowPaginationFeature,\n })\n</script>\n\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n showPagination\n showColumnFilters\n/>\n```\n\nAG Grid equivalent: `gridOptions: { defaultColDef: { sortable: true, filter: true }, pagination: true }`.\n\n### Cell editing with persistence\n\n```svelte\n<script lang=\"ts\">\n function onCellValueChange(e: { rowIndex: number; columnId: string; value: unknown }) {\n // Persist however you like (fetch to backend, optimistic local update, etc.)\n console.log('cell changed', e)\n }\n</script>\n\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n enableInlineEditing\n onCellValueChange={onCellValueChange}\n/>\n```\n\nAG Grid equivalent: `onCellValueChanged: ({ data, colDef, newValue, oldValue }) => ...`.\nSvGrid's event payload is column-id + row-index based rather than node-based; the row data is yours\nto mutate (or not) on the `rows` array you passed in.\n\n### Grouping + aggregation\n\n```svelte\n<script lang=\"ts\">\n import {\n SvGrid,\n tableFeatures,\n columnGroupingFeature,\n rowSortingFeature,\n rowExpandingFeature,\n } from '@svgrid/grid'\n\n const features = tableFeatures({\n rowSortingFeature,\n columnGroupingFeature,\n rowExpandingFeature,\n })\n\n const columns = [\n { field: 'department', header: 'Department' },\n { field: 'team', header: 'Team' },\n { field: 'salary', header: 'Salary', aggregate: 'sum',\n format: { type: 'currency', currency: 'USD' } },\n ]\n\n function setGroup(api) {\n api.setGroupBy(['department', 'team'])\n }\n</script>\n\n<SvGrid\n data={rows}\n columns={columns}\n features={features}\n showGroupingControls\n onApiReady={setGroup}\n/>\n```\n\nAG Grid Enterprise's `rowGroupPanelShow: 'always'` + `aggFunc: 'sum'` translates 1:1.\n\n### Master / detail\n\nAG Grid Enterprise feature; **free in SvGrid Community**. See\n[demo 08](https://svgrid.com/demos/08-tree-and-master-detail/) for the exact pattern.\n\n### Server-side data\n\nAG Grid's Infinite Row Model (Community) and Server-Side Row Model\n(Enterprise) both take an `IServerSideDatasource` with a `getRows(params)`\nthat answers through `params.success({ rowData, rowCount })`. SvGrid has one\n`ServerDataSource` whose `getRows(request)` returns `{ rows, rowCount }`,\nand two controllers over it: `createServerDataSource` (free: paging or\ninfinite block scroll, sort, filter, CRUD) and `createServerRowModel`\n(Enterprise: lazy grouping, tree, pivot, transactions, selection). Both\nmount through one prop, `<SvGrid rowModel={ctl} />`.\n\nAn existing datasource written for AG Grid keeps working behind one call:\n\n```ts\nimport { adaptCallbackDatasource, createServerRowModel } from '@svgrid/enterprise'\n\nconst ctl = createServerRowModel(adaptCallbackDatasource(myServerSideDatasource), {\n groupBy: ['country'],\n aggregations: [{ col: 'amount', fn: 'sum' }],\n})\n```\n\n`adaptCallbackDatasource` maps the request both ways (`rowGroupCols` ->\n`groupBy`, `valueCols` -> `aggregations`, `pivotCols` -> `pivotBy`, the\nsort and filter models, `context`, `parentNode`) and turns `success` /\n`fail` into a resolved or rejected promise.\n\nMore often the datasource is a thin `fetch` and the real investment is the\nendpoint behind it - a Java or Node service that parses AG Grid's\n`IServerSideGetRowsRequest` JSON. That endpoint stays as it is: post\n`toCallbackRequest(request)` and read the answer back.\n\n```ts\nimport { toCallbackRequest } from '@svgrid/enterprise'\n\nconst source = {\n async getRows(request) {\n const res = await fetch('/api/sales', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n body: JSON.stringify(toCallbackRequest(request)),\n })\n const { rowData, rowCount, pivotResultFields } = await res.json()\n return { rows: rowData, rowCount: rowCount ?? -1, pivotResultFields }\n },\n}\n```\n\n`fromCallbackRequest` is the other direction, for a SvelteKit endpoint that\nhas to keep serving an AG Grid client during the switch. A saved selection\nor a bulk endpoint written against `getServerSideSelectionState()` keeps\nits shape the same way: `toCallbackSelectionState(ctl.getSelectionState())`\nproduces `{ selectAll, toggledNodes }` (or the `nodeId` /\n`selectAllChildren` / `toggledNodes` tree), `ctl.setSelectionState` takes\nthat shape as it is when your group node ids are the group keys, and\n`fromCallbackSelectionState(state, { groupKey, isGroup })` maps them when\na `getRowId` gave group rows ids of their own. Option by option:\n\n| AG Grid | SvGrid |\n| --- | --- |\n| `rowModelType: 'infinite'` + `datasource` | `createServerDataSource(source, { mode: 'infinite' })` + `rowModel={ctl}` |\n| `rowModelType: 'serverSide'` + `serverSideDatasource` | `createServerRowModel(source, options)` + `rowModel={ctl}` |\n| `getRows(params)` + `params.success({ rowData, rowCount })` / `params.fail()` | `getRows(request)` returning `{ rows, rowCount }` / throwing |\n| `cacheBlockSize`, `maxBlocksInCache`, `maxConcurrentDatasourceRequests`, `blockLoadDebounceMillis` | `blockSize`, `maxBlocksInCache`, `maxConcurrentRequests`, `blockLoadDebounceMs` |\n| `infiniteInitialRowCount` / `serverSideInitialRowCount` | `initialRowCount` |\n| `rowCount: -1` (unknown) | `rowCount: -1` |\n| `refreshInfiniteCache()` / `purgeInfiniteCache()` | `ctl.refresh()` / `ctl.purge()` |\n| `request.rowGroupCols`, `groupKeys`, `valueCols`, `pivotCols`, `pivotMode` | `request.groupBy`, `groupKeys`, `aggregations`, `pivotBy`, `pivotMode` |\n| `getChildCount(data)` | `childCount: (row) => row.childCount` |\n| `isServerSideGroupOpenByDefault` | `isGroupOpenByDefault(route, row)` |\n| `getServerSideGroupLevelParams` | `levelParams(level, route)` |\n| `isServerSideGroup` / `getServerSideGroupKey` (tree) | `treeData: true` + `hasChildren` / `getRowId` |\n| `grandTotalRow` / `groupTotalRow` | `grandTotalRow` / `groupFooters` |\n| `refreshServerSide({ route, purge })` / `retryServerSideLoads()` | `ctl.refresh({ route, purge })` / `ctl.retryLoads()` |\n| `applyServerSideTransaction` / `applyServerSideTransactionAsync` / `flushServerSideAsyncTransactions` | `ctl.applyTransaction` / `applyTransactionAsync` / `flushAsyncTransactions` |\n| `applyServerSideRowData` | `ctl.applyRowData` |\n| `serverSideSortAllLevels`, `serverSideEnableClientSideSort`, `serverSideOnlyRefreshFilteredGroups` | `sortAllLevels`, `clientSideSort`, `onlyRefreshFilteredGroups` |\n| `getServerSideSelectionState` / `setServerSideSelectionState` | `ctl.getSelectionState()` / `setSelectionState()` (the `toggledNodes` shape is accepted; `toCallbackSelectionState` / `fromCallbackSelectionState` convert) |\n| `ServerSideTransactionResult.status`: `Applied`, `StoreNotFound`, `StoreLoading`, `StoreWaitingToLoad`, `StoreLoadingFailed`, `Cancelled` | `ServerTransactionResult.status`: the same six, lower camel case (`applied`, `storeNotFound`, ...) - a `switch` on the old spelling falls through silently |\n| `groupSelects: 'descendants'` | `selection: { groupSelects: 'descendants' }` |\n| `pivotResultFields` in `success`, `setPivotResultColumns`, `processPivotResultColDef` | `pivotResultFields` / `pivotResultColumns` in the result, `pivotResultColumn(field, def)` |\n| `pagination` + `paginateChildRows` | `pagination: { pageSize, paginateChildRows }` |\n| `getCacheBlockState()` / `getServerSideGroupLevelState()` | `ctl.getCacheState()` / `ctl.levelStates()` |\n| `serverSideDatasource.destroy()` | `source.destroy()` |\n\nTwo differences worth knowing before you start: SvGrid sends the global\nsearch box to the server as `filterModel.global` (AG Grid's quick filter is\nclient-side only and unsupported under its infinite and server-side models),\nand SvGrid has no viewport row model. See\n[Server grouping](./server/server-grouping.md) and\n[demo 467](https://svgrid.com/demos/467-server-row-model-1m/).\n\n### Excel / PDF export\n\nAG Grid: `gridApi.exportDataAsExcel({...})` (Enterprise-only).\nSvGrid: install `@svgrid/enterprise`, call `api.exportData({ format: 'xlsx', ... })`. See [Data export and printing](./export.md).\n\n```ts\nimport { installEnterprise, setLicenseKey } from '@svgrid/enterprise'\nsetLicenseKey('YOUR-LICENSE-KEY') // your Enterprise key\n\n// inside onApiReady:\nconst pro = installEnterprise(api)\nawait pro.exportData({ format: 'xlsx', filename: 'orders' })\n```\n\n## Gotchas - things that don't translate directly\n\n### 1. Per-column `editable: true`\nEditing is switched on at the grid level (`enableInlineEditing`) and\nnarrowed per column with `editable: boolean | (ctx) => boolean` on the\ncolumn definition, so AG Grid's per-column flag and its callback form both\nmap directly. What does not map is AG Grid's `editable` on a column\ngroup: set it on each child column.\n\n### 2. Column drag-to-reorder\nHeader drag is `enableColumnReorder` on `<SvGrid>`; `setColumnOrder`\non the API does the same from code. See\n[column moving](./columns/column-moving.md) for the events.\n\n### 3. AG Grid `valueGetter` chains\nAG Grid's `valueGetter` can read other column values via the API. In\nSvGrid, `fieldFn` only receives the row; if you need cross-column\ncomputed values, do it in the cell renderer with `ctx.row.original` or\ncompute the derived value upstream and store it in the row.\n\n### 4. `cellClass` / `rowClass` callbacks\nOn the roadmap. For now, render a wrapper element in your `cell` snippet\nwith the conditional class.\n\n### 5. The Status Bar / Side Bar / Tool Panels\nAG Grid's chrome (status bar with row count, side bar with filters and\ncolumns panels) doesn't exist in SvGrid - build it as plain Svelte\nmarkup around the grid. Most teams build their own anyway because\nAG Grid's defaults rarely match a polished design system.\n\n### 6. Set filter (the Excel-style funnel popup)\nSvGrid ships an Excel-style filter menu (free in Community). API surface\nis similar but not identical - see [Set filter](./filtering/set-filter.md).\n\n## When NOT to migrate\n\nBe honest. Stay on AG Grid if you:\n\n- **Use multiple frameworks** - AG Grid has React, Angular, Vue, Solid, Qwik, vanilla adapters. SvGrid is Svelte-only.\n- **Need a push-based viewport row model** - SvGrid's server-side row model covers grouping, tree, pivot, transactions and select-all across unloaded rows, and its real-time page merges deltas into loaded rows, but the server cannot push the visible window over a socket the way the viewport model does.\n- **Need custom tool panels** - SvGrid's tool panel is a fixed Columns + Filters pair. (Custom filter components are covered: a column's `customFilter` renders your own control in the filter menu, the floating filter row and the Filters tab.)\n- **Are mid-project and shipping in <2 weeks** - the migration is a few hours per grid, but only do it when you have buffer.\n- **Have a Svelte 4 codebase you can't upgrade** - SvGrid requires Svelte 5 runes. (Consider [htmlelements.com](https://www.htmlelements.com) for vanilla / multi-framework.)\n\nIf none of those apply: switching drops a per-developer Enterprise licence\nfor features that are in SvGrid's MIT core, cuts the bundle by the\ndifference in the facts box above, and gives you a Svelte-native API that\nplays well with runes.\n\n## Step-by-step migration\n\nA typical migration of a single grid takes 1-3 hours:\n\n1. **Install** - `pnpm add @svgrid/grid` (and `@svgrid/enterprise` if you need export).\n2. **Translate columnDefs** - use the mapping table above. Most columns are 1:1.\n3. **Wrap features** - figure out which AG Grid features you actually use; register only those in `tableFeatures({...})`.\n4. **Swap the component** - `<AgGridSvelte gridOptions={...}>` → `<SvGrid data={rows} columns={columns} features={features}>`.\n5. **Move event handlers** - AG Grid `onCellValueChanged` → SvGrid `onCellValueChange` (signature differs slightly, see above).\n6. **Move API calls** - AG Grid `gridApi.X()` → SvGrid `api.X()` per the API table.\n7. **Test interactions** - sort, filter, edit, select. Most \"just works.\"\n8. **Remove `ag-grid-*` packages** - `pnpm remove ag-grid-community ag-grid-svelte` etc. Inspect your bundle to confirm the drop; the facts box above has both measured sizes.\n\n## Need help migrating?\n\nEnterprise customers get **migration help included** with the support plan\n(architecture review, port one grid for you as a reference). Email\n`support@jqwidgets.com` after purchase, or `sales@jqwidgets.com` for\npre-sales questions.\n\n## Frequently asked questions\n\n### Is SvGrid a drop-in replacement for AG Grid in Svelte?\n\nNot a literal drop-in - there is no `ag-grid-svelte` shim to swap. But the\nconcepts map closely: column definitions, row models, sorting, filtering,\ngrouping, and an imperative API all have direct SvGrid equivalents, so most\nteams port a grid in 30 minutes to a day. It is a configuration translation,\nnot a rewrite.\n\n### What is the SvGrid equivalent of AG Grid Enterprise?\n\n`@svgrid/enterprise`. It adds Excel/PDF/styled-HTML export (CSV, TSV and JSON export are already free in the grid), a printable view, pivot\ntables and data import. The in-grid AI helpers are free in `@svgrid/grid`.\nIt is licensed per developer ($599 for the grid, $999 with the spreadsheet\nand Studio, both covering unlimited apps), and the\nCommunity package is MIT-licensed and free for commercial use.\n\n### Does SvGrid use Svelte 5 runes, or is it a wrapper?\n\nIt is Svelte-5-native. State is `$state` / `$derived` / `$effect` and cells\nrender through Svelte snippets - there is no React or Angular core underneath\nand no framework bridge to keep in sync.\n\n### Will my AG Grid bundle size shrink?\n\nAlmost always. The facts box at the top of this page has both packages\nmeasured the same way on the same date: the full SvGrid render component\nwith its stylesheet against `createGrid` with every AG Grid Community\nmodule registered. You add `@svgrid/enterprise` features only where you\nimport them, and the headless core on its own is a small fraction of the\nrender component.\n\n## More examples\n\n### AG Grid ↔ sv-grid side-by-side\n\nTwo real grids over the same dataset: the installed AG Grid Community on the left, sv-grid on the right. Same global filter drives both. Source code panels for either side.\n\n<div data-docs-demo=\"139-migration-from-ag-grid\" data-height=\"460\"></div>\n\n## See also\n\n- [Getting started](../getting-started.md) - full SvGrid walkthrough\n- [Why headless?](../why-headless.md) - the headless / render-component split\n- [Data export and printing](./export.md) - the `@svgrid/enterprise` feature pack\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](./comparison.md) - the\n measured benchmark and the feature matrix\n- [SvGrid vs AG Grid comparison page](https://svgrid.com/compare/ag-grid/) -\n every claim with its source and date\n"
|
|
6071
6071
|
},
|
|
6072
6072
|
{
|
|
6073
6073
|
"slug": "help/migrating-from-airtable",
|
|
@@ -6088,49 +6088,49 @@ export const docs = [
|
|
|
6088
6088
|
"path": "docs/help/migrating-from-devextreme.md",
|
|
6089
6089
|
"title": "Migrating from DevExtreme DataGrid (DevExpress)",
|
|
6090
6090
|
"section": "Help",
|
|
6091
|
-
"markdown": "# Migrating from DevExtreme DataGrid (DevExpress)\n\nDevExtreme DataGrid is a deep, commercial multi-framework grid from\nDevExpress (jQuery, React, Vue, Angular). Moving to SvGrid trades the\ncommercial suite for a Svelte-5-native grid with an MIT core and a far\nlower-cost paid tier.\n\n> Estimated effort: **3-6 hours** per grid.\n>\n> DevExtreme's option names vary by framework flavour; map your version's\n> columns and events onto the SvGrid equivalents below.\n\n<!-- facts:start devextreme-datagrid -->\n> **Facts, checked 9 Nov 2026.** `devextreme` 26.1.6, Commercial (see licence file), last published 23 Oct 2026, 1,180,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6091
|
+
"markdown": "# Migrating from DevExtreme DataGrid (DevExpress)\n\nDevExtreme DataGrid is a deep, commercial multi-framework grid from\nDevExpress (jQuery, React, Vue, Angular). Moving to SvGrid trades the\ncommercial suite for a Svelte-5-native grid with an MIT core and a far\nlower-cost paid tier.\n\n> Estimated effort: **3-6 hours** per grid.\n>\n> DevExtreme's option names vary by framework flavour; map your version's\n> columns and events onto the SvGrid equivalents below.\n\n<!-- facts:start devextreme-datagrid -->\n> **Facts, checked 9 Nov 2026.** `devextreme` 26.1.6, Commercial (see licence file), last published 23 Oct 2026, 1,180,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). DevExtreme DataGrid pricing, as its site states it: js.devexpress.com lists DevExtreme Complete at $899.99 per developer for a 12-month subscription with updates and support, renewing at $449.99; no free or non-commercial tier is shown (https://js.devexpress.com/Buy/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs DevExtreme DataGrid (DevExpress)](https://svgrid.com/compare/devextreme-datagrid/).\n<!-- facts:end -->\n\n## Concept map\n\n| DevExtreme DataGrid | sv-grid |\n| ---------------------------------------- | ----------------------------------------- |\n| `columns: [{ dataField, caption }]` | `columns: [{ field, header }]` |\n| `cellTemplate` | `cell: (c) => renderSnippet(...)` |\n| `editing: { mode, allowUpdating }` | `enableInlineEditing` + `editorType` |\n| `sorting` / `filterRow` / `headerFilter` | `rowSortingFeature` / `columnFilteringFeature` |\n| `grouping` + `summary` | `columnGroupingFeature` + aggregates |\n| `masterDetail` | `rowExpandingFeature` / master-detail rows |\n| `dataSource` (store / remote) | `data` array or `externalSort/Filter` |\n| `paging` + `pager` | `showPagination` |\n| `export` | `@svgrid/enterprise` export pack |\n| `stateStoring` | persist column state yourself (saved views) |\n\n## Shape of the change\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- $('#grid').dxDataGrid({\n- dataSource: rows,\n- paging: { pageSize: 25 },\n- sorting: { mode: 'multiple' }, filterRow: { visible: true },\n- editing: { mode: 'cell', allowUpdating: true },\n- columns: [\n- { dataField: 'name', caption: 'Name' },\n- { dataField: 'amount', caption: 'Amount', format: 'currency' },\n- ],\n- })\n\n+ <SvGrid\n+ data={rows}\n+ columns={[\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]}\n+ features={tableFeatures({ rowSortingFeature, columnFilteringFeature })}\n+ showPagination enableInlineEditing />\n```\n\n## Why teams switch\n\n- **Svelte 5 native** instead of a multi-framework commercial library.\n- **MIT community core** plus an optional Enterprise pack for export / import /\n pivot / AI.\n- **Much lower-cost paid tier.**\n\n## What to weigh\n\n- DevExtreme has a **larger built-in feature surface** (state storing,\n broad export, a full suite). If you depend on those, factor them in -\n `stateStoring` in particular becomes a saved-views pattern you wire up.\n\n## Frequently asked questions\n\n### How do DevExtreme columns map to SvGrid?\n\n`dataField` becomes `field`, `caption` becomes `header`, and `cellTemplate`\nbecomes a `renderSnippet` cell. Sorting / filtering / grouping move from grid\noptions to registered features.\n\n### Is SvGrid cheaper than DevExtreme?\n\nFor a Svelte stack, yes - the core is MIT and the paid tier is far below\ncommercial-suite pricing. You give up DevExtreme's multi-framework reach and\nsome built-in features like `stateStoring`.\n\n### Does SvGrid export like DevExtreme?\n\nYes, via the `@svgrid/enterprise` pack: Excel, PDF, CSV, TSV, and HTML export plus a\nprintable view.\n\n## What you end up with\n\nGrouping with totals plus the filter row, the DevExtreme default layout.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} groupBy={['department']} summary groupable sortable filterMode=\"row\" />\n```\n\n## See also\n\n- [SvGrid vs DevExtreme DataGrid](https://svgrid.com/compare/devextreme-datagrid/) - the side-by-side comparison\n- [Saved views](./saved-views.md) - the state-persistence pattern\n- [Data export and printing - Enterprise](./export.md) - the Enterprise export pack\n"
|
|
6092
6092
|
},
|
|
6093
6093
|
{
|
|
6094
6094
|
"slug": "help/migrating-from-glide",
|
|
6095
6095
|
"path": "docs/help/migrating-from-glide.md",
|
|
6096
6096
|
"title": "Migrating from Glide Data Grid",
|
|
6097
6097
|
"section": "Help",
|
|
6098
|
-
"markdown": "# Migrating from Glide Data Grid\n\nGlide Data Grid is the canvas-rendered, ultra-high-performance choice\nfor very wide datasets (100k+ rows, 100+ columns). Sv-grid renders to\nDOM with virtualization, which trades peak FPS for\naccessibility + standards-compliant HTML.\n\n> Estimated effort: **3-6 hours** per grid. Glide's getCellContent /\n> onCellEdited cell-data model is the opposite of sv-grid's\n> data-array model; the mental flip takes the most time.\n\n<!-- facts:start glide-data-grid -->\n> **Facts, checked 9 Nov 2026.** `@glideapps/glide-data-grid` 6.0.3, MIT, last published 3 Feb 2024, 2,010,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6098
|
+
"markdown": "# Migrating from Glide Data Grid\n\nGlide Data Grid is the canvas-rendered, ultra-high-performance choice\nfor very wide datasets (100k+ rows, 100+ columns). Sv-grid renders to\nDOM with virtualization, which trades peak FPS for\naccessibility + standards-compliant HTML.\n\n> Estimated effort: **3-6 hours** per grid. Glide's getCellContent /\n> onCellEdited cell-data model is the opposite of sv-grid's\n> data-array model; the mental flip takes the most time.\n\n<!-- facts:start glide-data-grid -->\n> **Facts, checked 9 Nov 2026.** `@glideapps/glide-data-grid` 6.0.3, MIT, last published 3 Feb 2024, 2,010,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `@glideapps/glide-data-grid` 6.0.3 71.1 KB JS + 0.2 KB CSS, lodash + marked + react + react-dom + react-responsive-carousel external (measured 9 Nov 2026). Glide Data Grid pricing, as its site states it: Glide Data Grid is MIT and, in its own words, fully free and open source; no licence is sold for the grid (https://grid.glideapps.com/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Glide Data Grid](https://svgrid.com/compare/glide-data-grid/).\n<!-- facts:end -->\n\n## Mental-model flip\n\nGlide gives you a **canvas + a `getCellContent` callback**: the grid\nasks you for each visible cell on demand. Sv-grid wants the\n**whole data array up front** (`<SvGrid data={rows}>`); the engine\nslices for virtualization.\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- function getCellContent([col, row]) {\n- const r = rows[row]\n- if (col === 0) return { kind: 'text', data: r.name, displayData: r.name, allowOverlay: true }\n- if (col === 1) return { kind: 'number', data: r.amount, displayData: fmt(r.amount), allowOverlay: true }\n- }\n- <DataEditor columns={[...]} getCellContent={getCellContent} rows={rows.length} />\n\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name', editorType: 'text' },\n+ { field: 'amount', header: 'Amount', editorType: 'number',\n+ format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ <SvGrid data={rows} columns={columns} features={features} />\n```\n\nThis change is **good** for 99% of apps: it's less code, less risk\nof typos in cell coordinates, full TypeScript type checking on the\nrow shape. For the 1% of apps with rows that don't fit in memory,\nsee \"Out-of-memory data\" below.\n\n## Cell editing\n\n```diff\n- function onCellEdited([col, row], newValue) {\n- rows[row] = { ...rows[row], [colToField(col)]: newValue.data }\n- }\n- <DataEditor onCellEdited={onCellEdited} />\n\n+ <SvGrid\n+ data={rows} columns={columns} features={features}\n+ onCellValueChange={(e) => {\n+ rows[e.rowIndex] = { ...rows[e.rowIndex], [e.columnId]: e.newValue }\n+ }}\n+ />\n```\n\nYou can also rely on sv-grid's built-in write-back if `data` is a\nSvelte 5 `$state` array - mutations propagate automatically.\n\n## Sorting + filtering\n\nGlide doesn't ship sort / filter UI; you wrap your own. Sv-grid\nships them:\n\n```diff\n- // Build your own sort buttons in the toolbar; sort rows yourself.\n\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ <SvGrid data={rows} columns={columns} features={features} filterMode=\"menu\" />\n```\n\n## Frozen columns / row markers\n\n| Glide | sv-grid |\n| -------------------------------------- | --------------------------------------------- |\n| `freezeColumns={1}` | `api.setColumnPinning({ left: ['firstColId'] })` |\n| `rowMarkers=\"number\"` | `showRowNumbers={true}` prop |\n| `rowMarkers=\"checkbox\"` | `selectionMode=\"row\"` prop |\n\n## Custom drawing → custom snippets\n\nGlide's `drawCustomCell` lets you render anything via canvas. The\nsv-grid equivalent is a Svelte snippet (DOM):\n\n```diff\n- drawCustomCell(args) {\n- const ctx = args.ctx\n- ctx.fillStyle = args.cell.data.color\n- ctx.fillRect(args.rect.x, args.rect.y, args.rect.width, args.rect.height)\n- return true\n- }\n\n+ {\n+ field: 'color',\n+ cell: (ctx) => renderSnippet(ColorChip, { color: ctx.row.original.color }),\n+ }\n```\n\n```svelte\n{#snippet ColorChip(props)}\n <span style=\"display: inline-block; width: 18px; height: 18px; background: {props.color};\"></span>\n{/snippet}\n```\n\n## Out-of-memory data\n\nFor \"10M rows, fetched on scroll\" workloads (the only case Glide\ngenuinely beats sv-grid on), use sv-grid's\n[server-side / infinite-scroll pattern](./server-side-data.md):\n\n```svelte\n<SvGrid\n data={loadedSlice}\n columns={columns} features={features}\n externalSort={true}\n externalFilter={true}\n onSortingChange={async (s) => { loadedSlice = await fetchPage({ sort: s, offset: 0, limit: 200 }) }}\n/>\n```\n\nYou'll cap practical perf at ~100k rendered rows; for true 10M+\ndatasets Glide's canvas approach has a perf edge sv-grid won't\nmatch. Most apps don't need 10M rows on screen at once - they need\nfast server-side filtering, which both libraries support equally.\n\n## Theming\n\nGlide: huge `theme` prop object. Sv-grid: CSS custom properties (`--sg-*`).\n\n```diff\n- <DataEditor theme={{\n- accentColor: '#4F5DFF',\n- accentLight: 'rgba(62, 116, 253, 0.2)',\n- bgCell: '#1c1c20',\n- /* …40 more properties… */\n- }} />\n\n+ <div style=\"--sg-accent: #4F5DFF; --sg-bg: #1c1c20;\">\n+ <SvGrid {data} {columns} features={features} />\n+ </div>\n```\n\nSee [design tokens](./tokens.md) for the full list (≤ 30 tokens\ncovers everything; Glide's theme has ~40).\n\n## What you get for free vs Glide\n\n- **Accessibility.** Glide's canvas is invisible to screen readers\n unless you build an off-screen ARIA buffer. Sv-grid is WAI-ARIA\n 1.2 grid pattern out of the box; demo 17 covers axe-core CI.\n- **Standard HTML.** SEO crawlers, browser Find-in-Page, browser\n zoom, OS-level text scaling - all work because the grid emits\n actual `<table><tr><td>`.\n- **Familiar editing.** Browser-native `<input>` / `<select>` for\n cells, with autofill / clipboard / autocorrect intact.\n- **Built-in sort / filter / pagination UI.**\n\n## What you give up\n\n- **Peak FPS on >200k visible rows.** Canvas wins here. For most\n apps the gap is invisible; if you've actually measured it on real\n hardware and need the FPS, Glide remains the right call.\n- **Per-pixel cell drawing.** DOM cells are sub-pixel-uniform but\n not arbitrarily drawn.\n\n## Frequently asked questions\n\n### Should I move from Glide Data Grid to SvGrid?\n\nMove if you need accessibility, standards-compliant HTML, SEO-friendly markup,\nor DOM-based custom cells. Stay on Glide only if you have measured a need for\npeak canvas FPS on 200k+ simultaneously visible rows. For most apps the\nperformance gap is invisible, and SvGrid virtualizes comfortably to 100k+ rows.\n\n### How long does a Glide migration take?\n\nAbout 3-6 hours per grid. The biggest shift is conceptual: Glide's\n`getCellContent` / `onCellEdited` cell-data model is the inverse of SvGrid's\nplain data-array model, so the mental flip takes the most time, not the code.\n\n### Does SvGrid render to canvas or DOM?\n\nDOM, with row and column virtualization. That is what gives you WAI-ARIA roles,\nkeyboard navigation, screen-reader support, and selectable/indexable text -\nthings a canvas grid like Glide cannot offer.\n\n## What you end up with\n\nInline editing over a virtualized body, without a canvas to draw into.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} editable enableCellSelection sortable />\n```\n\n## See also\n\n- [SvGrid vs Glide Data Grid](https://svgrid.com/compare/glide-data-grid/) - the side-by-side comparison\n- [Performance benchmarks](./benchmarks.md) - measured numbers\n- [Server-side data](./server-side-data.md) - the >100k-row pattern\n- [Accessibility](./accessibility.md) - the standards compliance Glide doesn't ship\n"
|
|
6099
6099
|
},
|
|
6100
6100
|
{
|
|
6101
6101
|
"slug": "help/migrating-from-gridjs",
|
|
6102
6102
|
"path": "docs/help/migrating-from-gridjs.md",
|
|
6103
6103
|
"title": "Migrating from Grid.js",
|
|
6104
6104
|
"section": "Help",
|
|
6105
|
-
"markdown": "# Migrating from Grid.js\n\nGrid.js is a small vanilla-JS table for search, sort, and pagination\nthat you render into a DOM element. SvGrid does the same in a\nSvelte-5-native component and keeps going - virtualization, Excel-style\nfilters, editing, grouping - when you outgrow the basics.\n\n> Estimated effort: **30 min - 1 hour** per table.\n\n<!-- facts:start gridjs -->\n> **Facts, checked 9 Nov 2026.** `gridjs` 6.2.0, MIT, last published 3 Mar 2024, 393,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6105
|
+
"markdown": "# Migrating from Grid.js\n\nGrid.js is a small vanilla-JS table for search, sort, and pagination\nthat you render into a DOM element. SvGrid does the same in a\nSvelte-5-native component and keeps going - virtualization, Excel-style\nfilters, editing, grouping - when you outgrow the basics.\n\n> Estimated effort: **30 min - 1 hour** per table.\n\n<!-- facts:start gridjs -->\n> **Facts, checked 9 Nov 2026.** `gridjs` 6.2.0, MIT, last published 3 Mar 2024, 393,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `gridjs` 6.2.0 17.8 KB JS + 2.4 KB CSS (measured 9 Nov 2026). Grid.js pricing, as its site states it: Grid.js is MIT, free and open source; no licence is sold (https://gridjs.io/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Grid.js](https://svgrid.com/compare/gridjs/).\n<!-- facts:end -->\n\n## Vocabulary cheat sheet\n\n| Grid.js | sv-grid |\n| ----------------------------------------- | ----------------------------------------- |\n| `new Grid({ ... }).render(el)` | `<SvGrid ... />` |\n| `columns: ['Name', 'Amount']` | `columns: [{ field, header }]` |\n| `columns: [{ name, formatter }]` | `{ header, cell: (c) => renderSnippet(...) }` |\n| `sort: true` | `rowSortingFeature` |\n| `search: true` | `api.setState({ globalFilter: query })` / filter feature |\n| `pagination: { limit: 25 }` | `showPagination` (+ page size) |\n| `server: { url, then }` | `externalSort` / `externalFilter` + refetch |\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import { Grid } from 'gridjs'\n- import 'gridjs/dist/theme/mermaid.css'\n-\n- new Grid({\n- data: rows,\n- columns: ['Name', 'Amount'],\n- sort: true, search: true,\n- pagination: { limit: 25 },\n- }).render(document.getElementById('grid'))\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination />\n```\n\n## What you gain\n\n- **Virtualization** for large datasets (Grid.js renders the page).\n- **Excel-style filter menu**, **inline editing**, **grouping**, and\n **tree / master-detail** when you need them.\n- **Reactive data** - no `.render(el)` re-instantiation.\n- A **headless engine** and an **imperative API** plus `@svgrid/mcp`.\n\n## Frequently asked questions\n\n### When should I move from Grid.js to SvGrid?\n\nWhen you need more than search / sort / paginate - virtualization for big\ndatasets, inline editing, Excel-style filters, grouping, or tree data. For a\nsmall table, Grid.js stays lighter.\n\n### Is SvGrid MIT-licensed like Grid.js?\n\nYes. `@svgrid/grid` is MIT. Only the optional `@svgrid/enterprise` add-on is paid.\n\n### Does SvGrid support server-side data like Grid.js?\n\nYes. Set `externalSort` / `externalFilter` and refetch on the\n`onSortingChange` / `onFiltersChange` events.\n\n## What you end up with\n\nSearch, sort and pagination - the whole Grid.js surface, plus editing.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} editable />\n```\n\n## See also\n\n- [SvGrid vs Grid.js](https://svgrid.com/compare/gridjs/) - the side-by-side comparison\n- [Getting started](../getting-started.md) - a working grid in ~15 lines\n- [Server-side data](./server-side-data.md) - the external-data pattern\n"
|
|
6106
6106
|
},
|
|
6107
6107
|
{
|
|
6108
6108
|
"slug": "help/migrating-from-handsontable",
|
|
6109
6109
|
"path": "docs/help/migrating-from-handsontable.md",
|
|
6110
6110
|
"title": "Migrating from Handsontable",
|
|
6111
6111
|
"section": "Help",
|
|
6112
|
-
"markdown": "# Migrating from Handsontable\n\nHandsontable's mental model is \"spreadsheet-in-a-page\": every cell\neditable, formulas, copy/paste with the OS clipboard, frozen rows\nand columns. Sv-grid covers ~90% of the same surface; the port is\nmostly a configuration translation, except for HyperFormula (see\nthe Formulas section below).\n\n> Estimated effort: **2-4 hours** per grid for typical spreadsheet\n> workflows. **Add 1-2 days** if you depend heavily on\n> HyperFormula features sv-grid doesn't ship.\n\n<!-- facts:start handsontable -->\n> **Facts, checked 9 Nov 2026.** `handsontable` 18.1.2, Commercial (see licence file), last published 7 Oct 2026, 1,250,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026). Handsontable pricing, as its site states it: Handsontable's Hobby licence is free for personal, exploratory projects and cannot be used in commercial settings; handsontable.com lists Standard from $999 per developer and Priority from $1,299 per developer, with Enterprise on custom terms (https://handsontable.com/pricing, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Handsontable](https://svgrid.com/compare/handsontable/).\n<!-- facts:end -->\n\n## Imports\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import Handsontable from 'handsontable'\n- import 'handsontable/dist/handsontable.full.min.css'\n\n+ import {\n+ SvGrid, tableFeatures,\n+ rowSortingFeature, columnFilteringFeature, rowSelectionFeature,\n+ + } from '@svgrid/grid'\n```\n\n## Schema → columns\n\nHandsontable accepts a 2D array OR an array of objects. Sv-grid\nexpects the array-of-objects form:\n\n```diff\n- const hot = new Handsontable(container, {\n- data: [\n- ['Tesla', 2017, 'black', false],\n- ['Nissan', 2018, 'blue', true ],\n- ],\n- colHeaders: ['Make', 'Year', 'Color', 'In stock'],\n- columns: [\n- {},\n- { type: 'numeric' },\n- {},\n- { type: 'checkbox' },\n- ],\n- })\n\n+ type Car = { make: string; year: number; color: string; inStock: boolean }\n+ const rows: Car[] = [\n+ { make: 'Tesla', year: 2017, color: 'black', inStock: false },\n+ { make: 'Nissan', year: 2018, color: 'blue', inStock: true },\n+ ]\n+ const columns: ColumnDef<typeof features, Car>[] = [\n+ { field: 'make', header: 'Make' },\n+ { field: 'year', header: 'Year', editorType: 'number' },\n+ { field: 'color', header: 'Color' },\n+ { field: 'inStock', header: 'In stock', editorType: 'checkbox' },\n+ ]\n+ <SvGrid data={rows} columns={columns} features={features} />\n```\n\nIf your existing data is a 2D array, transform once at boot:\n\n```ts\nconst headerRow = raw[0]\nconst rows = raw.slice(1).map((cells) =>\n Object.fromEntries(cells.map((v, i) => [headerRow[i], v])),\n)\n```\n\n## Editor types\n\n| Handsontable | sv-grid |\n| ---------------------------------------------- | ------------------------------------------------ |\n| `type: 'text'` | `editorType: 'text'` |\n| `type: 'numeric'` | `editorType: 'number'` |\n| `type: 'date'` | `editorType: 'date'` |\n| `type: 'checkbox'` | `editorType: 'checkbox'` |\n| `type: 'dropdown', source: [...]` | `editorType: 'list', editorOptions: [...]` |\n| `type: 'autocomplete'` | `editorType: 'list'` (combobox UI ships) |\n| `type: 'time'` | `editorType: 'time'` |\n| `type: 'password'` | Use `editorType: 'text'` + a custom snippet |\n\n## Selection + clipboard\n\n| Handsontable | sv-grid |\n| --------------------------------------- | ------------------------------------------------------- |\n| `selectCells([[0,0,2,5]])` | `api.selectCells(ranges)`, with `selectionMode='cell'` |\n| `getSelected()` | `api.getSelected()`: the same `[[startRow, startCol, endRow, endCol], ...]`, normalised to top-left / bottom-right and `[]` rather than `undefined` when nothing is selected |\n| `getSelectedLast()` | `api.getSelectedLast()`: `[startRow, startCol, endRow, endCol]` with the orientation kept (a range dragged upwards has `startRow > endRow`), or `undefined` |\n| `getSelectedRange()` / `getSelectedRangeLast()` | `api.getSelectedRange()` / `api.getSelectedRangeLast()`: `{ from, to, highlight }` per rectangle, the same three fields as `CellRange`; plain data rather than a class, so use `Math.min` / `Math.max` for the corners |\n| `copyPaste: true` (default) | Ships built-in; `enableCellSelection={true}`. The spreadsheet shell also exchanges formats, number formats and formulas with Excel and Google Sheets through the HTML clipboard |\n| `fillHandle: true` | Ships built-in (drag-to-fill on selected range) |\n| `moveCells: true` | `moveCells` - drag the range border to move it, Ctrl / Cmd to copy. On by default; see [move or copy a range](./editing/move-cells.md) |\n\n## Frozen rows / columns\n\n| Handsontable | sv-grid |\n| ---------------------------------- | ------------------------------------------------------ |\n| `fixedColumnsStart: 2` | `api.setColumnPinning({ left: ['firstColId', 'secondColId'] })` |\n| `fixedRowsTop: 1` | `pinnedTopRows` (and `pinnedBottomRows`) |\n| `manualColumnFreeze: true` | Ships via the column-header right-click menu |\n| `mergeCells: [{ row, col, rowspan, colspan }]` | `mergedCells={[{ rowIndex, colIndex, rowSpan, colSpan }]}` on `<SvGrid>`; the spreadsheet shell adds Merge & Center, Merge Across, Merge Cells and Unmerge on the ribbon and the cell menu |\n\nFreeze panes on a plain `<SvGrid>`: two pinned columns and the sticky\nletter and number headers, with formulas underneath.\n\n<div data-docs-demo=\"208-freeze-panes\" data-height=\"520\"></div>\n\n## Hooks → callbacks\n\n| Handsontable hook | sv-grid |\n| -------------------------------------- | ------------------------------------------------------- |\n| `afterChange((changes, src) => {})` | `onCellValueChange((e) => {...})` |\n| `afterSelection(...)` | `onActiveCellChange((cell) => {...})` |\n| `afterFilter(...)` | `onFiltersChange((f) => {...})` |\n| `afterColumnSort(...)` | `onSortingChange((s) => {...})` |\n| `beforeChange((changes) => false)` | Throw / return `false` from your inline validator; see [validation](./editing/validation.md) |\n| `afterCreateRow / afterRemoveRow` | Wrap `api.addRow / removeRow` in your own emitter; on the spreadsheet shell, `onChange` reports a `structure` reason with the edit |\n| `afterMergeCells / afterUnmergeCells` | On the spreadsheet shell, `onChange` reports `merges`; `api.getMergedCells()` reads the grid's list |\n| `afterSetCellMeta` (comments, validation) | `onChange` reports `comments`, `validation`, `conditional-formats` and `protection` on the shell |\n| `afterFilter` (the Filters plugin) | `onChange` reports `filter` on the shell; `getState().sheets[name].autoFilter` is the state |\n\nOn the spreadsheet shell (`<SvSheet>` in `@svgrid/enterprise`) one callback\ncovers the lot: `onChange(reasons)` fires once per tick with every kind of\nchange since the last call (`cells`, `formats`, `sizes`, `hidden`,\n`freeze`, `sheets`, `comments`, `protection`, `validation`,\n`conditional-formats`, `merges`, `filter`, `structure` with the insert or\ndelete, `restore`), which is where Handsontable's `afterChange` autosave\ngoes. `getState()` gives the document to save and `setState()` puts it back.\n\n## Cell meta → the sheet document\n\nHandsontable keeps comments, validators, read-only flags and merges as cell\nmeta on the instance. On the spreadsheet shell they are parts of the\ndocument, per sheet, saved with it and moved by inserts and deletes:\n\n| Handsontable | sv-grid spreadsheet shell |\n| --------------------------------------------------- | --------------------------------------------------------------- |\n| `comments: true`, `cell: [{ row, col, comment }]` | Review > New Comment, Shift+F2, the cell menu; `getState().sheets[name].comments` |\n| `validator: 'numeric'`, `allowInvalid: false` | Data > Data Validation (Whole number, Decimal, List, Date, Text length, Custom), Stop or Warning; `validation` in the state |\n| `readOnly: true` on a cell | Format Cells > Protection unlocks the cells that may change, Review > Protect Sheet locks the rest; `locked: false` in the format entry, `protected` per sheet |\n| `mergeCells` | Merge & Center on the ribbon and the cell menu; `merges` in the state |\n| `filters: true` + `dropdownMenu` | Ctrl+Shift+L or Data > Filter: Excel's AutoFilter arrows and menus; `autoFilter` in the state |\n| conditional formatting (a custom renderer) | Home > Styles > Conditional Formatting: Highlight Cells, Top/Bottom, Data Bars, Color Scales, Icon Sets, Manage Rules; `conditionalFormats` in the state |\n| `autofill` rules | The fill handle's own series: numbers, dates by day or by the set gap, `Item 1`, weekdays and months |\n\nOn a plain `<SvGrid>` the free grid has the primitives instead: `notes`\nand `editableComments` for comments, `editable` and `valueParser` on a\ncolumn for read-only cells and validation, `mergedCells` for merges, the\nfilter row and its Excel-style menu for filtering, and value-driven\n`conditionalFormats` by column.\n\n## Formulas (HyperFormula)\n\nSv-grid ships a focused subset under\n[`spreadsheet-formulas`](./spreadsheet-formulas.md) (SUM, IF, COUNTIF\n+ cell refs + ranges + cycle detection). It does NOT ship the full\nHyperFormula library.\n\nIf you need HyperFormula's full surface (~400 functions, complex\ndate math, R1C1 refs), the integration pattern is:\n\n```ts\nimport { HyperFormula } from 'hyperformula'\n\nconst hf = HyperFormula.buildFromArray(rowsAsMatrix, { licenseKey: 'gpl-v3' })\n\n// On every cell edit, push to HF + read back the computed value:\nfunction onCellValueChange(e) {\n hf.setCellContents({ sheet: 0, row: e.rowIndex, col: columnIndex }, e.newValue)\n // ...read computed cells you depend on + push back via api.setCellValue\n}\n```\n\nThis is the only piece where the swap isn't 1:1. Most teams find\nsv-grid's shipped subset covers 80% of real-world formula usage; if\nyours is in the 20%, HyperFormula plugs in with the pattern above.\n\n## Licence\n\nHandsontable's grid needs a commercial licence for commercial use; its free\nHobby licence is for personal, exploratory projects, as its pricing page\nstates (the wording and the date are in the facts box at the top of this\npage). Sv-grid's `@svgrid/grid` is MIT with no licence key, and the\n[Enterprise tier](../enterprise/licensing.md) needs no key to evaluate:\nit works without one and displays a watermark and a console\nmessage until you add one, so there is no cutoff to plan around.\n\n## What you get for free vs Handsontable\n\n- **No commercial licence for the grid.** @svgrid/grid is MIT.\n- **Modern Svelte 5 ergonomics.** `$state` arrays beat\n `loadData(...)`.\n- **Grid features a spreadsheet does not have.** Row grouping with\n aggregation, master/detail, server-side data (grouping, tree, pivot and transactions on the server are Enterprise) and integrated\n charts in the same package.\n- **CSP-clean.** Handsontable's HyperFormula path needs CSP `eval`\n exceptions in some configurations.\n\n## What you give up\n\n- **Full HyperFormula surface as a supported feature.** Sv-grid ships a\n subset and lets you wire HyperFormula yourself; see above.\n- **Nested headers.** Handsontable's `nestedHeaders` have no\n counterpart beyond column groups.\n- **Threaded comments and a validation Input Message.** Comments on the\n shell are Excel's notes, one text per cell; validation shows its message\n on a refusal, not on arrival.\n- **Excel export without a paid pack.** Handsontable's export plugin writes\n XLSX through its asynchronous method; on sv-grid, CSV, TSV and JSON export\n are free and Excel, PDF and print output are in `@svgrid/enterprise`.\n\n## Frequently asked questions\n\n### Can SvGrid replace Handsontable's spreadsheet features?\n\nIt covers roughly 90% of the surface - inline editing on every cell, copy/paste\nas TSV, range selection, column groups, and a built-in formula engine. Budget\n2-4 hours per grid for typical spreadsheet workflows, plus 1-2 days if you lean\nheavily on the full HyperFormula function set.\n\n### Does SvGrid support formulas like Handsontable?\n\nYes, a built-in formula engine with cell references, ranges, and common\nfunctions (see the spreadsheet-formulas guide and demo 27). It is a practical\nsubset rather than the complete HyperFormula library, so verify your specific\nfunctions before porting.\n\n### Is SvGrid licensed like Handsontable?\n\nNo. The `@svgrid/grid` core is MIT and free for commercial use - no per-seat\nlicence key - whereas Handsontable's free licence excludes commercial use and\nits commercial plans are per developer; the facts box has the statement as\nread from handsontable.com. The optional `@svgrid/enterprise` pack (Excel and\nPDF export, print, pivot, import) is priced per developer.\n\n### Does SvGrid have a blank spreadsheet like Handsontable?\n\nYes, on the plain grid: column-letter headers, a row gutter, a name box\nand formula bar, gridlines, range selection and a fill handle, with\nHyperFormula underneath when you want its function library.\n\n<div data-docs-demo=\"207-blank-sheet\" data-height=\"560\"></div>\n\n## What you end up with\n\nSpreadsheet behaviour: inline edit, drag a cell range, copy it out as TSV.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} editable enableCellSelection statusBar />\n```\n\n## See also\n\n- [SvGrid vs Handsontable](https://svgrid.com/compare/handsontable/) - the side-by-side comparison, with a source and date for every claim\n- [Spreadsheet formulas](./spreadsheet-formulas.md) - sv-grid's\n built-in formula engine, and the rest of the spreadsheet demos\n- [Demo 27 (Spreadsheet + Ribbon)](https://svgrid.com/demos/27-spreadsheet-ribbon/) - live\n- [Migrating from AG Grid](./migrating-from-ag-grid.md)\n"
|
|
6112
|
+
"markdown": "# Migrating from Handsontable\n\nHandsontable's mental model is \"spreadsheet-in-a-page\": every cell\neditable, formulas, copy/paste with the OS clipboard, frozen rows\nand columns. Sv-grid covers ~90% of the same surface; the port is\nmostly a configuration translation, except for HyperFormula (see\nthe Formulas section below).\n\n> Estimated effort: **2-4 hours** per grid for typical spreadsheet\n> workflows. **Add 1-2 days** if you depend heavily on\n> HyperFormula features sv-grid doesn't ship.\n\n<!-- facts:start handsontable -->\n> **Facts, checked 9 Nov 2026.** `handsontable` 18.1.2, Commercial (see licence file), last published 7 Oct 2026, 1,250,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). Handsontable pricing, as its site states it: Handsontable's Hobby licence is free for personal, exploratory projects and cannot be used in commercial settings; handsontable.com lists Standard from $999 per developer and Priority from $1,299 per developer, with Enterprise on custom terms (https://handsontable.com/pricing, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Handsontable](https://svgrid.com/compare/handsontable/).\n<!-- facts:end -->\n\n## Imports\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import Handsontable from 'handsontable'\n- import 'handsontable/dist/handsontable.full.min.css'\n\n+ import {\n+ SvGrid, tableFeatures,\n+ rowSortingFeature, columnFilteringFeature, rowSelectionFeature,\n+ + } from '@svgrid/grid'\n```\n\n## Schema → columns\n\nHandsontable accepts a 2D array OR an array of objects. Sv-grid\nexpects the array-of-objects form:\n\n```diff\n- const hot = new Handsontable(container, {\n- data: [\n- ['Tesla', 2017, 'black', false],\n- ['Nissan', 2018, 'blue', true ],\n- ],\n- colHeaders: ['Make', 'Year', 'Color', 'In stock'],\n- columns: [\n- {},\n- { type: 'numeric' },\n- {},\n- { type: 'checkbox' },\n- ],\n- })\n\n+ type Car = { make: string; year: number; color: string; inStock: boolean }\n+ const rows: Car[] = [\n+ { make: 'Tesla', year: 2017, color: 'black', inStock: false },\n+ { make: 'Nissan', year: 2018, color: 'blue', inStock: true },\n+ ]\n+ const columns: ColumnDef<typeof features, Car>[] = [\n+ { field: 'make', header: 'Make' },\n+ { field: 'year', header: 'Year', editorType: 'number' },\n+ { field: 'color', header: 'Color' },\n+ { field: 'inStock', header: 'In stock', editorType: 'checkbox' },\n+ ]\n+ <SvGrid data={rows} columns={columns} features={features} />\n```\n\nIf your existing data is a 2D array, transform once at boot:\n\n```ts\nconst headerRow = raw[0]\nconst rows = raw.slice(1).map((cells) =>\n Object.fromEntries(cells.map((v, i) => [headerRow[i], v])),\n)\n```\n\n## Editor types\n\n| Handsontable | sv-grid |\n| ---------------------------------------------- | ------------------------------------------------ |\n| `type: 'text'` | `editorType: 'text'` |\n| `type: 'numeric'` | `editorType: 'number'` |\n| `type: 'date'` | `editorType: 'date'` |\n| `type: 'checkbox'` | `editorType: 'checkbox'` |\n| `type: 'dropdown', source: [...]` | `editorType: 'list', editorOptions: [...]` |\n| `type: 'autocomplete'` | `editorType: 'list'` (combobox UI ships) |\n| `type: 'time'` | `editorType: 'time'` |\n| `type: 'password'` | Use `editorType: 'text'` + a custom snippet |\n\n## Selection + clipboard\n\n| Handsontable | sv-grid |\n| --------------------------------------- | ------------------------------------------------------- |\n| `selectCells([[0,0,2,5]])` | `api.selectCells(ranges)`, with `selectionMode='cell'` |\n| `getSelected()` | `api.getSelected()`: the same `[[startRow, startCol, endRow, endCol], ...]`, normalised to top-left / bottom-right and `[]` rather than `undefined` when nothing is selected |\n| `getSelectedLast()` | `api.getSelectedLast()`: `[startRow, startCol, endRow, endCol]` with the orientation kept (a range dragged upwards has `startRow > endRow`), or `undefined` |\n| `getSelectedRange()` / `getSelectedRangeLast()` | `api.getSelectedRange()` / `api.getSelectedRangeLast()`: `{ from, to, highlight }` per rectangle, the same three fields as `CellRange`; plain data rather than a class, so use `Math.min` / `Math.max` for the corners |\n| `copyPaste: true` (default) | Ships built-in; `enableCellSelection={true}`. The spreadsheet shell also exchanges formats, number formats and formulas with Excel and Google Sheets through the HTML clipboard |\n| `fillHandle: true` | Ships built-in (drag-to-fill on selected range) |\n| `moveCells: true` | `moveCells` - drag the range border to move it, Ctrl / Cmd to copy. On by default; see [move or copy a range](./editing/move-cells.md) |\n\n## Frozen rows / columns\n\n| Handsontable | sv-grid |\n| ---------------------------------- | ------------------------------------------------------ |\n| `fixedColumnsStart: 2` | `api.setColumnPinning({ left: ['firstColId', 'secondColId'] })` |\n| `fixedRowsTop: 1` | `pinnedTopRows` (and `pinnedBottomRows`) |\n| `manualColumnFreeze: true` | Ships via the column-header right-click menu |\n| `mergeCells: [{ row, col, rowspan, colspan }]` | `mergedCells={[{ rowIndex, colIndex, rowSpan, colSpan }]}` on `<SvGrid>`; the spreadsheet shell adds Merge & Center, Merge Across, Merge Cells and Unmerge on the ribbon and the cell menu |\n\nFreeze panes on a plain `<SvGrid>`: two pinned columns and the sticky\nletter and number headers, with formulas underneath.\n\n<div data-docs-demo=\"208-freeze-panes\" data-height=\"520\"></div>\n\n## Hooks → callbacks\n\n| Handsontable hook | sv-grid |\n| -------------------------------------- | ------------------------------------------------------- |\n| `afterChange((changes, src) => {})` | `onCellValueChange((e) => {...})` |\n| `afterSelection(...)` | `onActiveCellChange((cell) => {...})` |\n| `afterFilter(...)` | `onFiltersChange((f) => {...})` |\n| `afterColumnSort(...)` | `onSortingChange((s) => {...})` |\n| `beforeChange((changes) => false)` | Throw / return `false` from your inline validator; see [validation](./editing/validation.md) |\n| `afterCreateRow / afterRemoveRow` | Wrap `api.addRow / removeRow` in your own emitter; on the spreadsheet shell, `onChange` reports a `structure` reason with the edit |\n| `afterMergeCells / afterUnmergeCells` | On the spreadsheet shell, `onChange` reports `merges`; `api.getMergedCells()` reads the grid's list |\n| `afterSetCellMeta` (comments, validation) | `onChange` reports `comments`, `validation`, `conditional-formats` and `protection` on the shell |\n| `afterFilter` (the Filters plugin) | `onChange` reports `filter` on the shell; `getState().sheets[name].autoFilter` is the state |\n\nOn the spreadsheet shell (`<SvSheet>` in `@svgrid/enterprise`) one callback\ncovers the lot: `onChange(reasons)` fires once per tick with every kind of\nchange since the last call (`cells`, `formats`, `sizes`, `hidden`,\n`freeze`, `sheets`, `comments`, `protection`, `validation`,\n`conditional-formats`, `merges`, `filter`, `structure` with the insert or\ndelete, `restore`), which is where Handsontable's `afterChange` autosave\ngoes. `getState()` gives the document to save and `setState()` puts it back.\n\n## Cell meta → the sheet document\n\nHandsontable keeps comments, validators, read-only flags and merges as cell\nmeta on the instance. On the spreadsheet shell they are parts of the\ndocument, per sheet, saved with it and moved by inserts and deletes:\n\n| Handsontable | sv-grid spreadsheet shell |\n| --------------------------------------------------- | --------------------------------------------------------------- |\n| `comments: true`, `cell: [{ row, col, comment }]` | Review > New Comment, Shift+F2, the cell menu; `getState().sheets[name].comments` |\n| `validator: 'numeric'`, `allowInvalid: false` | Data > Data Validation (Whole number, Decimal, List, Date, Text length, Custom), Stop or Warning; `validation` in the state |\n| `readOnly: true` on a cell | Format Cells > Protection unlocks the cells that may change, Review > Protect Sheet locks the rest; `locked: false` in the format entry, `protected` per sheet |\n| `mergeCells` | Merge & Center on the ribbon and the cell menu; `merges` in the state |\n| `filters: true` + `dropdownMenu` | Ctrl+Shift+L or Data > Filter: Excel's AutoFilter arrows and menus; `autoFilter` in the state |\n| conditional formatting (a custom renderer) | Home > Styles > Conditional Formatting: Highlight Cells, Top/Bottom, Data Bars, Color Scales, Icon Sets, Manage Rules; `conditionalFormats` in the state |\n| `autofill` rules | The fill handle's own series: numbers, dates by day or by the set gap, `Item 1`, weekdays and months |\n\nOn a plain `<SvGrid>` the free grid has the primitives instead: `notes`\nand `editableComments` for comments, `editable` and `valueParser` on a\ncolumn for read-only cells and validation, `mergedCells` for merges, the\nfilter row and its Excel-style menu for filtering, and value-driven\n`conditionalFormats` by column.\n\n## Formulas (HyperFormula)\n\nSv-grid ships a focused subset under\n[`spreadsheet-formulas`](./spreadsheet-formulas.md) (SUM, IF, COUNTIF\n+ cell refs + ranges + cycle detection). It does NOT ship the full\nHyperFormula library.\n\nIf you need HyperFormula's full surface (~400 functions, complex\ndate math, R1C1 refs), the integration pattern is:\n\n```ts\nimport { HyperFormula } from 'hyperformula'\n\nconst hf = HyperFormula.buildFromArray(rowsAsMatrix, { licenseKey: 'gpl-v3' })\n\n// On every cell edit, push to HF + read back the computed value:\nfunction onCellValueChange(e) {\n hf.setCellContents({ sheet: 0, row: e.rowIndex, col: columnIndex }, e.newValue)\n // ...read computed cells you depend on + push back via api.setCellValue\n}\n```\n\nThis is the only piece where the swap isn't 1:1. Most teams find\nsv-grid's shipped subset covers 80% of real-world formula usage; if\nyours is in the 20%, HyperFormula plugs in with the pattern above.\n\n## Licence\n\nHandsontable's grid needs a commercial licence for commercial use; its free\nHobby licence is for personal, exploratory projects, as its pricing page\nstates (the wording and the date are in the facts box at the top of this\npage). Sv-grid's `@svgrid/grid` is MIT with no licence key, and the\n[Enterprise tier](../enterprise/licensing.md) needs no key to evaluate:\nit works without one and displays a watermark and a console\nmessage until you add one, so there is no cutoff to plan around.\n\n## What you get for free vs Handsontable\n\n- **No commercial licence for the grid.** @svgrid/grid is MIT.\n- **Modern Svelte 5 ergonomics.** `$state` arrays beat\n `loadData(...)`.\n- **Grid features a spreadsheet does not have.** Row grouping with\n aggregation, master/detail, server-side data (grouping, tree, pivot and transactions on the server are Enterprise) and integrated\n charts in the same package.\n- **CSP-clean.** Handsontable's HyperFormula path needs CSP `eval`\n exceptions in some configurations.\n\n## What you give up\n\n- **Full HyperFormula surface as a supported feature.** Sv-grid ships a\n subset and lets you wire HyperFormula yourself; see above.\n- **Nested headers.** Handsontable's `nestedHeaders` have no\n counterpart beyond column groups.\n- **Threaded comments and a validation Input Message.** Comments on the\n shell are Excel's notes, one text per cell; validation shows its message\n on a refusal, not on arrival.\n- **Excel export without a paid pack.** Handsontable's export plugin writes\n XLSX through its asynchronous method; on sv-grid, CSV, TSV and JSON export\n are free and Excel, PDF and print output are in `@svgrid/enterprise`.\n\n## Frequently asked questions\n\n### Can SvGrid replace Handsontable's spreadsheet features?\n\nIt covers roughly 90% of the surface - inline editing on every cell, copy/paste\nas TSV, range selection, column groups, and a built-in formula engine. Budget\n2-4 hours per grid for typical spreadsheet workflows, plus 1-2 days if you lean\nheavily on the full HyperFormula function set.\n\n### Does SvGrid support formulas like Handsontable?\n\nYes, a built-in formula engine with cell references, ranges, and common\nfunctions (see the spreadsheet-formulas guide and demo 27). It is a practical\nsubset rather than the complete HyperFormula library, so verify your specific\nfunctions before porting.\n\n### Is SvGrid licensed like Handsontable?\n\nNo. The `@svgrid/grid` core is MIT and free for commercial use - no per-seat\nlicence key - whereas Handsontable's free licence excludes commercial use and\nits commercial plans are per developer; the facts box has the statement as\nread from handsontable.com. The optional `@svgrid/enterprise` pack (Excel and\nPDF export, print, pivot, import) is priced per developer.\n\n### Does SvGrid have a blank spreadsheet like Handsontable?\n\nYes, on the plain grid: column-letter headers, a row gutter, a name box\nand formula bar, gridlines, range selection and a fill handle, with\nHyperFormula underneath when you want its function library.\n\n<div data-docs-demo=\"207-blank-sheet\" data-height=\"560\"></div>\n\n## What you end up with\n\nSpreadsheet behaviour: inline edit, drag a cell range, copy it out as TSV.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} editable enableCellSelection statusBar />\n```\n\n## See also\n\n- [SvGrid vs Handsontable](https://svgrid.com/compare/handsontable/) - the side-by-side comparison, with a source and date for every claim\n- [Spreadsheet formulas](./spreadsheet-formulas.md) - sv-grid's\n built-in formula engine, and the rest of the spreadsheet demos\n- [Demo 27 (Spreadsheet + Ribbon)](https://svgrid.com/demos/27-spreadsheet-ribbon/) - live\n- [Migrating from AG Grid](./migrating-from-ag-grid.md)\n"
|
|
6113
6113
|
},
|
|
6114
6114
|
{
|
|
6115
6115
|
"slug": "help/migrating-from-jqxgrid",
|
|
6116
6116
|
"path": "docs/help/migrating-from-jqxgrid.md",
|
|
6117
6117
|
"title": "Migrating from jqxGrid (jQWidgets)",
|
|
6118
6118
|
"section": "Help",
|
|
6119
|
-
"markdown": "# Migrating from jqxGrid (jQWidgets)\n\njqxGrid and SvGrid come from the **same team**. jqxGrid is the mature,\nmulti-framework grid (jQuery core with Angular, React, and Vue\nintegrations); SvGrid is the Svelte-5-native member of the family. If\nyour team is consolidating on Svelte 5, this guide maps a jqxGrid setup\nonto SvGrid - and the concepts will feel familiar because the\nengineering lineage is shared.\n\n> Estimated effort: **2-4 hours** per grid. Most of the work is moving\n> from the imperative jQuery source / API to reactive `$state`.\n\n<!-- facts:start jqxgrid -->\n> **Facts, checked 9 Nov 2026.** `jqwidgets-scripts` 27.2.0, https://www.jqwidgets.com/license/, last published 31 Oct 2026, 50,500 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6119
|
+
"markdown": "# Migrating from jqxGrid (jQWidgets)\n\njqxGrid and SvGrid come from the **same team**. jqxGrid is the mature,\nmulti-framework grid (jQuery core with Angular, React, and Vue\nintegrations); SvGrid is the Svelte-5-native member of the family. If\nyour team is consolidating on Svelte 5, this guide maps a jqxGrid setup\nonto SvGrid - and the concepts will feel familiar because the\nengineering lineage is shared.\n\n> Estimated effort: **2-4 hours** per grid. Most of the work is moving\n> from the imperative jQuery source / API to reactive `$state`.\n\n<!-- facts:start jqxgrid -->\n> **Facts, checked 9 Nov 2026.** `jqwidgets-scripts` 27.2.0, https://www.jqwidgets.com/license/, last published 31 Oct 2026, 50,500 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). jqxGrid pricing, as its site states it: jqwidgets.com lists the Developer License at $499 (on sale at $399) per developer, perpetual and royalty-free with one year of updates and support, and the Team License at $1,499 for five or more developers; the free Community License excludes the Grid (https://www.jqwidgets.com/license/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs jqxGrid (jQWidgets)](https://svgrid.com/compare/jqxgrid/).\n<!-- facts:end -->\n\n## Vocabulary cheat sheet\n\n| jqxGrid | sv-grid |\n| ---------------------------------------- | ----------------------------------------- |\n| `$('#grid').jqxGrid({ ... })` | `<SvGrid ... />` |\n| `source` / `jqxDataAdapter` | `data` array (or `externalSort/Filter`) |\n| `{ text: 'Name', datafield: 'name' }` | `{ header: 'Name', field: 'name' }` |\n| `cellsrenderer` | `cell: (c) => renderSnippet(...)` |\n| `columntype` / cell editor | `editorType` |\n| `cellsformat: 'c2'` | `format: { type: 'currency', currency: 'USD' }` |\n| `sortable` / `filterable` | `rowSortingFeature` / `columnFilteringFeature` |\n| `groupable` + `groups` | `columnGroupingFeature` + `api.setGroupBy()` |\n| `pageable` | `showPagination` |\n| `jqxGrid('updatebounddata')` | reassign the `$state` data array |\n| `editable` + `cellendedit` event | `enableInlineEditing` + `onCellValueChange` |\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- const source = { localdata: rows, datatype: 'array' }\n- const adapter = new $.jqx.dataAdapter(source)\n- $('#grid').jqxGrid({\n- source: adapter, sortable: true, filterable: true, pageable: true, editable: true,\n- columns: [\n- { text: 'Name', datafield: 'name' },\n- { text: 'Amount', datafield: 'amount', cellsformat: 'c2' },\n- ],\n- })\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination enableInlineEditing />\n```\n\n## What changes\n\n- **jQuery source / dataAdapter → reactive `$state`.** No\n `updatebounddata()`; reassign the array.\n- **`cellsrenderer` → snippet cells** via `renderSnippet`.\n- **jQWidgets theme → `--sg-*` tokens** (or your Tailwind theme).\n\n## A note on family\n\nMoving to SvGrid keeps you with the same team's Svelte-5 grid rather\nthan switching vendors. The Enterprise tier and support come from the same people behind jqxGrid.\nIf your app is still on jQuery / Angular / React / Vue, jqxGrid remains\nthe right tool; reach for SvGrid when the codebase is Svelte 5.\n\n## Frequently asked questions\n\n### Is SvGrid made by the same team as jqxGrid?\n\nYes. SvGrid is built by jQWidgets - the same team behind jqxGrid - specifically\nfor Svelte 5, rebuilt around runes and snippets with an MIT community core.\n\n### How do jqxGrid columns map to SvGrid?\n\n`text` becomes `header`, `datafield` becomes `field`, `cellsrenderer` becomes a\n`renderSnippet` cell, and `cellsformat` maps onto the `format` config. Sorting /\nfiltering / grouping move to registered features.\n\n### Should I migrate my jQuery jqxGrid app to SvGrid?\n\nOnly if you are moving that app to Svelte 5. If it stays on jQuery / Angular /\nReact / Vue, jqxGrid is the better fit. SvGrid is the native choice once the\nstack is Svelte.\n\n## What you end up with\n\nEditing plus range selection and a totals row - the jqxGrid working set.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} editable enableCellSelection summary sortable />\n```\n\n## See also\n\n- [SvGrid vs jqxGrid](https://svgrid.com/compare/jqxgrid/) - the side-by-side comparison\n- [About SvGrid](https://svgrid.com/about/) - built by jQWidgets\n- [Getting started](../getting-started.md) - a working grid in ~15 lines\n"
|
|
6120
6120
|
},
|
|
6121
6121
|
{
|
|
6122
6122
|
"slug": "help/migrating-from-kendo-grid",
|
|
6123
6123
|
"path": "docs/help/migrating-from-kendo-grid.md",
|
|
6124
6124
|
"title": "Migrating from Kendo UI Grid (Telerik)",
|
|
6125
6125
|
"section": "Help",
|
|
6126
|
-
"markdown": "# Migrating from Kendo UI Grid (Telerik)\n\nKendo UI Grid is the polished, commercial enterprise grid from Telerik /\nProgress, available for jQuery, React, Vue, and Angular. Moving to SvGrid\ntrades the multi-framework commercial suite for a Svelte-5-native grid\nwith an MIT core - and a much cheaper paid tier.\n\n> Estimated effort: **3-6 hours** per grid - column / event translation\n> plus re-theming.\n>\n> Kendo's exact API differs across its jQuery / React / Vue / Angular\n> flavours; map your version's column and event names onto the SvGrid\n> equivalents below.\n\n<!-- facts:start kendo-ui-grid -->\n> **Facts, checked 9 Nov 2026.** `@progress/kendo-react-grid` 16.3.0, Commercial (see licence file), last published 2 Nov 2026, 406,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6126
|
+
"markdown": "# Migrating from Kendo UI Grid (Telerik)\n\nKendo UI Grid is the polished, commercial enterprise grid from Telerik /\nProgress, available for jQuery, React, Vue, and Angular. Moving to SvGrid\ntrades the multi-framework commercial suite for a Svelte-5-native grid\nwith an MIT core - and a much cheaper paid tier.\n\n> Estimated effort: **3-6 hours** per grid - column / event translation\n> plus re-theming.\n>\n> Kendo's exact API differs across its jQuery / React / Vue / Angular\n> flavours; map your version's column and event names onto the SvGrid\n> equivalents below.\n\n<!-- facts:start kendo-ui-grid -->\n> **Facts, checked 9 Nov 2026.** `@progress/kendo-react-grid` 16.3.0, Commercial (see licence file), last published 2 Nov 2026, 406,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). Kendo UI Grid pricing, as its site states it: telerik.com lists the Kendo UI bundle at $799, $849 or $1,299 per developer per year depending on the support tier, and KendoReact alone from $649 per developer per year; no free tier for the grid (https://www.telerik.com/purchase.aspx, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Kendo UI Grid (Telerik)](https://svgrid.com/compare/kendo-ui-grid/).\n<!-- facts:end -->\n\n## Concept map\n\n| Kendo UI Grid | sv-grid |\n| ---------------------------------------- | ----------------------------------------- |\n| `columns: [{ field, title }]` | `columns: [{ field, header }]` |\n| `template` / cell render | `cell: (c) => renderSnippet(...)` |\n| `editable` + editor | `enableInlineEditing` + `editorType` |\n| `sortable` / `filterable` | `rowSortingFeature` / `columnFilteringFeature` |\n| `group` / aggregates | `columnGroupingFeature` + `api.setGroupBy()` |\n| `dataSource` (local / remote) | `data` array or `externalSort/Filter` |\n| `pageable` | `showPagination` |\n| Kendo themes (Default / Bootstrap) | `--sg-*` tokens / Tailwind |\n| Grid events (`change`, `dataBound`) | `onCellValueChange`, `onApiReady`, ... |\n\n## Shape of the change\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- $('#grid').kendoGrid({\n- dataSource: { data: rows, pageSize: 25 },\n- sortable: true, filterable: true, pageable: true, editable: true,\n- columns: [\n- { field: 'name', title: 'Name' },\n- { field: 'amount', title: 'Amount', format: '{0:c}' },\n- ],\n- })\n\n+ <SvGrid\n+ data={rows}\n+ columns={[\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]}\n+ features={tableFeatures({ rowSortingFeature, columnFilteringFeature })}\n+ showPagination enableInlineEditing />\n```\n\n## Why teams switch\n\n- **Svelte 5 native** instead of a jQuery / multi-framework suite.\n- **MIT community core** - no per-developer license for the grid itself.\n- **Paid support at a fraction of enterprise-suite pricing.**\n- **No design-system lock-in** - theme via `--sg-*` tokens.\n\n## What to weigh\n\n- Kendo bundles a **huge component suite** (charts, scheduler, editor)\n and decades of vendor support. If you need the whole suite across\n several frameworks, that has real value.\n\n## Frequently asked questions\n\n### Is SvGrid a cheaper alternative to Kendo UI Grid?\n\nFor a Svelte stack, yes: the `@svgrid/grid` core is MIT (free, including\ncommercial use), and the paid `@svgrid/enterprise` tier is a fraction of enterprise\ncomponent-suite pricing.\n\n### How long does a Kendo Grid migration take?\n\nAbout 3-6 hours per grid. It is a column / event rename pass plus re-theming;\nthe columns and editing concepts map closely.\n\n### Does SvGrid match Kendo's feature set?\n\nFor the grid itself it covers the common enterprise surface - sorting,\nExcel-style filters, grouping, virtualization, editing, master/detail, tree.\nKendo's value beyond that is the wider suite and multi-framework parity.\n\n## What you end up with\n\nSorting, filtering, grouping and editing, with the column menu Kendo users expect.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} groupBy={['department']} groupable sortable filterable editable />\n```\n\n## See also\n\n- [SvGrid vs Kendo UI Grid](https://svgrid.com/compare/kendo-ui-grid/) - the side-by-side comparison\n- [Pricing](https://svgrid.com/pricing/) - the SvGrid Enterprise tiers\n- [Architecture](./architecture.md) - engine + render-component split\n"
|
|
6127
6127
|
},
|
|
6128
6128
|
{
|
|
6129
6129
|
"slug": "help/migrating-from-mui-x",
|
|
6130
6130
|
"path": "docs/help/migrating-from-mui-x.md",
|
|
6131
6131
|
"title": "Migrating from MUI X DataGrid",
|
|
6132
6132
|
"section": "Help",
|
|
6133
|
-
"markdown": "# Migrating from MUI X DataGrid\n\nMUI X DataGrid is the most common starting point for teams already\non Material UI. Its MIT Community edition plus paid Pro and Premium\ntiers is a split similar to sv-grid's, except that column pinning,\nmaster/detail, tree data, row grouping, aggregation and cell selection\nare paid in MUI X and free here. The port is mostly mechanical.\n\n> Estimated effort: **1-3 hours** per grid, depending on how heavily\n> you've leant on `apiRef.current.*` calls.\n\n<!-- facts:start mui-x-datagrid -->\n> **Facts, checked 9 Nov 2026.** `@mui/x-data-grid` 9.17.0, MIT, last published 30 Oct 2026, 13,100,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `@mui/x-data-grid` 9.17.0 158.4 KB JS, no separate stylesheet, @emotion/react + @emotion/styled + @mui/material + @mui/system + react + react-dom external (measured 9 Nov 2026). MUI X DataGrid pricing, as its site states it: MUI X Community is free under MIT. mui.com lists Pro at $299 per year per developer, Premium at $599 per year per developer and Enterprise at $1,399 per year per developer, with perpetual and annual licence models (https://mui.com/pricing/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/).\n<!-- facts:end -->\n\n## Package map\n\n| MUI X | sv-grid |\n| ------------------------------------ | ---------------------------------------- |\n| `@mui/x-data-grid` | `@svgrid/grid` |\n| `@mui/x-data-grid-pro` | `@svgrid/enterprise` (export, import, pivot, AI) |\n| `@mui/x-data-grid-premium` | All of `@svgrid/enterprise` ships in one tier |\n\n## Imports\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import { DataGrid, GridColDef, GridRowsProp } from '@mui/x-data-grid'\n\n+ import { SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef } from '@svgrid/grid'\n```\n\n## Column defs\n\n```diff\n- const columns: GridColDef[] = [\n- { field: 'id', headerName: 'ID', width: 90 },\n- { field: 'lastName', headerName: 'Last', width: 150, editable: true },\n- { field: 'age', headerName: 'Age', type: 'number', width: 110, editable: true },\n- ]\n\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'id', header: 'ID', width: 90 },\n+ { field: 'lastName', header: 'Last', width: 150 },\n+ { field: 'age', header: 'Age', width: 110, editorType: 'number' },\n+ ]\n```\n\n- `headerName` → `header`\n- `type: 'number'` → `editorType: 'number'`\n- `editable: true` → omit (every column is editable by default; set\n `editable: false` to OPT OUT)\n\n## Mounting\n\n```diff\n- <DataGrid rows={rows} columns={columns} pageSize={25} checkboxSelection />\n\n+ <SvGrid\n+ data={rows} columns={columns} features={features}\n+ showPagination={true} pageSize={25}\n+ selectionMode=\"row\" />\n```\n\n`tableFeatures({ rowSortingFeature, columnFilteringFeature,\nrowSelectionFeature })` registers what you'd implicitly get from\nMUI X.\n\n## `apiRef` translation\n\n| MUI X (`apiRef.current.*`) | sv-grid (`api.*`) |\n| -------------------------------------------- | ------------------------------------------ |\n| `setRows(rows)` | mutate the `$state` array you bound to `data` |\n| `updateRows([{id, ...patch}])` | `api.setCellValue(rowIndex, field, value)` |\n| `setSortModel([{field, sort}])` | `api.setSort(field, sort)` |\n| `setFilterModel({items: [...]})` | `api.setFilter(field, {operator, value})` |\n| `setPage(0)` / `setPageSize(50)` | Use the built-in pager; for headless control register `pageSize` prop |\n| `selectRow(id)` | Toggle the row checkbox via the wrapper's UI; programmatic select is `api.selectRows([id])` (`api.toggleRowSelected(id)` to flip one) |\n| `getSelectedRows()` | `api.getSelectedRows()` (ids via `api.getSelectedRowIds()`) |\n| `exportDataAsExcel()` | `api.exportData({ format: 'xlsx' })` (Enterprise) |\n| `setColumnVisibilityModel({field: false})` | `api.setColumnVisible('field', false)` |\n\n## Custom cells\n\n```diff\n- {\n- field: 'status',\n- renderCell: ({ row }) => <Chip label={row.status} color={row.status === 'active' ? 'success' : 'default'} />,\n- }\n\n+ {\n+ field: 'status',\n+ cell: (ctx) => renderSnippet(StatusChip, { status: ctx.row.original.status }),\n+ }\n```\n\n## Selection\n\n```diff\n- <DataGrid checkboxSelection\n- onRowSelectionModelChange={(ids) => setSelected(ids)} />\n\n+ <SvGrid\n+ {data} {columns} features={features}\n+ selectionMode=\"row\"\n+ onRowSelectionChange={(selection, rows) => setSelected(rows)} />\n```\n\n`selectionMode` values: `'row'` (the MUI X equivalent), `'cell'`\n(spreadsheet-style range), `'both'`, `'none'`.\n\n## Inline editing\n\nMUI X had `processRowUpdate(newRow, oldRow)` returning the new row.\nSv-grid's equivalent is `onCellValueChange`:\n\n```diff\n- <DataGrid processRowUpdate={async (newRow) => {\n- await api.savePatch(newRow)\n- return newRow\n- }} />\n\n+ <SvGrid\n+ onCellValueChange={async (e) => {\n+ await api.savePatch({ id: e.row.id, [e.columnId]: e.newValue })\n+ }}\n+ />\n```\n\nFor full-row editing (one Save button per row), see\n[Full-row editing](./editing/full-row.md).\n\n## Server-side data\n\nMUI X's `pagination + serverSideMode + filterMode='server'` maps to\nsv-grid's `externalSort + externalFilter`, or to `createServerDataSource` (free:\npaging or infinite scroll, sort, filter) when the server pages, and to the\nEnterprise `createServerRowModel` when it also groups; the demo below runs\nthe free controller against a fake API with sort, filter and infinite scroll:\n\n<div data-docs-demo=\"148-server-row-model\" data-height=\"520\"></div>\n\nMUI X's server-side row grouping and aggregation (Premium) map to the\nEnterprise row model, which loads each group level on expand and pages,\nedits and selects across rows the grid never fetched:\n\n<div data-docs-demo=\"467-server-row-model-1m\" data-height=\"600\"></div>\n\n```svelte\n<SvGrid\n data={rows} columns={columns} features={features}\n externalSort={true}\n externalFilter={true}\n onSortingChange={async (s) => { rows = await fetchPage({ sort: s }) }}\n onFiltersChange={async (f) => { rows = await fetchPage({ filters: f.columns }) }}\n/>\n```\n\n## Slots / customisation\n\nMUI X exposes a `slots` object. Sv-grid doesn't - instead, every\nvisual piece is a CSS custom property (`--sg-*`); see\n[design tokens](./tokens.md). Override at any DOM level:\n\n```css\n.grid-host { --sg-accent: #db2777; --sg-radius: 10px; }\n```\n\nRow height is the exception: it is the `rowHeight` prop rather than a\ntoken, because the virtualizer needs it as a number.\n\nFor full theme presets (Ant, MUI, Fluent, Base Web, shadcn) see\n[demo 74](https://svgrid.com/demos/74-theme-integrations/).\n\n## What you get for free vs MUI X\n\n- **No Emotion / no Material theme dependency.** The facts box at the\n top of the page has both packages measured the same way; the MUI X\n figure excludes React, Material UI, Emotion and the MUI system, which\n it needs and sv-grid does not.\n- **Pro and Premium features in the MIT core.** Column pinning, master/detail,\n tree data, row grouping, aggregation and cell selection carry Pro or\n Premium badges on mui.com; they are free here. Excel export and pivot\n are paid on both sides.\n- **In-grid AI helpers against your own model.** MUI X's AI assistant is a\n Premium feature that routes prompts through MUI's hosted service unless\n you build your own; sv-grid's natural-language filter, smart fill and\n summarise helpers are free and run against a provider you register.\n- **CSP-clean.** No `eval`.\n\n## What you give up\n\n- **The Material Design look out of the box.** Sv-grid ships\n unstyled-by-token; the [MUI preset in demo 74](https://svgrid.com/demos/74-theme-integrations/)\n is one drop-in.\n- **MUI form-field integration.** Bind directly to your own MUI\n inputs in custom cell components if you want them.\n- **The rest of MUI X in one design system.** Date pickers, charts and\n the tree view share MUI X's theme; sv-grid ships its own date and time\n editors and charts, themed through the same `--sg-*` tokens.\n- **A hosted AI assistant with starter credits.** Premium licence holders\n get MUI's service; sv-grid's helpers need a model provider you host or\n pay for yourself.\n\n## Frequently asked questions\n\n### How hard is it to migrate from MUI X DataGrid to SvGrid?\n\nMostly mechanical - typically 1-3 hours per grid, depending on how heavily you\nrelied on `apiRef.current.*`. The Community/Enterprise split mirrors MUI X's, so the\nlicensing mental model carries over directly.\n\n### Can SvGrid keep the Material Design look?\n\nYes. SvGrid ships unstyled-by-token and re-themes through `--sg-*` CSS\nvariables; the MUI preset in demo 74 is a drop-in starting point. You can also\nbind your own MUI inputs inside custom cell components.\n\n### Is SvGrid cheaper than MUI X Pro/Premium?\n\nSvGrid's Community tier is MIT and free for commercial use, and `@svgrid/enterprise`\nis priced per developer ($599 for the grid, $999 with the spreadsheet and\nStudio, both covering unlimited apps). MUI X Pro and\nPremium are also per developer per year; the prices mui.com listed on the\ndate we read it are in the facts box at the top of this page. The difference\nis what the free tier holds: most of what MUI X sells in Pro and Premium is\nin SvGrid's MIT core, so compare feature needs before prices on the\n[pricing page](https://svgrid.com/pricing/).\n\n## What you end up with\n\nSorting, filtering, pagination and inline editing - the MUI X DataGrid feature set.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable editable pageable pageSize={3} />\n```\n\n## See also\n\n- [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/) - the side-by-side comparison, with a source and date for every claim\n- [Server-side data](./server-side-data.md) - the row model the demo above uses\n- [AI assistant](./ai.md) - the free in-grid helpers\n- [Migrating from AG Grid](./migrating-from-ag-grid.md)\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md)\n- [Design tokens](./tokens.md)\n"
|
|
6133
|
+
"markdown": "# Migrating from MUI X DataGrid\n\nMUI X DataGrid is the most common starting point for teams already\non Material UI. Its MIT Community edition plus paid Pro and Premium\ntiers is a split similar to sv-grid's, except that column pinning,\nmaster/detail, tree data, row grouping, aggregation and cell selection\nare paid in MUI X and free here. The port is mostly mechanical.\n\n> Estimated effort: **1-3 hours** per grid, depending on how heavily\n> you've leant on `apiRef.current.*` calls.\n\n<!-- facts:start mui-x-datagrid -->\n> **Facts, checked 9 Nov 2026.** `@mui/x-data-grid` 9.17.0, MIT, last published 30 Oct 2026, 13,100,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `@mui/x-data-grid` 9.17.0 158.4 KB JS, no separate stylesheet, @emotion/react + @emotion/styled + @mui/material + @mui/system + react + react-dom external (measured 9 Nov 2026). MUI X DataGrid pricing, as its site states it: MUI X Community is free under MIT. mui.com lists Pro at $299 per year per developer, Premium at $599 per year per developer and Enterprise at $1,399 per year per developer, with perpetual and annual licence models (https://mui.com/pricing/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/).\n<!-- facts:end -->\n\n## Package map\n\n| MUI X | sv-grid |\n| ------------------------------------ | ---------------------------------------- |\n| `@mui/x-data-grid` | `@svgrid/grid` |\n| `@mui/x-data-grid-pro` | `@svgrid/enterprise` (export, import, pivot, AI) |\n| `@mui/x-data-grid-premium` | All of `@svgrid/enterprise` ships in one tier |\n\n## Imports\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import { DataGrid, GridColDef, GridRowsProp } from '@mui/x-data-grid'\n\n+ import { SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef } from '@svgrid/grid'\n```\n\n## Column defs\n\n```diff\n- const columns: GridColDef[] = [\n- { field: 'id', headerName: 'ID', width: 90 },\n- { field: 'lastName', headerName: 'Last', width: 150, editable: true },\n- { field: 'age', headerName: 'Age', type: 'number', width: 110, editable: true },\n- ]\n\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'id', header: 'ID', width: 90 },\n+ { field: 'lastName', header: 'Last', width: 150 },\n+ { field: 'age', header: 'Age', width: 110, editorType: 'number' },\n+ ]\n```\n\n- `headerName` → `header`\n- `type: 'number'` → `editorType: 'number'`\n- `editable: true` → omit (every column is editable by default; set\n `editable: false` to OPT OUT)\n\n## Mounting\n\n```diff\n- <DataGrid rows={rows} columns={columns} pageSize={25} checkboxSelection />\n\n+ <SvGrid\n+ data={rows} columns={columns} features={features}\n+ showPagination={true} pageSize={25}\n+ selectionMode=\"row\" />\n```\n\n`tableFeatures({ rowSortingFeature, columnFilteringFeature,\nrowSelectionFeature })` registers what you'd implicitly get from\nMUI X.\n\n## `apiRef` translation\n\n| MUI X (`apiRef.current.*`) | sv-grid (`api.*`) |\n| -------------------------------------------- | ------------------------------------------ |\n| `setRows(rows)` | mutate the `$state` array you bound to `data` |\n| `updateRows([{id, ...patch}])` | `api.setCellValue(rowIndex, field, value)` |\n| `setSortModel([{field, sort}])` | `api.setSort(field, sort)` |\n| `setFilterModel({items: [...]})` | `api.setFilter(field, {operator, value})` |\n| `setPage(0)` / `setPageSize(50)` | Use the built-in pager; for headless control register `pageSize` prop |\n| `selectRow(id)` | Toggle the row checkbox via the wrapper's UI; programmatic select is `api.selectRows([id])` (`api.toggleRowSelected(id)` to flip one) |\n| `getSelectedRows()` | `api.getSelectedRows()` (ids via `api.getSelectedRowIds()`) |\n| `exportDataAsExcel()` | `api.exportData({ format: 'xlsx' })` (Enterprise) |\n| `setColumnVisibilityModel({field: false})` | `api.setColumnVisible('field', false)` |\n\n## Custom cells\n\n```diff\n- {\n- field: 'status',\n- renderCell: ({ row }) => <Chip label={row.status} color={row.status === 'active' ? 'success' : 'default'} />,\n- }\n\n+ {\n+ field: 'status',\n+ cell: (ctx) => renderSnippet(StatusChip, { status: ctx.row.original.status }),\n+ }\n```\n\n## Selection\n\n```diff\n- <DataGrid checkboxSelection\n- onRowSelectionModelChange={(ids) => setSelected(ids)} />\n\n+ <SvGrid\n+ {data} {columns} features={features}\n+ selectionMode=\"row\"\n+ onRowSelectionChange={(selection, rows) => setSelected(rows)} />\n```\n\n`selectionMode` values: `'row'` (the MUI X equivalent), `'cell'`\n(spreadsheet-style range), `'both'`, `'none'`.\n\n## Inline editing\n\nMUI X had `processRowUpdate(newRow, oldRow)` returning the new row.\nSv-grid's equivalent is `onCellValueChange`:\n\n```diff\n- <DataGrid processRowUpdate={async (newRow) => {\n- await api.savePatch(newRow)\n- return newRow\n- }} />\n\n+ <SvGrid\n+ onCellValueChange={async (e) => {\n+ await api.savePatch({ id: e.row.id, [e.columnId]: e.newValue })\n+ }}\n+ />\n```\n\nFor full-row editing (one Save button per row), see\n[Full-row editing](./editing/full-row.md).\n\n## Server-side data\n\nMUI X's `pagination + serverSideMode + filterMode='server'` maps to\nsv-grid's `externalSort + externalFilter`, or to `createServerDataSource` (free:\npaging or infinite scroll, sort, filter) when the server pages, and to the\nEnterprise `createServerRowModel` when it also groups; the demo below runs\nthe free controller against a fake API with sort, filter and infinite scroll:\n\n<div data-docs-demo=\"148-server-row-model\" data-height=\"520\"></div>\n\nMUI X's server-side row grouping and aggregation (Premium) map to the\nEnterprise row model, which loads each group level on expand and pages,\nedits and selects across rows the grid never fetched:\n\n<div data-docs-demo=\"467-server-row-model-1m\" data-height=\"600\"></div>\n\n```svelte\n<SvGrid\n data={rows} columns={columns} features={features}\n externalSort={true}\n externalFilter={true}\n onSortingChange={async (s) => { rows = await fetchPage({ sort: s }) }}\n onFiltersChange={async (f) => { rows = await fetchPage({ filters: f.columns }) }}\n/>\n```\n\n## Slots / customisation\n\nMUI X exposes a `slots` object. Sv-grid doesn't - instead, every\nvisual piece is a CSS custom property (`--sg-*`); see\n[design tokens](./tokens.md). Override at any DOM level:\n\n```css\n.grid-host { --sg-accent: #db2777; --sg-radius: 10px; }\n```\n\nRow height is the exception: it is the `rowHeight` prop rather than a\ntoken, because the virtualizer needs it as a number.\n\nFor full theme presets (Ant, MUI, Fluent, Base Web, shadcn) see\n[demo 74](https://svgrid.com/demos/74-theme-integrations/).\n\n## What you get for free vs MUI X\n\n- **No Emotion / no Material theme dependency.** The facts box at the\n top of the page has both packages measured the same way; the MUI X\n figure excludes React, Material UI, Emotion and the MUI system, which\n it needs and sv-grid does not.\n- **Pro and Premium features in the MIT core.** Column pinning, master/detail,\n tree data, row grouping, aggregation and cell selection carry Pro or\n Premium badges on mui.com; they are free here. Excel export and pivot\n are paid on both sides.\n- **In-grid AI helpers against your own model.** MUI X's AI assistant is a\n Premium feature that routes prompts through MUI's hosted service unless\n you build your own; sv-grid's natural-language filter, smart fill and\n summarise helpers are free and run against a provider you register.\n- **CSP-clean.** No `eval`.\n\n## What you give up\n\n- **The Material Design look out of the box.** Sv-grid ships\n unstyled-by-token; the [MUI preset in demo 74](https://svgrid.com/demos/74-theme-integrations/)\n is one drop-in.\n- **MUI form-field integration.** Bind directly to your own MUI\n inputs in custom cell components if you want them.\n- **The rest of MUI X in one design system.** Date pickers, charts and\n the tree view share MUI X's theme; sv-grid ships its own date and time\n editors and charts, themed through the same `--sg-*` tokens.\n- **A hosted AI assistant with starter credits.** Premium licence holders\n get MUI's service; sv-grid's helpers need a model provider you host or\n pay for yourself.\n\n## Frequently asked questions\n\n### How hard is it to migrate from MUI X DataGrid to SvGrid?\n\nMostly mechanical - typically 1-3 hours per grid, depending on how heavily you\nrelied on `apiRef.current.*`. The Community/Enterprise split mirrors MUI X's, so the\nlicensing mental model carries over directly.\n\n### Can SvGrid keep the Material Design look?\n\nYes. SvGrid ships unstyled-by-token and re-themes through `--sg-*` CSS\nvariables; the MUI preset in demo 74 is a drop-in starting point. You can also\nbind your own MUI inputs inside custom cell components.\n\n### Is SvGrid cheaper than MUI X Pro/Premium?\n\nSvGrid's Community tier is MIT and free for commercial use, and `@svgrid/enterprise`\nis priced per developer ($599 for the grid, $999 with the spreadsheet and\nStudio, both covering unlimited apps). MUI X Pro and\nPremium are also per developer per year; the prices mui.com listed on the\ndate we read it are in the facts box at the top of this page. The difference\nis what the free tier holds: most of what MUI X sells in Pro and Premium is\nin SvGrid's MIT core, so compare feature needs before prices on the\n[pricing page](https://svgrid.com/pricing/).\n\n## What you end up with\n\nSorting, filtering, pagination and inline editing - the MUI X DataGrid feature set.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable editable pageable pageSize={3} />\n```\n\n## See also\n\n- [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/) - the side-by-side comparison, with a source and date for every claim\n- [Server-side data](./server-side-data.md) - the row model the demo above uses\n- [AI assistant](./ai.md) - the free in-grid helpers\n- [Migrating from AG Grid](./migrating-from-ag-grid.md)\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md)\n- [Design tokens](./tokens.md)\n"
|
|
6134
6134
|
},
|
|
6135
6135
|
{
|
|
6136
6136
|
"slug": "help/migrating-from-nocodb",
|
|
@@ -6144,77 +6144,77 @@ export const docs = [
|
|
|
6144
6144
|
"path": "docs/help/migrating-from-primevue-datatable.md",
|
|
6145
6145
|
"title": "Migrating from PrimeVue / PrimeNG / PrimeReact DataTable",
|
|
6146
6146
|
"section": "Help",
|
|
6147
|
-
"markdown": "\n# Migrating from PrimeVue / PrimeNG / PrimeReact DataTable\n\nThe Prime DataTable is the grid in the Prime UI suites for Vue, Angular,\nand React. Its columns are declared as `<Column>` children with `field`\n/ `header` props - a shape that maps cleanly onto SvGrid's `ColumnDef`\narray. The port is mostly translating columns and events into a Svelte 5\ncomponent. Since PrimeVue 5 the package ships under the PrimeUI licence\nrather than MIT: free for individuals and small organisations under the\nlimits in its licence file, per developer with a licence key otherwise.\nThe facts box below quotes the terms as read on the date shown.\n\n> Estimated effort: **2-4 hours** per grid.\n\n<!-- facts:start primevue-datatable -->\n> **Facts, checked 9 Nov 2026.** `primevue` 5.0.4, Commercial (see licence file), last published 22 Oct 2026, 3,290,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6147
|
+
"markdown": "\n# Migrating from PrimeVue / PrimeNG / PrimeReact DataTable\n\nThe Prime DataTable is the grid in the Prime UI suites for Vue, Angular,\nand React. Its columns are declared as `<Column>` children with `field`\n/ `header` props - a shape that maps cleanly onto SvGrid's `ColumnDef`\narray. The port is mostly translating columns and events into a Svelte 5\ncomponent. Since PrimeVue 5 the package ships under the PrimeUI licence\nrather than MIT: free for individuals and small organisations under the\nlimits in its licence file, per developer with a licence key otherwise.\nThe facts box below quotes the terms as read on the date shown.\n\n> Estimated effort: **2-4 hours** per grid.\n\n<!-- facts:start primevue-datatable -->\n> **Facts, checked 9 Nov 2026.** `primevue` 5.0.4, Commercial (see licence file), last published 22 Oct 2026, 3,290,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). PrimeVue / PrimeNG / PrimeReact DataTable pricing, as its site states it: primeui.dev lists the Commercial Suite at a launch price of $599 per developer (standard $799) as a perpetual licence with one year of updates, renewable at $399 per developer per year; the Community License is free for individuals, non-profits and organisations under $1M revenue, fewer than five developers, fewer than ten employees and under $3M in venture funding (https://primeui.dev/pricing, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs PrimeVue / PrimeNG / PrimeReact DataTable](https://svgrid.com/compare/primevue-datatable/).\n<!-- facts:end -->\n\n## Vocabulary cheat sheet\n\n| Prime DataTable | sv-grid |\n| ---------------------------------------- | ----------------------------------------- |\n| `<DataTable :value=\"rows\">` | `<SvGrid data={rows}>` |\n| `<Column field=\"name\" header=\"Name\" />` | `{ field: 'name', header: 'Name' }` |\n| `sortable` | `rowSortingFeature` |\n| `:filters` / filter display | `columnFilteringFeature` |\n| `<template #body>` cell slot | `cell: (c) => renderSnippet(...)` |\n| `editMode` + cell editor template | `editorType` (+ custom `cellEditor`) |\n| `:expandedRows` / row expansion | `rowExpandingFeature` |\n| `lazy` + `@page` / `@sort` / `@filter` | `externalSort` / `externalFilter` + events |\n| `paginator` + `:rows` | `showPagination` (+ page size) |\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- <DataTable :value=\"rows\" paginator :rows=\"25\" sortMode=\"multiple\">\n- <Column field=\"name\" header=\"Name\" sortable />\n- <Column field=\"amount\" header=\"Amount\" sortable>\n- <template #body=\"{ data }\">{{ fmt(data.amount) }}</template>\n- </Column>\n- </DataTable>\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination />\n```\n\n## What changes\n\n- **`<Column>` children → a `ColumnDef[]` array.**\n- **`#body` slots → `cell` snippets** via `renderSnippet`.\n- **Prime theming → `--sg-*` tokens / Tailwind** - no Prime theme\n dependency.\n- **`lazy` → `externalSort` / `externalFilter`** with refetch on events.\n\n## Frequently asked questions\n\n### How do Prime `<Column>` definitions map to SvGrid?\n\nEach `<Column field header />` becomes a `{ field, header }` object in SvGrid's\n`columns` array, and `#body` templates become `renderSnippet` cells. Sorting and\nfiltering move from per-column props to the `rowSortingFeature` /\n`columnFilteringFeature` registration.\n\n### Is SvGrid open-source like the Prime grid core?\n\n`@svgrid/grid` is MIT with no licence key or eligibility conditions. The\nPrime cores were MIT through PrimeVue 4; from PrimeVue 5 the npm package\ncarries the PrimeUI licence, whose free Community License depends on your\nrevenue, developer count, headcount and funding, and whose Commercial\nLicense is per developer with a key. The other difference is framework:\nSvGrid is Svelte 5, not Vue / Angular / React.\n\n### Do I lose Prime theming?\n\nYou re-create the look with `--sg-*` tokens (optionally driven by your Tailwind\ntheme), so the grid matches your design system without a Prime theme dependency.\n\n## What you end up with\n\nSorting, filtering, pagination and row selection in one pass.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} selectable />\n```\n\n## See also\n\n- [SvGrid vs Prime DataTable](https://svgrid.com/compare/primevue-datatable/) - the side-by-side comparison\n- [Tailwind integration](./tailwind.md) - match your design system\n- [Cell components](./cells/cell-components.md) - snippet cells + editors\n"
|
|
6148
6148
|
},
|
|
6149
6149
|
{
|
|
6150
6150
|
"slug": "help/migrating-from-react-data-grid",
|
|
6151
6151
|
"path": "docs/help/migrating-from-react-data-grid.md",
|
|
6152
6152
|
"title": "Migrating from React Data Grid (adazzle)",
|
|
6153
6153
|
"section": "Help",
|
|
6154
|
-
"markdown": "# Migrating from React Data Grid (adazzle)\n\n`react-data-grid` is a fast, Excel-like React grid with a clean column\nAPI. SvGrid mirrors its shape - virtualized DOM, typed columns, inline\nediting, custom cells - on Svelte 5 runes instead of React, so the port\nis mostly a column rename pass.\n\n> Estimated effort: **2-4 hours** per grid, more if you lean on custom\n> editors.\n\n<!-- facts:start react-data-grid -->\n> **Facts, checked 9 Nov 2026.** `react-data-grid` 7.0.0-beta.64, MIT, last published 5 Nov 2026, 2,650,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6154
|
+
"markdown": "# Migrating from React Data Grid (adazzle)\n\n`react-data-grid` is a fast, Excel-like React grid with a clean column\nAPI. SvGrid mirrors its shape - virtualized DOM, typed columns, inline\nediting, custom cells - on Svelte 5 runes instead of React, so the port\nis mostly a column rename pass.\n\n> Estimated effort: **2-4 hours** per grid, more if you lean on custom\n> editors.\n\n<!-- facts:start react-data-grid -->\n> **Facts, checked 9 Nov 2026.** `react-data-grid` 7.0.0-beta.64, MIT, last published 5 Nov 2026, 2,650,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `react-data-grid` 7.0.0-beta.64 25.6 KB JS + 2.3 KB CSS, react + react-dom external (measured 9 Nov 2026). React Data Grid pricing, as its site states it: react-data-grid is MIT on npm and free; no licence is sold (https://github.com/adazzle/react-data-grid, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs React Data Grid (adazzle)](https://svgrid.com/compare/react-data-grid/).\n<!-- facts:end -->\n\n## Vocabulary cheat sheet\n\n| react-data-grid | sv-grid |\n| ---------------------------------------- | ----------------------------------------- |\n| `<DataGrid columns rows />` | `<SvGrid columns data />` |\n| `{ key: 'name', name: 'Name' }` | `{ field: 'name', header: 'Name' }` |\n| `renderCell: (p) => <Badge .../>` | `cell: (c) => renderSnippet(Badge, {...})` |\n| `renderEditCell` / `editor` | `editorType` (+ custom `cellEditor`) |\n| `rowKeyGetter={(r) => r.id}` | `getRowId={(r) => r.id}` |\n| `onRowsChange={setRows}` | `onCellValueChange` (+ your state) |\n| `sortColumns` / `onSortColumnsChange` | `rowSortingFeature` + `onSortingChange` |\n| `<DataGrid className=...>` theming | `--sg-*` tokens / Tailwind |\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import DataGrid, { textEditor } from 'react-data-grid'\n- const columns = [\n- { key: 'name', name: 'Name' },\n- { key: 'amount', name: 'Amount', renderEditCell: textEditor },\n- ]\n- <DataGrid columns={columns} rows={rows} rowKeyGetter={(r) => r.id} onRowsChange={setRows} />\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', editorType: 'text' },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features}\n+ getRowId={(r) => r.id} enableInlineEditing\n+ onCellValueChange={(e) => save(e)} />\n```\n\n## What changes\n\n- **React → Svelte 5.** `renderCell` / `renderEditCell` become\n `renderSnippet` snippets and `editorType`.\n- **`onRowsChange` → `onCellValueChange`.** SvGrid writes to its own\n working copy; subscribe to commits and persist where you like.\n- **Filtering UI is built in.** react-data-grid leaves the filter row to\n you; SvGrid ships the Excel-style menu.\n\n## Frequently asked questions\n\n### How do react-data-grid columns map to SvGrid?\n\n`key` becomes `field`, `name` becomes `header`, `renderCell` becomes a\n`renderSnippet` cell, and editors map to `editorType` (or a custom `cellEditor`\nsnippet). `rowKeyGetter` becomes `getRowId`.\n\n### Is SvGrid free like react-data-grid?\n\nYes - `@svgrid/grid` is MIT-licensed, like react-data-grid. SvGrid adds an\noptional paid Enterprise pack for export, import, pivot, and AI.\n\n### Does SvGrid have built-in filtering?\n\nYes. react-data-grid asks you to build the filter UI; SvGrid ships an\nExcel-style column filter menu and a global filter out of the box.\n\n## What you end up with\n\nInline editing with cell-range selection, which is the reason most people picked it.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} editable enableCellSelection sortable />\n```\n\n## See also\n\n- [SvGrid vs React Data Grid](https://svgrid.com/compare/react-data-grid/) - the side-by-side comparison\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - sibling React-to-Svelte guide\n- [Cell components](./cells/cell-components.md) - custom cells + editors\n"
|
|
6155
6155
|
},
|
|
6156
6156
|
{
|
|
6157
6157
|
"slug": "help/migrating-from-shadcn-data-table",
|
|
6158
6158
|
"path": "docs/help/migrating-from-shadcn-data-table.md",
|
|
6159
6159
|
"title": "Migrating from the shadcn-svelte data table",
|
|
6160
6160
|
"section": "Help",
|
|
6161
|
-
"markdown": "# Migrating from the shadcn-svelte data table\n\nThe shadcn-svelte **Data Table** is not the same thing as its `<Table>`\ncomponent. `<Table>` is presentation only. The data table is a recipe\nbuilt on TanStack Table v9 that you copy into your own repo: it already\ndoes sorting, filtering, pagination, row selection, and column\nvisibility. If that is what you have, this is your page. If you have the\nplain styled `<Table>` and hand-wrote the sorting yourself, read\n[Migrating from a UI-kit table](./migrating-from-ui-kit-tables.md)\ninstead.\n\n> Estimated effort: **20-40 min** per table. Your column definitions and\n> your feature registration carry over almost unchanged. Most of the work\n> is deleting files.\n\n<!-- facts:start tanstack-table,svelte-ui-kit-tables -->\n> **Facts, checked 9 Nov 2026.** `@tanstack/svelte-table` 9.3.1, MIT, last published 12 Oct 2026, 539,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `@tanstack/svelte-table` 9.3.1 36.5 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). TanStack Table pricing, as its site states it: TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table (https://tanstack.com/table/latest, read 12 Sep 2026). Flowbite / Skeleton / shadcn-svelte tables pricing, as its site states it: Flowbite Svelte, Skeleton and shadcn-svelte are MIT component libraries; their table components are free and no grid licence is sold (https://github.com/themesberg/flowbite-svelte, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/), [SvGrid vs Flowbite / Skeleton / shadcn-svelte tables](https://svgrid.com/compare/svelte-ui-kit-tables/).\n<!-- facts:end -->\n\n## Why this port is small\n\nSvGrid speaks the same vocabulary TanStack Table v9 introduced. These are\nreal exports from `@svgrid/grid`, not lookalikes:\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```ts\nimport {\n tableFeatures,\n rowSortingFeature,\n columnFilteringFeature,\n rowPaginationFeature,\n rowSelectionFeature,\n rowExpandingFeature,\n columnGroupingFeature,\n} from '@svgrid/grid'\n```\n\nSo `data-table-features.ts` moves over as-is, and `columns.ts` keeps its\nshape. What does not move is the rendering scaffolding, because SvGrid\nships a renderer and there is nothing to translate it into.\n\n## What happens to each file\n\nThe shadcn recipe generates seven files. Five of them stop existing.\n\n| Their file | Becomes |\n| --- | --- |\n| `data-table-features.ts` | Kept. Same `tableFeatures({...})` call. |\n| `columns.ts` | Kept, minus the `header` render helpers. `{ accessorKey: 'email' }` becomes `{ field: 'email' }`. |\n| `data-table.svelte` | Deleted. It is `<table>` markup over `getHeaderGroups()` / `getRowModel()`, which `<SvGrid>` does. |\n| `data-table-checkbox.svelte` | Deleted. `showRowSelection` renders the column and the select-all header. |\n| `data-table-email-button.svelte` | Deleted. `sortable` makes every header a sort toggle. |\n| `data-table-actions.svelte` | Kept if you want it, as a cell snippet. |\n| `+page.svelte` | Kept. It now renders one component instead of wiring state. |\n\n## Let the codemod do the mechanical part\n\n```bash\nnpx @svgrid/migrate src/routes/payments # preview\nnpx @svgrid/migrate src/routes/payments --write # apply\n```\n\nIt previews by default and only writes with `--write`. Point it at the whole\nroute directory rather than a single file: the shadcn layout keeps `features`\nin its own module, and the codemod follows that import to work out which\nprops the component needs.\n\nIt renames the column keys, re-points the imports, strips the features SvGrid\ndoes not have, and deletes the markup along with the `$state` / `onXChange`\npairs. Custom `cell` and `header` render functions are kept and reported, never\nguessed at. Run your type-checker afterwards - the markup is regenerated rather\nthan edited.\n\n## Before and after\n\n```diff\n- <script lang=\"ts\">\n- import { createSvelteTable, FlexRender } from '$lib/components/ui/data-table'\n- import { columns } from './columns'\n- import { features } from './data-table-features'\n-\n- let sorting = $state([])\n- let filters = $state([])\n- let selection = $state({})\n- let pagination = $state({ pageIndex: 0, pageSize: 10 })\n-\n- const table = createSvelteTable({\n- get data() { return data },\n- columns, features,\n- state: { get sorting() { return sorting }, /* ...and three more... */ },\n- onSortingChange: (u) => (sorting = typeof u === 'function' ? u(sorting) : u),\n- // ...one of these per piece of state...\n- })\n- </script>\n-\n- <Table.Root>\n- <Table.Header>\n- {#each table.getHeaderGroups() as headerGroup}\n- <!-- ...twenty more lines of markup... -->\n- {/each}\n- </Table.Header>\n- <Table.Body>\n- {#each table.getRowModel().rows as row}\n- <!-- ...and twenty more... -->\n- {/each}\n- </Table.Body>\n- </Table.Root>\n\n+ <script lang=\"ts\">\n+ import { SvGrid } from '@svgrid/grid'\n+ import '@svgrid/grid/themes/shadcn.css'\n+ import { columns } from './columns'\n+ import { features } from './data-table-features'\n+ </script>\n+\n+ <SvGrid\n+ {data} {columns} {features}\n+ sortable filterable showGlobalFilter showRowSelection\n+ pageable showPagination pageSize={10}\n+ fitColumns\n+ />\n```\n\nThe four `$state` declarations and their four `onXChange` updaters go\naway with the markup. Sorting, filtering, paging, and selection state\nlive in the grid.\n\nColumn visibility moves too: mark a column `visible: false` to start it\nhidden, and users toggle it from the header column menu. You no longer\nmaintain a dropdown for it.\n\n## One command\n\nUse the CLI you already have:\n\n```sh\nnpx shadcn-svelte@latest add https://svgrid.com/r/data-table.json\n```\n\nThat writes a ready-to-edit `data-table.svelte` into\n`$lib/components/ui/data-table/`, beside your other components, and\ninstalls `@svgrid/grid`. It is a normal registry item, so `components.json`\naliases and your existing setup are respected.\n\nIf you are not in a shadcn project, the same component ships through\nSvGrid's own scaffolder:\n\n```sh\nnpx @svgrid/ui add data-table\n```\n\nBoth routes write the identical file. It is yours to edit, exactly like a\nshadcn recipe. The difference is where the engine lives.\n\n## The upgrade path is the real difference\n\nBoth approaches put a file you own in your repo. Only one puts the\n*engine* in a package.\n\nWhen TanStack Table went from v8 to v9, `useReactTable` became `useTable`,\nthe `get*RowModel()` options became a features object, and `flexRender`\nbecame a component. Every copied data-table had to be hand-fixed, because\nthere is no `npm update` for code you pasted. With SvGrid the file you own\nstays a thin call site, and the behaviour behind it updates with a version\nbump.\n\nThe cost scales with how much you pasted. A seven-file starter is an\nafternoon. The richer community grids paste a whole subsystem - row\nrendering, virtualization, context menus, paste dialogs, hooks, config -\nand every one of those files is now yours to carry through the next\nupstream change.\n\n## Keep your design system\n\nYou do not have to leave shadcn's look, and you do not have to leave its\nmarkup either.\n\n- **Tokens.** `import '@svgrid/grid/themes/shadcn.css'` is a one-line\n match for the default palette in light and dark. To follow a customized\n theme, map your `--background` / `--border` / `--primary` onto the\n `--sg-*` properties - see the [shadcn integration\n guide](./shadcn.md).\n- **Your own markup.** If you want to keep shadcn's `Table.Root` /\n `Table.Row` elements exactly as they are, use the headless core from\n `@svgrid/grid/core` and swap only the engine. See\n [Why headless?](../why-headless.md).\n\n## What you gain\n\nThe official recipe stops where its docs stop: sorting, filtering,\npagination, row selection, column visibility. Community registry items go\nfurther, at the cost of pasting a whole multi-file subsystem into your\nrepo. In SvGrid each of these is a prop:\n\n- **Virtualization** (`virtualization`) - the official recipe has none, so\n a large table is a rewrite rather than a prop.\n- **Inline editing** (`editable`) and cell-range selection\n (`enableCellSelection`).\n- **Grouping with aggregation** (`groupable`) and tree data (`treeData`).\n- **Export** to CSV, and to Excel / PDF on the paid tier.\n- **WAI-ARIA grid semantics and keyboard navigation**, instead of a plain\n `<table>` you keep accessible yourself.\n\n## What you give up\n\n- **A file you can read top to bottom.** The recipe's behaviour is\n visible in your repo; SvGrid's is behind a prop. That is the trade the\n whole page is about.\n- **Pixel-level control of the markup**, unless you go headless.\n- **Weight.** For a short static list that never sorts, the copied\n recipe is smaller.\n\n## Frequently asked questions\n\n### Does SvGrid replace shadcn-svelte?\n\nNo. It replaces one recipe in it. Your buttons, dialogs, and inputs stay\nexactly as they are, and the grid reads the same theme variables they do.\n\n### Can I keep my existing columns.ts?\n\nMostly. Rename `accessorKey` to `field`, drop the `header` render\nhelpers that only existed to draw a sort button, and the rest carries\nover. Custom cells become snippets via `renderSnippet`.\n\n### Do I have to give up owning the code?\n\nYou still own the call site - `npx @svgrid/ui add data-table` writes a\nfile into your project that you edit freely. What you stop owning is the\nrow-model plumbing, which is the part that broke on the v8 to v9 upgrade.\n\n### Is this worth it for a 50-row table?\n\nProbably not, unless you want editing, grouping, or export later. The\ncase gets strong when the table grows past what fits on a page, or when\nthe next feature request is one you would otherwise hand-build.\n\n## What you end up with\n\nSorting, filtering, pagination and selection - the shadcn data-table demo, as props.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} selectable />\n```\n\n## See also\n\n- [shadcn-svelte integration](./shadcn.md) - matching the theme\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - the\n underlying API map\n- [Migrating from a UI-kit table](./migrating-from-ui-kit-tables.md) - for\n the plain styled `<Table>`\n- [Why headless?](../why-headless.md) - keeping your own markup\n"
|
|
6161
|
+
"markdown": "# Migrating from the shadcn-svelte data table\n\nThe shadcn-svelte **Data Table** is not the same thing as its `<Table>`\ncomponent. `<Table>` is presentation only. The data table is a recipe\nbuilt on TanStack Table v9 that you copy into your own repo: it already\ndoes sorting, filtering, pagination, row selection, and column\nvisibility. If that is what you have, this is your page. If you have the\nplain styled `<Table>` and hand-wrote the sorting yourself, read\n[Migrating from a UI-kit table](./migrating-from-ui-kit-tables.md)\ninstead.\n\n> Estimated effort: **20-40 min** per table. Your column definitions and\n> your feature registration carry over almost unchanged. Most of the work\n> is deleting files.\n\n<!-- facts:start tanstack-table,svelte-ui-kit-tables -->\n> **Facts, checked 9 Nov 2026.** `@tanstack/svelte-table` 9.3.1, MIT, last published 12 Oct 2026, 539,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `@tanstack/svelte-table` 9.3.1 36.5 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). TanStack Table pricing, as its site states it: TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table (https://tanstack.com/table/latest, read 12 Sep 2026). Flowbite / Skeleton / shadcn-svelte tables pricing, as its site states it: Flowbite Svelte, Skeleton and shadcn-svelte are MIT component libraries; their table components are free and no grid licence is sold (https://github.com/themesberg/flowbite-svelte, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/), [SvGrid vs Flowbite / Skeleton / shadcn-svelte tables](https://svgrid.com/compare/svelte-ui-kit-tables/).\n<!-- facts:end -->\n\n## Why this port is small\n\nSvGrid speaks the same vocabulary TanStack Table v9 introduced. These are\nreal exports from `@svgrid/grid`, not lookalikes:\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```ts\nimport {\n tableFeatures,\n rowSortingFeature,\n columnFilteringFeature,\n rowPaginationFeature,\n rowSelectionFeature,\n rowExpandingFeature,\n columnGroupingFeature,\n} from '@svgrid/grid'\n```\n\nSo `data-table-features.ts` moves over as-is, and `columns.ts` keeps its\nshape. What does not move is the rendering scaffolding, because SvGrid\nships a renderer and there is nothing to translate it into.\n\n## What happens to each file\n\nThe shadcn recipe generates seven files. Five of them stop existing.\n\n| Their file | Becomes |\n| --- | --- |\n| `data-table-features.ts` | Kept. Same `tableFeatures({...})` call. |\n| `columns.ts` | Kept, minus the `header` render helpers. `{ accessorKey: 'email' }` becomes `{ field: 'email' }`. |\n| `data-table.svelte` | Deleted. It is `<table>` markup over `getHeaderGroups()` / `getRowModel()`, which `<SvGrid>` does. |\n| `data-table-checkbox.svelte` | Deleted. `showRowSelection` renders the column and the select-all header. |\n| `data-table-email-button.svelte` | Deleted. `sortable` makes every header a sort toggle. |\n| `data-table-actions.svelte` | Kept if you want it, as a cell snippet. |\n| `+page.svelte` | Kept. It now renders one component instead of wiring state. |\n\n## Let the codemod do the mechanical part\n\n```bash\nnpx @svgrid/migrate src/routes/payments # preview\nnpx @svgrid/migrate src/routes/payments --write # apply\n```\n\nIt previews by default and only writes with `--write`. Point it at the whole\nroute directory rather than a single file: the shadcn layout keeps `features`\nin its own module, and the codemod follows that import to work out which\nprops the component needs.\n\nIt renames the column keys, re-points the imports, strips the features SvGrid\ndoes not have, and deletes the markup along with the `$state` / `onXChange`\npairs. Custom `cell` and `header` render functions are kept and reported, never\nguessed at. Run your type-checker afterwards - the markup is regenerated rather\nthan edited.\n\n## Before and after\n\n```diff\n- <script lang=\"ts\">\n- import { createSvelteTable, FlexRender } from '$lib/components/ui/data-table'\n- import { columns } from './columns'\n- import { features } from './data-table-features'\n-\n- let sorting = $state([])\n- let filters = $state([])\n- let selection = $state({})\n- let pagination = $state({ pageIndex: 0, pageSize: 10 })\n-\n- const table = createSvelteTable({\n- get data() { return data },\n- columns, features,\n- state: { get sorting() { return sorting }, /* ...and three more... */ },\n- onSortingChange: (u) => (sorting = typeof u === 'function' ? u(sorting) : u),\n- // ...one of these per piece of state...\n- })\n- </script>\n-\n- <Table.Root>\n- <Table.Header>\n- {#each table.getHeaderGroups() as headerGroup}\n- <!-- ...twenty more lines of markup... -->\n- {/each}\n- </Table.Header>\n- <Table.Body>\n- {#each table.getRowModel().rows as row}\n- <!-- ...and twenty more... -->\n- {/each}\n- </Table.Body>\n- </Table.Root>\n\n+ <script lang=\"ts\">\n+ import { SvGrid } from '@svgrid/grid'\n+ import '@svgrid/grid/themes/shadcn.css'\n+ import { columns } from './columns'\n+ import { features } from './data-table-features'\n+ </script>\n+\n+ <SvGrid\n+ {data} {columns} {features}\n+ sortable filterable showGlobalFilter showRowSelection\n+ pageable showPagination pageSize={10}\n+ fitColumns\n+ />\n```\n\nThe four `$state` declarations and their four `onXChange` updaters go\naway with the markup. Sorting, filtering, paging, and selection state\nlive in the grid.\n\nColumn visibility moves too: mark a column `visible: false` to start it\nhidden, and users toggle it from the header column menu. You no longer\nmaintain a dropdown for it.\n\n## One command\n\nUse the CLI you already have:\n\n```sh\nnpx shadcn-svelte@latest add https://svgrid.com/r/data-table.json\n```\n\nThat writes a ready-to-edit `data-table.svelte` into\n`$lib/components/ui/data-table/`, beside your other components, and\ninstalls `@svgrid/grid`. It is a normal registry item, so `components.json`\naliases and your existing setup are respected.\n\nIf you are not in a shadcn project, the same component ships through\nSvGrid's own scaffolder:\n\n```sh\nnpx @svgrid/ui add data-table\n```\n\nBoth routes write the identical file. It is yours to edit, exactly like a\nshadcn recipe. The difference is where the engine lives.\n\n## The upgrade path is the real difference\n\nBoth approaches put a file you own in your repo. Only one puts the\n*engine* in a package.\n\nWhen TanStack Table went from v8 to v9, `useReactTable` became `useTable`,\nthe `get*RowModel()` options became a features object, and `flexRender`\nbecame a component. Every copied data-table had to be hand-fixed, because\nthere is no `npm update` for code you pasted. With SvGrid the file you own\nstays a thin call site, and the behaviour behind it updates with a version\nbump.\n\nThe cost scales with how much you pasted. A seven-file starter is an\nafternoon. The richer community grids paste a whole subsystem - row\nrendering, virtualization, context menus, paste dialogs, hooks, config -\nand every one of those files is now yours to carry through the next\nupstream change.\n\n## Keep your design system\n\nYou do not have to leave shadcn's look, and you do not have to leave its\nmarkup either.\n\n- **Tokens.** `import '@svgrid/grid/themes/shadcn.css'` is a one-line\n match for the default palette in light and dark. To follow a customized\n theme, map your `--background` / `--border` / `--primary` onto the\n `--sg-*` properties - see the [shadcn integration\n guide](./shadcn.md).\n- **Your own markup.** If you want to keep shadcn's `Table.Root` /\n `Table.Row` elements exactly as they are, use the headless core from\n `@svgrid/grid/core` and swap only the engine. See\n [Why headless?](../why-headless.md).\n\n## What you gain\n\nThe official recipe stops where its docs stop: sorting, filtering,\npagination, row selection, column visibility. Community registry items go\nfurther, at the cost of pasting a whole multi-file subsystem into your\nrepo. In SvGrid each of these is a prop:\n\n- **Virtualization** (`virtualization`) - the official recipe has none, so\n a large table is a rewrite rather than a prop.\n- **Inline editing** (`editable`) and cell-range selection\n (`enableCellSelection`).\n- **Grouping with aggregation** (`groupable`) and tree data (`treeData`).\n- **Export** to CSV, and to Excel / PDF on the paid tier.\n- **WAI-ARIA grid semantics and keyboard navigation**, instead of a plain\n `<table>` you keep accessible yourself.\n\n## What you give up\n\n- **A file you can read top to bottom.** The recipe's behaviour is\n visible in your repo; SvGrid's is behind a prop. That is the trade the\n whole page is about.\n- **Pixel-level control of the markup**, unless you go headless.\n- **Weight.** For a short static list that never sorts, the copied\n recipe is smaller.\n\n## Frequently asked questions\n\n### Does SvGrid replace shadcn-svelte?\n\nNo. It replaces one recipe in it. Your buttons, dialogs, and inputs stay\nexactly as they are, and the grid reads the same theme variables they do.\n\n### Can I keep my existing columns.ts?\n\nMostly. Rename `accessorKey` to `field`, drop the `header` render\nhelpers that only existed to draw a sort button, and the rest carries\nover. Custom cells become snippets via `renderSnippet`.\n\n### Do I have to give up owning the code?\n\nYou still own the call site - `npx @svgrid/ui add data-table` writes a\nfile into your project that you edit freely. What you stop owning is the\nrow-model plumbing, which is the part that broke on the v8 to v9 upgrade.\n\n### Is this worth it for a 50-row table?\n\nProbably not, unless you want editing, grouping, or export later. The\ncase gets strong when the table grows past what fits on a page, or when\nthe next feature request is one you would otherwise hand-build.\n\n## What you end up with\n\nSorting, filtering, pagination and selection - the shadcn data-table demo, as props.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} selectable />\n```\n\n## See also\n\n- [shadcn-svelte integration](./shadcn.md) - matching the theme\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - the\n underlying API map\n- [Migrating from a UI-kit table](./migrating-from-ui-kit-tables.md) - for\n the plain styled `<Table>`\n- [Why headless?](../why-headless.md) - keeping your own markup\n"
|
|
6162
6162
|
},
|
|
6163
6163
|
{
|
|
6164
6164
|
"slug": "help/migrating-from-smart-grid",
|
|
6165
6165
|
"path": "docs/help/migrating-from-smart-grid.md",
|
|
6166
6166
|
"title": "Migrating from Smart.Grid (Smart Web Components)",
|
|
6167
6167
|
"section": "Help",
|
|
6168
|
-
"markdown": "\n# Migrating from Smart.Grid (Smart Web Components)\n\nSmart.Grid (htmlelements.com) and SvGrid come from the **same team**.\nSmart.Grid is a framework-agnostic custom element - it even works inside\nSvelte today - while SvGrid is the reactive, Svelte-5-native option. If\nyou are standardising a Svelte app on idiomatic components, this guide\nmaps a Smart.Grid setup onto SvGrid.\n\n> Estimated effort: **2-4 hours** per grid. The main shift is from a\n> custom element bound through properties / attributes to a reactive\n> Svelte component.\n\n<!-- facts:start smart-grid -->\n> **Facts, checked 9 Nov 2026.** `smart-webcomponents` 27.1.0, ISC, last published 2 Oct 2026, 5,690 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6168
|
+
"markdown": "\n# Migrating from Smart.Grid (Smart Web Components)\n\nSmart.Grid (htmlelements.com) and SvGrid come from the **same team**.\nSmart.Grid is a framework-agnostic custom element - it even works inside\nSvelte today - while SvGrid is the reactive, Svelte-5-native option. If\nyou are standardising a Svelte app on idiomatic components, this guide\nmaps a Smart.Grid setup onto SvGrid.\n\n> Estimated effort: **2-4 hours** per grid. The main shift is from a\n> custom element bound through properties / attributes to a reactive\n> Svelte component.\n\n<!-- facts:start smart-grid -->\n> **Facts, checked 9 Nov 2026.** `smart-webcomponents` 27.1.0, ISC, last published 2 Oct 2026, 5,690 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). Smart.Grid pricing, as its site states it: htmlelements.com lists the Developer License at $499 (on sale at $399) per developer, perpetual, or $39 per month, and the Team License at $1,499 per five developers; the free Community License covers the core components but not the Grid (https://www.htmlelements.com/license/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Smart.Grid (Smart Web Components)](https://svgrid.com/compare/smart-grid/).\n<!-- facts:end -->\n\n## Vocabulary cheat sheet\n\n| Smart.Grid (web component) | sv-grid |\n| ---------------------------------------- | ----------------------------------------- |\n| `<smart-grid>` element | `<SvGrid ... />` |\n| `grid.dataSource = new Smart.DataAdapter`| `data` array (or `externalSort/Filter`) |\n| `{ label: 'Name', dataField: 'name' }` | `{ header: 'Name', field: 'name' }` |\n| `template` / cell template | `cell: (c) => renderSnippet(...)` |\n| `editing` + editor | `enableInlineEditing` + `editorType` |\n| `sorting` / `filtering` | `rowSortingFeature` / `columnFilteringFeature` |\n| `grouping` | `columnGroupingFeature` + `api.setGroupBy()` |\n| `paging` + `pager` | `showPagination` |\n| element events (`change`, ...) | `onCellValueChange`, `onApiReady` |\n| `theme` attribute | `--sg-*` tokens / Tailwind |\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- <smart-grid id=\"grid\" sorting filtering paging></smart-grid>\n- <script>\n- const grid = document.querySelector('#grid')\n- grid.dataSource = new Smart.DataAdapter({ dataSource: rows, dataFields: [...] })\n- grid.columns = [\n- { label: 'Name', dataField: 'name' },\n- { label: 'Amount', dataField: 'amount' },\n- ]\n- </script>\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination />\n```\n\n## What changes\n\n- **Custom element + DataAdapter → reactive `$state`.** Data binding is a\n prop, not an assigned `dataSource`.\n- **Element templates → Svelte snippets** via `renderSnippet`.\n- **`theme` attribute → `--sg-*` tokens.**\n\n## A note on family\n\nSmart.Grid is a genuinely good framework-agnostic grid from the same\nteam, and it runs in Svelte as a web component. The reason to pick SvGrid\nis *idiomatic* Svelte: runes, snippets, and an MIT core. If you need one\ngrid across Angular, React, Vue, Svelte, and vanilla, Smart.Grid is the\nright call.\n\n## Frequently asked questions\n\n### Is SvGrid from the same team as Smart.Grid?\n\nYes. Smart Web Components (htmlelements.com) and SvGrid are built by the same\nteam. SvGrid is the Svelte-5-native option with an MIT community core.\n\n### Can I keep using Smart.Grid in Svelte instead?\n\nYes - Smart.Grid is a web component and works inside Svelte. Choose SvGrid when\nyou want an idiomatic Svelte component (runes + snippets) rather than a custom\nelement bound through properties.\n\n### How do Smart.Grid columns map to SvGrid?\n\n`label` becomes `header`, `dataField` becomes `field`, and element templates\nbecome `renderSnippet` cells. Sorting / filtering / grouping move to registered\nfeatures.\n\n## More examples\n\n### Smart.Chart integration\n\nMounts a <smart-chart> web component (htmlelements.com) and pipes the grid's displayed rows into its dataSource. Re-aggregates on every filter / sort.\n\n<div data-docs-demo=\"77-smart-chart\" data-height=\"460\"></div>\n\n## What you end up with\n\nSorting, filtering and editing with a footer summary.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable editable summary />\n```\n\n## The ported grid, running\n\nSorting, filtering, editing and a totals row - the working set a Smart grid\nusually carries, as props.\n\n```svelte {runnable}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n city: string\n age: number\n salary: number\n }\n\n const seed: Person[] = [\n { id: 1, name: 'Ada Lovelace', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', city: 'Portland', age: 54, salary: 155000 },\n ]\n\n let rows = $state<Person[]>(seed.map((p) => ({ ...p })))\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 180, editorType: 'text' },\n { field: 'city', header: 'City', width: 150, editorType: 'text' },\n { field: 'salary', header: 'Salary', width: 150, editorType: 'number', summary: 'sum',\n format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n\n<SvGrid data={rows} {columns} sortable filterable editable summary />\n```\n\n## See also\n\n- [SvGrid vs Smart.Grid](https://svgrid.com/compare/smart-grid/) - the side-by-side comparison\n- [About SvGrid](https://svgrid.com/about/) - built by jQWidgets / htmlelements.com\n- [Cell components](./cells/cell-components.md) - snippet-based custom cells\n"
|
|
6169
6169
|
},
|
|
6170
6170
|
{
|
|
6171
6171
|
"slug": "help/migrating-from-svar-svelte-datagrid",
|
|
6172
6172
|
"path": "docs/help/migrating-from-svar-svelte-datagrid.md",
|
|
6173
6173
|
"title": "Migrating from SVAR Svelte DataGrid",
|
|
6174
6174
|
"section": "Help",
|
|
6175
|
-
"markdown": "# Migrating from SVAR Svelte DataGrid\n\nSVAR Svelte DataGrid (`@svar-ui/svelte-grid`, formerly `wx-svelte-grid`) is, like SvGrid, an actual\nSvelte-native grid rather than a wrapper, and both are MIT-licensed and\nfree for commercial use. Because both are component-first with\narray-of-object column definitions, a port is mostly a configuration\ntranslation. The reasons people switch are **capability** (SvGrid adds\nrow grouping with aggregation, master-detail, Excel-style cell-range\nselection, integrated charts, and pivot) and **architecture** (SvGrid\nalso exposes a headless engine and an MCP server).\n\n> Estimated effort: **2-4 hours** per grid - a prop and event rename\n> pass, plus re-theming.\n>\n> SVAR's exact prop and event names evolve across releases; check the\n> current SVAR docs and map them onto the SvGrid equivalents below.\n\n<!-- facts:start svar-svelte-datagrid -->\n> **Facts, checked 9 Nov 2026.** `@svar-ui/svelte-grid` 2.7.6, MIT, last published 7 Nov 2026, 106,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `@svar-ui/svelte-grid` 2.7.6 53.1 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). SVAR Svelte DataGrid pricing, as its site states it: The DataGrid is MIT and free for commercial use with no paid tier; svar.dev sells PRO editions of its Gantt, Calendar and Kanban components and offers paid consulting and custom development, with no price list for the grid (https://svar.dev/svelte/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/).\n<!-- facts:end -->\n\n## Concept map\n\n| SVAR DataGrid (@svar-ui/svelte-grid) | sv-grid |\n| ----------------------------------------- | ----------------------------------------- |\n| `<Grid {data} {columns} />` | `<SvGrid data={...} columns={...} />` |\n| `columns: [{ id, header, width, ... }]` | `columns: [{ field, header, width, ... }]` |\n| `sizes={{ rowHeight, columnWidth }}` | `rowHeight` prop, `width` per column |\n| `autoRowHeight` | `autoRowHeight` |\n| Per-column `editor` / `template` | `editorType` + `cell` snippet |\n| `sort: true` on a column, `sortMarks` | `rowSortingFeature`; `initialSorting` |\n| Header filters, the Filter component | `columnFilteringFeature`; Excel-style menu and filter row built in |\n| `tree` prop + `data` with children | `treeData={{ parentField }}` or `rowExpandingFeature` with sub rows |\n| `select` / `multiselect` | `selectionMode=\"row\"` (+ checkbox column) |\n| `split={{ left: n }}` (pinned columns) | `initialColumnPinning` or `pinned: 'left' \\| 'right'` per column |\n| `reorder` (row drag) | `rowDragManaged` |\n| `undo` prop, undo/redo hotkeys | `history` prop; `api.undo()` / `api.redo()` |\n| Context menu component | `contextMenu` prop with items |\n| `init={(api) => ...}` | `onApiReady={(api) => ...}` |\n| `api.exec('sort-rows', { key, order })` | `api.setSort(field, 'asc' \\| 'desc')` |\n| `api.exec('filter-rows', { filter })` | `api.setFilter(field, { operator, value })` |\n| `api.on('...')` event bus | `onXxx` callback props |\n| Export to CSV, print API | `api.exportCsv()` (free); print in `@svgrid/enterprise` |\n| `RestDataProvider` | server-side row model / `externalSort` + `externalFilter` |\n| Theme / skin components (Willow, Material)| `--sg-*` CSS custom properties / Tailwind |\n\n## Before / after (shape, not exact prop names)\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- <script>\n- import { Grid } from '@svar-ui/svelte-grid'\n- const columns = [\n- { id: 'name', header: 'Name', width: 200 },\n- { id: 'amount', header: 'Amount', width: 120, editor: 'text' },\n- ]\n- </script>\n-\n- <Grid {data} {columns} />\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name', width: 200 },\n+ { field: 'amount', header: 'Amount', width: 120, editorType: 'text' },\n+ ]\n+ </script>\n+\n+ <SvGrid data={data} columns={columns} features={features} enableInlineEditing />\n```\n\n## Licensing note\n\nBoth grids are MIT and free for commercial use, so licensing is not the\ndeciding factor. The difference is monetization: SVAR keeps the whole\ngrid free (including CSV export and print) and sells PRO editions of its\nGantt, Calendar and Kanban instead, whereas SvGrid's `@svgrid/grid` core is\nMIT and the optional `@svgrid/enterprise` pack (XLSX/PDF export, print,\npivot, import, support) is the paid piece. CSV, TSV and JSON export and the\nin-grid AI helpers are free on SvGrid too. If all you need is CSV export and\nprint, SVAR gives both free; if you need pivot, Excel or PDF output, or a\nsupport SLA, that is Enterprise on SvGrid.\n\n## What you get with SvGrid\n\n- **Row grouping with aggregation**, **master-detail**, **pinned rows**,\n and left/right column freezing - beyond SVAR's documented surface.\n- A **headless engine** (`createSvGrid` + row models) in addition to the\n component, if you want to compose your own layer.\n- **Excel-style filter menu**, **cell-range selection + TSV copy**, a\n **fill handle**, **integrated charts**, and a documented **imperative API**.\n- **In-grid AI helpers** (natural-language filter, smart fill, summarise),\n free against a model you register, and **@svgrid/mcp** so AI assistants\n answer accurately about your grid and can check the code they write.\n\nThe two features most SVAR teams port for:\n\n<div data-docs-demo=\"07-grouping-aggregation\" data-height=\"520\"></div>\n\n<div data-docs-demo=\"181-master-detail-grid\" data-height=\"520\"></div>\n\n## What you give up\n\n- **Free printing.** SVAR's print API is in the MIT grid; SvGrid's print\n view is in `@svgrid/enterprise`.\n- **The React and Vue versions** of the same grid. SvGrid is Svelte-only.\n- **A smaller bundle.** The facts box at the top of the page has both\n packages measured the same way; the difference is the grouping,\n master/detail, range editing, charts and server-side data (flat paging and infinite scroll free; grouping, tree, pivot and transactions on the server are Enterprise) SvGrid\n carries, and features you never import load as separate chunks.\n- **The SVAR suite around the grid.** Gantt, Calendar, Kanban and File\n Manager share SVAR's core; SvGrid's Kanban and scheduler are views of the\n grid in `@svgrid/enterprise`.\n\n## What to check on the SVAR side\n\n- The **wider SVAR suite** (Gantt, Calendar, Kanban) - if you use several\n SVAR components together, staying on SVAR may be simpler.\n- Any **SVAR-specific column features** you rely on; map each to a SvGrid\n `cell` snippet, `editorType`, or feature before porting.\n- **Filter functions.** SVAR filters with a predicate you write; SvGrid's\n filter takes an operator and a value per column, and `externalFilter`\n hands you the rows when you want to keep a custom predicate.\n\n## Frequently asked questions\n\n### Why move from SVAR Svelte DataGrid to SvGrid?\n\nCapability and architecture, not licensing (both are MIT). SvGrid adds row\ngrouping with aggregation, master-detail, Excel-style cell-range selection,\nintegrated charts, and pivot, and it ships a headless engine plus an MCP server\nalongside the component. Both are Svelte-native, so the core grid\nbehaviour is comparable; SvGrid covers more ground.\n\n### Is the migration a rewrite?\n\nNo. Both are component-first with array-of-object columns, so it is mostly a\nprop / event rename pass (`id` → `field`, edit events → `onCellValueChange`)\nplus re-theming through `--sg-*` tokens.\n\n### Are SvGrid and SVAR both free and MIT?\n\nYes. `@svgrid/grid` and the SVAR DataGrid are both MIT and free for\ncommercial, closed-source use. SVAR keeps the whole grid free and sells PRO\neditions of its Gantt, Calendar and Kanban; on SvGrid, only the optional\n`@svgrid/enterprise` add-on (Excel and PDF export, print, pivot, import,\nsupport) is paid. The dated statement from svar.dev is in the facts box at\nthe top of this page.\n\n### How does SVAR's tree data map to SvGrid?\n\nSVAR takes hierarchical data with the `tree` prop. SvGrid takes either a\nflat array with a parent field (`treeData={{ parentField: 'parentId' }}`)\nor nested rows through `rowExpandingFeature`, and the same grid also does\nmaster/detail, which SVAR's docs do not list. The example below runs the\nflat shape:\n\n## What you end up with\n\nGrouping with aggregation and a totals row, the main capability step up.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} groupBy={['department']} summary groupable sortable filterable />\n```\n\nAnd the tree shape, from the same rows with a parent link, which is what SVAR's `tree` prop becomes:\n\n```svelte {runnable}\n<SvGrid data={rows.map((r, i) => ({ ...r, parentId: i === 0 ? null : rows[0].id }))} {columns} treeData={{ parentField: 'parentId' }} sortable />\n```\n\n## See also\n\n- [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/) - the side-by-side comparison, with a source and date for every claim and the measured benchmark\n- [Grouping and aggregation](./grouping-aggregation.md) - the first demo above\n- [Master/detail](./rows/master-detail.md) - the second demo above\n- [Architecture](./architecture.md) - the engine + render-component split\n- [Cell components](./cells/cell-components.md) - custom cells and editors\n"
|
|
6175
|
+
"markdown": "# Migrating from SVAR Svelte DataGrid\n\nSVAR Svelte DataGrid (`@svar-ui/svelte-grid`, formerly `wx-svelte-grid`) is, like SvGrid, an actual\nSvelte-native grid rather than a wrapper, and both are MIT-licensed and\nfree for commercial use. Because both are component-first with\narray-of-object column definitions, a port is mostly a configuration\ntranslation. The reasons people switch are **capability** (SvGrid adds\nrow grouping with aggregation, master-detail, Excel-style cell-range\nselection, integrated charts, and pivot) and **architecture** (SvGrid\nalso exposes a headless engine and an MCP server).\n\n> Estimated effort: **2-4 hours** per grid - a prop and event rename\n> pass, plus re-theming.\n>\n> SVAR's exact prop and event names evolve across releases; check the\n> current SVAR docs and map them onto the SvGrid equivalents below.\n\n<!-- facts:start svar-svelte-datagrid -->\n> **Facts, checked 9 Nov 2026.** `@svar-ui/svelte-grid` 2.7.6, MIT, last published 7 Nov 2026, 106,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `@svar-ui/svelte-grid` 2.7.6 53.1 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). SVAR Svelte DataGrid pricing, as its site states it: The DataGrid is MIT and free for commercial use with no paid tier; svar.dev sells PRO editions of its Gantt, Calendar and Kanban components and offers paid consulting and custom development, with no price list for the grid (https://svar.dev/svelte/, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/).\n<!-- facts:end -->\n\n## Concept map\n\n| SVAR DataGrid (@svar-ui/svelte-grid) | sv-grid |\n| ----------------------------------------- | ----------------------------------------- |\n| `<Grid {data} {columns} />` | `<SvGrid data={...} columns={...} />` |\n| `columns: [{ id, header, width, ... }]` | `columns: [{ field, header, width, ... }]` |\n| `sizes={{ rowHeight, columnWidth }}` | `rowHeight` prop, `width` per column |\n| `autoRowHeight` | `autoRowHeight` |\n| Per-column `editor` / `template` | `editorType` + `cell` snippet |\n| `sort: true` on a column, `sortMarks` | `rowSortingFeature`; `initialSorting` |\n| Header filters, the Filter component | `columnFilteringFeature`; Excel-style menu and filter row built in |\n| `tree` prop + `data` with children | `treeData={{ parentField }}` or `rowExpandingFeature` with sub rows |\n| `select` / `multiselect` | `selectionMode=\"row\"` (+ checkbox column) |\n| `split={{ left: n }}` (pinned columns) | `initialColumnPinning` or `pinned: 'left' \\| 'right'` per column |\n| `reorder` (row drag) | `rowDragManaged` |\n| `undo` prop, undo/redo hotkeys | `history` prop; `api.undo()` / `api.redo()` |\n| Context menu component | `contextMenu` prop with items |\n| `init={(api) => ...}` | `onApiReady={(api) => ...}` |\n| `api.exec('sort-rows', { key, order })` | `api.setSort(field, 'asc' \\| 'desc')` |\n| `api.exec('filter-rows', { filter })` | `api.setFilter(field, { operator, value })` |\n| `api.on('...')` event bus | `onXxx` callback props |\n| Export to CSV, print API | `api.exportCsv()` (free); print in `@svgrid/enterprise` |\n| `RestDataProvider` | server-side row model / `externalSort` + `externalFilter` |\n| Theme / skin components (Willow, Material)| `--sg-*` CSS custom properties / Tailwind |\n\n## Before / after (shape, not exact prop names)\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- <script>\n- import { Grid } from '@svar-ui/svelte-grid'\n- const columns = [\n- { id: 'name', header: 'Name', width: 200 },\n- { id: 'amount', header: 'Amount', width: 120, editor: 'text' },\n- ]\n- </script>\n-\n- <Grid {data} {columns} />\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name', width: 200 },\n+ { field: 'amount', header: 'Amount', width: 120, editorType: 'text' },\n+ ]\n+ </script>\n+\n+ <SvGrid data={data} columns={columns} features={features} enableInlineEditing />\n```\n\n## Licensing note\n\nBoth grids are MIT and free for commercial use, so licensing is not the\ndeciding factor. The difference is monetization: SVAR keeps the whole\ngrid free (including CSV export and print) and sells PRO editions of its\nGantt, Calendar and Kanban instead, whereas SvGrid's `@svgrid/grid` core is\nMIT and the optional `@svgrid/enterprise` pack (XLSX/PDF export, print,\npivot, import, support) is the paid piece. CSV, TSV and JSON export and the\nin-grid AI helpers are free on SvGrid too. If all you need is CSV export and\nprint, SVAR gives both free; if you need pivot, Excel or PDF output, or a\nsupport SLA, that is Enterprise on SvGrid.\n\n## What you get with SvGrid\n\n- **Row grouping with aggregation**, **master-detail**, **pinned rows**,\n and left/right column freezing - beyond SVAR's documented surface.\n- A **headless engine** (`createSvGrid` + row models) in addition to the\n component, if you want to compose your own layer.\n- **Excel-style filter menu**, **cell-range selection + TSV copy**, a\n **fill handle**, **integrated charts**, and a documented **imperative API**.\n- **In-grid AI helpers** (natural-language filter, smart fill, summarise),\n free against a model you register, and **@svgrid/mcp** so AI assistants\n answer accurately about your grid and can check the code they write.\n\nThe two features most SVAR teams port for:\n\n<div data-docs-demo=\"07-grouping-aggregation\" data-height=\"520\"></div>\n\n<div data-docs-demo=\"181-master-detail-grid\" data-height=\"520\"></div>\n\n## What you give up\n\n- **Free printing.** SVAR's print API is in the MIT grid; SvGrid's print\n view is in `@svgrid/enterprise`.\n- **The React and Vue versions** of the same grid. SvGrid is Svelte-only.\n- **A smaller bundle.** The facts box at the top of the page has both\n packages measured the same way; the difference is the grouping,\n master/detail, range editing, charts and server-side data (flat paging and infinite scroll free; grouping, tree, pivot and transactions on the server are Enterprise) SvGrid\n carries, and features you never import load as separate chunks.\n- **The SVAR suite around the grid.** Gantt, Calendar, Kanban and File\n Manager share SVAR's core; SvGrid's Kanban and scheduler are views of the\n grid in `@svgrid/enterprise`.\n\n## What to check on the SVAR side\n\n- The **wider SVAR suite** (Gantt, Calendar, Kanban) - if you use several\n SVAR components together, staying on SVAR may be simpler.\n- Any **SVAR-specific column features** you rely on; map each to a SvGrid\n `cell` snippet, `editorType`, or feature before porting.\n- **Filter functions.** SVAR filters with a predicate you write; SvGrid's\n filter takes an operator and a value per column, and `externalFilter`\n hands you the rows when you want to keep a custom predicate.\n\n## Frequently asked questions\n\n### Why move from SVAR Svelte DataGrid to SvGrid?\n\nCapability and architecture, not licensing (both are MIT). SvGrid adds row\ngrouping with aggregation, master-detail, Excel-style cell-range selection,\nintegrated charts, and pivot, and it ships a headless engine plus an MCP server\nalongside the component. Both are Svelte-native, so the core grid\nbehaviour is comparable; SvGrid covers more ground.\n\n### Is the migration a rewrite?\n\nNo. Both are component-first with array-of-object columns, so it is mostly a\nprop / event rename pass (`id` → `field`, edit events → `onCellValueChange`)\nplus re-theming through `--sg-*` tokens.\n\n### Are SvGrid and SVAR both free and MIT?\n\nYes. `@svgrid/grid` and the SVAR DataGrid are both MIT and free for\ncommercial, closed-source use. SVAR keeps the whole grid free and sells PRO\neditions of its Gantt, Calendar and Kanban; on SvGrid, only the optional\n`@svgrid/enterprise` add-on (Excel and PDF export, print, pivot, import,\nsupport) is paid. The dated statement from svar.dev is in the facts box at\nthe top of this page.\n\n### How does SVAR's tree data map to SvGrid?\n\nSVAR takes hierarchical data with the `tree` prop. SvGrid takes either a\nflat array with a parent field (`treeData={{ parentField: 'parentId' }}`)\nor nested rows through `rowExpandingFeature`, and the same grid also does\nmaster/detail, which SVAR's docs do not list. The example below runs the\nflat shape:\n\n## What you end up with\n\nGrouping with aggregation and a totals row, the main capability step up.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} groupBy={['department']} summary groupable sortable filterable />\n```\n\nAnd the tree shape, from the same rows with a parent link, which is what SVAR's `tree` prop becomes:\n\n```svelte {runnable}\n<SvGrid data={rows.map((r, i) => ({ ...r, parentId: i === 0 ? null : rows[0].id }))} {columns} treeData={{ parentField: 'parentId' }} sortable />\n```\n\n## See also\n\n- [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/) - the side-by-side comparison, with a source and date for every claim and the measured benchmark\n- [Grouping and aggregation](./grouping-aggregation.md) - the first demo above\n- [Master/detail](./rows/master-detail.md) - the second demo above\n- [Architecture](./architecture.md) - the engine + render-component split\n- [Cell components](./cells/cell-components.md) - custom cells and editors\n"
|
|
6176
6176
|
},
|
|
6177
6177
|
{
|
|
6178
6178
|
"slug": "help/migrating-from-svelte-headless-table",
|
|
6179
6179
|
"path": "docs/help/migrating-from-svelte-headless-table.md",
|
|
6180
6180
|
"title": "Migrating from svelte-headless-table",
|
|
6181
6181
|
"section": "Help",
|
|
6182
|
-
"markdown": "\n# Migrating from svelte-headless-table\n\nsvelte-headless-table popularised the headless-table pattern in the\nSvelte ecosystem. It is built on Svelte 4 stores and plugins\n(`addSortBy`, `addColumnFilters`, `addPagination`, ...), and it leaves\nthe markup to you. SvGrid keeps the same headless idea but runs on\nSvelte 5 runes and ships a render component, so the port mostly\n*removes* the table you used to hand-author.\n\n> Estimated effort: **1-3 hours** per grid. Most of the time is deleting\n> the `<table>` markup and `Subscribe` blocks you no longer need.\n\n<!-- facts:start svelte-headless-table pkg:@humanspeak/svelte-headless-table -->\n> **Facts, checked 9 Nov 2026.** `svelte-headless-table` 0.18.3, MIT, last published 28 Oct 2024, 96,400 npm downloads in the 30 days to 8 Nov 2026. `@humanspeak/svelte-headless-table` 7.1.0, MIT, last published 28 Oct 2026, 10,600 npm downloads in the same window. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `svelte-headless-table` 0.18.3 5.7 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). svelte-headless-table pricing, as its site states it: svelte-headless-table is MIT and free; no paid licence or support is offered, and the author states there are no plans for a Svelte 5 port (https://github.com/bryanmylee/svelte-headless-table, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/).\n<!-- facts:end -->\n\n## Know your options first\n\nThe original package's last release and its Svelte 4 peer range are in the\nfacts box above, and its README states there are no current plans for a\nSvelte 5 port, so a Svelte 5 upgrade forces a decision. There are three\nhonest answers and you should know all of them:\n\n1. **`@humanspeak/svelte-headless-table`** - a maintained fork on Svelte 5 with\n the same API; its version, publish date and downloads are in the facts box\n too. Changing one package name is the cheapest path by a wide margin. If\n your table works and you only need Svelte 5, do that.\n2. **TanStack Table v9** - its Svelte adapter declares a Svelte 5 peer range.\n Still headless-only, so you keep writing and maintaining the markup.\n3. **SvGrid** - this page. A different trade: you delete the markup and take a\n renderer instead.\n\nPick SvGrid when the markup is the part you are tired of. Note that the blocker\nis not the syntax and not really the install either: `svelte-headless-table@0.18.3`\ndeclares `svelte@^4`, which npm 11 overrides with a warning (older npm needed\n`--legacy-peer-deps`), and the untouched component then type-checks clean in\nlegacy mode. Slots and `let:` still work in Svelte 5 - they are deprecated in\nfavour of snippets, not removed - so the `Subscribe` blocks below keep\nrendering. The trouble starts when that component moves to runes: the library\ntakes a store, your data is a rune, and the bridge between them is yours to\nwrite and maintain. We ran the whole upgrade and captured every line of it in\n[Upgrading a Svelte 4 table to Svelte 5](./svelte-5-upgrade-data-tables.md).\n\n## Run the codemod\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```bash\nnpx @svgrid/migrate # preview the result\nnpx @svgrid/migrate src --write # apply it\n```\n\nIt translates column definitions and plugin config, deletes the\n`Subscribe`/`Render` scaffolding, and reports anything it cannot map rather than\ndropping it silently. It previews by default. See\n[`@svgrid/migrate`](https://www.npmjs.com/package/@svgrid/migrate) for the full\nmapping and its limits.\n\n## Vocabulary cheat sheet\n\n| svelte-headless-table | sv-grid |\n| ----------------------------------------- | ----------------------------------------- |\n| `createTable(data, plugins)` | `createSvGrid({...})` or `<SvGrid>` |\n| `table.createColumns((t) => [...])` | `columns: ColumnDef[]` |\n| `t.column({ accessor: 'x', header })` | `{ field: 'x', header }` |\n| `t.column({ accessor: (r) => ... })` | `{ id, fieldFn: (r) => ... }` |\n| `t.group({ header, columns })` | `{ header, columns: [...] }` (column group) |\n| `addSortBy()` | `rowSortingFeature` |\n| `addColumnFilters()` / `addTableFilter()` | `columnFilteringFeature` |\n| `addPagination()` | Built in; toggle `showPagination` |\n| `addExpandedRows()` / `addSubRows()` | `rowExpandingFeature` |\n| `addGroupBy()` | `columnGroupingFeature` + `api.setGroupBy()` |\n| `addSelectedRows()` | `rowSelectionFeature` |\n| `addDataExport()` | `@svgrid/enterprise` export pack |\n| `createViewModel(columns)` + `Subscribe` | `<SvGrid>` (no view model to wire) |\n| `pluginStates.sort.sortKeys` | `api.setSort(id, dir)` / `onSortingChange` |\n\n### The shortcut form\n\nThat table maps plugins onto the headless *features*, which is what you want if\nyou keep driving the engine yourself. If you are moving to the `<SvGrid>`\ncomponent, every capability also has a boolean prop, and that is what the\ncodemod emits:\n\n| Plugin | `<SvGrid>` prop |\n| --- | --- |\n| `addSortBy()` | `sortable` |\n| `addTableFilter()` | `filterable showGlobalFilter` |\n| `addColumnFilters()` | `filterable showColumnFilters` |\n| `addPagination({ initialPageSize: 25 })` | `pageable pageSize={25}` |\n| `addSelectedRows()` | `showRowSelection` |\n| `addGroupBy()` | `groupable` |\n| `addSubRows()` | `treeData` |\n| `addColumnOrder()` | `enableColumnReorder` |\n| `addResizedColumns()` | nothing - resizing is built in |\n| `addHiddenColumns()` | `visible: false` on the column |\n| `addExpandedRows()` | `treeData`, or `isDetailRow` + `renderDetailRow` |\n| `addGridLayout()` | nothing - SvGrid owns its layout |\n\nEvery capability is off by default and turned on by its prop; there is no\nplugin registration step.\n\n## Before / after\n\n```diff\n- <script>\n- import { createTable } from 'svelte-headless-table'\n- import { addSortBy, addColumnFilters, addPagination } from 'svelte-headless-table/plugins'\n- import { readable } from 'svelte/store'\n-\n- const table = createTable(readable(data), {\n- sort: addSortBy(), filter: addColumnFilters(), page: addPagination(),\n- })\n- const columns = table.createColumns((t) => [\n- t.column({ accessor: 'name', header: 'Name' }),\n- t.column({ accessor: 'amount', header: 'Amount' }),\n- ])\n- const { headerRows, rows, tableAttrs, tableBodyAttrs } = table.createViewModel(columns)\n- </script>\n-\n- <table {...$tableAttrs}>\n- <thead> ...Subscribe over headerRows... </thead>\n- <tbody {...$tableBodyAttrs}> ...Subscribe over rows... </tbody>\n- </table>\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination />\n```\n\nType the column array against your row type. `GridColumns<(typeof data)[number]>`\nis the shortest form; a bare `GridColumns` widens the row to\n`Record<string, unknown>` and stops checking `field` against your real keys.\n\n## What you get for free\n\n- **The renderer.** No `createViewModel`, no `Subscribe`, no hand-built\n `<table>`. SvGrid ships virtualization, sticky headers, column\n resize, keyboard nav, and ARIA.\n- **Excel-style filter menu** and **cell-range selection + TSV copy**,\n which are BYO in svelte-headless-table.\n- **Inline editing** with typed editors and validation hooks.\n- **In-grid AI helpers** - natural-language filter, smart fill, summarise -\n free in `@svgrid/grid` against a model you register.\n- **Enterprise features** - Excel and PDF export, print, import and pivot -\n in one paid add-on; CSV, TSV and JSON export are free.\n\nIf you would rather keep driving your own `<table>`, the headless demo\nbelow does exactly that on `createSvGrid`, plugins replaced by features:\n\n<div data-docs-demo=\"186-headless-table\" data-height=\"520\"></div>\n\n## What changes\n\n- **Stores → runes.** Reactive data is `$state` / a plain array, not a\n Svelte store you pass to `createTable`. If your rows came from a `derived`\n store, read it with `$` at the call site or move it to `$derived`.\n- **Plugins → features.** Register `rowSortingFeature` etc. in\n `tableFeatures({...})` instead of `addSortBy()` in the plugin bag.\n- **View model → component.** You stop owning the markup; style through\n `--sg-*` tokens (and Tailwind) instead of `tableAttrs`.\n\n## What does not come across\n\n- **Custom `cell` renderers.** `createRender(MyComponent, props)` has no direct\n equivalent; SvGrid uses a `cell` snippet. The codemod preserves yours as a\n `// TODO port:` comment.\n- **Your own plugins.** There is no plugin system to port them into.\n- **`tableAttrs` / `attrs()` spreading.** The component owns its attributes.\n\n## When not to migrate\n\n- You need control of the exact DOM. Use the fork, or SvGrid's\n [headless core](../why-headless.md) at `@svgrid/grid/core`.\n- Your table is a handful of rows with no interaction. A plain `{#each}` is\n less code than either library.\n- You depend on custom plugins. That is a rewrite, not a migration.\n- You only need Svelte 5 support. Use the fork.\n\n## Frequently asked questions\n\n### How hard is it to move from svelte-headless-table to SvGrid?\n\nUsually 1-3 hours per grid, and `npx @svgrid/migrate` does the mechanical part.\nThe plugin-to-feature mapping is almost one-to-one; most of the work is deleting\nthe `createViewModel` + `Subscribe` + `<table>` markup, because SvGrid renders\nthat for you.\n\n### Does SvGrid use Svelte 5 runes instead of stores?\n\nYes. svelte-headless-table is built on Svelte 4 stores; SvGrid is Svelte-5\nnative (`$state` / `$derived` / `$effect`) with snippets for custom cells.\n\n### Is SvGrid still headless like svelte-headless-table?\n\nYes - `createSvGrid` plus the row-model factories is a headless engine you can\ndrive with your own markup, importable on its own from `@svgrid/grid/core`. The\ndifference is that SvGrid *also* ships a batteries-included `<SvGrid>` component\nso you usually do not have to.\n\n### Is svelte-headless-table still maintained?\n\nThe original's last publish date and Svelte 4 peer range are in the facts box\nat the top of the page, read from npm on the date shown, and its README says\nthere are no current plans for a Svelte 5 port. A community fork,\n`@humanspeak/svelte-headless-table`, is maintained and runs on Svelte 5 with\nthe same API; the facts box has its release line too. The fork is the\nlowest-effort option if you are happy with the library and only need Svelte 5.\n\n## What you end up with\n\nSorting, filtering and selection, on a library that still ships for Svelte 5.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable selectable />\n```\n\n## See also\n\n- [Upgrading a Svelte 4 table to Svelte 5](./svelte-5-upgrade-data-tables.md) - the whole upgrade run and captured, step by step\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/) - the side-by-side comparison, with a source and date for every claim\n- [Headless: build a table](./headless/build-a-table.md) - the demo above, step by step\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - sibling headless guide\n- [Why headless?](../why-headless.md) - the design rationale\n- [Architecture](./architecture.md) - the engine + render-component split\n"
|
|
6182
|
+
"markdown": "\n# Migrating from svelte-headless-table\n\nsvelte-headless-table popularised the headless-table pattern in the\nSvelte ecosystem. It is built on Svelte 4 stores and plugins\n(`addSortBy`, `addColumnFilters`, `addPagination`, ...), and it leaves\nthe markup to you. SvGrid keeps the same headless idea but runs on\nSvelte 5 runes and ships a render component, so the port mostly\n*removes* the table you used to hand-author.\n\n> Estimated effort: **1-3 hours** per grid. Most of the time is deleting\n> the `<table>` markup and `Subscribe` blocks you no longer need.\n\n<!-- facts:start svelte-headless-table pkg:@humanspeak/svelte-headless-table -->\n> **Facts, checked 9 Nov 2026.** `svelte-headless-table` 0.18.3, MIT, last published 28 Oct 2024, 96,400 npm downloads in the 30 days to 8 Nov 2026. `@humanspeak/svelte-headless-table` 7.1.0, MIT, last published 28 Oct 2026, 10,600 npm downloads in the same window. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `svelte-headless-table` 0.18.3 5.7 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). svelte-headless-table pricing, as its site states it: svelte-headless-table is MIT and free; no paid licence or support is offered, and the author states there are no plans for a Svelte 5 port (https://github.com/bryanmylee/svelte-headless-table, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/).\n<!-- facts:end -->\n\n## Know your options first\n\nThe original package's last release and its Svelte 4 peer range are in the\nfacts box above, and its README states there are no current plans for a\nSvelte 5 port, so a Svelte 5 upgrade forces a decision. There are three\nhonest answers and you should know all of them:\n\n1. **`@humanspeak/svelte-headless-table`** - a maintained fork on Svelte 5 with\n the same API; its version, publish date and downloads are in the facts box\n too. Changing one package name is the cheapest path by a wide margin. If\n your table works and you only need Svelte 5, do that.\n2. **TanStack Table v9** - its Svelte adapter declares a Svelte 5 peer range.\n Still headless-only, so you keep writing and maintaining the markup.\n3. **SvGrid** - this page. A different trade: you delete the markup and take a\n renderer instead.\n\nPick SvGrid when the markup is the part you are tired of. Note that the blocker\nis not the syntax and not really the install either: `svelte-headless-table@0.18.3`\ndeclares `svelte@^4`, which npm 11 overrides with a warning (older npm needed\n`--legacy-peer-deps`), and the untouched component then type-checks clean in\nlegacy mode. Slots and `let:` still work in Svelte 5 - they are deprecated in\nfavour of snippets, not removed - so the `Subscribe` blocks below keep\nrendering. The trouble starts when that component moves to runes: the library\ntakes a store, your data is a rune, and the bridge between them is yours to\nwrite and maintain. We ran the whole upgrade and captured every line of it in\n[Upgrading a Svelte 4 table to Svelte 5](./svelte-5-upgrade-data-tables.md).\n\n## Run the codemod\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```bash\nnpx @svgrid/migrate # preview the result\nnpx @svgrid/migrate src --write # apply it\n```\n\nIt translates column definitions and plugin config, deletes the\n`Subscribe`/`Render` scaffolding, and reports anything it cannot map rather than\ndropping it silently. It previews by default. See\n[`@svgrid/migrate`](https://www.npmjs.com/package/@svgrid/migrate) for the full\nmapping and its limits.\n\n## Vocabulary cheat sheet\n\n| svelte-headless-table | sv-grid |\n| ----------------------------------------- | ----------------------------------------- |\n| `createTable(data, plugins)` | `createSvGrid({...})` or `<SvGrid>` |\n| `table.createColumns((t) => [...])` | `columns: ColumnDef[]` |\n| `t.column({ accessor: 'x', header })` | `{ field: 'x', header }` |\n| `t.column({ accessor: (r) => ... })` | `{ id, fieldFn: (r) => ... }` |\n| `t.group({ header, columns })` | `{ header, columns: [...] }` (column group) |\n| `addSortBy()` | `rowSortingFeature` |\n| `addColumnFilters()` / `addTableFilter()` | `columnFilteringFeature` |\n| `addPagination()` | Built in; toggle `showPagination` |\n| `addExpandedRows()` / `addSubRows()` | `rowExpandingFeature` |\n| `addGroupBy()` | `columnGroupingFeature` + `api.setGroupBy()` |\n| `addSelectedRows()` | `rowSelectionFeature` |\n| `addDataExport()` | `@svgrid/enterprise` export pack |\n| `createViewModel(columns)` + `Subscribe` | `<SvGrid>` (no view model to wire) |\n| `pluginStates.sort.sortKeys` | `api.setSort(id, dir)` / `onSortingChange` |\n\n### The shortcut form\n\nThat table maps plugins onto the headless *features*, which is what you want if\nyou keep driving the engine yourself. If you are moving to the `<SvGrid>`\ncomponent, every capability also has a boolean prop, and that is what the\ncodemod emits:\n\n| Plugin | `<SvGrid>` prop |\n| --- | --- |\n| `addSortBy()` | `sortable` |\n| `addTableFilter()` | `filterable showGlobalFilter` |\n| `addColumnFilters()` | `filterable showColumnFilters` |\n| `addPagination({ initialPageSize: 25 })` | `pageable pageSize={25}` |\n| `addSelectedRows()` | `showRowSelection` |\n| `addGroupBy()` | `groupable` |\n| `addSubRows()` | `treeData` |\n| `addColumnOrder()` | `enableColumnReorder` |\n| `addResizedColumns()` | nothing - resizing is built in |\n| `addHiddenColumns()` | `visible: false` on the column |\n| `addExpandedRows()` | `treeData`, or `isDetailRow` + `renderDetailRow` |\n| `addGridLayout()` | nothing - SvGrid owns its layout |\n\nEvery capability is off by default and turned on by its prop; there is no\nplugin registration step.\n\n## Before / after\n\n```diff\n- <script>\n- import { createTable } from 'svelte-headless-table'\n- import { addSortBy, addColumnFilters, addPagination } from 'svelte-headless-table/plugins'\n- import { readable } from 'svelte/store'\n-\n- const table = createTable(readable(data), {\n- sort: addSortBy(), filter: addColumnFilters(), page: addPagination(),\n- })\n- const columns = table.createColumns((t) => [\n- t.column({ accessor: 'name', header: 'Name' }),\n- t.column({ accessor: 'amount', header: 'Amount' }),\n- ])\n- const { headerRows, rows, tableAttrs, tableBodyAttrs } = table.createViewModel(columns)\n- </script>\n-\n- <table {...$tableAttrs}>\n- <thead> ...Subscribe over headerRows... </thead>\n- <tbody {...$tableBodyAttrs}> ...Subscribe over rows... </tbody>\n- </table>\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination />\n```\n\nType the column array against your row type. `GridColumns<(typeof data)[number]>`\nis the shortest form; a bare `GridColumns` widens the row to\n`Record<string, unknown>` and stops checking `field` against your real keys.\n\n## What you get for free\n\n- **The renderer.** No `createViewModel`, no `Subscribe`, no hand-built\n `<table>`. SvGrid ships virtualization, sticky headers, column\n resize, keyboard nav, and ARIA.\n- **Excel-style filter menu** and **cell-range selection + TSV copy**,\n which are BYO in svelte-headless-table.\n- **Inline editing** with typed editors and validation hooks.\n- **In-grid AI helpers** - natural-language filter, smart fill, summarise -\n free in `@svgrid/grid` against a model you register.\n- **Enterprise features** - Excel and PDF export, print, import and pivot -\n in one paid add-on; CSV, TSV and JSON export are free.\n\nIf you would rather keep driving your own `<table>`, the headless demo\nbelow does exactly that on `createSvGrid`, plugins replaced by features:\n\n<div data-docs-demo=\"186-headless-table\" data-height=\"520\"></div>\n\n## What changes\n\n- **Stores → runes.** Reactive data is `$state` / a plain array, not a\n Svelte store you pass to `createTable`. If your rows came from a `derived`\n store, read it with `$` at the call site or move it to `$derived`.\n- **Plugins → features.** Register `rowSortingFeature` etc. in\n `tableFeatures({...})` instead of `addSortBy()` in the plugin bag.\n- **View model → component.** You stop owning the markup; style through\n `--sg-*` tokens (and Tailwind) instead of `tableAttrs`.\n\n## What does not come across\n\n- **Custom `cell` renderers.** `createRender(MyComponent, props)` has no direct\n equivalent; SvGrid uses a `cell` snippet. The codemod preserves yours as a\n `// TODO port:` comment.\n- **Your own plugins.** There is no plugin system to port them into.\n- **`tableAttrs` / `attrs()` spreading.** The component owns its attributes.\n\n## When not to migrate\n\n- You need control of the exact DOM. Use the fork, or SvGrid's\n [headless core](../why-headless.md) at `@svgrid/grid/core`.\n- Your table is a handful of rows with no interaction. A plain `{#each}` is\n less code than either library.\n- You depend on custom plugins. That is a rewrite, not a migration.\n- You only need Svelte 5 support. Use the fork.\n\n## Frequently asked questions\n\n### How hard is it to move from svelte-headless-table to SvGrid?\n\nUsually 1-3 hours per grid, and `npx @svgrid/migrate` does the mechanical part.\nThe plugin-to-feature mapping is almost one-to-one; most of the work is deleting\nthe `createViewModel` + `Subscribe` + `<table>` markup, because SvGrid renders\nthat for you.\n\n### Does SvGrid use Svelte 5 runes instead of stores?\n\nYes. svelte-headless-table is built on Svelte 4 stores; SvGrid is Svelte-5\nnative (`$state` / `$derived` / `$effect`) with snippets for custom cells.\n\n### Is SvGrid still headless like svelte-headless-table?\n\nYes - `createSvGrid` plus the row-model factories is a headless engine you can\ndrive with your own markup, importable on its own from `@svgrid/grid/core`. The\ndifference is that SvGrid *also* ships a batteries-included `<SvGrid>` component\nso you usually do not have to.\n\n### Is svelte-headless-table still maintained?\n\nThe original's last publish date and Svelte 4 peer range are in the facts box\nat the top of the page, read from npm on the date shown, and its README says\nthere are no current plans for a Svelte 5 port. A community fork,\n`@humanspeak/svelte-headless-table`, is maintained and runs on Svelte 5 with\nthe same API; the facts box has its release line too. The fork is the\nlowest-effort option if you are happy with the library and only need Svelte 5.\n\n## What you end up with\n\nSorting, filtering and selection, on a library that still ships for Svelte 5.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable selectable />\n```\n\n## See also\n\n- [Upgrading a Svelte 4 table to Svelte 5](./svelte-5-upgrade-data-tables.md) - the whole upgrade run and captured, step by step\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/) - the side-by-side comparison, with a source and date for every claim\n- [Headless: build a table](./headless/build-a-table.md) - the demo above, step by step\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - sibling headless guide\n- [Why headless?](../why-headless.md) - the design rationale\n- [Architecture](./architecture.md) - the engine + render-component split\n"
|
|
6183
6183
|
},
|
|
6184
6184
|
{
|
|
6185
6185
|
"slug": "help/migrating-from-syncfusion",
|
|
6186
6186
|
"path": "docs/help/migrating-from-syncfusion.md",
|
|
6187
6187
|
"title": "Migrating from Syncfusion Grid",
|
|
6188
6188
|
"section": "Help",
|
|
6189
|
-
"markdown": "# Migrating from Syncfusion Grid\n\nSyncfusion Grid is a comprehensive commercial grid across JavaScript,\nReact, Vue, Angular, and Blazor, with a free community license for\nqualifying small teams. Moving to SvGrid trades the multi-framework suite\nfor a Svelte-5-native grid with an unconditional MIT core.\n\n> Estimated effort: **3-6 hours** per grid.\n>\n> Syncfusion's option names vary across its framework flavours; map your\n> version's columns and events onto the SvGrid equivalents below.\n\n<!-- facts:start syncfusion-grid -->\n> **Facts, checked 9 Nov 2026.** `@syncfusion/ej2-grids` 35.1.42, Commercial (see licence file), last published 27 Oct 2026, 1,060,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6189
|
+
"markdown": "# Migrating from Syncfusion Grid\n\nSyncfusion Grid is a comprehensive commercial grid across JavaScript,\nReact, Vue, Angular, and Blazor, with a free community license for\nqualifying small teams. Moving to SvGrid trades the multi-framework suite\nfor a Svelte-5-native grid with an unconditional MIT core.\n\n> Estimated effort: **3-6 hours** per grid.\n>\n> Syncfusion's option names vary across its framework flavours; map your\n> version's columns and events onto the SvGrid equivalents below.\n\n<!-- facts:start syncfusion-grid -->\n> **Facts, checked 9 Nov 2026.** `@syncfusion/ej2-grids` 35.1.42, Commercial (see licence file), last published 27 Oct 2026, 1,060,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). Syncfusion Grid pricing, as its site states it: syncfusion.com lists the Grid SDK at $959 per developer per year and the UI Component Suite at $1,199 per developer per year, minimum five developers; a free Community License applies to companies and individuals with under $1M annual revenue, up to five developers and no more than ten employees (https://www.syncfusion.com/sales/products, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Syncfusion Grid](https://svgrid.com/compare/syncfusion-grid/).\n<!-- facts:end -->\n\n## Concept map\n\n| Syncfusion Grid | sv-grid |\n| ---------------------------------------- | ----------------------------------------- |\n| `columns: [{ field, headerText }]` | `columns: [{ field, header }]` |\n| `template` / cell template | `cell: (c) => renderSnippet(...)` |\n| `editSettings` + `editType` | `enableInlineEditing` + `editorType` |\n| `allowSorting` / `allowFiltering` | `rowSortingFeature` / `columnFilteringFeature` |\n| `allowGrouping` + `aggregates` | `columnGroupingFeature` + aggregates |\n| `detailTemplate` | `rowExpandingFeature` / master-detail rows |\n| `dataSource` (local / `DataManager`) | `data` array or `externalSort/Filter` |\n| `allowPaging` + `pageSettings` | `showPagination` |\n| `toolbar` export | `@svgrid/enterprise` export pack |\n\n## Shape of the change\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- <ejs-grid [dataSource]=\"rows\" [allowSorting]=\"true\" [allowFiltering]=\"true\"\n- [allowPaging]=\"true\" [editSettings]=\"{ allowEditing: true }\">\n- <e-columns>\n- <e-column field=\"name\" headerText=\"Name\"></e-column>\n- <e-column field=\"amount\" headerText=\"Amount\" format=\"C2\"></e-column>\n- </e-columns>\n- </ejs-grid>\n\n+ <SvGrid\n+ data={rows}\n+ columns={[\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]}\n+ features={tableFeatures({ rowSortingFeature, columnFilteringFeature })}\n+ showPagination enableInlineEditing />\n```\n\n## Why teams switch\n\n- **Svelte 5 native** instead of a multi-framework commercial suite.\n- **Unconditional MIT core** - no revenue / headcount threshold like the\n Syncfusion community license.\n- **Optional Enterprise pack** for export / import / pivot / AI.\n\n## What to weigh\n\n- Syncfusion ships **one of the largest feature sets and suites**\n available, plus Blazor support. If you need that breadth or Blazor,\n weigh it against the Svelte-native fit.\n\n## Frequently asked questions\n\n### Is SvGrid free, unlike the Syncfusion commercial license?\n\n`@svgrid/grid` is MIT - free for everyone, with no revenue or team-size\nconditions. Syncfusion's community license is free only for qualifying small\nteams; otherwise it is commercial.\n\n### How do Syncfusion columns map to SvGrid?\n\n`field` stays `field`, `headerText` becomes `header`, and `template` becomes a\n`renderSnippet` cell. Sorting / filtering / grouping move to registered\nfeatures.\n\n### Does SvGrid support Blazor?\n\nNo - SvGrid is Svelte 5 only. If you need Blazor, that is a genuine reason to\nstay on Syncfusion. For a Svelte stack, SvGrid is the native fit.\n\n## What you end up with\n\nSort, filter, group and inline edit - the four things a Syncfusion grid is usually doing.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} groupBy={['department']} groupable sortable filterable editable />\n```\n\n## See also\n\n- [SvGrid vs Syncfusion Grid](https://svgrid.com/compare/syncfusion-grid/) - the side-by-side comparison\n- [Data export and printing - Enterprise](./export.md) - the Enterprise export pack\n- [Getting started](../getting-started.md) - a working grid in ~15 lines\n"
|
|
6190
6190
|
},
|
|
6191
6191
|
{
|
|
6192
6192
|
"slug": "help/migrating-from-tabulator",
|
|
6193
6193
|
"path": "docs/help/migrating-from-tabulator.md",
|
|
6194
6194
|
"title": "Migrating from Tabulator",
|
|
6195
6195
|
"section": "Help",
|
|
6196
|
-
"markdown": "# Migrating from Tabulator\n\nTabulator is a feature-rich vanilla-JS table you instantiate against a\nDOM element and drive imperatively (`table.setData(...)`,\n`table.on('cellEdited', ...)`). SvGrid covers a similar feature surface\nbut as a Svelte 5 component: data is a reactive `$state` array, custom\ncells are snippets, and there is no manual mount / teardown.\n\n> Estimated effort: **2-4 hours** per grid - column translation plus\n> swapping imperative `setData` for reactive state.\n\n<!-- facts:start tabulator -->\n> **Facts, checked 9 Nov 2026.** `tabulator-tables` 6.7.1, MIT, last published 22 Oct 2026, 826,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6196
|
+
"markdown": "# Migrating from Tabulator\n\nTabulator is a feature-rich vanilla-JS table you instantiate against a\nDOM element and drive imperatively (`table.setData(...)`,\n`table.on('cellEdited', ...)`). SvGrid covers a similar feature surface\nbut as a Svelte 5 component: data is a reactive `$state` array, custom\ncells are snippets, and there is no manual mount / teardown.\n\n> Estimated effort: **2-4 hours** per grid - column translation plus\n> swapping imperative `setData` for reactive state.\n\n<!-- facts:start tabulator -->\n> **Facts, checked 9 Nov 2026.** `tabulator-tables` 6.7.1, MIT, last published 22 Oct 2026, 826,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `tabulator-tables` 6.7.1 109.5 KB JS + 3.8 KB CSS (measured 9 Nov 2026). Tabulator pricing, as its site states it: Tabulator is MIT and free; no licence or support plan is sold (https://github.com/olifolkerd/tabulator, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Tabulator](https://svgrid.com/compare/tabulator/).\n<!-- facts:end -->\n\n## Vocabulary cheat sheet\n\n| Tabulator | sv-grid |\n| -------------------------------------- | ----------------------------------------- |\n| `new Tabulator(el, { data, columns })` | `<SvGrid data={...} columns={...} />` |\n| `{ title: 'Name', field: 'name' }` | `{ header: 'Name', field: 'name' }` |\n| `formatter: fn` / `formatter: 'money'` | `cell: (c) => renderSnippet(...)` or `format` |\n| `editor: 'input' / 'number' / ...` | `editorType: 'text' / 'number' / ...` |\n| `headerFilter: true` | `columnFilteringFeature` |\n| `dataTree: true` | `rowExpandingFeature` + tree row shape |\n| `table.setData(rows)` | reassign the `$state` data array |\n| `table.on('cellEdited', ...)` | `onCellValueChange` |\n| `table.setSort(field, dir)` | `api.setSort(field, dir)` |\n| `layout: 'fitColumns'` | `fitColumns` prop |\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import { TabulatorFull as Tabulator } from 'tabulator-tables'\n-\n- const table = new Tabulator('#grid', {\n- data: rows,\n- layout: 'fitColumns',\n- columns: [\n- { title: 'Name', field: 'name' },\n- { title: 'Amount', field: 'amount', formatter: 'money', editor: 'number' },\n- ],\n- })\n- table.on('cellEdited', (cell) => save(cell.getData()))\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' }, editorType: 'number' },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} fitColumns enableInlineEditing\n+ onCellValueChange={(e) => save(e)} />\n```\n\n## What changes\n\n- **Imperative → reactive.** No `setData()` - reassign the `$state`\n array and the grid updates.\n- **String formatters → snippets.** Custom cells are Svelte snippets /\n components, not HTML-string formatters.\n- **Mount / teardown disappears.** No `new Tabulator(el)` and no manual\n destroy on unmount.\n\n## Frequently asked questions\n\n### Is migrating from Tabulator to SvGrid hard?\n\nIt is a configuration translation plus one mindset shift: you stop calling\n`setData()` and instead let a reactive `$state` array drive the grid. Budget\n2-4 hours per grid.\n\n### Is SvGrid free like Tabulator?\n\nYes. `@svgrid/grid` is MIT-licensed like Tabulator. The optional\n`@svgrid/enterprise` pack (export, import, pivot, AI) is the only paid piece.\n\n### Can I keep Tabulator's custom formatters?\n\nYou re-create them as Svelte snippets via `renderSnippet`. Any Svelte\ncomponent or markup works, not just an HTML string.\n\n## What you end up with\n\nSort, filter and edit, with pagination underneath.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable editable pageable pageSize={3} />\n```\n\n## See also\n\n- [SvGrid vs Tabulator](https://svgrid.com/compare/tabulator/) - the side-by-side comparison\n- [Cell components](./cells/cell-components.md) - snippet-based custom cells\n- [Architecture](./architecture.md) - engine + render-component split\n"
|
|
6197
6197
|
},
|
|
6198
6198
|
{
|
|
6199
6199
|
"slug": "help/migrating-from-tanstack-table",
|
|
6200
6200
|
"path": "docs/help/migrating-from-tanstack-table.md",
|
|
6201
6201
|
"title": "Migrating from TanStack Table",
|
|
6202
6202
|
"section": "Help",
|
|
6203
|
-
"markdown": "# Migrating from TanStack Table\n\nTanStack Table (formerly React Table) is the closest conceptual\nsibling to sv-grid - both are \"headless data grid\" libraries with\nexplicit row-model pipelines, and the v9 Svelte adapter,\n`@tanstack/svelte-table`, targets Svelte 5 with the same runes-first\nshape. If you already think in `createTable()` + a features object,\nthis is a half-day port; the vocabulary below covers the v8 names too.\n\n> Estimated effort: **30 min** per grid for read-only views, **2-4\n> hours** for editing-heavy grids.\n\n<!-- facts:start tanstack-table -->\n> **Facts, checked 9 Nov 2026.** `@tanstack/svelte-table` 9.3.1, MIT, last published 12 Oct 2026, 539,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `@tanstack/svelte-table` 9.3.1 36.5 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). TanStack Table pricing, as its site states it: TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table (https://tanstack.com/table/latest, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/).\n<!-- facts:end -->\n\n> **On v9?** SvGrid exports the same feature vocabulary, so most of this\n> page is automated. Run `npx @svgrid/migrate src` to preview the port, and\n> see [Migrating from the shadcn-svelte data table](./migrating-from-shadcn-data-table.md)\n> if that is where your table came from.\n\n## Vocabulary cheat sheet\n\n| TanStack Table | sv-grid |\n| ------------------------------- | ---------------------------------------- |\n| `useReactTable({...})` | `createSvGrid({...})` or `<SvGrid>` |\n| `getCoreRowModel()` | `createCoreRowModel()` |\n| `getSortedRowModel()` | Auto-registered by `rowSortingFeature` |\n| `getFilteredRowModel()` | Auto-registered by `columnFilteringFeature` |\n| `getPaginationRowModel()` | Built in; toggle with `showPagination` |\n| `getGroupedRowModel()` | `columnGroupingFeature` + `api.setGroupBy()` |\n| `getExpandedRowModel()` | `rowExpandingFeature` |\n| `flexRender(col.cell, ctx)` | `renderSnippet(MyCell, props)` OR string field |\n| `columnHelper.accessor('field')` | `{ field: 'field' }` directly |\n| `table.getRowModel().rows` | `api.getDisplayedRows()` |\n| `table.setColumnFilters(...)` | `api.setFilter(id, {...})` per column |\n| `meta` (column / table) | n/a - use column `cellClass` / `cell` instead |\n\n## Imports\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import {\n- useReactTable, getCoreRowModel, getSortedRowModel, getFilteredRowModel,\n- flexRender, createColumnHelper,\n- } from '@tanstack/react-table'\n\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ renderSnippet,\n+ } from '@svgrid/grid'\n```\n\n## Column definitions\n\n```diff\n- const columnHelper = createColumnHelper<Order>()\n- const columns = [\n- columnHelper.accessor('orderId', { header: 'Order ID' }),\n- columnHelper.accessor('amount', { header: 'Amount', cell: ({ getValue }) => fmt(getValue<number>()) }),\n- ]\n\n+ const columns: ColumnDef<typeof features, Order>[] = [\n+ { field: 'orderId', header: 'Order ID' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n```\n\nThe `fieldFn` form is the same:\n\n```diff\n- columnHelper.accessor((row) => row.profile.name, { id: 'name', header: 'Name' })\n\n+ { id: 'name', fieldFn: (row) => row.profile.name, header: 'Name' }\n```\n\n## Mounting\n\n```diff\n- const table = useReactTable({\n- data, columns,\n- getCoreRowModel: getCoreRowModel(),\n- getSortedRowModel: getSortedRowModel(),\n- getFilteredRowModel: getFilteredRowModel(),\n- })\n- return (\n- <table>\n- <thead>{table.getHeaderGroups().map(/* ... */)}</thead>\n- <tbody>{table.getRowModel().rows.map(/* ... */)}</tbody>\n- </table>\n- )\n\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+\n+ <SvGrid data={rows} columns={columns} features={features} />\n```\n\nSv-grid bundles the render + virtualization. No `<table>` you have\nto author yourself.\n\n## Imperative state\n\n| TanStack Table | sv-grid |\n| ------------------------------------------- | ---------------------------------------- |\n| `table.setColumnFilters([{id, value}])` | `api.setFilter(id, { operator: 'contains', value })` |\n| `table.getColumn('id')?.setFilterValue(v)` | `api.setFilter(id, { operator: 'contains', value: v })` |\n| `table.setSorting([{id, desc}])` | `api.setSort(id, desc ? 'desc' : 'asc')` |\n| `table.setRowSelection(state)` | n/a - use `api.clearRowSelection()` + UI events |\n| `table.toggleAllRowsExpanded()` | `api.expandAllGroups()` |\n| `table.getColumn('x').toggleVisibility()` | `api.setColumnVisible('x', false)` |\n| `table.options.meta?.foo` | Pass through component props / `$state` |\n\n## Custom cells\n\n```diff\n- {\n- header: 'Status',\n- cell: ({ row }) => <Badge tone={row.original.status} />,\n- }\n\n+ {\n+ field: 'status', header: 'Status',\n+ cell: (ctx) => renderSnippet(StatusCell, { tone: ctx.row.original.status }),\n+ }\n```\n\n`renderSnippet` accepts any Svelte 5 snippet; `renderComponent`\naccepts a regular component if you prefer SFCs.\n\n## Server-side data\n\n```diff\n- const [pagination, setPagination] = useState({pageIndex: 0, pageSize: 25})\n- const [sorting, setSorting] = useState([])\n- const table = useReactTable({\n- data, columns, manualPagination: true, manualSorting: true,\n- state: { pagination, sorting },\n- onPaginationChange: setPagination,\n- onSortingChange: setSorting,\n- })\n\n+ <SvGrid\n+ data={rows} columns={columns} features={features}\n+ externalSort={true}\n+ externalFilter={true}\n+ onSortingChange={(clauses) => refetch({ sort: clauses })}\n+ onFiltersChange={(f) => refetch({ filters: f.columns })}\n+ />\n```\n\nOr hand the fetching to a controller and pass it as one prop:\n`createServerDataSource(source, { mode: 'infinite' })` owns the blocks,\nthe sort and filter round trips and the placeholder rows, and the\nmanual-flag wiring above disappears. TanStack Table has no server row\nmodel; per-group fetching is yours to write, where the Enterprise\n`createServerRowModel` does it over the same contract.\n\n<div data-docs-demo=\"148-server-row-model\" data-height=\"480\"></div>\n\n## What you get for free vs TanStack Table\n\n- **Renderer**. TanStack is headless-only; you draw the `<table>`.\n Sv-grid ships an opinionated, fast renderer with virtualization,\n scroll, sticky headers, column resize, keyboard nav, ARIA.\n- **Inline editing**. `editorType: 'text' | 'number' | 'date' |\n 'list' | ...` - built-in editors with parsing + validation hooks.\n- **CSP-clean**. No `eval`. The shipped tests confirm.\n- **In-grid AI helpers**. Natural-language filter, smart fill, summarise\n and classify, free in `@svgrid/grid` against a model you register.\n- **Enterprise features**. Excel and PDF export, print, import and pivot\n in one paid add-on; CSV, TSV and JSON export are free.\n\nThe headless demo below is the shape a TanStack app has today - a plain\n`<table>` driven by the engine - running on `createSvGrid`:\n\n<div data-docs-demo=\"186-headless-table\" data-height=\"520\"></div>\n\n## What you give up\n\n- **One engine across frameworks.** TanStack has adapters for React,\n Vue, Solid, Qwik, Lit and Svelte; sv-grid is Svelte 5-native and has\n no React wrapper.\n- **The smallest engine-only bundle.** The facts box at the top of the\n page has both packages measured the same way; the difference is the\n renderer, virtualizer, filter UI and editors you would otherwise write.\n- **TanStack Virtual and the shadcn-svelte data table recipe.** Sv-grid\n virtualizes on its own and has its own\n [shadcn-svelte guide](./migrating-from-shadcn-data-table.md).\n- **`meta` for arbitrary side-channel state.** Pass props directly.\n- **`@tanstack/match-sorter-utils` integration**. The grid's filter\n has a `contains` operator; if you need fuzzy match, plug your\n matcher in via the column's `cell` snippet or use\n `externalFilter={true}` and run the matcher yourself.\n\n## Frequently asked questions\n\n### How long does it take to migrate from TanStack Table to SvGrid?\n\nAbout 30 minutes per read-only grid and 2-4 hours for editing-heavy grids.\nBoth libraries use explicit row-model pipelines, so `createTable()` +\n`getCoreRowModel()` maps almost directly onto `createSvGrid()` +\n`createCoreRowModel()`.\n\n### Why switch from TanStack Table to SvGrid on Svelte 5?\n\nTanStack Table is headless-only and multi-framework, so you build the entire\nDOM, virtualization, filter UI, and editing layer yourself. SvGrid keeps the\nheadless core but ships a batteries-included `<SvGrid>` render component -\nvirtualization, Excel-style filters, cell selection, and inline editing work\nin one prop pass.\n\n### Is SvGrid free like TanStack Table?\n\nYes - `@svgrid/grid` is MIT-licensed, like TanStack Table. SvGrid\nadditionally offers an optional paid `@svgrid/enterprise` pack for Excel and\nPDF export, print, pivot and import, which TanStack Table does not provide at\nall; TanStack sells Enterprise Support as consulting instead, as the facts box\nabove notes.\n\n### Does the TanStack Svelte adapter support Svelte 5?\n\nYes. The v9 line of `@tanstack/svelte-table` declares a Svelte 5 peer range\nand reads rune data through getters; the version in the facts box above is\nthe one read from npm. If you are on the v8 adapter with Svelte 4 stores,\nthe port to sv-grid is the same work as the port to v9, minus the markup.\n\n## What you end up with\n\nThe same model you had, with the rendering already written.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} selectable />\n```\n\n## See also\n\n- [SvGrid vs TanStack Table](https://svgrid.com/compare/tanstack-table/) -\n the side-by-side comparison, with a source and date for every claim\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](./comparison.md) -\n the measured benchmark, TanStack column included\n- [Architecture](./architecture.md) - the headless engine + render\n component split\n- [Migrating from AG Grid](./migrating-from-ag-grid.md) - sibling guide\n- [Why headless?](../why-headless.md) - the design rationale\n"
|
|
6203
|
+
"markdown": "# Migrating from TanStack Table\n\nTanStack Table (formerly React Table) is the closest conceptual\nsibling to sv-grid - both are \"headless data grid\" libraries with\nexplicit row-model pipelines, and the v9 Svelte adapter,\n`@tanstack/svelte-table`, targets Svelte 5 with the same runes-first\nshape. If you already think in `createTable()` + a features object,\nthis is a half-day port; the vocabulary below covers the v8 names too.\n\n> Estimated effort: **30 min** per grid for read-only views, **2-4\n> hours** for editing-heavy grids.\n\n<!-- facts:start tanstack-table -->\n> **Facts, checked 9 Nov 2026.** `@tanstack/svelte-table` 9.3.1, MIT, last published 12 Oct 2026, 539,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `@tanstack/svelte-table` 9.3.1 36.5 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). TanStack Table pricing, as its site states it: TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table (https://tanstack.com/table/latest, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/).\n<!-- facts:end -->\n\n> **On v9?** SvGrid exports the same feature vocabulary, so most of this\n> page is automated. Run `npx @svgrid/migrate src` to preview the port, and\n> see [Migrating from the shadcn-svelte data table](./migrating-from-shadcn-data-table.md)\n> if that is where your table came from.\n\n## Vocabulary cheat sheet\n\n| TanStack Table | sv-grid |\n| ------------------------------- | ---------------------------------------- |\n| `useReactTable({...})` | `createSvGrid({...})` or `<SvGrid>` |\n| `getCoreRowModel()` | `createCoreRowModel()` |\n| `getSortedRowModel()` | Auto-registered by `rowSortingFeature` |\n| `getFilteredRowModel()` | Auto-registered by `columnFilteringFeature` |\n| `getPaginationRowModel()` | Built in; toggle with `showPagination` |\n| `getGroupedRowModel()` | `columnGroupingFeature` + `api.setGroupBy()` |\n| `getExpandedRowModel()` | `rowExpandingFeature` |\n| `flexRender(col.cell, ctx)` | `renderSnippet(MyCell, props)` OR string field |\n| `columnHelper.accessor('field')` | `{ field: 'field' }` directly |\n| `table.getRowModel().rows` | `api.getDisplayedRows()` |\n| `table.setColumnFilters(...)` | `api.setFilter(id, {...})` per column |\n| `meta` (column / table) | n/a - use column `cellClass` / `cell` instead |\n\n## Imports\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- import {\n- useReactTable, getCoreRowModel, getSortedRowModel, getFilteredRowModel,\n- flexRender, createColumnHelper,\n- } from '@tanstack/react-table'\n\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ renderSnippet,\n+ } from '@svgrid/grid'\n```\n\n## Column definitions\n\n```diff\n- const columnHelper = createColumnHelper<Order>()\n- const columns = [\n- columnHelper.accessor('orderId', { header: 'Order ID' }),\n- columnHelper.accessor('amount', { header: 'Amount', cell: ({ getValue }) => fmt(getValue<number>()) }),\n- ]\n\n+ const columns: ColumnDef<typeof features, Order>[] = [\n+ { field: 'orderId', header: 'Order ID' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n```\n\nThe `fieldFn` form is the same:\n\n```diff\n- columnHelper.accessor((row) => row.profile.name, { id: 'name', header: 'Name' })\n\n+ { id: 'name', fieldFn: (row) => row.profile.name, header: 'Name' }\n```\n\n## Mounting\n\n```diff\n- const table = useReactTable({\n- data, columns,\n- getCoreRowModel: getCoreRowModel(),\n- getSortedRowModel: getSortedRowModel(),\n- getFilteredRowModel: getFilteredRowModel(),\n- })\n- return (\n- <table>\n- <thead>{table.getHeaderGroups().map(/* ... */)}</thead>\n- <tbody>{table.getRowModel().rows.map(/* ... */)}</tbody>\n- </table>\n- )\n\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+\n+ <SvGrid data={rows} columns={columns} features={features} />\n```\n\nSv-grid bundles the render + virtualization. No `<table>` you have\nto author yourself.\n\n## Imperative state\n\n| TanStack Table | sv-grid |\n| ------------------------------------------- | ---------------------------------------- |\n| `table.setColumnFilters([{id, value}])` | `api.setFilter(id, { operator: 'contains', value })` |\n| `table.getColumn('id')?.setFilterValue(v)` | `api.setFilter(id, { operator: 'contains', value: v })` |\n| `table.setSorting([{id, desc}])` | `api.setSort(id, desc ? 'desc' : 'asc')` |\n| `table.setRowSelection(state)` | n/a - use `api.clearRowSelection()` + UI events |\n| `table.toggleAllRowsExpanded()` | `api.expandAllGroups()` |\n| `table.getColumn('x').toggleVisibility()` | `api.setColumnVisible('x', false)` |\n| `table.options.meta?.foo` | Pass through component props / `$state` |\n\n## Custom cells\n\n```diff\n- {\n- header: 'Status',\n- cell: ({ row }) => <Badge tone={row.original.status} />,\n- }\n\n+ {\n+ field: 'status', header: 'Status',\n+ cell: (ctx) => renderSnippet(StatusCell, { tone: ctx.row.original.status }),\n+ }\n```\n\n`renderSnippet` accepts any Svelte 5 snippet; `renderComponent`\naccepts a regular component if you prefer SFCs.\n\n## Server-side data\n\n```diff\n- const [pagination, setPagination] = useState({pageIndex: 0, pageSize: 25})\n- const [sorting, setSorting] = useState([])\n- const table = useReactTable({\n- data, columns, manualPagination: true, manualSorting: true,\n- state: { pagination, sorting },\n- onPaginationChange: setPagination,\n- onSortingChange: setSorting,\n- })\n\n+ <SvGrid\n+ data={rows} columns={columns} features={features}\n+ externalSort={true}\n+ externalFilter={true}\n+ onSortingChange={(clauses) => refetch({ sort: clauses })}\n+ onFiltersChange={(f) => refetch({ filters: f.columns })}\n+ />\n```\n\nOr hand the fetching to a controller and pass it as one prop:\n`createServerDataSource(source, { mode: 'infinite' })` owns the blocks,\nthe sort and filter round trips and the placeholder rows, and the\nmanual-flag wiring above disappears. TanStack Table has no server row\nmodel; per-group fetching is yours to write, where the Enterprise\n`createServerRowModel` does it over the same contract.\n\n<div data-docs-demo=\"148-server-row-model\" data-height=\"480\"></div>\n\n## What you get for free vs TanStack Table\n\n- **Renderer**. TanStack is headless-only; you draw the `<table>`.\n Sv-grid ships an opinionated, fast renderer with virtualization,\n scroll, sticky headers, column resize, keyboard nav, ARIA.\n- **Inline editing**. `editorType: 'text' | 'number' | 'date' |\n 'list' | ...` - built-in editors with parsing + validation hooks.\n- **CSP-clean**. No `eval`. The shipped tests confirm.\n- **In-grid AI helpers**. Natural-language filter, smart fill, summarise\n and classify, free in `@svgrid/grid` against a model you register.\n- **Enterprise features**. Excel and PDF export, print, import and pivot\n in one paid add-on; CSV, TSV and JSON export are free.\n\nThe headless demo below is the shape a TanStack app has today - a plain\n`<table>` driven by the engine - running on `createSvGrid`:\n\n<div data-docs-demo=\"186-headless-table\" data-height=\"520\"></div>\n\n## What you give up\n\n- **One engine across frameworks.** TanStack has adapters for React,\n Vue, Solid, Qwik, Lit and Svelte; sv-grid is Svelte 5-native and has\n no React wrapper.\n- **The smallest engine-only bundle.** The facts box at the top of the\n page has both packages measured the same way; the difference is the\n renderer, virtualizer, filter UI and editors you would otherwise write.\n- **TanStack Virtual and the shadcn-svelte data table recipe.** Sv-grid\n virtualizes on its own and has its own\n [shadcn-svelte guide](./migrating-from-shadcn-data-table.md).\n- **`meta` for arbitrary side-channel state.** Pass props directly.\n- **`@tanstack/match-sorter-utils` integration**. The grid's filter\n has a `contains` operator; if you need fuzzy match, plug your\n matcher in via the column's `cell` snippet or use\n `externalFilter={true}` and run the matcher yourself.\n\n## Frequently asked questions\n\n### How long does it take to migrate from TanStack Table to SvGrid?\n\nAbout 30 minutes per read-only grid and 2-4 hours for editing-heavy grids.\nBoth libraries use explicit row-model pipelines, so `createTable()` +\n`getCoreRowModel()` maps almost directly onto `createSvGrid()` +\n`createCoreRowModel()`.\n\n### Why switch from TanStack Table to SvGrid on Svelte 5?\n\nTanStack Table is headless-only and multi-framework, so you build the entire\nDOM, virtualization, filter UI, and editing layer yourself. SvGrid keeps the\nheadless core but ships a batteries-included `<SvGrid>` render component -\nvirtualization, Excel-style filters, cell selection, and inline editing work\nin one prop pass.\n\n### Is SvGrid free like TanStack Table?\n\nYes - `@svgrid/grid` is MIT-licensed, like TanStack Table. SvGrid\nadditionally offers an optional paid `@svgrid/enterprise` pack for Excel and\nPDF export, print, pivot and import, which TanStack Table does not provide at\nall; TanStack sells Enterprise Support as consulting instead, as the facts box\nabove notes.\n\n### Does the TanStack Svelte adapter support Svelte 5?\n\nYes. The v9 line of `@tanstack/svelte-table` declares a Svelte 5 peer range\nand reads rune data through getters; the version in the facts box above is\nthe one read from npm. If you are on the v8 adapter with Svelte 4 stores,\nthe port to sv-grid is the same work as the port to v9, minus the markup.\n\n## What you end up with\n\nThe same model you had, with the rendering already written.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} selectable />\n```\n\n## See also\n\n- [SvGrid vs TanStack Table](https://svgrid.com/compare/tanstack-table/) -\n the side-by-side comparison, with a source and date for every claim\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](./comparison.md) -\n the measured benchmark, TanStack column included\n- [Architecture](./architecture.md) - the headless engine + render\n component split\n- [Migrating from AG Grid](./migrating-from-ag-grid.md) - sibling guide\n- [Why headless?](../why-headless.md) - the design rationale\n"
|
|
6204
6204
|
},
|
|
6205
6205
|
{
|
|
6206
6206
|
"slug": "help/migrating-from-ui-kit-tables",
|
|
6207
6207
|
"path": "docs/help/migrating-from-ui-kit-tables.md",
|
|
6208
6208
|
"title": "Migrating from a UI-kit table (Flowbite / Skeleton / shadcn-svelte)",
|
|
6209
6209
|
"section": "Help",
|
|
6210
|
-
"markdown": "\n# Migrating from a UI-kit table (Flowbite / Skeleton / shadcn-svelte)\n\nFlowbite-Svelte, Skeleton, and shadcn-svelte all ship a styled `<Table>`\ncomponent. They are presentation components: they render the rows you\npass and match your design tokens, but sorting, filtering,\nvirtualization, and editing are yours to write by hand. Moving to SvGrid\nreplaces that hand-rolled logic with built-in features - while still\nletting you match the design system.\n\n> **Not the shadcn-svelte data table.** That one is a separate recipe\n> built on TanStack Table v9, and it already does sorting, filtering,\n> pagination, and row selection. If that is what you have, read\n> [Migrating from the shadcn-svelte data table](./migrating-from-shadcn-data-table.md)\n> instead - the port is different, and smaller.\n\n<!-- facts:start svelte-ui-kit-tables -->\n> **Facts, checked 9 Nov 2026.** `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the 30 days to 8 Nov 2026. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6210
|
+
"markdown": "\n# Migrating from a UI-kit table (Flowbite / Skeleton / shadcn-svelte)\n\nFlowbite-Svelte, Skeleton, and shadcn-svelte all ship a styled `<Table>`\ncomponent. They are presentation components: they render the rows you\npass and match your design tokens, but sorting, filtering,\nvirtualization, and editing are yours to write by hand. Moving to SvGrid\nreplaces that hand-rolled logic with built-in features - while still\nletting you match the design system.\n\n> **Not the shadcn-svelte data table.** That one is a separate recipe\n> built on TanStack Table v9, and it already does sorting, filtering,\n> pagination, and row selection. If that is what you have, read\n> [Migrating from the shadcn-svelte data table](./migrating-from-shadcn-data-table.md)\n> instead - the port is different, and smaller.\n\n<!-- facts:start svelte-ui-kit-tables -->\n> **Facts, checked 9 Nov 2026.** `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the 30 days to 8 Nov 2026. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026). Flowbite / Skeleton / shadcn-svelte tables pricing, as its site states it: Flowbite Svelte, Skeleton and shadcn-svelte are MIT component libraries; their table components are free and no grid licence is sold (https://github.com/themesberg/flowbite-svelte, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs Flowbite / Skeleton / shadcn-svelte tables](https://svgrid.com/compare/svelte-ui-kit-tables/).\n<!-- facts:end -->\n\n> Estimated effort: **30 min - 1 hour** per table. You are mostly\n> deleting `{#each}` markup and the sort / filter state you wrote\n> yourself.\n\n## When this guide applies\n\nYou have a table that started simple and has grown:\n\n- You added a click-to-sort handler and a sort-state variable.\n- You added a search box and an array `.filter(...)`.\n- The list got long and now you want virtualization or pagination.\n- You started editing cells inline and it got messy.\n\nThat is the moment a styled `<Table>` stops paying for itself.\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- <script>\n- import { Table, TableHead, TableHeadCell, TableBody, TableBodyRow, TableBodyCell } from 'flowbite-svelte'\n- let sortKey = 'name', asc = true\n- $: sorted = [...rows].sort((a, b) => (a[sortKey] > b[sortKey] ? 1 : -1) * (asc ? 1 : -1))\n- </script>\n-\n- <Table>\n- <TableHead>\n- <TableHeadCell on:click={() => (sortKey = 'name')}>Name</TableHeadCell>\n- <TableHeadCell on:click={() => (sortKey = 'amount')}>Amount</TableHeadCell>\n- </TableHead>\n- <TableBody>\n- {#each sorted as row}\n- <TableBodyRow>\n- <TableBodyCell>{row.name}</TableBodyCell>\n- <TableBodyCell>{row.amount}</TableBodyCell>\n- </TableBodyRow>\n- {/each}\n- </TableBody>\n- </Table>\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination />\n```\n\nThe sort handler, the `sorted` derivation, and the `{#each}` all go\naway. Sorting is a click on the header; filtering is the column menu.\n\n## Keep your design system\n\nSvGrid is unstyled-by-token, so it can match Flowbite / Skeleton /\nshadcn:\n\n- Re-theme through the `--sg-*` CSS custom properties (borders, header\n background, zebra rows, hover, selection, density).\n- Or drive those tokens from your Tailwind theme - see the\n [Tailwind integration](./tailwind.md) guide.\n\n## What you get for free\n\n- **Sorting, filtering, and pagination** without writing handlers.\n- **Row + column virtualization** so thousands of rows stay smooth.\n- **Inline editing**, **cell-range selection + copy**, grouping, tree,\n and master/detail when you need them.\n- **Accessibility** - WAI-ARIA grid roles and keyboard navigation built\n in, instead of a plain `<table>`.\n\n## What you give up\n\n- The **tiny footprint** of a styled `<table>` for a truly static list.\n- A **pixel-perfect**, zero-config match with the rest of the kit - you\n re-create the look with tokens instead (a one-time setup).\n\n## Frequently asked questions\n\n### When should I replace a Flowbite / Skeleton / shadcn table with a data grid?\n\nWhen the table needs sorting, filtering, virtualization, inline editing, or\nlarge datasets. These styled `<Table>` components are presentation only;\nonce you are hand-writing table behaviour, a data grid like SvGrid removes\nthat code. (shadcn-svelte also ships a separate TanStack-based data table -\nsee [that migration guide](./migrating-from-shadcn-data-table.md).)\n\n### Can SvGrid match my existing UI-kit styling?\n\nYes. SvGrid themes through `--sg-*` CSS variables, which you can wire to your\nTailwind / design-system tokens so it matches Flowbite, Skeleton, or\nshadcn-svelte.\n\n### Is it overkill for a small static table?\n\nFor a small, static table that never sorts or filters, a styled `<table>` is\nlighter and fine. Switch when the behaviour - not just the styling - becomes the\nwork.\n\n## What you end up with\n\nEverything the presentational table could not do: sort, filter, page, edit.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} editable />\n```\n\n## See also\n\n- [SvGrid vs UI-kit tables](https://svgrid.com/compare/svelte-ui-kit-tables/) - the side-by-side comparison\n- [Tailwind integration](./tailwind.md) - match your design system\n- [Getting started](../getting-started.md) - a working grid in ~15 lines\n"
|
|
6211
6211
|
},
|
|
6212
6212
|
{
|
|
6213
6213
|
"slug": "help/migrating-from-vincjo-datatables",
|
|
6214
6214
|
"path": "docs/help/migrating-from-vincjo-datatables.md",
|
|
6215
6215
|
"title": "Migrating from @vincjo/datatables",
|
|
6216
6216
|
"section": "Help",
|
|
6217
|
-
"markdown": "# Migrating from @vincjo/datatables\n\n`@vincjo/datatables` is a small, ergonomic Svelte datatable helper: you\nwrap your data in a handler and it gives you reactive sorting,\nfiltering, and pagination while you keep your own table markup. SvGrid\ncovers the same job and then keeps going - virtualization, an\nExcel-style filter menu, inline editing, and a render component - so the\nport is mostly about deciding how much markup you want to keep.\n\n> Estimated effort: **30 min - 2 hours** per table. A simple list is a\n> 30-minute swap; a feature-heavy one trends toward two hours.\n\n<!-- facts:start vincjo-datatables -->\n> **Facts, checked 9 Nov 2026.** `@vincjo/datatables` 2.8.1, MIT, last published 4 Jun 2026, 107,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.
|
|
6217
|
+
"markdown": "# Migrating from @vincjo/datatables\n\n`@vincjo/datatables` is a small, ergonomic Svelte datatable helper: you\nwrap your data in a handler and it gives you reactive sorting,\nfiltering, and pagination while you keep your own table markup. SvGrid\ncovers the same job and then keeps going - virtualization, an\nExcel-style filter menu, inline editing, and a render component - so the\nport is mostly about deciding how much markup you want to keep.\n\n> Estimated effort: **30 min - 2 hours** per table. A simple list is a\n> 30-minute swap; a feature-heavy one trends toward two hours.\n\n<!-- facts:start vincjo-datatables -->\n> **Facts, checked 9 Nov 2026.** `@vincjo/datatables` 2.8.1, MIT, last published 4 Jun 2026, 107,000 npm downloads in the 30 days to 8 Nov 2026. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `@vincjo/datatables` 2.8.1 10.2 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). @vincjo/datatables pricing, as its site states it: @vincjo/datatables is MIT on npm and free; no licence is sold (https://github.com/vincjo/datatables, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs @vincjo/datatables](https://svgrid.com/compare/vincjo-datatables/).\n<!-- facts:end -->\n\n## Vocabulary cheat sheet\n\n| @vincjo/datatables | sv-grid |\n| ------------------------------------------ | ----------------------------------------- |\n| `new TableHandler(data, { rowsPerPage })` | `createSvGrid({...})` or `<SvGrid>` |\n| `<ThSort {table} field=\"name\">` | `rowSortingFeature` (header sort built in) |\n| `<ThFilter {table} field=\"name\">` | `columnFilteringFeature` |\n| `table.global.set(query)` (search) | `api.setState({ globalFilter: query })` |\n| `<Pagination {table} />` / `<RowCount>` | Built in; toggle `showPagination` |\n| `table.rows` (current page rows) | `api.getDisplayedRows()` |\n| Server mode (`table.load(...)`) | `externalSort` / `externalFilter` + refetch |\n| Your own `<table>` + `{#each table.rows}` | `<SvGrid>` render component |\n\n## Before / after\n\nThe example at the end of this page runs against these rows:\n\n```svelte {preamble}\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n\n type Person = {\n id: number\n name: string\n department: string\n city: string\n age: number\n salary: number\n }\n\n const people: Person[] = [\n { id: 1, name: 'Ada Lovelace', department: 'Engineering', city: 'London', age: 36, salary: 142000 },\n { id: 2, name: 'Grace Hopper', department: 'Engineering', city: 'New York', age: 45, salary: 168000 },\n { id: 3, name: 'Linus Torvalds', department: 'Platform', city: 'Portland', age: 54, salary: 155000 },\n { id: 4, name: 'Radia Perlman', department: 'Networking', city: 'Seattle', age: 49, salary: 161000 },\n { id: 5, name: 'Barbara Liskov', department: 'Platform', city: 'Boston', age: 52, salary: 172000 },\n ]\n\n let rows = $state<Person[]>(people)\n\n const columns: GridColumns<Person> = [\n { field: 'name', header: 'Name', width: 200, editorType: 'text' },\n { field: 'department', header: 'Department', width: 150, editorType: 'text' },\n { field: 'city', header: 'City', width: 140, editorType: 'text' },\n { field: 'age', header: 'Age', width: 90, editorType: 'number' },\n { field: 'salary', header: 'Salary', width: 130, editorType: 'number', format: { type: 'currency', currency: 'USD' } },\n ]\n</script>\n```\n\n```diff\n- <script>\n- import { TableHandler, ThSort, ThFilter, Pagination } from '@vincjo/datatables'\n- const table = new TableHandler(rows, { rowsPerPage: 25 })\n- </script>\n-\n- <table>\n- <thead><tr>\n- <ThSort {table} field=\"name\">Name</ThSort>\n- <ThSort {table} field=\"amount\">Amount</ThSort>\n- </tr></thead>\n- <tbody>\n- {#each table.rows as row}\n- <tr><td>{row.name}</td><td>{row.amount}</td></tr>\n- {/each}\n- </tbody>\n- </table>\n- <Pagination {table} />\n\n+ <script lang=\"ts\">\n+ import {\n+ SvGrid, tableFeatures, rowSortingFeature, columnFilteringFeature,\n+ type ColumnDef,\n+ } from '@svgrid/grid'\n+\n+ const features = tableFeatures({ rowSortingFeature, columnFilteringFeature })\n+ const columns: ColumnDef<typeof features, Row>[] = [\n+ { field: 'name', header: 'Name' },\n+ { field: 'amount', header: 'Amount', format: { type: 'currency', currency: 'USD' } },\n+ ]\n+ </script>\n+\n+ <SvGrid data={rows} columns={columns} features={features} showPagination />\n```\n\n## Server-side data\n\n```diff\n- // @vincjo/datatables: drive a server with the handler's load hook\n- const table = new TableHandler(rows, { rowsPerPage: 25 })\n- table.load((state) => fetchRows(state)) // sort/filter/page sent to your API\n\n+ <SvGrid\n+ data={rows} columns={columns} features={features}\n+ externalSort={true} externalFilter={true}\n+ onSortingChange={(clauses) => refetch({ sort: clauses })}\n+ onFiltersChange={(f) => refetch({ filters: f.columns })}\n+ />\n```\n\n## What you get for free\n\n- **A render component** with virtualization - you stop authoring the\n `<table>` and the `{#each}`.\n- **Excel-style filter menu**, **cell-range selection + copy**, and\n **inline editing** with typed editors.\n- **Grouping, tree data, and master/detail** when the table grows up.\n- **Enterprise features** - export, import, pivot, AI.\n\n## What you give up\n\n- **The tiny footprint.** If all you ever need is sort / filter /\n paginate over a small list, `@vincjo/datatables` stays smaller.\n- **Total markup control.** SvGrid renders the table; you theme it with\n `--sg-*` tokens and Tailwind rather than writing every `<td>`.\n\n## Frequently asked questions\n\n### Should I move from @vincjo/datatables to SvGrid?\n\nMove when a hand-rolled table stops being enough - when you need virtualization\nfor large datasets, an Excel-style filter menu, inline editing, grouping, or\ntree data. For a small sort/filter/paginate list, `@vincjo/datatables` is a fine,\nlighter choice.\n\n### Is SvGrid also MIT-licensed like @vincjo/datatables?\n\nYes. `@svgrid/grid` is MIT, like `@vincjo/datatables`. SvGrid adds an\noptional paid `@svgrid/enterprise` pack (export, import, pivot, AI).\n\n### Can I keep my own table markup after switching?\n\nYes. SvGrid has a headless core (`createSvGrid` + row-model factories) you can\ndrive with your own markup, the same way `@vincjo/datatables` lets you. Most\nteams use the `<SvGrid>` component instead because it removes the boilerplate.\n\n## What you end up with\n\nSorting, filtering and pagination without the hand-written table around it.\n\n```svelte {runnable}\n<SvGrid data={rows} {columns} sortable filterable pageable pageSize={3} />\n```\n\n## See also\n\n- [SvGrid vs @vincjo/datatables](https://svgrid.com/compare/vincjo-datatables/) - the side-by-side comparison\n- [Migrating from svelte-headless-table](./migrating-from-svelte-headless-table.md) - sibling Svelte guide\n- [Why headless?](../why-headless.md) - keep your own markup if you want to\n"
|
|
6218
6218
|
},
|
|
6219
6219
|
{
|
|
6220
6220
|
"slug": "help/missing-features",
|
|
@@ -6634,7 +6634,7 @@ export const docs = [
|
|
|
6634
6634
|
"path": "docs/help/svelte-5-upgrade-data-tables.md",
|
|
6635
6635
|
"title": "Upgrading a Svelte 4 table to Svelte 5: what breaks, what does not, and the three ways out",
|
|
6636
6636
|
"section": "Help",
|
|
6637
|
-
"markdown": "\n# Upgrading a Svelte 4 table to Svelte 5: what breaks, what does not, and the three ways out\n\nIf your Svelte 4 app has a table built on `svelte-headless-table`, the Svelte 5\nupgrade forces a decision about it, and most of what is written about that\ndecision is guesswork. This page is not. We put the table from the library's\nown documentation into a Svelte 4 project, upgraded it to Svelte 5 one step at a\ntime, and captured every line the tools printed. The script and the captures\nare in the repo at\n[tools/migration-lab](https://github.com/sv-grid/sv-grid/tree/main/tools/migration-lab);\nevery code block below is a quote from those files, checked by a test, and the\nfirst line of each capture records the versions it was made with.\n\n<!-- facts:start svelte-headless-table pkg:@humanspeak/svelte-headless-table -->\n> **Facts, checked 9 Nov 2026.** `svelte-headless-table` 0.18.3, MIT, last published 28 Oct 2024, 96,400 npm downloads in the 30 days to 8 Nov 2026. `@humanspeak/svelte-headless-table` 7.1.0, MIT, last published 28 Oct 2026, 10,600 npm downloads in the same window. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.34 99.6 KB JS + 11.4 KB CSS (measured 10 Nov 2026); `svelte-headless-table` 0.18.3 5.7 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). svelte-headless-table pricing, as its site states it: svelte-headless-table is MIT and free; no paid licence or support is offered, and the author states there are no plans for a Svelte 5 port (https://github.com/bryanmylee/svelte-headless-table, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/).\n<!-- facts:end -->\n\nThe short version: the install warns and goes through, the untouched component\nkeeps compiling, and the trouble starts the day you write your first rune in\nthat component. The three exits are a maintained fork, TanStack Table v9, and\nSvGrid, and they trade different things.\n\n## The component we upgraded\n\nA `PeopleTable` written the way svelte-headless-table's docs teach it: a\n`writable` over a prop, a `$:` to keep it in sync, three plugins, the view model\nread through `<Subscribe>` and `<Render>`, a pager on `pluginStates.page`, and a\n`select` event dispatched from the row.\n\n<!-- captured: fixture/svelte4/PeopleTable.svelte -->\n```svelte\n<script lang=\"ts\">\n // The table as svelte-headless-table's own docs show it: a store for the\n // data, plugins for behaviour, and a view model read through <Subscribe>\n // and <Render>. Svelte 4 throughout: `export let`, `$:`, a dispatcher,\n // `on:click`, and `let:` slot props.\n import { createEventDispatcher } from 'svelte'\n import { writable } from 'svelte/store'\n import { createTable, Subscribe, Render } from 'svelte-headless-table'\n import { addSortBy, addColumnFilters, addPagination } from 'svelte-headless-table/plugins'\n import type { Person } from './people'\n\n export let people: Person[] = []\n export let pageSize = 5\n\n const dispatch = createEventDispatcher<{ select: Person }>()\n\n const data = writable<Person[]>(people)\n $: data.set(people)\n\n const table = createTable(data, {\n sort: addSortBy(),\n filter: addColumnFilters(),\n page: addPagination({ initialPageSize: pageSize }),\n })\n```\n\nThe full file is 83 lines; the 40 that follow are the `<table>`, three levels\nof `<Subscribe let:...>` and a `<p>` with the pager. On the pinned Svelte 4\ntoolchain it checks clean:\n\n<!-- captured: 01-svelte4-baseline.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\nsvelte-check found 0 errors and 0 warnings\n```\n\n## Step 1: the install warns and goes through\n\n`svelte-headless-table` declares `peerDependencies: { svelte: \"^4.0.0\" }`, and\nthat range is not going to change: the facts box above has the last release\ndate, and the project's README says there are no plans for a Svelte 5 port.\nSo what does `npm install svelte@5` do against it? On npm 11, this:\n\n<!-- captured: 02-npm-install-svelte5.txt -->\n```text\n$ npm install svelte@5.57.1\n\nadded 10 packages, removed 10 packages, and changed 2 packages in <time>\nnpm warn ERESOLVE overriding peer dependency\nnpm warn While resolving: svgrid-migration-lab@undefined\nnpm warn Found: svelte@4.2.20\nnpm warn node_modules/svelte\nnpm warn peer svelte@\"^4.0.0 || ^5.0.0-next.0\" from svelte-check@4.7.6\nnpm warn node_modules/svelte-check\nnpm warn dev svelte-check@\"4.7.6\" from the root project\nnpm warn 5 more (svelte-headless-table, svelte-keyed, svelte-render, ...)\nnpm warn\nnpm warn Could not resolve dependency:\nnpm warn peer svelte@\"^4.0.0\" from svelte-headless-table@0.18.3\nnpm warn node_modules/svelte-headless-table\nnpm warn dev svelte-headless-table@\"0.18.3\" from the root project\nnpm warn ERESOLVE overriding peer dependency\nnpm warn ERESOLVE overriding peer dependency\nnpm warn ERESOLVE overriding peer dependency\n\n(exit 0)\n```\n\nExit 0. npm 11 overrides the conflict and tells you so; older npm releases\nstopped with an `ERESOLVE` error until you added `--legacy-peer-deps`, and\npnpm prints an unmet-peer warning of its own. Either way, the peer range is a\nstatement, not a lock: the library's author is telling you it was never run\nagainst the Svelte you now have. Nothing enforces it.\n\n## Step 2: the untouched component still compiles\n\nSvelte 5 compiles Svelte 4 components in legacy mode, so `export let`, `$:`,\n`createEventDispatcher`, `on:click` and `let:` slot props all keep working\nuntil you opt a file into runes. With Svelte 5 installed and the component\nexactly as it was:\n\n<!-- captured: 03-svelte5-legacy-component.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\nsvelte-check found 0 errors and 0 warnings\n```\n\nThis is the part the scare stories leave out. If your only goal is to be on\nSvelte 5, you can install it, keep the table exactly as it is, and ship. The\nlibrary's own components (`<Subscribe>`, `<Render>`) compile in legacy mode\ntoo.\n\n## Step 3: the first rune\n\nWhat you cannot do is make that component a runes component and keep the\ntable as it is. Port `PeopleTable` by the rules in the\n[official migration guide](https://svelte.dev/docs/svelte/v5-migration-guide):\n`export let` becomes `$props()`, `$:` becomes `$derived` and `$effect`, the\ndispatcher becomes a callback prop, `on:click` becomes `onclick`. Leave the\nsvelte-headless-table wiring alone, because the guide has nothing to say about\nit. The checker now says:\n\n<!-- captured: 04-svelte5-runes-component.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\n<lab>\\src\\PeopleTable.svelte:19:35\nWarn: This reference only captures the initial value of `people`. Did you mean to reference it inside a closure instead?\nhttps://svelte.dev/e/state_referenced_locally (svelte)\n\n<lab>\\src\\PeopleTable.svelte:27:44\nWarn: This reference only captures the initial value of `pageSize`. Did you mean to reference it inside a closure instead?\nhttps://svelte.dev/e/state_referenced_locally (svelte)\n\n====================================\nsvelte-check found 0 errors and 2 warnings in 1 file\n```\n\nTwo warnings, no errors, and both are the same fact: the library takes a store,\nyour data is now a rune, and the `writable(people)` you built to bridge them\ncaptured the first value of `people` and nothing after. The fix is an\n`$effect` that writes the prop into the store on every change, which is what\nthe ported fixture does, and it works. It is also a bridge you now own, in\nevery component that has a table, between a reactivity model the library was\nbuilt for and the one your app is written in.\n\nThat is the actual shape of the problem. Not a red build: a component that\ncompiles, with a store-and-slot-props library bolted to a runes app by code you\nmaintain, on a package that will not move. The pieces it leans on are the ones\nSvelte 5 has deprecated: `let:` slot props and `<slot>` in favour of snippets,\nand `<svelte:component>`, which is what `<Render>` uses underneath\n(`svelte-render` 2.0.1, `PropsRenderer.svelte`, peer `svelte ^4.0.0`). They\nkeep working in legacy mode today; deprecated syntax is what the next major\nremoves, and this library will not be updated when it does.\n\n## The three ways out\n\nYou have three honest options, and you should know all of them before picking.\n\n1. **`@humanspeak/svelte-headless-table`**, a maintained fork on Svelte 5 with\n the same API. Its version, publish date and downloads are in the facts box.\n Switching is one package rename; you keep every line of markup and every\n `<Subscribe>`, and you keep the store bridge from step 3. If your table\n works and Svelte 5 is all you need, this is the cheapest exit by a wide\n margin.\n2. **TanStack Table v9.** Its Svelte adapter declares a Svelte 5 peer range and\n its state shape is runes-first, so the bridge goes away. It is still\n headless: you write and maintain the `<table>`, the virtualizer, the filter\n UI and the editors yourself. The\n [TanStack migration guide](./migrating-from-tanstack-table.md) covers the\n vocabulary.\n3. **SvGrid.** A different trade: you delete the markup and take a renderer.\n The column definitions and the plugin list carry over; the `<table>`, the\n `<Subscribe>` blocks, the pager and the store bridge do not exist any more,\n because `<SvGrid>` renders all of that. The rest of this page is what that\n looks like on the fixture above.\n\nPick 1 if the markup is fine and the library being dead does not bother you.\nPick 2 if you want the markup and a maintained engine. Pick 3 if the markup is\nthe part you are tired of.\n\n## Step 4: the codemod\n\n`npx @svgrid/migrate` ports a svelte-headless-table component to SvGrid. It\npreviews by default and only writes with `--write`, and it says what it could\nnot map instead of dropping it. On the Svelte 4 original:\n\n<!-- captured: 05-codemod.txt -->\n```text\n warning A custom `cell` renderer was found. SvGrid renders cells with a snippet, not `createRender`, so this one needs porting by hand - it is preserved as a comment.\n warning The template still reads `pageIndex`, `pageCount`, `shown` from the view model, which is gone. <SvGrid> renders its own pager and row count (`pageable`, `showPagination`), so remove that markup, or read the grid through `onApiReady` if you need the numbers.\n warning The table markup dispatched `select` from a row; that handler went with the `<tr>`. Wire it to `onRowClick={({ row }) => ...}` (or `onCellClick`) on <SvGrid>, and turn the `createEventDispatcher` into a callback prop if the component is moving to runes.\n note Column resizing, keyboard navigation and ARIA grid semantics are built into <SvGrid>; the markup that provided them is intentionally gone.\n\n1 file(s) would change, with 3 warning(s).\nRe-run with --write to apply.\n```\n\nThree warnings, each naming a thing it left for you. Write it, swap the\npackages, and check:\n\n<!-- captured: 06-after-codemod.txt -->\n```text\n$ npm install @svgrid/grid@3.0.4 --legacy-peer-deps\n\nadded 1 package in <time>\n\n(exit 0)\n\n$ npm uninstall svelte-headless-table --legacy-peer-deps\n\nremoved 4 packages in <time>\n\n(exit 0)\n\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\n<lab>\\src\\PeopleTable.svelte:31:23\nError: `$pageIndex` is an illegal variable name. To reference a global variable called `$pageIndex`, use `globalThis.$pageIndex`\nhttps://svelte.dev/e/global_reference_invalid (svelte)\n```\n\n<!-- captured: 06-after-codemod.txt -->\n```text\nsvelte-check found 9 errors and 0 warnings in 1 file\n```\n\nAll nine are the pager `<p>` the second warning named, reading `shown`,\n`$pageIndex` and `$pageCount` from a view model that no longer exists. The\ncodemod does not delete markup outside the `<table>`, because it cannot know\nwhat else is in there; it tells you what will not compile. Delete the `<p>`\n(the grid draws its own pager), turn the `select` event into a callback prop\non `onRowClick` as the third warning says, and:\n\n<!-- captured: 07-hand-edits.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\nsvelte-check found 0 errors and 0 warnings\n```\n\n## What you end up with\n\nThe component after the codemod and the two hand edits:\n\n<!-- captured: PeopleTable.after.svelte -->\n```svelte\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n import type { Person } from './people'\n export let people: Person[] = []\n export let pageSize = 5\n export let onselect: (person: Person) => void = () => {}\n\n const columns: GridColumns<(typeof people)[number]> = [\n {\n header: 'Name',\n field: 'name',\n },\n {\n header: 'Department',\n field: 'department',\n },\n {\n header: 'City',\n field: 'city',\n },\n {\n header: 'Salary',\n field: 'salary',\n // TODO port: cell: ({ value }) => value.toLocaleString('en-US', { style: 'currency', currency: 'USD\n },\n ]\n</script>\n\n<SvGrid data={people} {columns} sortable filterable showColumnFilters pageable pageSize={pageSize}\n onRowClick={({ row }) => onselect(row)} />\n```\n\n83 lines became 31. The `TODO port:` comment is the one thing left to do by\nhand: the currency cell becomes `format: { type: 'currency', currency: 'USD' }`\non the column, and the comment goes. There is no store, no `$:`, no\n`<Subscribe>`, no `let:`, and nothing in the file that Svelte 5 has deprecated,\nso the same component moves to runes whenever you like with the official\nmigration script and nothing else to port.\n\n## What to read next\n\n- [Migrating from svelte-headless-table](./migrating-from-svelte-headless-table.md) -\n the plugin-by-plugin mapping and what the codemod will not do\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/) -\n the side-by-side, with a source and date for every claim\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - exit 2 in detail\n- [Migrating from the shadcn-svelte data table](./migrating-from-shadcn-data-table.md) -\n the same codemod on the TanStack-based recipe\n- [Why headless?](../why-headless.md) - if you want to keep your own markup\n on a maintained Svelte 5 engine, `@svgrid/grid/core` is that too\n\n## Frequently asked questions\n\n### Does svelte-headless-table work with Svelte 5?\n\nIn legacy mode, yes: the install prints a peer-dependency warning and the\nuntouched component type-checks clean, as the captures above show. What does\nnot work is moving a component that uses it to runes without maintaining a\nstore bridge yourself, and the library is not going to be updated for the\ndeprecations that bridge leans on.\n\n### Is the peer dependency conflict an error?\n\nOn npm 11 it is a warning and the install exits 0; on older npm it was an\n`ERESOLVE` error until you passed `--legacy-peer-deps`; pnpm warns. It never\nstops the code from running. It tells you the library was not built against\nthe Svelte you have.\n\n### Should I just use the maintained fork?\n\nIf your table works and all you need is Svelte 5, yes, and this page says so.\nThe fork keeps the same API, so you keep the same markup and the same store\nbridge. Move to SvGrid when the markup and the bridge are what you want gone.\n\n### How much of the port does the codemod do?\n\nThe column definitions, the plugin list and the `<table>` replacement, and it\nnames what it leaves: custom cell renderers, markup outside the table that read\nthe view model, and events the rows dispatched. On the fixture that was two\nhand edits and one `format` option.\n\n### Can I rerun this myself?\n\n`node tools/migration-lab/run.mjs` in the repo. It installs the pinned Svelte 4\ntoolchain into its own folder, upgrades it, runs the codemod from the checkout,\nand rewrites the captured files; the header of each one records the versions.\nBump the pins to try a newer Svelte.\n"
|
|
6637
|
+
"markdown": "\n# Upgrading a Svelte 4 table to Svelte 5: what breaks, what does not, and the three ways out\n\nIf your Svelte 4 app has a table built on `svelte-headless-table`, the Svelte 5\nupgrade forces a decision about it, and most of what is written about that\ndecision is guesswork. This page is not. We put the table from the library's\nown documentation into a Svelte 4 project, upgraded it to Svelte 5 one step at a\ntime, and captured every line the tools printed. The script and the captures\nare in the repo at\n[tools/migration-lab](https://github.com/sv-grid/sv-grid/tree/main/tools/migration-lab);\nevery code block below is a quote from those files, checked by a test, and the\nfirst line of each capture records the versions it was made with.\n\n<!-- facts:start svelte-headless-table pkg:@humanspeak/svelte-headless-table -->\n> **Facts, checked 9 Nov 2026.** `svelte-headless-table` 0.18.3, MIT, last published 28 Oct 2024, 96,400 npm downloads in the 30 days to 8 Nov 2026. `@humanspeak/svelte-headless-table` 7.1.0, MIT, last published 28 Oct 2026, 10,600 npm downloads in the same window. `@svgrid/grid` 3.0.32, MIT, last published 3 Nov 2026, 44,600 npm downloads in the same window. Bundle, minified and gzipped, each package built alone with Svelte external: SvGrid 3.0.36 97.8 KB JS + 11.7 KB CSS (measured 17 Nov 2026); `svelte-headless-table` 0.18.3 5.7 KB JS, no separate stylesheet, svelte external (measured 9 Nov 2026). svelte-headless-table pricing, as its site states it: svelte-headless-table is MIT and free; no paid licence or support is offered, and the author states there are no plans for a Svelte 5 port (https://github.com/bryanmylee/svelte-headless-table, read 12 Sep 2026). SvGrid: MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise. Side by side, with sources: [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/).\n<!-- facts:end -->\n\nThe short version: the install warns and goes through, the untouched component\nkeeps compiling, and the trouble starts the day you write your first rune in\nthat component. The three exits are a maintained fork, TanStack Table v9, and\nSvGrid, and they trade different things.\n\n## The component we upgraded\n\nA `PeopleTable` written the way svelte-headless-table's docs teach it: a\n`writable` over a prop, a `$:` to keep it in sync, three plugins, the view model\nread through `<Subscribe>` and `<Render>`, a pager on `pluginStates.page`, and a\n`select` event dispatched from the row.\n\n<!-- captured: fixture/svelte4/PeopleTable.svelte -->\n```svelte\n<script lang=\"ts\">\n // The table as svelte-headless-table's own docs show it: a store for the\n // data, plugins for behaviour, and a view model read through <Subscribe>\n // and <Render>. Svelte 4 throughout: `export let`, `$:`, a dispatcher,\n // `on:click`, and `let:` slot props.\n import { createEventDispatcher } from 'svelte'\n import { writable } from 'svelte/store'\n import { createTable, Subscribe, Render } from 'svelte-headless-table'\n import { addSortBy, addColumnFilters, addPagination } from 'svelte-headless-table/plugins'\n import type { Person } from './people'\n\n export let people: Person[] = []\n export let pageSize = 5\n\n const dispatch = createEventDispatcher<{ select: Person }>()\n\n const data = writable<Person[]>(people)\n $: data.set(people)\n\n const table = createTable(data, {\n sort: addSortBy(),\n filter: addColumnFilters(),\n page: addPagination({ initialPageSize: pageSize }),\n })\n```\n\nThe full file is 83 lines; the 40 that follow are the `<table>`, three levels\nof `<Subscribe let:...>` and a `<p>` with the pager. On the pinned Svelte 4\ntoolchain it checks clean:\n\n<!-- captured: 01-svelte4-baseline.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\nsvelte-check found 0 errors and 0 warnings\n```\n\n## Step 1: the install warns and goes through\n\n`svelte-headless-table` declares `peerDependencies: { svelte: \"^4.0.0\" }`, and\nthat range is not going to change: the facts box above has the last release\ndate, and the project's README says there are no plans for a Svelte 5 port.\nSo what does `npm install svelte@5` do against it? On npm 11, this:\n\n<!-- captured: 02-npm-install-svelte5.txt -->\n```text\n$ npm install svelte@5.57.1\n\nadded 10 packages, removed 10 packages, and changed 2 packages in <time>\nnpm warn ERESOLVE overriding peer dependency\nnpm warn While resolving: svgrid-migration-lab@undefined\nnpm warn Found: svelte@4.2.20\nnpm warn node_modules/svelte\nnpm warn peer svelte@\"^4.0.0 || ^5.0.0-next.0\" from svelte-check@4.7.6\nnpm warn node_modules/svelte-check\nnpm warn dev svelte-check@\"4.7.6\" from the root project\nnpm warn 5 more (svelte-headless-table, svelte-keyed, svelte-render, ...)\nnpm warn\nnpm warn Could not resolve dependency:\nnpm warn peer svelte@\"^4.0.0\" from svelte-headless-table@0.18.3\nnpm warn node_modules/svelte-headless-table\nnpm warn dev svelte-headless-table@\"0.18.3\" from the root project\nnpm warn ERESOLVE overriding peer dependency\nnpm warn ERESOLVE overriding peer dependency\nnpm warn ERESOLVE overriding peer dependency\n\n(exit 0)\n```\n\nExit 0. npm 11 overrides the conflict and tells you so; older npm releases\nstopped with an `ERESOLVE` error until you added `--legacy-peer-deps`, and\npnpm prints an unmet-peer warning of its own. Either way, the peer range is a\nstatement, not a lock: the library's author is telling you it was never run\nagainst the Svelte you now have. Nothing enforces it.\n\n## Step 2: the untouched component still compiles\n\nSvelte 5 compiles Svelte 4 components in legacy mode, so `export let`, `$:`,\n`createEventDispatcher`, `on:click` and `let:` slot props all keep working\nuntil you opt a file into runes. With Svelte 5 installed and the component\nexactly as it was:\n\n<!-- captured: 03-svelte5-legacy-component.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\nsvelte-check found 0 errors and 0 warnings\n```\n\nThis is the part the scare stories leave out. If your only goal is to be on\nSvelte 5, you can install it, keep the table exactly as it is, and ship. The\nlibrary's own components (`<Subscribe>`, `<Render>`) compile in legacy mode\ntoo.\n\n## Step 3: the first rune\n\nWhat you cannot do is make that component a runes component and keep the\ntable as it is. Port `PeopleTable` by the rules in the\n[official migration guide](https://svelte.dev/docs/svelte/v5-migration-guide):\n`export let` becomes `$props()`, `$:` becomes `$derived` and `$effect`, the\ndispatcher becomes a callback prop, `on:click` becomes `onclick`. Leave the\nsvelte-headless-table wiring alone, because the guide has nothing to say about\nit. The checker now says:\n\n<!-- captured: 04-svelte5-runes-component.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\n<lab>\\src\\PeopleTable.svelte:19:35\nWarn: This reference only captures the initial value of `people`. Did you mean to reference it inside a closure instead?\nhttps://svelte.dev/e/state_referenced_locally (svelte)\n\n<lab>\\src\\PeopleTable.svelte:27:44\nWarn: This reference only captures the initial value of `pageSize`. Did you mean to reference it inside a closure instead?\nhttps://svelte.dev/e/state_referenced_locally (svelte)\n\n====================================\nsvelte-check found 0 errors and 2 warnings in 1 file\n```\n\nTwo warnings, no errors, and both are the same fact: the library takes a store,\nyour data is now a rune, and the `writable(people)` you built to bridge them\ncaptured the first value of `people` and nothing after. The fix is an\n`$effect` that writes the prop into the store on every change, which is what\nthe ported fixture does, and it works. It is also a bridge you now own, in\nevery component that has a table, between a reactivity model the library was\nbuilt for and the one your app is written in.\n\nThat is the actual shape of the problem. Not a red build: a component that\ncompiles, with a store-and-slot-props library bolted to a runes app by code you\nmaintain, on a package that will not move. The pieces it leans on are the ones\nSvelte 5 has deprecated: `let:` slot props and `<slot>` in favour of snippets,\nand `<svelte:component>`, which is what `<Render>` uses underneath\n(`svelte-render` 2.0.1, `PropsRenderer.svelte`, peer `svelte ^4.0.0`). They\nkeep working in legacy mode today; deprecated syntax is what the next major\nremoves, and this library will not be updated when it does.\n\n## The three ways out\n\nYou have three honest options, and you should know all of them before picking.\n\n1. **`@humanspeak/svelte-headless-table`**, a maintained fork on Svelte 5 with\n the same API. Its version, publish date and downloads are in the facts box.\n Switching is one package rename; you keep every line of markup and every\n `<Subscribe>`, and you keep the store bridge from step 3. If your table\n works and Svelte 5 is all you need, this is the cheapest exit by a wide\n margin.\n2. **TanStack Table v9.** Its Svelte adapter declares a Svelte 5 peer range and\n its state shape is runes-first, so the bridge goes away. It is still\n headless: you write and maintain the `<table>`, the virtualizer, the filter\n UI and the editors yourself. The\n [TanStack migration guide](./migrating-from-tanstack-table.md) covers the\n vocabulary.\n3. **SvGrid.** A different trade: you delete the markup and take a renderer.\n The column definitions and the plugin list carry over; the `<table>`, the\n `<Subscribe>` blocks, the pager and the store bridge do not exist any more,\n because `<SvGrid>` renders all of that. The rest of this page is what that\n looks like on the fixture above.\n\nPick 1 if the markup is fine and the library being dead does not bother you.\nPick 2 if you want the markup and a maintained engine. Pick 3 if the markup is\nthe part you are tired of.\n\n## Step 4: the codemod\n\n`npx @svgrid/migrate` ports a svelte-headless-table component to SvGrid. It\npreviews by default and only writes with `--write`, and it says what it could\nnot map instead of dropping it. On the Svelte 4 original:\n\n<!-- captured: 05-codemod.txt -->\n```text\n warning A custom `cell` renderer was found. SvGrid renders cells with a snippet, not `createRender`, so this one needs porting by hand - it is preserved as a comment.\n warning The template still reads `pageIndex`, `pageCount`, `shown` from the view model, which is gone. <SvGrid> renders its own pager and row count (`pageable`, `showPagination`), so remove that markup, or read the grid through `onApiReady` if you need the numbers.\n warning The table markup dispatched `select` from a row; that handler went with the `<tr>`. Wire it to `onRowClick={({ row }) => ...}` (or `onCellClick`) on <SvGrid>, and turn the `createEventDispatcher` into a callback prop if the component is moving to runes.\n note Column resizing, keyboard navigation and ARIA grid semantics are built into <SvGrid>; the markup that provided them is intentionally gone.\n\n1 file(s) would change, with 3 warning(s).\nRe-run with --write to apply.\n```\n\nThree warnings, each naming a thing it left for you. Write it, swap the\npackages, and check:\n\n<!-- captured: 06-after-codemod.txt -->\n```text\n$ npm install @svgrid/grid@3.0.4 --legacy-peer-deps\n\nadded 1 package in <time>\n\n(exit 0)\n\n$ npm uninstall svelte-headless-table --legacy-peer-deps\n\nremoved 4 packages in <time>\n\n(exit 0)\n\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\n<lab>\\src\\PeopleTable.svelte:31:23\nError: `$pageIndex` is an illegal variable name. To reference a global variable called `$pageIndex`, use `globalThis.$pageIndex`\nhttps://svelte.dev/e/global_reference_invalid (svelte)\n```\n\n<!-- captured: 06-after-codemod.txt -->\n```text\nsvelte-check found 9 errors and 0 warnings in 1 file\n```\n\nAll nine are the pager `<p>` the second warning named, reading `shown`,\n`$pageIndex` and `$pageCount` from a view model that no longer exists. The\ncodemod does not delete markup outside the `<table>`, because it cannot know\nwhat else is in there; it tells you what will not compile. Delete the `<p>`\n(the grid draws its own pager), turn the `select` event into a callback prop\non `onRowClick` as the third warning says, and:\n\n<!-- captured: 07-hand-edits.txt -->\n```text\n$ npx svelte-check --tsconfig ./tsconfig.json --output human --threshold warning\nsvelte-check found 0 errors and 0 warnings\n```\n\n## What you end up with\n\nThe component after the codemod and the two hand edits:\n\n<!-- captured: PeopleTable.after.svelte -->\n```svelte\n<script lang=\"ts\">\n import { SvGrid, type GridColumns } from '@svgrid/grid'\n import type { Person } from './people'\n export let people: Person[] = []\n export let pageSize = 5\n export let onselect: (person: Person) => void = () => {}\n\n const columns: GridColumns<(typeof people)[number]> = [\n {\n header: 'Name',\n field: 'name',\n },\n {\n header: 'Department',\n field: 'department',\n },\n {\n header: 'City',\n field: 'city',\n },\n {\n header: 'Salary',\n field: 'salary',\n // TODO port: cell: ({ value }) => value.toLocaleString('en-US', { style: 'currency', currency: 'USD\n },\n ]\n</script>\n\n<SvGrid data={people} {columns} sortable filterable showColumnFilters pageable pageSize={pageSize}\n onRowClick={({ row }) => onselect(row)} />\n```\n\n83 lines became 31. The `TODO port:` comment is the one thing left to do by\nhand: the currency cell becomes `format: { type: 'currency', currency: 'USD' }`\non the column, and the comment goes. There is no store, no `$:`, no\n`<Subscribe>`, no `let:`, and nothing in the file that Svelte 5 has deprecated,\nso the same component moves to runes whenever you like with the official\nmigration script and nothing else to port.\n\n## What to read next\n\n- [Migrating from svelte-headless-table](./migrating-from-svelte-headless-table.md) -\n the plugin-by-plugin mapping and what the codemod will not do\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/) -\n the side-by-side, with a source and date for every claim\n- [Migrating from TanStack Table](./migrating-from-tanstack-table.md) - exit 2 in detail\n- [Migrating from the shadcn-svelte data table](./migrating-from-shadcn-data-table.md) -\n the same codemod on the TanStack-based recipe\n- [Why headless?](../why-headless.md) - if you want to keep your own markup\n on a maintained Svelte 5 engine, `@svgrid/grid/core` is that too\n\n## Frequently asked questions\n\n### Does svelte-headless-table work with Svelte 5?\n\nIn legacy mode, yes: the install prints a peer-dependency warning and the\nuntouched component type-checks clean, as the captures above show. What does\nnot work is moving a component that uses it to runes without maintaining a\nstore bridge yourself, and the library is not going to be updated for the\ndeprecations that bridge leans on.\n\n### Is the peer dependency conflict an error?\n\nOn npm 11 it is a warning and the install exits 0; on older npm it was an\n`ERESOLVE` error until you passed `--legacy-peer-deps`; pnpm warns. It never\nstops the code from running. It tells you the library was not built against\nthe Svelte you have.\n\n### Should I just use the maintained fork?\n\nIf your table works and all you need is Svelte 5, yes, and this page says so.\nThe fork keeps the same API, so you keep the same markup and the same store\nbridge. Move to SvGrid when the markup and the bridge are what you want gone.\n\n### How much of the port does the codemod do?\n\nThe column definitions, the plugin list and the `<table>` replacement, and it\nnames what it leaves: custom cell renderers, markup outside the table that read\nthe view model, and events the rows dispatched. On the fixture that was two\nhand edits and one `format` option.\n\n### Can I rerun this myself?\n\n`node tools/migration-lab/run.mjs` in the repo. It installs the pinned Svelte 4\ntoolchain into its own folder, upgrades it, runs the codemod from the checkout,\nand rewrites the captured files; the header of each one records the versions.\nBump the pins to try a newer Svelte.\n"
|
|
6638
6638
|
},
|
|
6639
6639
|
{
|
|
6640
6640
|
"slug": "help/tailwind",
|
|
@@ -7614,7 +7614,7 @@ export const docs = [
|
|
|
7614
7614
|
"path": "docs/help/web-components.md",
|
|
7615
7615
|
"title": "Web Components & Custom Elements",
|
|
7616
7616
|
"section": "Help",
|
|
7617
|
-
"markdown": "# Web Components & Custom Elements\n\nShip SvGrid as a framework-agnostic web component and use the Svelte 5 data grid\nin React, Vue, Angular, or plain HTML - no Svelte required in the host app.\n\n\n\nSvGrid is authored in Svelte 5, but Svelte compiles to standards-based\n[custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_components).\n`@svgrid/grid-wc` publishes two of them, prebuilt: drop in one `<script>` tag\nand use `<sv-grid>` like any built-in element. If you searched for a \"web\ncomponent data grid\" or a \"framework-agnostic Svelte table\", this is the\nintegration path.\n\n> Video: A data grid web component: one script tag, any framework (https://www.youtube.com/watch?v=_zWVutDXlVY)\n\n## Start here\n\n| Page | What it covers |\n| --- | --- |\n| [**React, Vue or Angular**](./web-components/frameworks.md) | **Start here if you use one.** A running project in about thirty seconds, and 27 examples you can open and edit. |\n| [Quick start](./web-components/quick-start.md) | The CDN path, and the attribute-vs-property rule that trips everyone up once. |\n| [`<sv-grid>` reference](./web-components/sv-grid.md) | Every property, attribute and event. Generated from the grid's own types. |\n| [Shadow DOM](./web-components/shadow-dom.md) | `<sv-grid-shadow>`, for pages whose CSS you do not control. |\n| [React](./web-components/react.md) | The `@svgrid/grid-wc/react` component, and why React 18 needs it. |\n| [Vue](./web-components/vue.md) | The `@svgrid/grid-wc/vue` component - no `isCustomElement` config, no `.prop` modifiers. |\n| [Angular](./web-components/angular.md) | The `@svgrid/grid-wc/angular` standalone component, with typed inputs and outputs. |\n| [TypeScript](./web-components/typescript.md) | Typing the element, its properties and its events. |\n| [Enterprise features](./web-components/enterprise.md) | Excel / PDF export, import, print and pivot from a non-Svelte host - and the two views that need a Svelte-aware bundler. |\n| [Limitations](./web-components/limitations.md) | What cannot cross the boundary, and why. |\n\n## Framework wrappers\n\nThe package ships a component for each of the three big frameworks, generated\nfrom the same types as the element, as subpath imports:\n\n| Framework | Import |\n| --- | --- |\n| React | `import { SvGrid } from '@svgrid/grid-wc/react'` |\n| Vue | `import { SvGrid } from '@svgrid/grid-wc/vue'` |\n| Angular | `import { SvGridComponent } from '@svgrid/grid-wc/angular'` |\n\nEach framework is an OPTIONAL peer dependency, so a plain-HTML consumer never\ninstalls any of them, and each wrapper is a couple of KB that reuses the one\nelement bundle rather than shipping a second copy of the grid.\n\n**[Start here](./web-components/frameworks.md)** for the thirty-second path and\nnine runnable examples per framework - each one opens as a full editable\nproject, with no local setup.\n\n## Why a custom element\n\n- **Use it anywhere.** React, Vue, Angular, Solid, Astro, Rails/Laravel\n server-rendered pages, or a plain `<script>` tag. The browser treats\n `<sv-grid>` like any built-in element.\n- **One bundle, no framework lock-in.** Ship a single file to a CDN; consumers\n add one `<script type=\"module\">` and a tag.\n- **The whole grid.**
|
|
7617
|
+
"markdown": "# Web Components & Custom Elements\n\nShip SvGrid as a framework-agnostic web component and use the Svelte 5 data grid\nin React, Vue, Angular, or plain HTML - no Svelte required in the host app.\n\n\n\nSvGrid is authored in Svelte 5, but Svelte compiles to standards-based\n[custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_components).\n`@svgrid/grid-wc` publishes two of them, prebuilt: drop in one `<script>` tag\nand use `<sv-grid>` like any built-in element. If you searched for a \"web\ncomponent data grid\" or a \"framework-agnostic Svelte table\", this is the\nintegration path.\n\n> Video: A data grid web component: one script tag, any framework (https://www.youtube.com/watch?v=_zWVutDXlVY)\n\n## Start here\n\n| Page | What it covers |\n| --- | --- |\n| [**React, Vue or Angular**](./web-components/frameworks.md) | **Start here if you use one.** A running project in about thirty seconds, and 27 examples you can open and edit. |\n| [Quick start](./web-components/quick-start.md) | The CDN path, and the attribute-vs-property rule that trips everyone up once. |\n| [`<sv-grid>` reference](./web-components/sv-grid.md) | Every property, attribute and event. Generated from the grid's own types. |\n| [Shadow DOM](./web-components/shadow-dom.md) | `<sv-grid-shadow>`, for pages whose CSS you do not control. |\n| [React](./web-components/react.md) | The `@svgrid/grid-wc/react` component, and why React 18 needs it. |\n| [Vue](./web-components/vue.md) | The `@svgrid/grid-wc/vue` component - no `isCustomElement` config, no `.prop` modifiers. |\n| [Angular](./web-components/angular.md) | The `@svgrid/grid-wc/angular` standalone component, with typed inputs and outputs. |\n| [TypeScript](./web-components/typescript.md) | Typing the element, its properties and its events. |\n| [Enterprise features](./web-components/enterprise.md) | Excel / PDF export, import, print and pivot from a non-Svelte host - and the two views that need a Svelte-aware bundler. |\n| [Limitations](./web-components/limitations.md) | What cannot cross the boundary, and why. |\n\n## Framework wrappers\n\nThe package ships a component for each of the three big frameworks, generated\nfrom the same types as the element, as subpath imports:\n\n| Framework | Import |\n| --- | --- |\n| React | `import { SvGrid } from '@svgrid/grid-wc/react'` |\n| Vue | `import { SvGrid } from '@svgrid/grid-wc/vue'` |\n| Angular | `import { SvGridComponent } from '@svgrid/grid-wc/angular'` |\n\nEach framework is an OPTIONAL peer dependency, so a plain-HTML consumer never\ninstalls any of them, and each wrapper is a couple of KB that reuses the one\nelement bundle rather than shipping a second copy of the grid.\n\n**[Start here](./web-components/frameworks.md)** for the thirty-second path and\nnine runnable examples per framework - each one opens as a full editable\nproject, with no local setup.\n\n## Why a custom element\n\n- **Use it anywhere.** React, Vue, Angular, Solid, Astro, Rails/Laravel\n server-rendered pages, or a plain `<script>` tag. The browser treats\n `<sv-grid>` like any built-in element.\n- **One bundle, no framework lock-in.** Ship a single file to a CDN; consumers\n add one `<script type=\"module\">` and a tag.\n- **The whole grid.** 128 properties and 36 events, so virtualization,\n Excel-style filters, inline editing, grouping, tree data, pinning, pagination\n and the enterprise features are all reachable - not a hand-picked subset. The\n surface is **generated** from `<SvGrid>`'s own `Props` type and CI fails if\n the two drift. Exactly two props are left out, and the\n [reference](./web-components/sv-grid.md) says why.\n\nIf your team *is* on Svelte 5, use the component directly\n([First grid](../getting-started/2-first-grid.md)) - the custom element exists\nto reach non-Svelte hosts, and it costs you the Svelte runtime to do it.\n\n## Quick look\n\n```html\n<script type=\"module\" src=\"https://unpkg.com/@svgrid/grid-wc\"></script>\n\n<sv-grid id=\"grid\" sortable filterable pageable page-size=\"25\"\n style=\"display:block;height:420px\"></sv-grid>\n\n<script type=\"module\">\n const grid = document.getElementById('grid')\n // Arrays and objects are properties; primitives can be attributes.\n grid.columns = [{ field: 'name', header: 'Name' }, { field: 'role', header: 'Role' }]\n grid.data = [{ name: 'Ada', role: 'Engineering' }, { name: 'Alan', role: 'Research' }]\n grid.addEventListener('cellvaluechange', (e) => console.log(e.detail))\n</script>\n```\n\nFull walkthrough in [Quick start](./web-components/quick-start.md).\n\n## Building your own element\n\nThe published package is the recommended path, but the wrapper is about sixty\nlines and you may want a narrower surface, your own tag name, or extra\nbehaviour. The source is `packages/grid-wc/src` in the repository:\n`sv-grid-element.svelte` is the light-DOM wrapper, `GridBody.svelte` is the part\nboth elements share, and `scripts/generate-surface.mjs` writes the prop and\nevent declarations from `<SvGrid>`'s `Props` type.\n\n## See also\n\n- [Enterprise features from the element](./web-components/enterprise.md) -\n export, import, print and pivot need no Svelte in your build; the board and\n scheduler views do.\n- [Tailwind integration](./tailwind.md) - the full `--sg-*` token list.\n"
|
|
7618
7618
|
},
|
|
7619
7619
|
{
|
|
7620
7620
|
"slug": "help/web-components/angular",
|
|
@@ -7635,7 +7635,7 @@ export const docs = [
|
|
|
7635
7635
|
"path": "docs/help/web-components/frameworks.md",
|
|
7636
7636
|
"title": "SvGrid with React, Vue or Angular",
|
|
7637
7637
|
"section": "help/web-components",
|
|
7638
|
-
"markdown": "# SvGrid with React, Vue or Angular\n\nPick your framework and you have a running grid in about thirty seconds - no\nlocal setup, nothing to configure.\n\n## The 30-second path\n\n**1.** Install one package:\n\n<div data-docs-install=\"@svgrid/grid-wc\"></div>\n\n**2.** Import the component for your framework and render it:\n\n| Framework | Import | Tag |\n| --- | --- | --- |\n| React | `import { SvGrid } from '@svgrid/grid-wc/react'` | `<SvGrid data={rows} columns={cols} sortable filterable />` |\n| Vue | `import { SvGrid } from '@svgrid/grid-wc/vue'` | `<SvGrid :data=\"rows\" :columns=\"cols\" sortable filterable />` |\n| Angular | `import { SvGridComponent } from '@svgrid/grid-wc/angular'` | `<sv-grid [data]=\"rows\" [columns]=\"cols\" [sortable]=\"true\" />` |\n\nThat is the whole integration. All
|
|
7638
|
+
"markdown": "# SvGrid with React, Vue or Angular\n\nPick your framework and you have a running grid in about thirty seconds - no\nlocal setup, nothing to configure.\n\n## The 30-second path\n\n**1.** Install one package:\n\n<div data-docs-install=\"@svgrid/grid-wc\"></div>\n\n**2.** Import the component for your framework and render it:\n\n| Framework | Import | Tag |\n| --- | --- | --- |\n| React | `import { SvGrid } from '@svgrid/grid-wc/react'` | `<SvGrid data={rows} columns={cols} sortable filterable />` |\n| Vue | `import { SvGrid } from '@svgrid/grid-wc/vue'` | `<SvGrid :data=\"rows\" :columns=\"cols\" sortable filterable />` |\n| Angular | `import { SvGridComponent } from '@svgrid/grid-wc/angular'` | `<sv-grid [data]=\"rows\" [columns]=\"cols\" [sortable]=\"true\" />` |\n\nThat is the whole integration. All 128 properties and 36 events of the grid are\ntyped props on every one of them.\n\n**Or skip step 1** and open a working project right now:\n\n<div data-docs-sandbox=\"react:basic\" data-title=\"A first grid\"></div>\n<div data-docs-sandbox=\"vue:basic\" data-title=\"A first grid\"></div>\n<div data-docs-sandbox=\"angular:basic\" data-title=\"A first grid\"></div>\n\n## The examples\n\n<!-- BEGIN generated recipe table - packages/grid-wc/scripts/sync-example-docs.mjs -->\n\nThe same nine apps in each framework, so you can compare them\ndirectly - only the framework differs, never the data or the grid\nconfiguration. Every one is compiled in CI, so what you open is what works.\n\n| Recipe | What it shows | React | Vue | Angular |\n| --- | --- | --- | --- | --- |\n| A first grid | Rows, columns, and the two features almost every table wants | [→](./react.md#a-first-grid) | [→](./vue.md#a-first-grid) | [→](./angular.md#a-first-grid) |\n| Sorting and filtering | A filter row under the headers, multi-column sort, and the current sort read back into your own state | [→](./react.md#sorting-and-filtering) | [→](./vue.md#sorting-and-filtering) | [→](./angular.md#sorting-and-filtering) |\n| Editing and saving | Inline editing, with each committed edit arriving through `cellvaluechange` | [→](./react.md#editing-and-saving) | [→](./vue.md#editing-and-saving) | [→](./angular.md#editing-and-saving) |\n| Row selection | Checkboxes, with the selected rows handed straight to you - both the selection map and the rows themselves | [→](./react.md#row-selection) | [→](./vue.md#row-selection) | [→](./angular.md#row-selection) |\n| Grouping and totals | Group by one or two columns with an aggregate in the group row | [→](./react.md#grouping-and-totals) | [→](./vue.md#grouping-and-totals) | [→](./angular.md#grouping-and-totals) |\n| Pagination | Client-side paging | [→](./react.md#pagination) | [→](./vue.md#pagination) | [→](./angular.md#pagination) |\n| Server-side data | The grid renders the page you hand it and tells you when the user wants another | [→](./react.md#server-side-data) | [→](./vue.md#server-side-data) | [→](./angular.md#server-side-data) |\n| Theming | The `--sg-*` custom properties | [→](./react.md#theming) | [→](./vue.md#theming) | [→](./angular.md#theming) |\n| Excel export (Enterprise) | The paid pack from a non-Svelte host | [→](./react.md#excel-export-enterprise) | [→](./vue.md#excel-export-enterprise) | [→](./angular.md#excel-export-enterprise) |\n\n<!-- END generated recipe table -->\n## The chart element\n\nThe standalone chart ships as its own element, `<sv-chart>`, in the same\npackage: `import '@svgrid/grid-wc/chart'` registers it, and\n`@svgrid/grid-wc/react/chart`, `@svgrid/grid-wc/vue/chart` and the\n`SvChartComponent` export of the Angular package wrap it the same way the\ngrid is wrapped. Set `spec` as a property; the primitives (`zoomable`,\n`range-presets`, `legend=\"right\"`, `animate`, `drawable`) are attributes.\nThe [`<sv-chart>` reference](sv-chart.md) lists all of it, and the\n[charts guide](../charts.md) says what goes in a spec. It carries none of the\ngrid, so a page that only charts loads the chart.\n\n## What each wrapper is actually for\n\nThe grid is a custom element underneath, and a custom element is awkward in each\nframework in a different way. Each wrapper removes exactly that awkwardness:\n\n- **React** - React 18 and earlier stringify object props onto **attributes**,\n so `columns={cols}` silently becomes `\"[object Object]\"` and the grid renders\n empty with no error. The wrapper assigns them as properties on every version.\n- **Vue** - removes the `isCustomElement` build config and the `.prop` modifier\n that every object binding would otherwise need.\n- **Angular** - removes `CUSTOM_ELEMENTS_SCHEMA` from every component that shows\n a grid, and gives you typed `@Input` / `@Output` instead of an untyped\n element. Its selector is the element's own tag, so there is no extra wrapper\n element in your DOM.\n\nAll three also handle two ordering problems you would otherwise meet yourself:\nthe element renders **before** a framework assigns properties in an effect, and\n`apiready` fires once during that first mount - before React can bind a listener\nat all.\n\n## The imperative api\n\nEvery wrapper exposes the grid api once it is ready:\n\n- **React** - a ref: `grid.current?.api`\n- **Vue** - a template ref: `grid.value?.api`\n- **Angular** - the component instance: `grid.api`\n\n## Not using a framework?\n\n`<sv-grid>` works in plain HTML with one `<script>` tag - see\n[Quick start](./quick-start.md).\n\n## See also\n\n- [`<sv-grid>` reference](./sv-grid.md) - every property, attribute and event.\n- [Shadow DOM](./shadow-dom.md) - for pages whose CSS you do not control.\n- [TypeScript](./typescript.md) - typing the raw element, if you use it directly.\n- [Limitations](./limitations.md) - what cannot cross the boundary.\n"
|
|
7639
7639
|
},
|
|
7640
7640
|
{
|
|
7641
7641
|
"slug": "help/web-components/limitations",
|
|
@@ -7656,14 +7656,14 @@ export const docs = [
|
|
|
7656
7656
|
"path": "docs/help/web-components/react.md",
|
|
7657
7657
|
"title": "SvGrid in React",
|
|
7658
7658
|
"section": "help/web-components",
|
|
7659
|
-
"markdown": "# SvGrid in React\n\n```bash\nnpm install @svgrid/grid-wc\n```\n\n```tsx\nimport { SvGrid } from '@svgrid/grid-wc/react'\n\nexport default function Screen() {\n return (\n <div style={{ height: 480 }}>\n <SvGrid\n data={rows}\n columns={columns}\n sortable\n filterable\n editable\n onCellValueChange={(e) => save(e)}\n />\n </div>\n )\n}\n```\n\nThat is the whole integration. The component is generated from `<SvGrid>`'s\nown types, so all 127 properties and 36 events are typed props, and it works the\nsame on React 17, 18 and 19.\n\n## Server rendering (Next.js, TanStack Start, Remix)\n\nThe grid is a custom element, so a server has nothing to render for it. Load\nit in the browser: the `DataGrid` component in\n[SvGrid in Lovable](../lovable.md#why-the-grid-waits-for-the-browser) does it\nwith `lazy` and a mounted flag, and works in any server-rendered React app.\n`@svgrid/grid-wc` 3.0.35 and earlier threw `customElements is not defined`\nwhen a server imported it; later releases import cleanly there and render a\nplain `<sv-grid>` tag that upgrades on hydration.\n\n## Why the wrapper rather than the raw element\n\n- **React 18 and earlier stringify object props onto attributes.**\n `columns={cols}` becomes the attribute `\"[object Object]\"` and the grid\n renders empty, with no error. React 19 assigns them as properties; the wrapper\n does so on every version.\n- **The element renders before your props arrive.** Both React and Angular\n create the element first and assign properties in an effect, so the grid\n mounts once with nothing. The wrapper handles that ordering.\n- **`apiready` fires once, during that first mount** - before React can bind a\n listener, so a raw `addEventListener` misses it entirely. The wrapper replays\n it.\n- Typed props and handlers, instead of `el.columns = ...` on an `HTMLElement`.\n\n## Shadow DOM\n\n`shadow` picks the style-isolated element. Same props, same events; the extra\nbundle loads only when you ask for it.\n\n```tsx\n<SvGrid shadow data={rows} columns={columns} />\n```\n\n## The imperative api\n\n```tsx\nimport { useRef } from 'react'\nimport { SvGrid, type SvGridHandle } from '@svgrid/grid-wc/react'\n\nexport function Screen() {\n const grid = useRef<SvGridHandle>(null)\n\n const exportCsv = () => {\n // `api` is the grid api; `element` is the host custom element.\n ;(grid.current?.api as { exportCsv(): void } | undefined)?.exportCsv()\n }\n\n return <SvGrid ref={grid} data={rows} columns={columns} />\n}\n```\n\n<!-- BEGIN generated examples - packages/grid-wc/scripts/sync-example-docs.mjs -->\n\n## Examples\n\nNine complete apps. Each one is **running on this page** - sort it,\nfilter it, edit a cell - above the code that produces it. **Open in StackBlitz**\nthen boots the whole project, editable, with no local install and nothing to\nconfigure, and every one is compiled in this repository's CI, so what you open\nis what works.\n\nThey all share the same typed `data.ts`, so the only thing that changes\nbetween recipes is the grid.\n\nA note on the previews: the grid you can touch is driven by a Svelte host\nrather than a React one. It is not a recording or a\nlookalike - it renders through the same component `<sv-grid>` renders, with\nthe same data and the same props as the listing below it, so the only thing\nthat differs from the React app is who sets those props. Click **Open in\nStackBlitz** to run the real React one.\n\n### A first grid\n\nRows, columns, and the two features almost every table wants.\n\n<div data-docs-mirror=\"basic\" data-height=\"420\"></div>\n\n<div data-docs-sandbox=\"react:basic\" data-title=\"A first grid\"></div>\n\n```tsx {nocheck}\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * The smallest useful grid: rows, columns, and the two features almost every\n * table wants. `data` and `columns` are arrays, so they cross as properties -\n * the wrapper handles that on every React version.\n */\nexport default function App() {\n return (\n <div style={{ height: '100%', padding: 16 }}>\n <SvGrid data={people} columns={columns} sortable filterable />\n </div>\n )\n}\n```\n\n### Sorting and filtering\n\nA filter row under the headers, multi-column sort, and the current sort read back into your own state.\n\n<div data-docs-mirror=\"sorting-filtering\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:sorting-filtering\" data-title=\"Sorting and filtering\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * A filter row under the headers, multi-column sort, and the current sort read\n * back into React state. `onSortingChange` hands you the same array the grid\n * holds, so it can drive your own UI.\n */\nexport default function App() {\n const [sorting, setSorting] = useState<Array<{ id: string; desc: boolean }>>([])\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <p style={{ margin: 0, font: '13px system-ui', color: '#64748b' }}>\n Sorted by:{' '}\n {sorting.length === 0\n ? 'nothing yet - click a header, then shift-click a second one'\n : sorting.map((s) => `${s.id} ${s.desc ? 'desc' : 'asc'}`).join(', ')}\n </p>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={people}\n columns={columns}\n sortable\n filterable\n showFilterRow\n onSortingChange={setSorting}\n />\n </div>\n </div>\n )\n}\n```\n\n### Editing and saving\n\nInline editing, with each committed edit arriving through `cellvaluechange`. Swap the local update for your save call.\n\n<div data-docs-mirror=\"editing\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:editing\" data-title=\"Editing and saving\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns, type Person } from '../data'\n\n/**\n * Inline editing, with the change written back into React state.\n *\n * `cellvaluechange` fires once per committed edit and its detail is typed, so\n * `rowIndex`, `columnId` and `newValue` come through without a cast. Replace\n * the setState with your own save call.\n */\nexport default function App() {\n const [rows, setRows] = useState<Person[]>(people)\n const [log, setLog] = useState<string[]>([])\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <p style={{ margin: 0, font: '13px system-ui', color: '#64748b' }}>\n Double-click a Name or Amount cell. Last edits: {log.slice(-3).join(' · ') || 'none yet'}\n </p>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={rows}\n columns={columns.map((c) =>\n c.id === 'name' || c.id === 'amount' ? { ...c, editable: true } : c,\n )}\n sortable\n filterable\n editable\n onCellValueChange={(e) => {\n setRows((prev) =>\n prev.map((row, i) => (i === e.rowIndex ? { ...row, [e.columnId]: e.newValue } : row)),\n )\n setLog((prev) => [...prev, `${e.columnId} = ${String(e.newValue)}`])\n }}\n />\n </div>\n </div>\n )\n}\n```\n\n### Row selection\n\nCheckboxes, with the selected rows handed straight to you - both the selection map and the rows themselves.\n\n<div data-docs-mirror=\"selection\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:selection\" data-title=\"Row selection\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns, type Person } from '../data'\n\n/**\n * Row checkboxes, with the selected rows handed to React so you can act on\n * them. `rowselectionchange` carries both the selection map and the rows\n * themselves, so you rarely need to look anything up.\n */\nexport default function App() {\n const [selected, setSelected] = useState<Person[]>([])\n const total = selected.reduce((sum, r) => sum + r.amount, 0)\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <div style={{ font: '13px system-ui', color: '#64748b' }}>\n {selected.length === 0\n ? 'Tick some rows to total them'\n : `${selected.length} selected · ${total.toLocaleString('en-US', { style: 'currency', currency: 'USD', maximumFractionDigits: 0 })}`}\n </div>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={people}\n columns={columns}\n sortable\n filterable\n showRowSelection\n onRowSelectionChange={(e) => setSelected(e.rows as Person[])}\n />\n </div>\n </div>\n )\n}\n```\n\n### Grouping and totals\n\nGroup by one or two columns with an aggregate in the group row. `groupBy` is an array, so it is one of the props that can only be a property.\n\n<div data-docs-mirror=\"grouping\" data-height=\"470\"></div>\n\n<div data-docs-sandbox=\"react:grouping\" data-title=\"Grouping and totals\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * Grouping by one or two columns, with an aggregate in the group row.\n *\n * `groupBy` is an array, so it is one of the props that can only be a\n * property - which is the whole reason the React wrapper exists.\n */\nexport default function App() {\n const [groupBy, setGroupBy] = useState<string[]>(['team'])\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <div style={{ display: 'flex', gap: 8, font: '13px system-ui' }}>\n {[['team'], ['country'], ['team', 'country'], []].map((g) => (\n <button\n key={g.join('+') || 'none'}\n onClick={() => setGroupBy(g)}\n style={{\n padding: '4px 10px',\n borderRadius: 6,\n border: '1px solid #cbd5e1',\n background: groupBy.join() === g.join() ? '#e2e8f0' : '#fff',\n cursor: 'pointer',\n }}\n >\n {g.join(' + ') || 'No grouping'}\n </button>\n ))}\n </div>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={people}\n columns={columns.map((c) => (c.id === 'amount' ? { ...c, aggregate: 'sum' } : c))}\n sortable\n filterable\n groupable\n groupBy={groupBy}\n groupFooters\n />\n </div>\n </div>\n )\n}\n```\n\n### Pagination\n\nClient-side paging. `pageSize` is the INITIAL page size, read once at mount.\n\n<div data-docs-mirror=\"pagination\" data-height=\"440\"></div>\n\n<div data-docs-sandbox=\"react:pagination\" data-title=\"Pagination\"></div>\n\n```tsx {nocheck}\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * Client-side paging. `pageSize` is read once at mount - it is the INITIAL\n * page size - so change pages through the footer or the grid api rather than\n * by reassigning the prop.\n */\nexport default function App() {\n return (\n <div style={{ height: '100%', padding: 16 }}>\n <SvGrid\n data={people}\n columns={columns}\n sortable\n filterable\n pageable\n pageSize={25}\n pageSizeOptions={[10, 25, 50, 100]}\n paginationPosition=\"bottom\"\n />\n </div>\n )\n}\n```\n\n### Server-side data\n\nThe grid renders the page you hand it and tells you when the user wants another. `externalSort` and `externalPagination` stop it doing the work locally; `rowCount` is how it knows how many pages exist.\n\n<div data-docs-mirror=\"server-data\" data-height=\"440\"></div>\n\n<div data-docs-sandbox=\"react:server-data\" data-title=\"Server-side data\"></div>\n\n```tsx {nocheck}\nimport { useEffect, useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns, type Person } from '../data'\n\ntype Query = { page: number; sort: Array<{ id: string; desc: boolean }> }\n\n/**\n * Server-side data: the grid renders whatever page you hand it and tells you\n * when the user wants a different one.\n *\n * `externalSort` and `externalPagination` stop the grid doing the work\n * locally; `rowCount` is how it knows how many pages exist. `fetchPage` here\n * stands in for your API call.\n */\nconst PAGE_SIZE = 25\n\nfunction fetchPage({ page, sort }: Query): Promise<{ rows: Person[]; total: number }> {\n // Pretend this is a network call.\n const sorted = [...people].sort((a, b) => {\n for (const s of sort) {\n const av = a[s.id as keyof Person]\n const bv = b[s.id as keyof Person]\n if (av === bv) continue\n return (av > bv ? 1 : -1) * (s.desc ? -1 : 1)\n }\n return 0\n })\n const start = page * PAGE_SIZE\n return new Promise((resolve) =>\n setTimeout(() => resolve({ rows: sorted.slice(start, start + PAGE_SIZE), total: sorted.length }), 250),\n )\n}\n\nexport default function App() {\n const [query, setQuery] = useState<Query>({ page: 0, sort: [] })\n const [rows, setRows] = useState<Person[]>([])\n const [total, setTotal] = useState(0)\n const [loading, setLoading] = useState(true)\n\n useEffect(() => {\n let cancelled = false\n setLoading(true)\n fetchPage(query).then((res) => {\n if (cancelled) return\n setRows(res.rows)\n setTotal(res.total)\n setLoading(false)\n })\n return () => {\n cancelled = true\n }\n }, [query])\n\n return (\n <div style={{ height: '100%', padding: 16 }}>\n <SvGrid\n data={rows}\n columns={columns}\n loading={loading}\n sortable\n externalSort\n externalPagination\n pageable\n pageSize={PAGE_SIZE}\n rowCount={total}\n pageIndex={query.page}\n onSortingChange={(sort) => setQuery((q) => ({ ...q, sort, page: 0 }))}\n onPaginationChange={(p) => setQuery((q) => ({ ...q, page: (p as { pageIndex: number }).pageIndex }))}\n />\n </div>\n )\n}\n```\n\n### Theming\n\nThe `--sg-*` custom properties. Ordinary CSS custom properties, so they cascade from any ancestor - which is why they also reach inside `<sv-grid-shadow>`.\n\n<div data-docs-mirror=\"theming\" data-height=\"470\"></div>\n\n<div data-docs-sandbox=\"react:theming\" data-title=\"Theming\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * Theming through `--sg-*` custom properties.\n *\n * They are ordinary CSS custom properties, so they cascade: set them on any\n * ancestor and the grid inherits. That is also why they reach into\n * `<sv-grid-shadow>` - inheritance crosses a shadow boundary.\n */\nconst THEMES = {\n Light: {},\n Dark: {\n '--sg-bg': '#0b1220',\n '--sg-fg': '#e2e8f0',\n '--sg-border': '#1e293b',\n '--sg-header-bg': '#111a2e',\n '--sg-row-hover': '#111a2e',\n },\n Warm: {\n '--sg-bg': '#fffaf5',\n '--sg-fg': '#42302a',\n '--sg-border': '#f0dcc9',\n '--sg-header-bg': '#fdf1e4',\n '--sg-accent': '#c2410c',\n },\n} satisfies Record<string, Record<string, string>>\n\nexport default function App() {\n const [theme, setTheme] = useState<keyof typeof THEMES>('Light')\n\n return (\n <div\n style={{\n height: '100%',\n padding: 16,\n display: 'flex',\n flexDirection: 'column',\n gap: 12,\n ...THEMES[theme],\n }}\n >\n <div style={{ display: 'flex', gap: 8 }}>\n {(Object.keys(THEMES) as Array<keyof typeof THEMES>).map((name) => (\n <button\n key={name}\n onClick={() => setTheme(name)}\n style={{\n padding: '4px 10px',\n borderRadius: 6,\n border: '1px solid #cbd5e1',\n background: theme === name ? '#e2e8f0' : '#fff',\n cursor: 'pointer',\n }}\n >\n {name}\n </button>\n ))}\n </div>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid data={people} columns={columns} sortable filterable zebraRows />\n </div>\n </div>\n )\n}\n```\n\n### Excel export (Enterprise)\n\nThe paid pack from a non-Svelte host. `@svgrid/enterprise/export` is plain JavaScript, so it needs no Svelte in your build - the same goes for `/import`, `/print`, `/pivot` and `/license`. See [Enterprise features](./enterprise.md) for what those subpaths cover and what needs a Svelte-aware bundler.\n\n<div data-docs-mirror=\"enterprise\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:enterprise\" data-title=\"Excel export (Enterprise)\"></div>\n\n```tsx {nocheck}\nimport { useRef, useState } from 'react'\nimport { SvGrid, type SvGridHandle } from '@svgrid/grid-wc/react'\nimport { exportGrid } from '@svgrid/enterprise/export'\nimport { people, columns } from '../data'\n\n/**\n * Excel export from a React host.\n *\n * `@svgrid/enterprise/export` is plain JavaScript - no Svelte in your build -\n * so this works in any bundler. The same is true of `/import`, `/print`,\n * `/pivot` and `/license`. The Kanban and scheduler views are the exception:\n * they are Svelte components, so they need a Svelte-aware bundler.\n *\n * The api arrives on the handle once `apiready` has fired. It is typed\n * `unknown` there because the wrapper does not depend on the grid's types, so\n * the enterprise call needs a cast.\n */\nexport default function App() {\n const grid = useRef<SvGridHandle>(null)\n const [ready, setReady] = useState(false)\n const [busy, setBusy] = useState(false)\n\n async function exportXlsx() {\n if (!grid.current?.api) return\n setBusy(true)\n try {\n await exportGrid(grid.current.api as Parameters<typeof exportGrid>[0], {\n format: 'xlsx',\n filename: 'people',\n })\n } finally {\n setBusy(false)\n }\n }\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <button type=\"button\" onClick={exportXlsx} disabled={!ready || busy}>\n {busy ? 'Building…' : 'Export to Excel'}\n </button>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n ref={grid}\n data={people}\n columns={columns}\n sortable\n filterable\n onApiReady={() => setReady(true)}\n />\n </div>\n </div>\n )\n}\n```\n\n<!-- END generated examples -->\n\n## Rendering into cells\n\nYou cannot put a React component inside a cell: cell rendering is a Svelte\ncompile-time feature, and there is nothing to hand across the boundary. Column\n`format` options, `fieldFn` and HTML-string renderers cover badges, links and\nformatted values.\n\nColumn `format` and HTML-string renderers, which is what to reach for instead:\n\n<div data-docs-demo=\"10-custom-cells-and-themes\" data-height=\"480\"></div>\n\nIf a grid's cells must render your own components, use the Svelte component\ndirectly. See [limitations](./limitations.md).\n\n## Why it lives in `@svgrid/grid-wc`\n\nRather than a separate `@svgrid/react` package: one version to keep in step\nwith the element instead of two, and `react` is an OPTIONAL peer dependency, so\na plain-HTML consumer never installs React. The wrapper is a subpath import and\nabout 1.4 KB - it reuses the one element bundle rather than shipping a second\ncopy of the grid.\n\n## The raw element\n\n`<SvGrid>` wraps `<sv-grid>`, and nothing stops you using the element\ndirectly - it is the same grid, and the wrapper is a thin layer over it. You\nwould be taking on the property assignment, the event binding and the two\nordering problems the wrapper handles, so do it only if you have a reason to.\n\n[Quick start](./quick-start.md) covers the element, and the\n[reference](./sv-grid.md) lists every property, attribute and event.\n\n## See also\n\n- [All frameworks](./frameworks.md) - the same examples in Vue and Angular.\n- [`<sv-grid>` reference](./sv-grid.md) - every property, attribute and event.\n- [TypeScript](./typescript.md) - typing the element, if you use it directly.\n- [Limitations](./limitations.md) - what cannot cross the boundary.\n"
|
|
7659
|
+
"markdown": "# SvGrid in React\n\n```bash\nnpm install @svgrid/grid-wc\n```\n\n```tsx\nimport { SvGrid } from '@svgrid/grid-wc/react'\n\nexport default function Screen() {\n return (\n <div style={{ height: 480 }}>\n <SvGrid\n data={rows}\n columns={columns}\n sortable\n filterable\n editable\n onCellValueChange={(e) => save(e)}\n />\n </div>\n )\n}\n```\n\nThat is the whole integration. The component is generated from `<SvGrid>`'s\nown types, so all 128 properties and 36 events are typed props, and it works the\nsame on React 17, 18 and 19.\n\n## Server rendering (Next.js, TanStack Start, Remix)\n\nThe grid is a custom element, so a server has nothing to render for it. Load\nit in the browser: the `DataGrid` component in\n[SvGrid in Lovable](../lovable.md#why-the-grid-waits-for-the-browser) does it\nwith `lazy` and a mounted flag, and works in any server-rendered React app.\n`@svgrid/grid-wc` 3.0.35 and earlier threw `customElements is not defined`\nwhen a server imported it; later releases import cleanly there and render a\nplain `<sv-grid>` tag that upgrades on hydration.\n\n## Why the wrapper rather than the raw element\n\n- **React 18 and earlier stringify object props onto attributes.**\n `columns={cols}` becomes the attribute `\"[object Object]\"` and the grid\n renders empty, with no error. React 19 assigns them as properties; the wrapper\n does so on every version.\n- **The element renders before your props arrive.** Both React and Angular\n create the element first and assign properties in an effect, so the grid\n mounts once with nothing. The wrapper handles that ordering.\n- **`apiready` fires once, during that first mount** - before React can bind a\n listener, so a raw `addEventListener` misses it entirely. The wrapper replays\n it.\n- Typed props and handlers, instead of `el.columns = ...` on an `HTMLElement`.\n\n## Shadow DOM\n\n`shadow` picks the style-isolated element. Same props, same events; the extra\nbundle loads only when you ask for it.\n\n```tsx\n<SvGrid shadow data={rows} columns={columns} />\n```\n\n## The imperative api\n\n```tsx\nimport { useRef } from 'react'\nimport { SvGrid, type SvGridHandle } from '@svgrid/grid-wc/react'\n\nexport function Screen() {\n const grid = useRef<SvGridHandle>(null)\n\n const exportCsv = () => {\n // `api` is the grid api; `element` is the host custom element.\n ;(grid.current?.api as { exportCsv(): void } | undefined)?.exportCsv()\n }\n\n return <SvGrid ref={grid} data={rows} columns={columns} />\n}\n```\n\n<!-- BEGIN generated examples - packages/grid-wc/scripts/sync-example-docs.mjs -->\n\n## Examples\n\nNine complete apps. Each one is **running on this page** - sort it,\nfilter it, edit a cell - above the code that produces it. **Open in StackBlitz**\nthen boots the whole project, editable, with no local install and nothing to\nconfigure, and every one is compiled in this repository's CI, so what you open\nis what works.\n\nThey all share the same typed `data.ts`, so the only thing that changes\nbetween recipes is the grid.\n\nA note on the previews: the grid you can touch is driven by a Svelte host\nrather than a React one. It is not a recording or a\nlookalike - it renders through the same component `<sv-grid>` renders, with\nthe same data and the same props as the listing below it, so the only thing\nthat differs from the React app is who sets those props. Click **Open in\nStackBlitz** to run the real React one.\n\n### A first grid\n\nRows, columns, and the two features almost every table wants.\n\n<div data-docs-mirror=\"basic\" data-height=\"420\"></div>\n\n<div data-docs-sandbox=\"react:basic\" data-title=\"A first grid\"></div>\n\n```tsx {nocheck}\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * The smallest useful grid: rows, columns, and the two features almost every\n * table wants. `data` and `columns` are arrays, so they cross as properties -\n * the wrapper handles that on every React version.\n */\nexport default function App() {\n return (\n <div style={{ height: '100%', padding: 16 }}>\n <SvGrid data={people} columns={columns} sortable filterable />\n </div>\n )\n}\n```\n\n### Sorting and filtering\n\nA filter row under the headers, multi-column sort, and the current sort read back into your own state.\n\n<div data-docs-mirror=\"sorting-filtering\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:sorting-filtering\" data-title=\"Sorting and filtering\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * A filter row under the headers, multi-column sort, and the current sort read\n * back into React state. `onSortingChange` hands you the same array the grid\n * holds, so it can drive your own UI.\n */\nexport default function App() {\n const [sorting, setSorting] = useState<Array<{ id: string; desc: boolean }>>([])\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <p style={{ margin: 0, font: '13px system-ui', color: '#64748b' }}>\n Sorted by:{' '}\n {sorting.length === 0\n ? 'nothing yet - click a header, then shift-click a second one'\n : sorting.map((s) => `${s.id} ${s.desc ? 'desc' : 'asc'}`).join(', ')}\n </p>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={people}\n columns={columns}\n sortable\n filterable\n showFilterRow\n onSortingChange={setSorting}\n />\n </div>\n </div>\n )\n}\n```\n\n### Editing and saving\n\nInline editing, with each committed edit arriving through `cellvaluechange`. Swap the local update for your save call.\n\n<div data-docs-mirror=\"editing\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:editing\" data-title=\"Editing and saving\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns, type Person } from '../data'\n\n/**\n * Inline editing, with the change written back into React state.\n *\n * `cellvaluechange` fires once per committed edit and its detail is typed, so\n * `rowIndex`, `columnId` and `newValue` come through without a cast. Replace\n * the setState with your own save call.\n */\nexport default function App() {\n const [rows, setRows] = useState<Person[]>(people)\n const [log, setLog] = useState<string[]>([])\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <p style={{ margin: 0, font: '13px system-ui', color: '#64748b' }}>\n Double-click a Name or Amount cell. Last edits: {log.slice(-3).join(' · ') || 'none yet'}\n </p>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={rows}\n columns={columns.map((c) =>\n c.id === 'name' || c.id === 'amount' ? { ...c, editable: true } : c,\n )}\n sortable\n filterable\n editable\n onCellValueChange={(e) => {\n setRows((prev) =>\n prev.map((row, i) => (i === e.rowIndex ? { ...row, [e.columnId]: e.newValue } : row)),\n )\n setLog((prev) => [...prev, `${e.columnId} = ${String(e.newValue)}`])\n }}\n />\n </div>\n </div>\n )\n}\n```\n\n### Row selection\n\nCheckboxes, with the selected rows handed straight to you - both the selection map and the rows themselves.\n\n<div data-docs-mirror=\"selection\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:selection\" data-title=\"Row selection\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns, type Person } from '../data'\n\n/**\n * Row checkboxes, with the selected rows handed to React so you can act on\n * them. `rowselectionchange` carries both the selection map and the rows\n * themselves, so you rarely need to look anything up.\n */\nexport default function App() {\n const [selected, setSelected] = useState<Person[]>([])\n const total = selected.reduce((sum, r) => sum + r.amount, 0)\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <div style={{ font: '13px system-ui', color: '#64748b' }}>\n {selected.length === 0\n ? 'Tick some rows to total them'\n : `${selected.length} selected · ${total.toLocaleString('en-US', { style: 'currency', currency: 'USD', maximumFractionDigits: 0 })}`}\n </div>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={people}\n columns={columns}\n sortable\n filterable\n showRowSelection\n onRowSelectionChange={(e) => setSelected(e.rows as Person[])}\n />\n </div>\n </div>\n )\n}\n```\n\n### Grouping and totals\n\nGroup by one or two columns with an aggregate in the group row. `groupBy` is an array, so it is one of the props that can only be a property.\n\n<div data-docs-mirror=\"grouping\" data-height=\"470\"></div>\n\n<div data-docs-sandbox=\"react:grouping\" data-title=\"Grouping and totals\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * Grouping by one or two columns, with an aggregate in the group row.\n *\n * `groupBy` is an array, so it is one of the props that can only be a\n * property - which is the whole reason the React wrapper exists.\n */\nexport default function App() {\n const [groupBy, setGroupBy] = useState<string[]>(['team'])\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <div style={{ display: 'flex', gap: 8, font: '13px system-ui' }}>\n {[['team'], ['country'], ['team', 'country'], []].map((g) => (\n <button\n key={g.join('+') || 'none'}\n onClick={() => setGroupBy(g)}\n style={{\n padding: '4px 10px',\n borderRadius: 6,\n border: '1px solid #cbd5e1',\n background: groupBy.join() === g.join() ? '#e2e8f0' : '#fff',\n cursor: 'pointer',\n }}\n >\n {g.join(' + ') || 'No grouping'}\n </button>\n ))}\n </div>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n data={people}\n columns={columns.map((c) => (c.id === 'amount' ? { ...c, aggregate: 'sum' } : c))}\n sortable\n filterable\n groupable\n groupBy={groupBy}\n groupFooters\n />\n </div>\n </div>\n )\n}\n```\n\n### Pagination\n\nClient-side paging. `pageSize` is the INITIAL page size, read once at mount.\n\n<div data-docs-mirror=\"pagination\" data-height=\"440\"></div>\n\n<div data-docs-sandbox=\"react:pagination\" data-title=\"Pagination\"></div>\n\n```tsx {nocheck}\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * Client-side paging. `pageSize` is read once at mount - it is the INITIAL\n * page size - so change pages through the footer or the grid api rather than\n * by reassigning the prop.\n */\nexport default function App() {\n return (\n <div style={{ height: '100%', padding: 16 }}>\n <SvGrid\n data={people}\n columns={columns}\n sortable\n filterable\n pageable\n pageSize={25}\n pageSizeOptions={[10, 25, 50, 100]}\n paginationPosition=\"bottom\"\n />\n </div>\n )\n}\n```\n\n### Server-side data\n\nThe grid renders the page you hand it and tells you when the user wants another. `externalSort` and `externalPagination` stop it doing the work locally; `rowCount` is how it knows how many pages exist.\n\n<div data-docs-mirror=\"server-data\" data-height=\"440\"></div>\n\n<div data-docs-sandbox=\"react:server-data\" data-title=\"Server-side data\"></div>\n\n```tsx {nocheck}\nimport { useEffect, useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns, type Person } from '../data'\n\ntype Query = { page: number; sort: Array<{ id: string; desc: boolean }> }\n\n/**\n * Server-side data: the grid renders whatever page you hand it and tells you\n * when the user wants a different one.\n *\n * `externalSort` and `externalPagination` stop the grid doing the work\n * locally; `rowCount` is how it knows how many pages exist. `fetchPage` here\n * stands in for your API call.\n */\nconst PAGE_SIZE = 25\n\nfunction fetchPage({ page, sort }: Query): Promise<{ rows: Person[]; total: number }> {\n // Pretend this is a network call.\n const sorted = [...people].sort((a, b) => {\n for (const s of sort) {\n const av = a[s.id as keyof Person]\n const bv = b[s.id as keyof Person]\n if (av === bv) continue\n return (av > bv ? 1 : -1) * (s.desc ? -1 : 1)\n }\n return 0\n })\n const start = page * PAGE_SIZE\n return new Promise((resolve) =>\n setTimeout(() => resolve({ rows: sorted.slice(start, start + PAGE_SIZE), total: sorted.length }), 250),\n )\n}\n\nexport default function App() {\n const [query, setQuery] = useState<Query>({ page: 0, sort: [] })\n const [rows, setRows] = useState<Person[]>([])\n const [total, setTotal] = useState(0)\n const [loading, setLoading] = useState(true)\n\n useEffect(() => {\n let cancelled = false\n setLoading(true)\n fetchPage(query).then((res) => {\n if (cancelled) return\n setRows(res.rows)\n setTotal(res.total)\n setLoading(false)\n })\n return () => {\n cancelled = true\n }\n }, [query])\n\n return (\n <div style={{ height: '100%', padding: 16 }}>\n <SvGrid\n data={rows}\n columns={columns}\n loading={loading}\n sortable\n externalSort\n externalPagination\n pageable\n pageSize={PAGE_SIZE}\n rowCount={total}\n pageIndex={query.page}\n onSortingChange={(sort) => setQuery((q) => ({ ...q, sort, page: 0 }))}\n onPaginationChange={(p) => setQuery((q) => ({ ...q, page: (p as { pageIndex: number }).pageIndex }))}\n />\n </div>\n )\n}\n```\n\n### Theming\n\nThe `--sg-*` custom properties. Ordinary CSS custom properties, so they cascade from any ancestor - which is why they also reach inside `<sv-grid-shadow>`.\n\n<div data-docs-mirror=\"theming\" data-height=\"470\"></div>\n\n<div data-docs-sandbox=\"react:theming\" data-title=\"Theming\"></div>\n\n```tsx {nocheck}\nimport { useState } from 'react'\nimport { SvGrid } from '@svgrid/grid-wc/react'\nimport { people, columns } from '../data'\n\n/**\n * Theming through `--sg-*` custom properties.\n *\n * They are ordinary CSS custom properties, so they cascade: set them on any\n * ancestor and the grid inherits. That is also why they reach into\n * `<sv-grid-shadow>` - inheritance crosses a shadow boundary.\n */\nconst THEMES = {\n Light: {},\n Dark: {\n '--sg-bg': '#0b1220',\n '--sg-fg': '#e2e8f0',\n '--sg-border': '#1e293b',\n '--sg-header-bg': '#111a2e',\n '--sg-row-hover': '#111a2e',\n },\n Warm: {\n '--sg-bg': '#fffaf5',\n '--sg-fg': '#42302a',\n '--sg-border': '#f0dcc9',\n '--sg-header-bg': '#fdf1e4',\n '--sg-accent': '#c2410c',\n },\n} satisfies Record<string, Record<string, string>>\n\nexport default function App() {\n const [theme, setTheme] = useState<keyof typeof THEMES>('Light')\n\n return (\n <div\n style={{\n height: '100%',\n padding: 16,\n display: 'flex',\n flexDirection: 'column',\n gap: 12,\n ...THEMES[theme],\n }}\n >\n <div style={{ display: 'flex', gap: 8 }}>\n {(Object.keys(THEMES) as Array<keyof typeof THEMES>).map((name) => (\n <button\n key={name}\n onClick={() => setTheme(name)}\n style={{\n padding: '4px 10px',\n borderRadius: 6,\n border: '1px solid #cbd5e1',\n background: theme === name ? '#e2e8f0' : '#fff',\n cursor: 'pointer',\n }}\n >\n {name}\n </button>\n ))}\n </div>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid data={people} columns={columns} sortable filterable zebraRows />\n </div>\n </div>\n )\n}\n```\n\n### Excel export (Enterprise)\n\nThe paid pack from a non-Svelte host. `@svgrid/enterprise/export` is plain JavaScript, so it needs no Svelte in your build - the same goes for `/import`, `/print`, `/pivot` and `/license`. See [Enterprise features](./enterprise.md) for what those subpaths cover and what needs a Svelte-aware bundler.\n\n<div data-docs-mirror=\"enterprise\" data-height=\"460\"></div>\n\n<div data-docs-sandbox=\"react:enterprise\" data-title=\"Excel export (Enterprise)\"></div>\n\n```tsx {nocheck}\nimport { useRef, useState } from 'react'\nimport { SvGrid, type SvGridHandle } from '@svgrid/grid-wc/react'\nimport { exportGrid } from '@svgrid/enterprise/export'\nimport { people, columns } from '../data'\n\n/**\n * Excel export from a React host.\n *\n * `@svgrid/enterprise/export` is plain JavaScript - no Svelte in your build -\n * so this works in any bundler. The same is true of `/import`, `/print`,\n * `/pivot` and `/license`. The Kanban and scheduler views are the exception:\n * they are Svelte components, so they need a Svelte-aware bundler.\n *\n * The api arrives on the handle once `apiready` has fired. It is typed\n * `unknown` there because the wrapper does not depend on the grid's types, so\n * the enterprise call needs a cast.\n */\nexport default function App() {\n const grid = useRef<SvGridHandle>(null)\n const [ready, setReady] = useState(false)\n const [busy, setBusy] = useState(false)\n\n async function exportXlsx() {\n if (!grid.current?.api) return\n setBusy(true)\n try {\n await exportGrid(grid.current.api as Parameters<typeof exportGrid>[0], {\n format: 'xlsx',\n filename: 'people',\n })\n } finally {\n setBusy(false)\n }\n }\n\n return (\n <div style={{ height: '100%', padding: 16, display: 'flex', flexDirection: 'column', gap: 12 }}>\n <button type=\"button\" onClick={exportXlsx} disabled={!ready || busy}>\n {busy ? 'Building…' : 'Export to Excel'}\n </button>\n <div style={{ flex: 1, minHeight: 0 }}>\n <SvGrid\n ref={grid}\n data={people}\n columns={columns}\n sortable\n filterable\n onApiReady={() => setReady(true)}\n />\n </div>\n </div>\n )\n}\n```\n\n<!-- END generated examples -->\n\n## Rendering into cells\n\nYou cannot put a React component inside a cell: cell rendering is a Svelte\ncompile-time feature, and there is nothing to hand across the boundary. Column\n`format` options, `fieldFn` and HTML-string renderers cover badges, links and\nformatted values.\n\nColumn `format` and HTML-string renderers, which is what to reach for instead:\n\n<div data-docs-demo=\"10-custom-cells-and-themes\" data-height=\"480\"></div>\n\nIf a grid's cells must render your own components, use the Svelte component\ndirectly. See [limitations](./limitations.md).\n\n## Why it lives in `@svgrid/grid-wc`\n\nRather than a separate `@svgrid/react` package: one version to keep in step\nwith the element instead of two, and `react` is an OPTIONAL peer dependency, so\na plain-HTML consumer never installs React. The wrapper is a subpath import and\nabout 1.4 KB - it reuses the one element bundle rather than shipping a second\ncopy of the grid.\n\n## The raw element\n\n`<SvGrid>` wraps `<sv-grid>`, and nothing stops you using the element\ndirectly - it is the same grid, and the wrapper is a thin layer over it. You\nwould be taking on the property assignment, the event binding and the two\nordering problems the wrapper handles, so do it only if you have a reason to.\n\n[Quick start](./quick-start.md) covers the element, and the\n[reference](./sv-grid.md) lists every property, attribute and event.\n\n## See also\n\n- [All frameworks](./frameworks.md) - the same examples in Vue and Angular.\n- [`<sv-grid>` reference](./sv-grid.md) - every property, attribute and event.\n- [TypeScript](./typescript.md) - typing the element, if you use it directly.\n- [Limitations](./limitations.md) - what cannot cross the boundary.\n"
|
|
7660
7660
|
},
|
|
7661
7661
|
{
|
|
7662
7662
|
"slug": "help/web-components/shadow-dom",
|
|
7663
7663
|
"path": "docs/help/web-components/shadow-dom.md",
|
|
7664
7664
|
"title": "Shadow DOM: <sv-grid-shadow>",
|
|
7665
7665
|
"section": "help/web-components",
|
|
7666
|
-
"markdown": "# Shadow DOM: `<sv-grid-shadow>`\n\nTwo elements ship, and which one you want is a styling decision:\n\n| Element | Renders in | Page CSS | Use when |\n| --- | --- | --- | --- |\n| `<sv-grid>` | the light DOM | applies normally | Almost always - a data grid usually wants to inherit your app's theme. |\n| `<sv-grid-shadow>` | an open shadow root | **cannot reach the grid** | You are embedding in a page whose CSS you do not control, or shipping into someone else's site. |\n\nThey are two elements rather than one with a `shadow` attribute because Svelte's\n`customElement.shadow` is resolved when the component is COMPILED. No runtime\nflag can switch it, so no attribute can either.\n\n```html\n<script type=\"module\" src=\"https://unpkg.com/@svgrid/grid-wc/dist/shadow/sv-grid-shadow-element.js\"></script>\n\n<sv-grid-shadow id=\"grid\" sortable filterable style=\"display:block;height:420px\"></sv-grid-shadow>\n<script type=\"module\">\n const grid = document.getElementById('grid')\n grid.columns = [{ field: 'name', header: 'Name' }, { field: 'city', header: 'City' }]\n grid.data = [{ name: 'Ada', city: 'London' }, { name: 'Linus', city: 'Helsinki' }]\n</script>\n```\n\nEverything else is identical: the same
|
|
7666
|
+
"markdown": "# Shadow DOM: `<sv-grid-shadow>`\n\nTwo elements ship, and which one you want is a styling decision:\n\n| Element | Renders in | Page CSS | Use when |\n| --- | --- | --- | --- |\n| `<sv-grid>` | the light DOM | applies normally | Almost always - a data grid usually wants to inherit your app's theme. |\n| `<sv-grid-shadow>` | an open shadow root | **cannot reach the grid** | You are embedding in a page whose CSS you do not control, or shipping into someone else's site. |\n\nThey are two elements rather than one with a `shadow` attribute because Svelte's\n`customElement.shadow` is resolved when the component is COMPILED. No runtime\nflag can switch it, so no attribute can either.\n\n```html\n<script type=\"module\" src=\"https://unpkg.com/@svgrid/grid-wc/dist/shadow/sv-grid-shadow-element.js\"></script>\n\n<sv-grid-shadow id=\"grid\" sortable filterable style=\"display:block;height:420px\"></sv-grid-shadow>\n<script type=\"module\">\n const grid = document.getElementById('grid')\n grid.columns = [{ field: 'name', header: 'Name' }, { field: 'city', header: 'City' }]\n grid.data = [{ name: 'Ada', city: 'London' }, { name: 'Linus', city: 'Helsinki' }]\n</script>\n```\n\nEverything else is identical: the same 128 properties, the same 87 attributes,\nthe same 36 events. Events are dispatched `composed: true`, so\n`addEventListener` on the host works exactly as it does on `<sv-grid>`.\n\n\n## What the shadow root does and does not isolate\n\nTheming with `--sg-*` tokens, which reach into the shadow root by inheritance.\n\n<div data-docs-demo=\"10-custom-cells-and-themes\" data-height=\"500\"></div>\n\nThe root is **open**, never closed. A closed root leaves `el.shadowRoot` null,\nwhich would stop you styling, querying, or testing your own grid - so it is not\noffered.\n\nIsolation is one-directional, and worth being precise about:\n\n- **Page CSS cannot reach the grid.** A page rule like\n `table td { background: fuchsia }` hits `<sv-grid>` and stops at\n `<sv-grid-shadow>`'s boundary. That is the point of the element.\n- **The grid's CSS is still in your page.** About twenty overlay surfaces - the\n cell dropdown, the date picker, tooltips, toasts, modals - portal to\n `document.body` deliberately, so they escape every ancestor `overflow` and\n clip. Those land outside the shadow root, so the bundle injects its stylesheet\n into `document.head` as well as adopting it into the root. Every rule is\n scoped to an `.sv-grid-*` class, so it does not style your page, but it is\n present in it.\n- **Styles arrive with the code that needs them.** The entry carries the\n grid's own sheet; a lazy chunk (the chart, the date pickers, the menus)\n carries the styles of the components inside it and adds them to the page\n and to every open root when it loads. A page that never charts never\n downloads the chart's styles.\n\n## Theming\n\n`--sg-*` tokens work in both elements, unchanged:\n\n```css\nsv-grid, sv-grid-shadow {\n --sg-bg: #fff;\n --sg-header-bg: #f8fafc;\n}\n```\n\nA theme stylesheet works too, including its dark variant, even though its\nselectors are `:root` and `:root[data-theme='dark']` and neither can MATCH\ninside a shadow tree. Custom properties are *inherited* properties, and\ninheritance crosses a shadow boundary - so the values land on the host and are\ninherited by everything in the root. Verified in a browser rather than reasoned\nabout: it was assumed to be broken for a while, and it is not.\n\n\n## Constraints\n\nSelection, clipboard and the menus that portal out of the root - all identical inside a shadow tree.\n\n<div data-docs-demo=\"04-selection-copy-paste\" data-height=\"460\"></div>\n\n- **The root is resolved on mount.** Moving a live `<sv-grid-shadow>` into a\n different document needs a fresh element, not a reparent.\n- **Do not give the host a `transform`, `filter`, or `contain`.** Any of those\n makes it a containing block for fixed positioning, and the grid's menus -\n which are `position: fixed` - would anchor to the host instead of the\n viewport.\n- **Closed roots are unsupported**, for the reason above.\n\n\n## See also\n\n- [Quick start](./quick-start.md)\n- [`<sv-grid>` reference](./sv-grid.md)\n- [Limitations](./limitations.md)\n"
|
|
7667
7667
|
},
|
|
7668
7668
|
{
|
|
7669
7669
|
"slug": "help/web-components/sv-base",
|
|
@@ -7684,7 +7684,7 @@ export const docs = [
|
|
|
7684
7684
|
"path": "docs/help/web-components/sv-grid.md",
|
|
7685
7685
|
"title": "<sv-grid> reference",
|
|
7686
7686
|
"section": "help/web-components",
|
|
7687
|
-
"markdown": "# `<sv-grid>` reference\n\nEvery property, attribute and event of the custom element.\n\n**This page is generated** from `<SvGrid>`'s own `Props` type by\n`packages/grid-wc/scripts/generate-surface.mjs`, and CI fails if it drifts. The\nelement used to declare 7 props and 2 events by hand while the docs claimed\n\"grouping, sorting, pagination all come along\" - a hand-written table is how\nthat happens.\n\n## Attributes vs properties\n\n`groupable` is an attribute; `groupBy` is an array, so it is property-only. This grid uses both.\n\n<div data-docs-demo=\"07-grouping-aggregation\" data-height=\"480\"></div>\n\nThe distinction matters more here than anywhere else in the API:\n\n- **An attribute is a string.** Primitives (`boolean`, `number`, `string`) can\n be written in HTML: `<sv-grid page-size=\"25\" show-row-numbers>`.\n- **Arrays, objects and functions cannot.** `columns='[object Object]'` is not\n a thing. Assign them in script: `el.columns = [...]`.\n\nBoth work through the property, so `el.pageSize = 25` is equally valid. The\nattribute is the extra convenience, offered only where it can work.\n\n```html\n<sv-grid id=\"grid\" sortable filterable page-size=\"25\" row-height=\"32\"></sv-grid>\n<script type=\"module\">\n const grid = document.getElementById('grid')\n grid.columns = [{ field: 'name', header: 'Name' }] // property: an array\n grid.data = rows // property: an array\n</script>\n```\n\n<!-- BEGIN generated reference - packages/grid-wc/scripts/generate-surface.mjs -->\n\n### Attributes (86)\n\nPrimitives, so they work in plain HTML as well as through a property.\n\n| Attribute | Property | Type |\n| --- | --- | --- |\n| `pivot-mode` | `pivotMode` | `boolean` |\n| `context-menu` | `contextMenu` | `boolean \\| ReadonlyArray<ContextMenuItem<TData>>` |\n| `selection-bar` | `selectionBar` | `\\| boolean \\| ReadonlyArray<SelectionBarAction<TData> \\| SelectionBarBuiltin> \\| SelectionB...` |\n| `row-adder` | `rowAdder` | `boolean \\| RowAdderConfig<TData>` |\n| `column-adder` | `columnAdder` | `boolean \\| ColumnAdderConfig` |\n| `field-menu` | `fieldMenu` | `boolean` |\n| `expand-rows` | `expandRows` | `boolean` |\n| `pin-splitter` | `pinSplitter` | `boolean` |\n| `primary-field` | `primaryField` | `string` |\n| `sortable` | `sortable` | `boolean` |\n| `filterable` | `filterable` | `boolean` |\n| `editable` | `editable` | `boolean` |\n| `groupable` | `groupable` | `boolean` |\n| `group-footers` | `groupFooters` | `boolean` |\n| `grand-total-row` | `grandTotalRow` | `boolean` |\n| `group-display-mode` | `groupDisplayMode` | `GroupDisplayType` |\n| `auto-group-column-header` | `autoGroupColumnHeader` | `string` |\n| `auto-group-column-width` | `autoGroupColumnWidth` | `number` |\n| `pageable` | `pageable` | `boolean` |\n| `loading` | `loading` | `boolean` |\n| `loading-overlay` | `loadingOverlay` | `boolean` |\n| `loading-skeleton-rows` | `loadingSkeletonRows` | `number` |\n| `error` | `error` | `string \\| null` |\n| `empty-message` | `emptyMessage` | `string` |\n| `grid-label` | `gridLabel` | `string` |\n| `show-global-filter` | `showGlobalFilter` | `boolean` |\n| `show-column-filters` | `showColumnFilters` | `boolean` |\n| `filter-mode` | `filterMode` | `\"row\" \\| \"menu\" \\| \"global\" \\| \"none\"` |\n| `show-grouping-controls` | `showGroupingControls` | `boolean` |\n| `show-row-selection` | `showRowSelection` | `boolean` |\n| `show-pagination` | `showPagination` | `boolean` |\n| `page-size` | `pageSize` | `number` |\n| `pagination-position` | `paginationPosition` | `'top' \\| 'bottom' \\| 'both'` |\n| `external-pagination` | `externalPagination` | `boolean` |\n| `row-count` | `rowCount` | `number` |\n| `page-index` | `pageIndex` | `number` |\n| `virtualization` | `virtualization` | `boolean` |\n| `row-height` | `rowHeight` | `number \\| ((rowIndex: number) => number)` |\n| `auto-row-height` | `autoRowHeight` | `boolean` |\n| `row-resize` | `rowResize` | `boolean` |\n| `header-height` | `headerHeight` | `number` |\n| `overscan` | `overscan` | `number` |\n| `container-height` | `containerHeight` | `number \\| string` |\n| `column-virtualization` | `columnVirtualization` | `boolean` |\n| `column-overscan` | `columnOverscan` | `number` |\n| `column-width` | `columnWidth` | `number` |\n| `fit-columns` | `fitColumns` | `boolean` |\n| `column-resize` | `columnResize` | `boolean` |\n| `responsive` | `responsive` | `boolean \\| { breakpoint?: number }` |\n| `show-filter-menu` | `showFilterMenu` | `boolean` |\n| `show-filter-row` | `showFilterRow` | `boolean` |\n| `enable-cell-selection` | `enableCellSelection` | `boolean` |\n| `move-cells` | `moveCells` | `boolean` |\n| `enable-row-hover` | `enableRowHover` | `boolean` |\n| `copy-headers-to-clipboard` | `copyHeadersToClipboard` | `boolean` |\n| `hold-rows-on-write` | `holdRowsOnWrite` | `boolean` |\n| `enable-inline-editing` | `enableInlineEditing` | `boolean` |\n| `edit-on-second-click` | `editOnSecondClick` | `boolean` |\n| `full-row-editing` | `fullRowEditing` | `boolean` |\n| `enable-row-summaries` | `enableRowSummaries` | `boolean` |\n| `summary` | `summary` | `boolean` |\n| `status-bar` | `statusBar` | `\\| boolean \\| { ... }` |\n| `tool-panel` | `toolPanel` | `boolean` |\n| `charting` | `charting` | `boolean \\| ChartingConfig<TData>` |\n| `column-menu-tabs` | `columnMenuTabs` | `boolean` |\n| `tool-panel-default-open` | `toolPanelDefaultOpen` | `boolean` |\n| `tool-panel-default-tab` | `toolPanelDefaultTab` | `\"columns\" \\| \"filters\"` |\n| `selection-mode` | `selectionMode` | `\"row\" \\| \"cell\" \\| \"both\" \\| \"none\"` |\n| `show-row-numbers` | `showRowNumbers` | `boolean` |\n| `zebra-rows` | `zebraRows` | `boolean` |\n| `row-number-width` | `rowNumberWidth` | `number` |\n| `external-sort` | `externalSort` | `boolean` |\n| `external-filter` | `externalFilter` | `boolean` |\n| `editable-comments` | `editableComments` | `boolean` |\n| `conditional-stat-scope` | `conditionalStatScope` | `\"filtered\" \\| \"visible\" \\| \"all\"` |\n| `detail-row-height` | `detailRowHeight` | `number \\| ((row: TData) => number)` |\n| `show-detail-toggle` | `showDetailToggle` | `boolean` |\n| `frozen-rows` | `frozenRows` | `number` |\n| `sticky-group-rows` | `stickyGroupRows` | `boolean` |\n| `row-layout` | `rowLayout` | `\"flex\" \\| \"table\"` |\n| `enable-column-reorder` | `enableColumnReorder` | `boolean` |\n| `infer-column-types` | `inferColumnTypes` | `boolean` |\n| `row-drag-managed` | `rowDragManaged` | `boolean` |\n| `row-drag-group` | `rowDragGroup` | `string` |\n| `aligned-grid-group` | `alignedGridGroup` | `string` |\n| `filter-locale` | `filterLocale` | `string \\| ReadonlyArray<string>` |\n\n### Properties only (41)\n\nArrays, objects and functions. An HTML attribute is a string, so these can\nonly be assigned in script: `el.columns = [...]`.\n\n| Property | Type |\n| --- | --- |\n| `data` | `ReadonlyArray<TData>` |\n| `columns` | `Array<ColumnDef<TFeatures, TData>>` |\n| `board` | `BoardConfig<TFeatures, TData>` |\n| `gallery` | `GalleryConfig<TFeatures, TData>` |\n| `scheduler` | `SchedulerConfig<TFeatures, TData>` |\n| `gantt` | `GanttConfig<TFeatures, TData>` |\n| `chart` | `ChartViewConfig<TFeatures, TData>` |\n| `pivot` | `GridPivotConfig<TData>` |\n| `rowColor` | `RowColorConfig<TData>` |\n| `features` | `TFeatures` |\n| `treeData` | `{ ... }` |\n| `groupBy` | `ReadonlyArray<string>` |\n| `expanded` | `Record<string, boolean>` |\n| `localization` | `GridLocalization` |\n| `pageSizeOptions` | `number[]` |\n| `initialColumnPinning` | `{ ... }` |\n| `processCellForFill` | `(params: { value: unknown; delta: { rows: number; cols: number }; rowIndex: number; col...` |\n| `processCellForClipboard` | `(params: { ... }) => unknown` |\n| `includeCollapsedRows` | `(rowIndex: number) => boolean` |\n| `clipboardHtml` | `(params: { rects: ReadonlyArray<{ ... }>; text: string; }) => string \\| null \\| undefined` |\n| `parseClipboardText` | `(text: string) => string[][]` |\n| `processCellFromClipboard` | `(params: { ... }) => unknown` |\n| `initialSorting` | `Array<{ id: string; desc: boolean }>` |\n| `initialAdvancedFilter` | `GridPredicateExpr \\| null` |\n| `getRowId` | `(row: TData, index: number) => string` |\n| `rowClass` | `(ctx: { row: TData; rowIndex: number; }) => string \\| ReadonlyArray<string> \\| Record<str...` |\n| `notes` | `Record<string, Record<string, string>>` |\n| `conditionalFormats` | `ReadonlyArray<ConditionalFormat<TData>>` |\n| `rowPlaceholder` | `(row: TData, rowIndex: number) => \"loading\" \\| \"failed\" \\| null` |\n| `rowModel` | `GridRowModel<TData>` |\n| `pivotResultColumns` | `Array<ColumnDef<TFeatures, TData>> \\| null` |\n| `rowSelectionModel` | `{ ... }` |\n| `isDetailRow` | `(row: TData, rowIndex: number) => boolean` |\n| `isDetailOpen` | `(row: TData) => boolean` |\n| `hasDetail` | `(row: TData) => boolean` |\n| `serverGroup` | `{ ... }` |\n| `serverFilterValues` | `(columnId: string) => Promise<string[]>` |\n| `pinnedTopRows` | `ReadonlyArray<TData>` |\n| `mergedCells` | `ReadonlyArray<{ ... }>` |\n| `pinnedBottomRows` | `ReadonlyArray<TData>` |\n| `columnOrder` | `ReadonlyArray<string>` |\n\n### Events (35)\n\n`detail` is the callback's argument. The one callback that takes two carries\nan object keyed by its parameter names.\n\n| Event | From | `detail` |\n| --- | --- | --- |\n| `pivotmodechange` | `onPivotModeChange` | `on` |\n| `rowadd` | `onRowAdd` | `event` |\n| `columnadd` | `onColumnAdd` | `event` |\n| `columnchange` | `onColumnChange` | `event` |\n| `columnremove` | `onColumnRemove` | `event` |\n| `rowsdelete` | `onRowsDelete` | `event` |\n| `rowcolorchange` | `onRowColorChange` | `config` |\n| `expandedchange` | `onExpandedChange` | `expanded` |\n| `paginationchange` | `onPaginationChange` | `pagination` |\n| `columnresize` | `onColumnResize` | `event` |\n| `rowresize` | `onRowResize` | `event` |\n| `pasteclipboard` | `onPasteClipboard` | `payload` |\n| `pasteoverflow` | `onPasteOverflow` | `e` |\n| `apiready` | `onApiReady` | `api` |\n| `rowselectionchange` | `onRowSelectionChange` | `{ selection, rows }` |\n| `cellselectionchange` | `onCellSelectionChange` | `ranges` |\n| `sortingchange` | `onSortingChange` | `sorting` |\n| `advancedfilterchange` | `onAdvancedFilterChange` | `expr` |\n| `filterschange` | `onFiltersChange` | `filters` |\n| `notechange` | `onNoteChange` | `event` |\n| `cellvaluechange` | `onCellValueChange` | `event` |\n| `activecellchange` | `onActiveCellChange` | `cell` |\n| `cellclick` | `onCellClick` | `event` |\n| `rowclick` | `onRowClick` | `row` - published detail is the row, not the whole click event |\n| `celldoubleclick` | `onCellDoubleClick` | `event` |\n| `rowdoubleclick` | `onRowDoubleClick` | `event` |\n| `scrollbottomreached` | `onScrollBottomReached` | `event` |\n| `visiblerangechange` | `onVisibleRangeChange` | `range` |\n| `retryrow` | `onRetryRow` | `{ row, rowIndex }` |\n| `detailtoggle` | `onDetailToggle` | `{ row, rowIndex }` |\n| `columnorderchange` | `onColumnOrderChange` | `order` |\n| `columnvisibilitychange` | `onColumnVisibilityChange` | `hiddenColumns` |\n| `columnpinningchange` | `onColumnPinningChange` | `pinning` |\n| `rowdragend` | `onRowDragEnd` | `event` |\n| `rowdrop` | `onRowDrop` | `event` |\n\nPlus one alias kept from before the surface was generated:\n\n| Event | From | `detail` |\n| --- | --- | --- |\n| `selectionchange` | `onRowSelectionChange` | `rows` - published alias of rowselectionchange, detail is the selected rows |\n\n### Not exposed (3)\n\n| Prop | Why |\n| --- | --- |\n| `selectable` | element-level shorthand for row selection - see GridBody.svelte |\n| `icons` | Svelte snippets keyed by icon name - cannot cross the custom-element boundary |\n| `renderDetailRow` | Svelte snippet - cannot cross the custom-element boundary |\n\n<!-- END generated reference -->\n\n\n## The imperative API\n\nThe api surface `apiready` hands you.\n\n<div data-docs-demo=\"90-selection-api\" data-height=\"460\"></div>\n\n`onApiReady` fires once with the grid's api. Because a listener bound after\nmount would miss it, the handle is also parked on the element:\n\n```js\ngrid.addEventListener('apiready', (e) => e.detail.exportCsv())\n// or, at any time later:\ngrid.api.exportCsv()\n```\n\n\n## See also\n\n- [Quick start](./quick-start.md) - the CDN path, no build step.\n- [Limitations](./limitations.md) - what cannot cross the boundary.\n- [Shadow DOM](./shadow-dom.md) - `<sv-grid-shadow>` and style isolation.\n"
|
|
7687
|
+
"markdown": "# `<sv-grid>` reference\n\nEvery property, attribute and event of the custom element.\n\n**This page is generated** from `<SvGrid>`'s own `Props` type by\n`packages/grid-wc/scripts/generate-surface.mjs`, and CI fails if it drifts. The\nelement used to declare 7 props and 2 events by hand while the docs claimed\n\"grouping, sorting, pagination all come along\" - a hand-written table is how\nthat happens.\n\n## Attributes vs properties\n\n`groupable` is an attribute; `groupBy` is an array, so it is property-only. This grid uses both.\n\n<div data-docs-demo=\"07-grouping-aggregation\" data-height=\"480\"></div>\n\nThe distinction matters more here than anywhere else in the API:\n\n- **An attribute is a string.** Primitives (`boolean`, `number`, `string`) can\n be written in HTML: `<sv-grid page-size=\"25\" show-row-numbers>`.\n- **Arrays, objects and functions cannot.** `columns='[object Object]'` is not\n a thing. Assign them in script: `el.columns = [...]`.\n\nBoth work through the property, so `el.pageSize = 25` is equally valid. The\nattribute is the extra convenience, offered only where it can work.\n\n```html\n<sv-grid id=\"grid\" sortable filterable page-size=\"25\" row-height=\"32\"></sv-grid>\n<script type=\"module\">\n const grid = document.getElementById('grid')\n grid.columns = [{ field: 'name', header: 'Name' }] // property: an array\n grid.data = rows // property: an array\n</script>\n```\n\n<!-- BEGIN generated reference - packages/grid-wc/scripts/generate-surface.mjs -->\n\n### Attributes (87)\n\nPrimitives, so they work in plain HTML as well as through a property.\n\n| Attribute | Property | Type |\n| --- | --- | --- |\n| `pivot-mode` | `pivotMode` | `boolean` |\n| `context-menu` | `contextMenu` | `boolean \\| ReadonlyArray<ContextMenuItem<TData>>` |\n| `selection-bar` | `selectionBar` | `\\| boolean \\| ReadonlyArray<SelectionBarAction<TData> \\| SelectionBarBuiltin> \\| SelectionB...` |\n| `row-adder` | `rowAdder` | `boolean \\| RowAdderConfig<TData>` |\n| `column-adder` | `columnAdder` | `boolean \\| ColumnAdderConfig` |\n| `field-menu` | `fieldMenu` | `boolean` |\n| `expand-rows` | `expandRows` | `boolean` |\n| `pin-splitter` | `pinSplitter` | `boolean` |\n| `max-pinned-column-width` | `maxPinnedColumnWidth` | `number` |\n| `primary-field` | `primaryField` | `string` |\n| `sortable` | `sortable` | `boolean` |\n| `filterable` | `filterable` | `boolean` |\n| `editable` | `editable` | `boolean` |\n| `groupable` | `groupable` | `boolean` |\n| `group-footers` | `groupFooters` | `boolean` |\n| `grand-total-row` | `grandTotalRow` | `boolean` |\n| `group-display-mode` | `groupDisplayMode` | `GroupDisplayType` |\n| `auto-group-column-header` | `autoGroupColumnHeader` | `string` |\n| `auto-group-column-width` | `autoGroupColumnWidth` | `number` |\n| `pageable` | `pageable` | `boolean` |\n| `loading` | `loading` | `boolean` |\n| `loading-overlay` | `loadingOverlay` | `boolean` |\n| `loading-skeleton-rows` | `loadingSkeletonRows` | `number` |\n| `error` | `error` | `string \\| null` |\n| `empty-message` | `emptyMessage` | `string` |\n| `grid-label` | `gridLabel` | `string` |\n| `show-global-filter` | `showGlobalFilter` | `boolean` |\n| `show-column-filters` | `showColumnFilters` | `boolean` |\n| `filter-mode` | `filterMode` | `\"row\" \\| \"menu\" \\| \"global\" \\| \"none\"` |\n| `show-grouping-controls` | `showGroupingControls` | `boolean` |\n| `show-row-selection` | `showRowSelection` | `boolean` |\n| `show-pagination` | `showPagination` | `boolean` |\n| `page-size` | `pageSize` | `number` |\n| `pagination-position` | `paginationPosition` | `'top' \\| 'bottom' \\| 'both'` |\n| `external-pagination` | `externalPagination` | `boolean` |\n| `row-count` | `rowCount` | `number` |\n| `page-index` | `pageIndex` | `number` |\n| `virtualization` | `virtualization` | `boolean` |\n| `row-height` | `rowHeight` | `number \\| ((rowIndex: number) => number)` |\n| `auto-row-height` | `autoRowHeight` | `boolean` |\n| `row-resize` | `rowResize` | `boolean` |\n| `header-height` | `headerHeight` | `number` |\n| `overscan` | `overscan` | `number` |\n| `container-height` | `containerHeight` | `number \\| string` |\n| `column-virtualization` | `columnVirtualization` | `boolean` |\n| `column-overscan` | `columnOverscan` | `number` |\n| `column-width` | `columnWidth` | `number` |\n| `fit-columns` | `fitColumns` | `boolean` |\n| `column-resize` | `columnResize` | `boolean` |\n| `responsive` | `responsive` | `boolean \\| { breakpoint?: number }` |\n| `show-filter-menu` | `showFilterMenu` | `boolean` |\n| `show-filter-row` | `showFilterRow` | `boolean` |\n| `enable-cell-selection` | `enableCellSelection` | `boolean` |\n| `move-cells` | `moveCells` | `boolean` |\n| `enable-row-hover` | `enableRowHover` | `boolean` |\n| `copy-headers-to-clipboard` | `copyHeadersToClipboard` | `boolean` |\n| `hold-rows-on-write` | `holdRowsOnWrite` | `boolean` |\n| `enable-inline-editing` | `enableInlineEditing` | `boolean` |\n| `edit-on-second-click` | `editOnSecondClick` | `boolean` |\n| `full-row-editing` | `fullRowEditing` | `boolean` |\n| `enable-row-summaries` | `enableRowSummaries` | `boolean` |\n| `summary` | `summary` | `boolean` |\n| `status-bar` | `statusBar` | `\\| boolean \\| { ... }` |\n| `tool-panel` | `toolPanel` | `boolean` |\n| `charting` | `charting` | `boolean \\| ChartingConfig<TData>` |\n| `column-menu-tabs` | `columnMenuTabs` | `boolean` |\n| `tool-panel-default-open` | `toolPanelDefaultOpen` | `boolean` |\n| `tool-panel-default-tab` | `toolPanelDefaultTab` | `\"columns\" \\| \"filters\"` |\n| `selection-mode` | `selectionMode` | `\"row\" \\| \"cell\" \\| \"both\" \\| \"none\"` |\n| `show-row-numbers` | `showRowNumbers` | `boolean` |\n| `zebra-rows` | `zebraRows` | `boolean` |\n| `row-number-width` | `rowNumberWidth` | `number` |\n| `external-sort` | `externalSort` | `boolean` |\n| `external-filter` | `externalFilter` | `boolean` |\n| `editable-comments` | `editableComments` | `boolean` |\n| `conditional-stat-scope` | `conditionalStatScope` | `\"filtered\" \\| \"visible\" \\| \"all\"` |\n| `detail-row-height` | `detailRowHeight` | `number \\| ((row: TData) => number)` |\n| `show-detail-toggle` | `showDetailToggle` | `boolean` |\n| `frozen-rows` | `frozenRows` | `number` |\n| `sticky-group-rows` | `stickyGroupRows` | `boolean` |\n| `row-layout` | `rowLayout` | `\"flex\" \\| \"table\"` |\n| `enable-column-reorder` | `enableColumnReorder` | `boolean` |\n| `infer-column-types` | `inferColumnTypes` | `boolean` |\n| `row-drag-managed` | `rowDragManaged` | `boolean` |\n| `row-drag-group` | `rowDragGroup` | `string` |\n| `aligned-grid-group` | `alignedGridGroup` | `string` |\n| `filter-locale` | `filterLocale` | `string \\| ReadonlyArray<string>` |\n\n### Properties only (41)\n\nArrays, objects and functions. An HTML attribute is a string, so these can\nonly be assigned in script: `el.columns = [...]`.\n\n| Property | Type |\n| --- | --- |\n| `data` | `ReadonlyArray<TData>` |\n| `columns` | `Array<ColumnDef<TFeatures, TData>>` |\n| `board` | `BoardConfig<TFeatures, TData>` |\n| `gallery` | `GalleryConfig<TFeatures, TData>` |\n| `scheduler` | `SchedulerConfig<TFeatures, TData>` |\n| `gantt` | `GanttConfig<TFeatures, TData>` |\n| `chart` | `ChartViewConfig<TFeatures, TData>` |\n| `pivot` | `GridPivotConfig<TData>` |\n| `rowColor` | `RowColorConfig<TData>` |\n| `features` | `TFeatures` |\n| `treeData` | `{ ... }` |\n| `groupBy` | `ReadonlyArray<string>` |\n| `expanded` | `Record<string, boolean>` |\n| `localization` | `GridLocalization` |\n| `pageSizeOptions` | `number[]` |\n| `initialColumnPinning` | `{ ... }` |\n| `processCellForFill` | `(params: { value: unknown; delta: { rows: number; cols: number }; rowIndex: number; col...` |\n| `processCellForClipboard` | `(params: { ... }) => unknown` |\n| `includeCollapsedRows` | `(rowIndex: number) => boolean` |\n| `clipboardHtml` | `(params: { rects: ReadonlyArray<{ ... }>; text: string; }) => string \\| null \\| undefined` |\n| `parseClipboardText` | `(text: string) => string[][]` |\n| `processCellFromClipboard` | `(params: { ... }) => unknown` |\n| `initialSorting` | `Array<{ id: string; desc: boolean }>` |\n| `initialAdvancedFilter` | `GridPredicateExpr \\| null` |\n| `getRowId` | `(row: TData, index: number) => string` |\n| `rowClass` | `(ctx: { row: TData; rowIndex: number; }) => string \\| ReadonlyArray<string> \\| Record<str...` |\n| `notes` | `Record<string, Record<string, string>>` |\n| `conditionalFormats` | `ReadonlyArray<ConditionalFormat<TData>>` |\n| `rowPlaceholder` | `(row: TData, rowIndex: number) => \"loading\" \\| \"failed\" \\| null` |\n| `rowModel` | `GridRowModel<TData>` |\n| `pivotResultColumns` | `Array<ColumnDef<TFeatures, TData>> \\| null` |\n| `rowSelectionModel` | `{ ... }` |\n| `isDetailRow` | `(row: TData, rowIndex: number) => boolean` |\n| `isDetailOpen` | `(row: TData) => boolean` |\n| `hasDetail` | `(row: TData) => boolean` |\n| `serverGroup` | `{ ... }` |\n| `serverFilterValues` | `(columnId: string) => Promise<string[]>` |\n| `pinnedTopRows` | `ReadonlyArray<TData>` |\n| `mergedCells` | `ReadonlyArray<{ ... }>` |\n| `pinnedBottomRows` | `ReadonlyArray<TData>` |\n| `columnOrder` | `ReadonlyArray<string>` |\n\n### Events (35)\n\n`detail` is the callback's argument. The one callback that takes two carries\nan object keyed by its parameter names.\n\n| Event | From | `detail` |\n| --- | --- | --- |\n| `pivotmodechange` | `onPivotModeChange` | `on` |\n| `rowadd` | `onRowAdd` | `event` |\n| `columnadd` | `onColumnAdd` | `event` |\n| `columnchange` | `onColumnChange` | `event` |\n| `columnremove` | `onColumnRemove` | `event` |\n| `rowsdelete` | `onRowsDelete` | `event` |\n| `rowcolorchange` | `onRowColorChange` | `config` |\n| `expandedchange` | `onExpandedChange` | `expanded` |\n| `paginationchange` | `onPaginationChange` | `pagination` |\n| `columnresize` | `onColumnResize` | `event` |\n| `rowresize` | `onRowResize` | `event` |\n| `pasteclipboard` | `onPasteClipboard` | `payload` |\n| `pasteoverflow` | `onPasteOverflow` | `e` |\n| `apiready` | `onApiReady` | `api` |\n| `rowselectionchange` | `onRowSelectionChange` | `{ selection, rows }` |\n| `cellselectionchange` | `onCellSelectionChange` | `ranges` |\n| `sortingchange` | `onSortingChange` | `sorting` |\n| `advancedfilterchange` | `onAdvancedFilterChange` | `expr` |\n| `filterschange` | `onFiltersChange` | `filters` |\n| `notechange` | `onNoteChange` | `event` |\n| `cellvaluechange` | `onCellValueChange` | `event` |\n| `activecellchange` | `onActiveCellChange` | `cell` |\n| `cellclick` | `onCellClick` | `event` |\n| `rowclick` | `onRowClick` | `row` - published detail is the row, not the whole click event |\n| `celldoubleclick` | `onCellDoubleClick` | `event` |\n| `rowdoubleclick` | `onRowDoubleClick` | `event` |\n| `scrollbottomreached` | `onScrollBottomReached` | `event` |\n| `visiblerangechange` | `onVisibleRangeChange` | `range` |\n| `retryrow` | `onRetryRow` | `{ row, rowIndex }` |\n| `detailtoggle` | `onDetailToggle` | `{ row, rowIndex }` |\n| `columnorderchange` | `onColumnOrderChange` | `order` |\n| `columnvisibilitychange` | `onColumnVisibilityChange` | `hiddenColumns` |\n| `columnpinningchange` | `onColumnPinningChange` | `pinning` |\n| `rowdragend` | `onRowDragEnd` | `event` |\n| `rowdrop` | `onRowDrop` | `event` |\n\nPlus one alias kept from before the surface was generated:\n\n| Event | From | `detail` |\n| --- | --- | --- |\n| `selectionchange` | `onRowSelectionChange` | `rows` - published alias of rowselectionchange, detail is the selected rows |\n\n### Not exposed (3)\n\n| Prop | Why |\n| --- | --- |\n| `selectable` | element-level shorthand for row selection - see GridBody.svelte |\n| `icons` | Svelte snippets keyed by icon name - cannot cross the custom-element boundary |\n| `renderDetailRow` | Svelte snippet - cannot cross the custom-element boundary |\n\n<!-- END generated reference -->\n\n\n## The imperative API\n\nThe api surface `apiready` hands you.\n\n<div data-docs-demo=\"90-selection-api\" data-height=\"460\"></div>\n\n`onApiReady` fires once with the grid's api. Because a listener bound after\nmount would miss it, the handle is also parked on the element:\n\n```js\ngrid.addEventListener('apiready', (e) => e.detail.exportCsv())\n// or, at any time later:\ngrid.api.exportCsv()\n```\n\n\n## See also\n\n- [Quick start](./quick-start.md) - the CDN path, no build step.\n- [Limitations](./limitations.md) - what cannot cross the boundary.\n- [Shadow DOM](./shadow-dom.md) - `<sv-grid-shadow>` and style isolation.\n"
|
|
7688
7688
|
},
|
|
7689
7689
|
{
|
|
7690
7690
|
"slug": "help/web-components/sv-sheet",
|
|
@@ -8608,7 +8608,7 @@ export const docs = [
|
|
|
8608
8608
|
"path": "docs/_data/comparisons/ag-grid.json",
|
|
8609
8609
|
"title": "SvGrid vs AG Grid (community + enterprise)",
|
|
8610
8610
|
"section": "Comparisons",
|
|
8611
|
-
"markdown": "# SvGrid vs AG Grid (community + enterprise)\n\nCanonical URL: https://svgrid.com/compare/ag-grid/\nFacts verified: 2026-09-12\nCompetitor package: ag-grid-community\nCompetitor site: https://www.ag-grid.com/\n\nAG Grid is the most widely used JavaScript data grid, sold for React, Angular, Vue and plain JavaScript, with Svelte covered only by community-built integrations.\n\n## Verdict\n\nAG Grid has the longer track record and the wider Enterprise catalogue; SvGrid is Svelte-5-native, smaller on a Svelte page, and puts most of what AG Grid sells as Enterprise into its MIT core. Pick AG Grid for parity with React and Angular teams; pick SvGrid for a Svelte-first stack.\n\nMigration guide: moving from AG Grid (community + enterprise) to SvGrid: https://svgrid.com/docs/help/migrating-from-ag-grid/\n\n## At a glance\n\n| Fact | SvGrid | AG Grid (community + enterprise) | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 36.3.0 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 4 Nov 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (JavaScript, React, Angular, Vue) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 16,400,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 99.6 KB JS + 11.4 KB CSS | 346.4 KB JS, no separate stylesheet | 9 Nov 2026 |\n| Frameworks | Svelte 5 | JavaScript, React, Angular, Vue | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | AG Grid Community is free under MIT. AG Grid Enterprise is listed at $999 USD per developer with one year of updates and Zendesk support; the Enterprise Bundle with AG Charts Enterprise is $1,498 USD per developer | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.34 measured 10 Nov 2026 with packages/grid/scripts/measure-size.mjs; ag-grid-community 36.3.0 entry `createGrid + AllCommunityModule + themeQuartz` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nAG Grid is the heavyweight of the category: a Community edition under MIT and an Enterprise edition sold per developer that adds the set filter, range selection, master/detail, tree data, row grouping, pivoting, integrated charts, Excel export and the server-side row model. Its own pages mark each of those as Enterprise, and the sources at the bottom of this page link to them.\n\nFor Svelte there is no official package. ag-grid.com names React, Angular, Vue and JavaScript and points Svelte users to community-built integrations, so in practice you call the JavaScript API from onMount and manage the DOM yourself. SvGrid is the inverse: a Svelte 5 component with runes and snippets, and a headless core underneath it.\n\n## Looking for an AG Grid alternative for Svelte?\n\nThe usual reason to look is that AG Grid on Svelte means the JavaScript API inside onMount plus a wrapper you do not control. SvGrid gives you a component that speaks runes natively and an MIT core with no row cap and no licence key. What you give up is breadth: AG Grid has more Enterprise modules, more integrations and a far larger body of examples, and if you need one grid across three frameworks it is still the right answer.\n\n## What they have in common\n\n- A full grid with sorting, filtering, grouping, virtualization, editing and selection.\n- Documentation with a runnable example per feature.\n- TypeScript-first APIs with an imperative grid API for code outside the component.\n- An MIT core plus a paid tier with support.\n- An official MCP server so AI assistants read the real docs instead of guessing.\n\n## Where SvGrid is stronger\n\n- Svelte 5 native: runes for state, snippets for cells, no wrapper layer and no DOM imperatives.\n- A smaller bundle on a Svelte page; the At a glance table above carries both measured numbers and the method.\n- Set-style Excel filters, cell-range selection with clipboard, master/detail, tree data, row grouping with aggregation, integrated charts, the column tool panel and the context menu are in the MIT core. AG Grid lists each of these under Enterprise. Flat server-side data (paging, infinite block scroll) is free in both; the server-side row model with lazy grouping, tree, pivot, transactions and selection across unloaded rows is a paid module in both.\n- In-grid AI helpers (natural-language filter, smart fill, summarise, classify, anomalies) ship free in @svgrid/grid with your own model provider.\n- @svgrid/mcp validates props and imports against the real API surface and scaffolds a project, on top of docs and examples.\n- @svgrid/enterprise costs $599 per developer per year for the enterprise grid, unlimited applications; AG Grid Enterprise's per-developer price is in the pricing line above.\n\n## Where AG Grid (community + enterprise) is stronger\n\n- A longer production record across very large enterprise deployments, and the largest body of third-party examples and answers of any grid.\n- The viewport row model, where the server pushes the visible window over a socket; SvGrid has no equivalent.\n- AG Charts, a separately licensed charting product with far more chart types than SvGridChart.\n- One grid API across React, Angular and Vue teams.\n- Enterprise support through Zendesk with one year of updates on the licence.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | AG Grid (community + enterprise) |\n| --- | --- | --- |\n| Svelte 5 native | Yes - runes and snippets | No - JavaScript build; Svelte is pointed to community-built integrations |\n| Sorting and filtering | Yes | Yes |\n| Excel-style set filter | Yes - MIT core | Paid tier - the Set Filter page is marked Enterprise |\n| Row and column virtualization | Yes | Yes |\n| Inline editing | Yes | Yes |\n| Cell-range selection and clipboard | Yes - MIT core, with a fill handle | Paid tier - Range Selection and Clipboard are Enterprise |\n| Master/detail | Yes - MIT core | Paid tier - Enterprise |\n| Tree data | Yes - MIT core | Paid tier - the Tree Data page is marked Enterprise |\n| Row grouping with aggregation | Yes - MIT core | Paid tier - Enterprise |\n| Pivot tables | Paid tier - @svgrid/enterprise | Paid tier - Enterprise |\n| Integrated charts | Yes - SvGridChart in the MIT core | Paid tier - Enterprise, through AG Charts |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes - MIT core: createServerDataSource, page or infinite block scroll | Yes - Infinite Row Model, Community |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise: createServerRowModel | Paid tier - Server-Side Row Model, Enterprise |\n| Global search over server-side data | Yes - filterModel.global goes to the server | No - the Quick Filter is not supported by the Infinite or Server-Side row models |\n| Viewport row model (server pushes the visible window) | No - not built; real-time deltas merge into loaded rows instead | Paid tier - Viewport Row Model, Enterprise |\n| CSV export | Yes - MIT core | Yes - Community, through the API |\n| Excel export | Paid tier - @svgrid/enterprise | Paid tier - Enterprise |\n| Column tool panel | Yes - MIT core | Paid tier - Tool Panels are Enterprise |\n| Context menu | Yes - MIT core | Paid tier - Enterprise |\n| MCP server for AI assistants | Yes - @svgrid/mcp, MIT: docs, examples, code check, scaffold, preview | Yes - ag-mcp, MIT: docs search, version detection, upgrade prompts |\n| In-grid AI helpers (natural-language filter, smart fill) | Yes - MIT core, bring your own model | No - not in the feature list |\n| Paid support | Yes - with @svgrid/enterprise, per developer per year | Yes - Enterprise licence, Zendesk |\n| Core licence | Yes - MIT | Yes - MIT (Community) |\n\n## Measured performance\n\nMeasured 28 Oct 2026 with the harness in the repository (pnpm bench:compare): 100,000 rows, fastest of 3 samples per operation, each grid in a fresh page, Chromium through Playwright, headless, on win32 10.0.26200 x64, Intel(R) Core(TM) Ultra 7 255U; a developer workstation, not a dedicated bench rig. Versions: @svgrid/grid 3.0.25, ag-grid-community 36.1.0. Lower is better. Tick: 1,000 of the rows replaced per tick with a new amount, the grid sorted by amount, on the update path each grid provides, timed until the changed cells paint; 180 ticks after 10 to warm up.\n\n| Operation | SvGrid | AG Grid (community + enterprise) |\n| --- | --- | --- |\n| Mount | 30.7 ms | 67 ms |\n| Sort, text column | 77.4 ms | 213.9 ms |\n| Sort, numeric column | 32.8 ms | 216.7 ms |\n| Filter, one column (indicative only) | 34.5 ms | 148.8 ms |\n| Scroll, p95 frame | 34.3 ms | 34.5 ms |\n| Live tick, 1,000 rows replaced, sorted by that column, p95 | 48.6 ms | 259.2 ms |\n| Ticks over one 60 Hz frame, of 180 | 115 | 180 |\n| Rows kept in the DOM (virtualization on) | 36 | 36 |\n\nThe filter row is not like for like: each grid is driven through its own single-column filter API, and the amount of work differs. The comparison guide explains the method, what is left out and why.\n\n## When to choose SvGrid\n\n- You are on Svelte 5 and want a grid shaped by Svelte idioms rather than a wrapper around a JavaScript build.\n- You want the set filter, master/detail, tree data, range selection, grouping and flat server-side infinite scroll without an Enterprise licence.\n- You want a paid support tier priced per developer per year at $599.\n- You want an assistant that can check the code it writes against the real API, not only read the docs.\n\n## When to choose AG Grid (community + enterprise)\n\n- You depend on a specific AG Grid Enterprise module, the viewport row model or server-side pivoting.\n- You run the same grid across React, Angular and Vue teams and want one library.\n- Your procurement already covers AG Grid Enterprise, or you need AG Charts.\n- You want the largest possible pool of existing examples, answers and contractors.\n\n## Migration effort\n\nEstimated effort: 1-3 hours per grid.\n\nWhat you give up:\n\n- AG Charts as a separately licensed charting product with far more chart types than SvGridChart.\n- The viewport row model; SvGrid's server-side row model covers sort, filter, grouping, tree, pivot, transactions and select-all across unloaded rows, but the server cannot push the visible window.\n- One grid API across React, Angular and Vue teams.\n- The largest body of third-party examples, Stack Overflow answers and contractors of any grid.\n\nMigration guide: moving from AG Grid (community + enterprise) to SvGrid: https://svgrid.com/docs/help/migrating-from-ag-grid/\n\n## Live example\n\nMigration From Ag Grid: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/139-migration-from-ag-grid/\n\n## The bottom line\n\nAG Grid is the safer pick for a multi-framework organisation, or when you need its deepest Enterprise modules, AG Charts or the viewport row model. For a Svelte-first team, SvGrid covers the Enterprise surface most teams actually buy AG Grid for, in the MIT core: master/detail, tree data, range selection, grouping, flat server-side infinite scroll and integrated charts, with pivot tables, the server-side row model and Excel, PDF and print output in the @svgrid/enterprise pack. The bundle and benchmark numbers on this page are measured on the dates shown, so read them rather than either vendor's adjectives.\n\n## Frequently asked questions\n\n### Does AG Grid support Svelte?\n\nNot with an official package. ag-grid.com names React, Angular, Vue and JavaScript, and points Svelte, Solid and Python users to community-built integrations. In practice you create the grid from the JavaScript API inside onMount and keep its state in sync with your Svelte state by hand.\n\n### Which AG Grid Enterprise features does SvGrid include in its MIT core?\n\nThe set-style Excel filter, cell-range selection with clipboard, master/detail, tree data, row grouping with aggregation, integrated charts, the column tool panel and the context menu. AG Grid's own pages list each of these under Enterprise. Pivot tables, the server-side row model (grouping, tree, pivot, transactions, selection) and Excel, PDF and print output are in @svgrid/enterprise, as they are in AG Grid Enterprise; flat server-side infinite scroll is free in both.\n\n### What does SvGrid not have that AG Grid Enterprise has?\n\nThe viewport row model, AG Charts as a full charting product, and the breadth of niche Enterprise modules that come from a decade of enterprise customers. SvGrid's server-side row model handles sort, filter, grouping, tree, pivot, transactions and selection across unloaded rows; if your requirement is the viewport model, AG Grid Enterprise is the better fit.\n\n### Does AG Grid have an MCP server too?\n\nYes. ag-mcp (MIT) gives an assistant AG Grid's docs, examples and version-specific upgrade prompts. @svgrid/mcp covers the same ground for SvGrid and adds a code checker that validates props and imports against the real API surface, a scaffold tool and a preview. Neither is an in-grid feature; SvGrid's natural-language filter, smart fill and summarise helpers are, and they ship free in @svgrid/grid with your own model provider.\n\n### How much does AG Grid Enterprise cost compared with SvGrid?\n\nAG Grid Enterprise is sold per developer with one year of updates; the price as ag-grid.com listed it on the date we read it is in the pricing line at the top of this page. SvGrid's core is MIT and @svgrid/enterprise is $599 per developer per year for the enterprise grid or $999 with the spreadsheet and Studio, both for unlimited applications. Compare what each paid tier adds before comparing prices: most of what AG Grid sells as Enterprise is in SvGrid's free core.\n\n### How long does a migration from AG Grid to SvGrid take?\n\nThe migration guide budgets one to three hours per grid. Column definitions map almost one to one, the imperative API has equivalents on SvGridApi, and most of the time goes into moving cell renderers to snippets. The guide also lists what does not map, so you can decide before you start.\n\n### Is SvGrid a good AG Grid alternative for Svelte?\n\nThe usual reason to look is that AG Grid on Svelte means the JavaScript API inside onMount plus a wrapper you do not control. SvGrid gives you a component that speaks runes natively and an MIT core with no row cap and no licence key. What you give up is breadth: AG Grid has more Enterprise modules, more integrations and a far larger body of examples, and if you need one grid across three frameworks it is still the right answer.\n\n## Related comparisons and docs\n\n- [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/)\n- [SvGrid vs Handsontable](https://svgrid.com/compare/handsontable/)\n- [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Performance benchmarks](https://svgrid.com/docs/help/benchmarks/)\n- [Server-side data](https://svgrid.com/docs/help/server-side-data/)\n- [MCP server](https://svgrid.com/docs/help/mcp-server/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- ag-pricing: Enterprise is per developer at $999 USD with one year of updates and Zendesk support; the Enterprise Bundle is $1,498 USD; Community is free under MIT (checked 12 Sep 2026) https://www.ag-grid.com/license-pricing/\n- ag-community-vs-enterprise: Lists Range Selection, Clipboard, Master/Detail, Row Grouping, Pivot Tables and Aggregations, Integrated Charts, Excel export, Server-Side Row Model, Tool Panels and Context Menu under Enterprise Features; no AI feature in either list (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/community-vs-enterprise/\n- ag-set-filter: The Set Filter page is marked enterprise (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/filter-set/\n- ag-tree-data: The Tree Data page is marked enterprise (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/tree-data/\n- ag-csv-export: CSV export is available in Community through the API; the context-menu export and Excel export are Enterprise (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/csv-export/\n- ag-mcp: Official MCP server installed with npx ag-mcp: search_docs, detect_version, set_version and list_versions tools, quick-start and upgrade-grid prompts, docs and examples as resources; described as help for integrating and maintaining grid code, not an in-grid feature. The ag-mcp package on npm is MIT (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/mcp-server/\n- ag-home: Names React, Angular, Vue and JavaScript; says Svelte, Solid and Python users can use community-built integrations; the 36.1.0 release notes list an AI Coding Skill (checked 12 Sep 2026) https://www.ag-grid.com/\n- ag-row-models: The row-models feature table lists the Infinite Row Model as Community and the Server-Side and Viewport row models as Enterprise; the Quick Filter row is marked unsupported for the Infinite, Server-Side and Viewport models (checked 15 Sep 2026) https://www.ag-grid.com/javascript-data-grid/row-models/\n"
|
|
8611
|
+
"markdown": "# SvGrid vs AG Grid (community + enterprise)\n\nCanonical URL: https://svgrid.com/compare/ag-grid/\nFacts verified: 2026-09-12\nCompetitor package: ag-grid-community\nCompetitor site: https://www.ag-grid.com/\n\nAG Grid is the most widely used JavaScript data grid, sold for React, Angular, Vue and plain JavaScript, with Svelte covered only by community-built integrations.\n\n## Verdict\n\nAG Grid has the longer track record and the wider Enterprise catalogue; SvGrid is Svelte-5-native, smaller on a Svelte page, and puts most of what AG Grid sells as Enterprise into its MIT core. Pick AG Grid for parity with React and Angular teams; pick SvGrid for a Svelte-first stack.\n\nMigration guide: moving from AG Grid (community + enterprise) to SvGrid: https://svgrid.com/docs/help/migrating-from-ag-grid/\n\n## At a glance\n\n| Fact | SvGrid | AG Grid (community + enterprise) | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 36.3.0 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 4 Nov 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (JavaScript, React, Angular, Vue) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 16,400,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 346.4 KB JS, no separate stylesheet | 9 Nov 2026 |\n| Frameworks | Svelte 5 | JavaScript, React, Angular, Vue | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | AG Grid Community is free under MIT. AG Grid Enterprise is listed at $999 USD per developer with one year of updates and Zendesk support; the Enterprise Bundle with AG Charts Enterprise is $1,498 USD per developer | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; ag-grid-community 36.3.0 entry `createGrid + AllCommunityModule + themeQuartz` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nAG Grid is the heavyweight of the category: a Community edition under MIT and an Enterprise edition sold per developer that adds the set filter, range selection, master/detail, tree data, row grouping, pivoting, integrated charts, Excel export and the server-side row model. Its own pages mark each of those as Enterprise, and the sources at the bottom of this page link to them.\n\nFor Svelte there is no official package. ag-grid.com names React, Angular, Vue and JavaScript and points Svelte users to community-built integrations, so in practice you call the JavaScript API from onMount and manage the DOM yourself. SvGrid is the inverse: a Svelte 5 component with runes and snippets, and a headless core underneath it.\n\n## Looking for an AG Grid alternative for Svelte?\n\nThe usual reason to look is that AG Grid on Svelte means the JavaScript API inside onMount plus a wrapper you do not control. SvGrid gives you a component that speaks runes natively and an MIT core with no row cap and no licence key. What you give up is breadth: AG Grid has more Enterprise modules, more integrations and a far larger body of examples, and if you need one grid across three frameworks it is still the right answer.\n\n## What they have in common\n\n- A full grid with sorting, filtering, grouping, virtualization, editing and selection.\n- Documentation with a runnable example per feature.\n- TypeScript-first APIs with an imperative grid API for code outside the component.\n- An MIT core plus a paid tier with support.\n- An official MCP server so AI assistants read the real docs instead of guessing.\n\n## Where SvGrid is stronger\n\n- Svelte 5 native: runes for state, snippets for cells, no wrapper layer and no DOM imperatives.\n- A smaller bundle on a Svelte page; the At a glance table above carries both measured numbers and the method.\n- Set-style Excel filters, cell-range selection with clipboard, master/detail, tree data, row grouping with aggregation, integrated charts, the column tool panel and the context menu are in the MIT core. AG Grid lists each of these under Enterprise. Flat server-side data (paging, infinite block scroll) is free in both; the server-side row model with lazy grouping, tree, pivot, transactions and selection across unloaded rows is a paid module in both.\n- In-grid AI helpers (natural-language filter, smart fill, summarise, classify, anomalies) ship free in @svgrid/grid with your own model provider.\n- @svgrid/mcp validates props and imports against the real API surface and scaffolds a project, on top of docs and examples.\n- @svgrid/enterprise costs $599 per developer per year for the enterprise grid, unlimited applications; AG Grid Enterprise's per-developer price is in the pricing line above.\n\n## Where AG Grid (community + enterprise) is stronger\n\n- A longer production record across very large enterprise deployments, and the largest body of third-party examples and answers of any grid.\n- The viewport row model, where the server pushes the visible window over a socket; SvGrid has no equivalent.\n- AG Charts, a separately licensed charting product with far more chart types than SvGridChart.\n- One grid API across React, Angular and Vue teams.\n- Enterprise support through Zendesk with one year of updates on the licence.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | AG Grid (community + enterprise) |\n| --- | --- | --- |\n| Svelte 5 native | Yes - runes and snippets | No - JavaScript build; Svelte is pointed to community-built integrations |\n| Sorting and filtering | Yes | Yes |\n| Excel-style set filter | Yes - MIT core | Paid tier - the Set Filter page is marked Enterprise |\n| Row and column virtualization | Yes | Yes |\n| Inline editing | Yes | Yes |\n| Cell-range selection and clipboard | Yes - MIT core, with a fill handle | Paid tier - Range Selection and Clipboard are Enterprise |\n| Master/detail | Yes - MIT core | Paid tier - Enterprise |\n| Tree data | Yes - MIT core | Paid tier - the Tree Data page is marked Enterprise |\n| Row grouping with aggregation | Yes - MIT core | Paid tier - Enterprise |\n| Pivot tables | Paid tier - @svgrid/enterprise | Paid tier - Enterprise |\n| Integrated charts | Yes - SvGridChart in the MIT core | Paid tier - Enterprise, through AG Charts |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes - MIT core: createServerDataSource, page or infinite block scroll | Yes - Infinite Row Model, Community |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise: createServerRowModel | Paid tier - Server-Side Row Model, Enterprise |\n| Global search over server-side data | Yes - filterModel.global goes to the server | No - the Quick Filter is not supported by the Infinite or Server-Side row models |\n| Viewport row model (server pushes the visible window) | No - not built; real-time deltas merge into loaded rows instead | Paid tier - Viewport Row Model, Enterprise |\n| CSV export | Yes - MIT core | Yes - Community, through the API |\n| Excel export | Paid tier - @svgrid/enterprise | Paid tier - Enterprise |\n| Column tool panel | Yes - MIT core | Paid tier - Tool Panels are Enterprise |\n| Context menu | Yes - MIT core | Paid tier - Enterprise |\n| MCP server for AI assistants | Yes - @svgrid/mcp, MIT: docs, examples, code check, scaffold, preview | Yes - ag-mcp, MIT: docs search, version detection, upgrade prompts |\n| In-grid AI helpers (natural-language filter, smart fill) | Yes - MIT core, bring your own model | No - not in the feature list |\n| Paid support | Yes - with @svgrid/enterprise, per developer per year | Yes - Enterprise licence, Zendesk |\n| Core licence | Yes - MIT | Yes - MIT (Community) |\n\n## Measured performance\n\nMeasured 28 Oct 2026 with the harness in the repository (pnpm bench:compare): 100,000 rows, fastest of 3 samples per operation, each grid in a fresh page, Chromium through Playwright, headless, on win32 10.0.26200 x64, Intel(R) Core(TM) Ultra 7 255U; a developer workstation, not a dedicated bench rig. Versions: @svgrid/grid 3.0.25, ag-grid-community 36.1.0. Lower is better. Tick: 1,000 of the rows replaced per tick with a new amount, the grid sorted by amount, on the update path each grid provides, timed until the changed cells paint; 180 ticks after 10 to warm up.\n\n| Operation | SvGrid | AG Grid (community + enterprise) |\n| --- | --- | --- |\n| Mount | 30.7 ms | 67 ms |\n| Sort, text column | 77.4 ms | 213.9 ms |\n| Sort, numeric column | 32.8 ms | 216.7 ms |\n| Filter, one column (indicative only) | 34.5 ms | 148.8 ms |\n| Scroll, p95 frame | 34.3 ms | 34.5 ms |\n| Live tick, 1,000 rows replaced, sorted by that column, p95 | 48.6 ms | 259.2 ms |\n| Ticks over one 60 Hz frame, of 180 | 115 | 180 |\n| Rows kept in the DOM (virtualization on) | 36 | 36 |\n\nThe filter row is not like for like: each grid is driven through its own single-column filter API, and the amount of work differs. The comparison guide explains the method, what is left out and why.\n\n## When to choose SvGrid\n\n- You are on Svelte 5 and want a grid shaped by Svelte idioms rather than a wrapper around a JavaScript build.\n- You want the set filter, master/detail, tree data, range selection, grouping and flat server-side infinite scroll without an Enterprise licence.\n- You want a paid support tier priced per developer per year at $599.\n- You want an assistant that can check the code it writes against the real API, not only read the docs.\n\n## When to choose AG Grid (community + enterprise)\n\n- You depend on a specific AG Grid Enterprise module, the viewport row model or server-side pivoting.\n- You run the same grid across React, Angular and Vue teams and want one library.\n- Your procurement already covers AG Grid Enterprise, or you need AG Charts.\n- You want the largest possible pool of existing examples, answers and contractors.\n\n## Migration effort\n\nEstimated effort: 1-3 hours per grid.\n\nWhat you give up:\n\n- AG Charts as a separately licensed charting product with far more chart types than SvGridChart.\n- The viewport row model; SvGrid's server-side row model covers sort, filter, grouping, tree, pivot, transactions and select-all across unloaded rows, but the server cannot push the visible window.\n- One grid API across React, Angular and Vue teams.\n- The largest body of third-party examples, Stack Overflow answers and contractors of any grid.\n\nMigration guide: moving from AG Grid (community + enterprise) to SvGrid: https://svgrid.com/docs/help/migrating-from-ag-grid/\n\n## Live example\n\nMigration From Ag Grid: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/139-migration-from-ag-grid/\n\n## The bottom line\n\nAG Grid is the safer pick for a multi-framework organisation, or when you need its deepest Enterprise modules, AG Charts or the viewport row model. For a Svelte-first team, SvGrid covers the Enterprise surface most teams actually buy AG Grid for, in the MIT core: master/detail, tree data, range selection, grouping, flat server-side infinite scroll and integrated charts, with pivot tables, the server-side row model and Excel, PDF and print output in the @svgrid/enterprise pack. The bundle and benchmark numbers on this page are measured on the dates shown, so read them rather than either vendor's adjectives.\n\n## Frequently asked questions\n\n### Does AG Grid support Svelte?\n\nNot with an official package. ag-grid.com names React, Angular, Vue and JavaScript, and points Svelte, Solid and Python users to community-built integrations. In practice you create the grid from the JavaScript API inside onMount and keep its state in sync with your Svelte state by hand.\n\n### Which AG Grid Enterprise features does SvGrid include in its MIT core?\n\nThe set-style Excel filter, cell-range selection with clipboard, master/detail, tree data, row grouping with aggregation, integrated charts, the column tool panel and the context menu. AG Grid's own pages list each of these under Enterprise. Pivot tables, the server-side row model (grouping, tree, pivot, transactions, selection) and Excel, PDF and print output are in @svgrid/enterprise, as they are in AG Grid Enterprise; flat server-side infinite scroll is free in both.\n\n### What does SvGrid not have that AG Grid Enterprise has?\n\nThe viewport row model, AG Charts as a full charting product, and the breadth of niche Enterprise modules that come from a decade of enterprise customers. SvGrid's server-side row model handles sort, filter, grouping, tree, pivot, transactions and selection across unloaded rows; if your requirement is the viewport model, AG Grid Enterprise is the better fit.\n\n### Does AG Grid have an MCP server too?\n\nYes. ag-mcp (MIT) gives an assistant AG Grid's docs, examples and version-specific upgrade prompts. @svgrid/mcp covers the same ground for SvGrid and adds a code checker that validates props and imports against the real API surface, a scaffold tool and a preview. Neither is an in-grid feature; SvGrid's natural-language filter, smart fill and summarise helpers are, and they ship free in @svgrid/grid with your own model provider.\n\n### How much does AG Grid Enterprise cost compared with SvGrid?\n\nAG Grid Enterprise is sold per developer with one year of updates; the price as ag-grid.com listed it on the date we read it is in the pricing line at the top of this page. SvGrid's core is MIT and @svgrid/enterprise is $599 per developer per year for the enterprise grid or $999 with the spreadsheet and Studio, both for unlimited applications. Compare what each paid tier adds before comparing prices: most of what AG Grid sells as Enterprise is in SvGrid's free core.\n\n### How long does a migration from AG Grid to SvGrid take?\n\nThe migration guide budgets one to three hours per grid. Column definitions map almost one to one, the imperative API has equivalents on SvGridApi, and most of the time goes into moving cell renderers to snippets. The guide also lists what does not map, so you can decide before you start.\n\n### Is SvGrid a good AG Grid alternative for Svelte?\n\nThe usual reason to look is that AG Grid on Svelte means the JavaScript API inside onMount plus a wrapper you do not control. SvGrid gives you a component that speaks runes natively and an MIT core with no row cap and no licence key. What you give up is breadth: AG Grid has more Enterprise modules, more integrations and a far larger body of examples, and if you need one grid across three frameworks it is still the right answer.\n\n## Related comparisons and docs\n\n- [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/)\n- [SvGrid vs Handsontable](https://svgrid.com/compare/handsontable/)\n- [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Performance benchmarks](https://svgrid.com/docs/help/benchmarks/)\n- [Server-side data](https://svgrid.com/docs/help/server-side-data/)\n- [MCP server](https://svgrid.com/docs/help/mcp-server/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- ag-pricing: Enterprise is per developer at $999 USD with one year of updates and Zendesk support; the Enterprise Bundle is $1,498 USD; Community is free under MIT (checked 12 Sep 2026) https://www.ag-grid.com/license-pricing/\n- ag-community-vs-enterprise: Lists Range Selection, Clipboard, Master/Detail, Row Grouping, Pivot Tables and Aggregations, Integrated Charts, Excel export, Server-Side Row Model, Tool Panels and Context Menu under Enterprise Features; no AI feature in either list (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/community-vs-enterprise/\n- ag-set-filter: The Set Filter page is marked enterprise (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/filter-set/\n- ag-tree-data: The Tree Data page is marked enterprise (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/tree-data/\n- ag-csv-export: CSV export is available in Community through the API; the context-menu export and Excel export are Enterprise (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/csv-export/\n- ag-mcp: Official MCP server installed with npx ag-mcp: search_docs, detect_version, set_version and list_versions tools, quick-start and upgrade-grid prompts, docs and examples as resources; described as help for integrating and maintaining grid code, not an in-grid feature. The ag-mcp package on npm is MIT (checked 12 Sep 2026) https://www.ag-grid.com/javascript-data-grid/mcp-server/\n- ag-home: Names React, Angular, Vue and JavaScript; says Svelte, Solid and Python users can use community-built integrations; the 36.1.0 release notes list an AI Coding Skill (checked 12 Sep 2026) https://www.ag-grid.com/\n- ag-row-models: The row-models feature table lists the Infinite Row Model as Community and the Server-Side and Viewport row models as Enterprise; the Quick Filter row is marked unsupported for the Infinite, Server-Side and Viewport models (checked 15 Sep 2026) https://www.ag-grid.com/javascript-data-grid/row-models/\n"
|
|
8612
8612
|
},
|
|
8613
8613
|
{
|
|
8614
8614
|
"slug": "compare/airtable",
|
|
@@ -8636,14 +8636,14 @@ export const docs = [
|
|
|
8636
8636
|
"path": "docs/_data/comparisons/glide-data-grid.json",
|
|
8637
8637
|
"title": "SvGrid vs Glide Data Grid",
|
|
8638
8638
|
"section": "Comparisons",
|
|
8639
|
-
"markdown": "# SvGrid vs Glide Data Grid\n\nCanonical URL: https://svgrid.com/compare/glide-data-grid/\nFacts verified: 2026-09-12\nCompetitor package: @glideapps/glide-data-grid\nCompetitor site: https://grid.glideapps.com/\n\nGlide Data Grid is a canvas-rendered React data grid built for extreme scroll performance on very large datasets.\n\n## Verdict\n\nGlide wins on raw canvas FPS for hundreds of thousands of visible cells. SvGrid renders accessible, selectable DOM with virtualization and is Svelte-5-native - the right call for most apps.\n\nMigration guide: moving from Glide Data Grid to SvGrid: https://svgrid.com/docs/help/migrating-from-glide/\n\n## At a glance\n\n| Fact | SvGrid | Glide Data Grid | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 6.0.3 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 3 Feb 2024 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (React) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 2,010,000 | 9 Nov 2026 |\n| Bundle, minified + gzip |
|
|
8639
|
+
"markdown": "# SvGrid vs Glide Data Grid\n\nCanonical URL: https://svgrid.com/compare/glide-data-grid/\nFacts verified: 2026-09-12\nCompetitor package: @glideapps/glide-data-grid\nCompetitor site: https://grid.glideapps.com/\n\nGlide Data Grid is a canvas-rendered React data grid built for extreme scroll performance on very large datasets.\n\n## Verdict\n\nGlide wins on raw canvas FPS for hundreds of thousands of visible cells. SvGrid renders accessible, selectable DOM with virtualization and is Svelte-5-native - the right call for most apps.\n\nMigration guide: moving from Glide Data Grid to SvGrid: https://svgrid.com/docs/help/migrating-from-glide/\n\n## At a glance\n\n| Fact | SvGrid | Glide Data Grid | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 6.0.3 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 3 Feb 2024 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (React) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 2,010,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 71.1 KB JS + 0.2 KB CSS, lodash + marked + react + react-dom + react-responsive-carousel external | 9 Nov 2026 |\n| Frameworks | Svelte 5 | React | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | Glide Data Grid is MIT and, in its own words, fully free and open source; no licence is sold for the grid | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; @glideapps/glide-data-grid 6.0.3 entry `DataEditor component` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nGlide Data Grid renders to a <canvas> instead of DOM, which gives it exceptional performance on very wide, very tall datasets at the cost of standard HTML semantics. It is React-only and MIT-licensed.\n\nSvGrid renders virtualized DOM: real table semantics, WAI-ARIA roles, keyboard navigation, and selectable / indexable text. For the vast majority of apps the performance gap is invisible, and you keep accessibility and SEO-friendly markup.\n\n## Looking for a Glide Data Grid alternative for Svelte?\n\nGlide renders to canvas, which is why it is fast and also why text selection, accessibility and custom cells work differently there. SvGrid renders real DOM with virtualization, so a screen reader and browser find behave normally and a cell can be any Svelte snippet. If your bar is a million-row canvas scroll inside React, Glide is still the specialist.\n\n## What they have in common\n\n- MIT-licensed.\n- Virtualized rendering for large datasets.\n- Cell editing and custom cell content.\n- TypeScript-first.\n\n## Where SvGrid is stronger\n\n- Renders real DOM - WAI-ARIA, keyboard nav, screen-reader support, selectable text.\n- Svelte 5 native rather than React-only.\n- Excel-style filter menu, headless engine, and the imperative API out of the box.\n- @svgrid/mcp MCP server for AI assistants.\n\n## Where Glide Data Grid is stronger\n\n- Peak canvas rendering performance on hundreds of thousands of visible cells.\n- Per-pixel custom cell drawing.\n- Proven inside Glide's own product at scale.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | Glide Data Grid |\n| --- | --- | --- |\n| Svelte 5 native | Yes | No - React only |\n| Rendering | Yes - Accessible DOM | Partial - canvas |\n| WAI-ARIA + keyboard | Yes | Partial - Limited (canvas) |\n| Selectable / indexable text | Yes | No - Canvas pixels |\n| Peak FPS on 200k+ visible cells | Partial - Good | Yes - Best |\n| Virtualization | Yes | Yes |\n| Excel-style filters | Yes | No - BYO |\n| AI / MCP integration | Yes | No |\n\n## When to choose SvGrid\n\n- You need accessibility, keyboard support, or selectable text.\n- You are on Svelte 5 and want a native grid.\n- You want filters, editing, and an imperative API without building them.\n\n## When to choose Glide Data Grid\n\n- You have measured a need for peak canvas FPS on 200k+ simultaneously visible cells.\n- You require per-pixel custom cell drawing.\n- Your app is React and accessibility is not a requirement.\n\n## Migration effort\n\nEstimated effort: 3-6 hours per grid.\n\nWhat you give up:\n\n- Canvas rendering throughput on very wide, very dense sheets.\n- The React ecosystem around it, including Glide Data Editor.\n\nMigration guide: moving from Glide Data Grid to SvGrid: https://svgrid.com/docs/help/migrating-from-glide/\n\n## Live example\n\nHeadless Virtual: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/187-headless-virtual/\n\n## The bottom line\n\nGlide is the right tool when you have measured a need for canvas-level FPS on hundreds of thousands of visible cells. For everyone else - and especially when accessibility, selectable text, or Svelte matter - the virtualized DOM in SvGrid is the better default.\n\n## Frequently asked questions\n\n### SvGrid vs Glide Data Grid - which should I use?\n\nUse SvGrid unless you have a measured need for canvas rendering at extreme scale. SvGrid renders accessible DOM and is Svelte-native; Glide is React-only and canvas-based.\n\n### Is Glide faster than SvGrid?\n\nAt hundreds of thousands of simultaneously visible cells, canvas rendering gives Glide higher peak FPS. For typical datasets the difference is invisible, and SvGrid virtualizes comfortably to 100k+ rows.\n\n### Does SvGrid handle accessibility better than Glide?\n\nYes. SvGrid renders real DOM with WAI-ARIA roles, keyboard navigation, and selectable text; a canvas grid like Glide cannot offer those natively.\n\n### Is SvGrid a good Glide Data Grid alternative for Svelte?\n\nGlide renders to canvas, which is why it is fast and also why text selection, accessibility and custom cells work differently there. SvGrid renders real DOM with virtualization, so a screen reader and browser find behave normally and a cell can be any Svelte snippet. If your bar is a million-row canvas scroll inside React, Glide is still the specialist.\n\n## Related comparisons and docs\n\n- [SvGrid vs React Data Grid (adazzle)](https://svgrid.com/compare/react-data-grid/)\n- [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/)\n- [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Headless virtualization](https://svgrid.com/docs/help/headless/virtualization/)\n- [Accessibility](https://svgrid.com/docs/help/accessibility/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- glide-site: MIT, fully free and open source; a React data grid that scales to millions of rows with lazy cell rendering and native scrolling (checked 12 Sep 2026) https://grid.glideapps.com/\n- glide-readme: README explains why the grid renders on an HTML canvas; supports React 16 and later (checked 12 Sep 2026) https://github.com/glideapps/glide-data-grid\n"
|
|
8640
8640
|
},
|
|
8641
8641
|
{
|
|
8642
8642
|
"slug": "compare/gridjs",
|
|
8643
8643
|
"path": "docs/_data/comparisons/gridjs.json",
|
|
8644
8644
|
"title": "SvGrid vs Grid.js",
|
|
8645
8645
|
"section": "Comparisons",
|
|
8646
|
-
"markdown": "# SvGrid vs Grid.js\n\nCanonical URL: https://svgrid.com/compare/gridjs/\nFacts verified: 2026-09-12\nCompetitor package: gridjs\nCompetitor site: https://gridjs.io/\n\nGrid.js is a small, elegant, framework-agnostic table library focused on the essentials, MIT-licensed.\n\n## Verdict\n\nGrid.js is a lovely lightweight pick for search / sort / paginate. SvGrid is the fuller, Svelte-native grid when you need virtualization, editing, grouping, or large datasets.\n\nMigration guide: moving from Grid.js to SvGrid: https://svgrid.com/docs/help/migrating-from-gridjs/\n\n## At a glance\n\n| Fact | SvGrid | Grid.js | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 6.2.0 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 3 Mar 2024 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (JavaScript) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 393,000 | 9 Nov 2026 |\n| Bundle, minified + gzip |
|
|
8646
|
+
"markdown": "# SvGrid vs Grid.js\n\nCanonical URL: https://svgrid.com/compare/gridjs/\nFacts verified: 2026-09-12\nCompetitor package: gridjs\nCompetitor site: https://gridjs.io/\n\nGrid.js is a small, elegant, framework-agnostic table library focused on the essentials, MIT-licensed.\n\n## Verdict\n\nGrid.js is a lovely lightweight pick for search / sort / paginate. SvGrid is the fuller, Svelte-native grid when you need virtualization, editing, grouping, or large datasets.\n\nMigration guide: moving from Grid.js to SvGrid: https://svgrid.com/docs/help/migrating-from-gridjs/\n\n## At a glance\n\n| Fact | SvGrid | Grid.js | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 6.2.0 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 3 Mar 2024 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (JavaScript) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 393,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 17.8 KB JS + 2.4 KB CSS | 9 Nov 2026 |\n| Frameworks | Svelte 5 | JavaScript | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | Grid.js is MIT, free and open source; no licence is sold | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; gridjs 6.2.0 entry `Grid` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nGrid.js keeps a deliberately small surface: search, sort, pagination, and basic server-side data, rendered through a tiny vanilla-JS core with framework wrappers. It is MIT-licensed and easy to learn.\n\nSvGrid trades that minimalism for depth: a Svelte-5-native render component with virtualization, an Excel-style filter menu, inline editing, grouping, tree data, and an imperative API.\n\n## Looking for a Grid.js alternative for Svelte?\n\nGrid.js is deliberately small and covers the essentials well. People outgrow it at the same points every time: virtualization for large datasets, inline editing, row grouping and server-side data. SvGrid has those, and keeps a headless core so a simple table does not have to carry the weight of the full component.\n\n## What they have in common\n\n- MIT-licensed.\n- Search, sort, and pagination out of the box.\n- Server-side data support.\n- Small, approachable API.\n\n## Where SvGrid is stronger\n\n- Svelte 5 native instead of a vanilla core + wrapper.\n- Row + column virtualization for large datasets.\n- Excel-style filters, inline editing, grouping, tree, master/detail.\n- Headless engine + imperative API + @svgrid/mcp.\n\n## Where Grid.js is stronger\n\n- Tiny footprint if all you need is search / sort / paginate.\n- Framework-agnostic core.\n- Very fast to learn for a simple table.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | Grid.js |\n| --- | --- | --- |\n| Svelte 5 native | Yes | No - vanilla JavaScript with React, Angular and Vue wrappers |\n| Search / sort / paginate | Yes | Yes |\n| Excel-style filters | Yes | No |\n| Inline editing | Yes | No |\n| Virtualization | Yes | No |\n| Grouping / tree / master-detail | Yes | No |\n| Footprint for a simple table | Partial - Larger | Yes - Tiny |\n| AI / MCP integration | Yes | No |\n\n## When to choose SvGrid\n\n- You need virtualization, editing, grouping, or tree data.\n- You are on Svelte 5 and want a native component.\n- You expect the table to grow beyond search / sort / paginate.\n\n## When to choose Grid.js\n\n- You only need search / sort / paginate over a modest dataset.\n- You want the smallest possible footprint.\n- You want a framework-agnostic drop-in.\n\n## Migration effort\n\nEstimated effort: 30 minutes to 1 hour per table.\n\nWhat you give up:\n\n- A very small library for a simple table on any page.\n- Wrappers for React, Angular and Vue.\n\nMigration guide: moving from Grid.js to SvGrid: https://svgrid.com/docs/help/migrating-from-gridjs/\n\n## Live example\n\nExcel Filters: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/03-excel-filters/\n\n## The bottom line\n\nGrid.js is a lovely minimalist table for search, sort, and paginate. When you outgrow that - virtualization, editing, grouping, tree - SvGrid is the Svelte-native grid that already covers it.\n\n## Frequently asked questions\n\n### SvGrid vs Grid.js - which should I choose?\n\nGrid.js for a small table that only needs search, sort, and paginate; SvGrid when you need virtualization, editing, Excel-style filters, or grouping.\n\n### Is SvGrid heavier than Grid.js?\n\nYes, because it does much more. For a trivial table Grid.js is lighter; for a real data grid SvGrid pays for itself.\n\n### Does SvGrid support server-side data like Grid.js?\n\nYes - externalSort and externalFilter, plus the onSortingChange and onFiltersChange events.\n\n### Is SvGrid a good Grid.js alternative for Svelte?\n\nGrid.js is deliberately small and covers the essentials well. People outgrow it at the same points every time: virtualization for large datasets, inline editing, row grouping and server-side data. SvGrid has those, and keeps a headless core so a simple table does not have to carry the weight of the full component.\n\n## Related comparisons and docs\n\n- [SvGrid vs Tabulator](https://svgrid.com/compare/tabulator/)\n- [SvGrid vs @vincjo/datatables](https://svgrid.com/compare/vincjo-datatables/)\n- [SvGrid vs Flowbite / Skeleton / shadcn-svelte tables](https://svgrid.com/compare/svelte-ui-kit-tables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Getting started with SvGrid](https://svgrid.com/docs/getting-started/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- gridjs-site: Free and open source under MIT; works with React, Angular, Vue and vanilla JavaScript; an extensible data pipeline (checked 12 Sep 2026) https://gridjs.io/\n"
|
|
8647
8647
|
},
|
|
8648
8648
|
{
|
|
8649
8649
|
"slug": "compare/handsontable",
|
|
@@ -8671,7 +8671,7 @@ export const docs = [
|
|
|
8671
8671
|
"path": "docs/_data/comparisons/mui-x-datagrid.json",
|
|
8672
8672
|
"title": "SvGrid vs MUI X DataGrid",
|
|
8673
8673
|
"section": "Comparisons",
|
|
8674
|
-
"markdown": "# SvGrid vs MUI X DataGrid\n\nCanonical URL: https://svgrid.com/compare/mui-x-datagrid/\nFacts verified: 2026-09-12\nCompetitor package: @mui/x-data-grid\nCompetitor site: https://mui.com/x/react-data-grid/\n\nMUI X DataGrid is the data grid of the Material UI ecosystem on React, split into a free Community tier and paid Pro and Premium tiers.\n\n## Verdict\n\nMUI X is the obvious pick if you are already on Material UI and React. SvGrid is Svelte-5-native, ships more in its MIT core (pinning, master/detail, tree data, grouping and cell selection are not Pro or Premium features), and carries no Material Design opinion.\n\nMigration guide: moving from MUI X DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-mui-x/\n\n## At a glance\n\n| Fact | SvGrid | MUI X DataGrid | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 9.17.0 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 30 Oct 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (React) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 13,100,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 99.6 KB JS + 11.4 KB CSS | 158.4 KB JS, no separate stylesheet, @emotion/react + @emotion/styled + @mui/material + @mui/system + react + react-dom external | 9 Nov 2026 |\n| Frameworks | Svelte 5 | React | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | MUI X Community is free under MIT. mui.com lists Pro at $299 per year per developer, Premium at $599 per year per developer and Enterprise at $1,399 per year per developer, with perpetual and annual licence models | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.34 measured 10 Nov 2026 with packages/grid/scripts/measure-size.mjs; @mui/x-data-grid 9.17.0 entry `DataGrid component` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nMUI X DataGrid is what most React teams on Material UI reach for. The Community edition is MIT and covers sorting, filtering, pagination, CSV export and row virtualization. Column pinning, column virtualization, row reordering, tree data and master/detail are Pro; row grouping, aggregation, cell selection, Excel export, pivoting and the AI assistant are Premium. Both paid tiers are sold per developer per year, and the sources below link to the pages that mark each feature.\n\nSvGrid is the inverse trade: one Svelte-5-native grid whose MIT core already includes pinning, master/detail, tree data, grouping with aggregation, cell-range selection with a fill handle, integrated charts and in-grid AI helpers you point at your own model, plus an optional @svgrid/enterprise pack for Excel, PDF and print output, import and pivot tables.\n\n## Looking for a MUI X DataGrid alternative for Svelte?\n\nMUI X DataGrid is React-only, so this is less an alternative than a port. The concepts carry over almost one to one: column definitions, a free tier and a paid tier, server-side rows, an imperative API. What does not carry over is Material Design: SvGrid is themed through CSS custom properties, so you bring your own look, and Emotion and Material UI stay out of the bundle.\n\n## What they have in common\n\n- A Community / paid split with an MIT free tier.\n- Sorting, filtering, pagination, virtualization and inline editing.\n- Server-side data through a row model the app feeds.\n- TypeScript-first with an imperative API for code outside the component.\n- An official MCP server so AI assistants read the real docs.\n- An in-grid AI assistant driven by natural language.\n\n## Where SvGrid is stronger\n\n- Svelte 5 native: runes and snippets, not a React component behind a wrapper.\n- Column pinning, master/detail, tree data, row grouping with aggregation and cell-range selection are in the MIT core; MUI X sells them as Pro or Premium.\n- The in-grid AI helpers (natural-language filter, smart fill, summarise, classify) are free in @svgrid/grid and run against a provider you register; MUI X's AI assistant is Premium and routes prompts through MUI's hosted service unless you build your own.\n- No Material Design opinion: theme through --sg-* tokens, with no Emotion or Material UI in the bundle. The At a glance table has the measured sizes.\n- Integrated charts in the MIT core, without a separate charts package.\n\n## Where MUI X DataGrid is stronger\n\n- First-class fit if the app is already built on Material UI and React: theming, date pickers and charts share one design system.\n- Pro and Premium features are vendor-supported with priority support and guaranteed response times on the Enterprise plan.\n- A very large React community and years of production use.\n- The Premium AI assistant comes with a hosted prompt service and starter credits, so there is nothing to run yourself.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | MUI X DataGrid |\n| --- | --- | --- |\n| Svelte 5 native | Yes - runes and snippets | No - React only |\n| Sorting, filtering, pagination | Yes | Yes - Community |\n| Row virtualization | Yes | Yes - Community |\n| Column virtualization | Yes | Paid tier - Pro |\n| Column pinning | Yes - MIT core, left and right | Paid tier - Pro |\n| Row reordering by drag | Yes - MIT core | Paid tier - Pro |\n| Master/detail | Yes - MIT core | Paid tier - Pro |\n| Tree data | Yes - MIT core | Paid tier - Pro |\n| Row grouping with aggregation | Yes - MIT core | Paid tier - Premium |\n| Cell-range selection and clipboard | Yes - MIT core, with a fill handle | Paid tier - Premium |\n| CSV export | Yes - MIT core | Yes - Community |\n| Excel export | Paid tier - @svgrid/enterprise | Paid tier - Premium |\n| Pivot tables | Paid tier - @svgrid/enterprise | Paid tier - Premium |\n| Integrated charts | Yes - SvGridChart in the MIT core | Partial - MUI X Charts is a separate package |\n| In-grid AI assistant | Yes - MIT core, bring your own model | Paid tier - Premium, through MUI's hosted service or your own proxy |\n| MCP server for AI assistants | Yes - @svgrid/mcp, MIT: docs, examples, code check, scaffold, preview | Yes - @mui/mcp, free: docs and examples |\n| Inline editing | Yes | Yes - Community |\n| Design-system independence | Yes - --sg-* tokens, no UI framework dependency | Partial - Material UI, Emotion and the MUI system are peer dependencies |\n| Core licence | Yes - MIT | Yes - MIT (Community) |\n\n## When to choose SvGrid\n\n- You are on Svelte 5 and want a grid shaped by runes, not a React component.\n- You want pinning, master/detail, tree data, grouping and cell selection without buying Pro or Premium.\n- You do not want Material Design, Emotion or the MUI system in your bundle.\n- You want the in-grid AI helpers to talk to a model you choose and host.\n\n## When to choose MUI X DataGrid\n\n- Your app is already built on Material UI and React.\n- You need Premium grouping, aggregation, pivoting or Excel export as vendor-supported features with a support contract.\n- You want one grid that matches React teammates across the MUI X suite, including date pickers and charts.\n- You want a hosted AI assistant with nothing to run yourself.\n\n## Migration effort\n\nEstimated effort: 1-3 hours per grid.\n\nWhat you give up:\n\n- Material Design out of the box; SvGrid ships neutral tokens and you theme it.\n- The rest of MUI X in the same design system: date pickers, charts and the tree view.\n- A hosted AI assistant with starter credits; SvGrid's helpers need a model provider you register.\n- React-specific patterns such as slots and hooks; SvGrid uses snippets and props.\n\nMigration guide: moving from MUI X DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-mui-x/\n\n## Live example\n\nTree And Master Detail: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/08-tree-and-master-detail/\n\n## The bottom line\n\nIf your app already lives in Material UI and React, MUI X is the path of least resistance, and its Premium tier now includes a hosted AI assistant. On Svelte 5, SvGrid is the better fit: it puts pinning, master/detail, tree data, grouping and cell selection in the MIT core that MUI X reserves for Pro and Premium, keeps Material UI and Emotion out of the bundle, and runs its AI helpers against a model you choose.\n\n## Frequently asked questions\n\n### SvGrid vs MUI X DataGrid: which one for Svelte?\n\nSvGrid, if your stack is Svelte. MUI X is React-only and depends on Material UI, Emotion and the MUI system as peer dependencies; SvGrid is Svelte-5-native with no design-system dependency.\n\n### Which MUI X Pro and Premium features are free in SvGrid?\n\nColumn pinning, column virtualization, row reordering, master/detail and tree data (Pro in MUI X), and row grouping, aggregation and cell-range selection (Premium in MUI X) ship in the MIT core of SvGrid. Excel export and pivoting are paid on both sides: Premium in MUI X, @svgrid/enterprise in SvGrid.\n\n### Does MUI X have an AI assistant like SvGrid?\n\nYes, in Premium. mui.com describes a natural-language assistant (sort by name, show amounts larger than a value) that sends prompts through a proxy to MUI's hosted service with an API key, with starter credits included and the option to build your own processing service. SvGrid's natural-language filter, smart fill, summarise and classify helpers are free in @svgrid/grid and only run against a model provider you register, so nothing leaves your infrastructure unless you route it there.\n\n### Does MUI ship an MCP server?\n\nYes. @mui/mcp gives an AI client the official docs and code examples for Material UI and MUI X, including the Data Grid. @svgrid/mcp does the same for SvGrid and adds a code checker that validates props and imports against the real API surface, a scaffold tool and a preview.\n\n### Is SvGrid cheaper than MUI X Pro or Premium?\n\nThe prices mui.com listed on the date we read them are in the pricing line at the top of this page, per developer per year for Pro and Premium. SvGrid's core is MIT and @svgrid/enterprise is $599 per developer per year for the enterprise grid or $999 with the spreadsheet and Studio, both for unlimited applications. The difference is what the free tier holds: most features MUI X sells in Pro and Premium are in SvGrid's MIT core, so many teams never need the paid pack.\n\n### How long does a MUI X to SvGrid migration take?\n\nThe migration guide budgets one to three hours per grid. Column definitions and the row model map directly; the time goes into replacing React slots and renderCell functions with Svelte snippets and re-theming away from Material Design.\n\n### Is SvGrid a good MUI X DataGrid alternative for Svelte?\n\nMUI X DataGrid is React-only, so this is less an alternative than a port. The concepts carry over almost one to one: column definitions, a free tier and a paid tier, server-side rows, an imperative API. What does not carry over is Material Design: SvGrid is themed through CSS custom properties, so you bring your own look, and Emotion and Material UI stay out of the bundle.\n\n## Related comparisons and docs\n\n- [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/)\n- [SvGrid vs React Data Grid (adazzle)](https://svgrid.com/compare/react-data-grid/)\n- [SvGrid vs Glide Data Grid](https://svgrid.com/compare/glide-data-grid/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [AI assistant](https://svgrid.com/docs/help/ai/)\n- [Column pinning](https://svgrid.com/docs/help/columns/column-pinning/)\n- [Master / detail (nested grids)](https://svgrid.com/docs/help/rows/master-detail/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- mui-overview: Feature list with plan badges: CSV export, cell editing and row virtualization in Community; column pinning, column reordering, row reordering, tree data and column virtualization Pro; row grouping, aggregation, Excel export and pivoting Premium; React package with Material UI peer dependencies (checked 12 Sep 2026) https://mui.com/x/react-data-grid/\n- mui-master-detail: Master-detail row panels carry the Pro plan badge (checked 12 Sep 2026) https://mui.com/x/react-data-grid/master-detail/\n- mui-cell-selection: Cell selection carries the Premium plan badge: with the Data Grid Premium, you can apply the cellSelection prop (checked 12 Sep 2026) https://mui.com/x/react-data-grid/cell-selection/\n- mui-ai-assistant: AI Assistant is Premium: natural-language prompts such as sort by name or show amounts larger than 1000, sent through a server-side proxy to MUI's hosted service with an API key from MUI Console; Premium licence holders get starter credits; a self-built prompt service is optional (checked 12 Sep 2026) https://mui.com/x/react-data-grid/ai-assistant/\n- mui-mcp: Official MCP server (@mui/mcp) that quotes the official docs and code examples for MUI X components including the Data Grid; installed with npx, no payment (checked 12 Sep 2026) https://mui.com/x/introduction/mcp/\n- mui-pricing: Community free forever under MIT; Pro $299 per year per dev; Premium $599 per year per dev; Enterprise $1,399 per year per dev; perpetual and annual models both allow perpetual production use (checked 12 Sep 2026) https://mui.com/pricing/\n"
|
|
8674
|
+
"markdown": "# SvGrid vs MUI X DataGrid\n\nCanonical URL: https://svgrid.com/compare/mui-x-datagrid/\nFacts verified: 2026-09-12\nCompetitor package: @mui/x-data-grid\nCompetitor site: https://mui.com/x/react-data-grid/\n\nMUI X DataGrid is the data grid of the Material UI ecosystem on React, split into a free Community tier and paid Pro and Premium tiers.\n\n## Verdict\n\nMUI X is the obvious pick if you are already on Material UI and React. SvGrid is Svelte-5-native, ships more in its MIT core (pinning, master/detail, tree data, grouping and cell selection are not Pro or Premium features), and carries no Material Design opinion.\n\nMigration guide: moving from MUI X DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-mui-x/\n\n## At a glance\n\n| Fact | SvGrid | MUI X DataGrid | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 9.17.0 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 30 Oct 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (React) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 13,100,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 158.4 KB JS, no separate stylesheet, @emotion/react + @emotion/styled + @mui/material + @mui/system + react + react-dom external | 9 Nov 2026 |\n| Frameworks | Svelte 5 | React | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | MUI X Community is free under MIT. mui.com lists Pro at $299 per year per developer, Premium at $599 per year per developer and Enterprise at $1,399 per year per developer, with perpetual and annual licence models | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; @mui/x-data-grid 9.17.0 entry `DataGrid component` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nMUI X DataGrid is what most React teams on Material UI reach for. The Community edition is MIT and covers sorting, filtering, pagination, CSV export and row virtualization. Column pinning, column virtualization, row reordering, tree data and master/detail are Pro; row grouping, aggregation, cell selection, Excel export, pivoting and the AI assistant are Premium. Both paid tiers are sold per developer per year, and the sources below link to the pages that mark each feature.\n\nSvGrid is the inverse trade: one Svelte-5-native grid whose MIT core already includes pinning, master/detail, tree data, grouping with aggregation, cell-range selection with a fill handle, integrated charts and in-grid AI helpers you point at your own model, plus an optional @svgrid/enterprise pack for Excel, PDF and print output, import and pivot tables.\n\n## Looking for a MUI X DataGrid alternative for Svelte?\n\nMUI X DataGrid is React-only, so this is less an alternative than a port. The concepts carry over almost one to one: column definitions, a free tier and a paid tier, server-side rows, an imperative API. What does not carry over is Material Design: SvGrid is themed through CSS custom properties, so you bring your own look, and Emotion and Material UI stay out of the bundle.\n\n## What they have in common\n\n- A Community / paid split with an MIT free tier.\n- Sorting, filtering, pagination, virtualization and inline editing.\n- Server-side data through a row model the app feeds.\n- TypeScript-first with an imperative API for code outside the component.\n- An official MCP server so AI assistants read the real docs.\n- An in-grid AI assistant driven by natural language.\n\n## Where SvGrid is stronger\n\n- Svelte 5 native: runes and snippets, not a React component behind a wrapper.\n- Column pinning, master/detail, tree data, row grouping with aggregation and cell-range selection are in the MIT core; MUI X sells them as Pro or Premium.\n- The in-grid AI helpers (natural-language filter, smart fill, summarise, classify) are free in @svgrid/grid and run against a provider you register; MUI X's AI assistant is Premium and routes prompts through MUI's hosted service unless you build your own.\n- No Material Design opinion: theme through --sg-* tokens, with no Emotion or Material UI in the bundle. The At a glance table has the measured sizes.\n- Integrated charts in the MIT core, without a separate charts package.\n\n## Where MUI X DataGrid is stronger\n\n- First-class fit if the app is already built on Material UI and React: theming, date pickers and charts share one design system.\n- Pro and Premium features are vendor-supported with priority support and guaranteed response times on the Enterprise plan.\n- A very large React community and years of production use.\n- The Premium AI assistant comes with a hosted prompt service and starter credits, so there is nothing to run yourself.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | MUI X DataGrid |\n| --- | --- | --- |\n| Svelte 5 native | Yes - runes and snippets | No - React only |\n| Sorting, filtering, pagination | Yes | Yes - Community |\n| Row virtualization | Yes | Yes - Community |\n| Column virtualization | Yes | Paid tier - Pro |\n| Column pinning | Yes - MIT core, left and right | Paid tier - Pro |\n| Row reordering by drag | Yes - MIT core | Paid tier - Pro |\n| Master/detail | Yes - MIT core | Paid tier - Pro |\n| Tree data | Yes - MIT core | Paid tier - Pro |\n| Row grouping with aggregation | Yes - MIT core | Paid tier - Premium |\n| Cell-range selection and clipboard | Yes - MIT core, with a fill handle | Paid tier - Premium |\n| CSV export | Yes - MIT core | Yes - Community |\n| Excel export | Paid tier - @svgrid/enterprise | Paid tier - Premium |\n| Pivot tables | Paid tier - @svgrid/enterprise | Paid tier - Premium |\n| Integrated charts | Yes - SvGridChart in the MIT core | Partial - MUI X Charts is a separate package |\n| In-grid AI assistant | Yes - MIT core, bring your own model | Paid tier - Premium, through MUI's hosted service or your own proxy |\n| MCP server for AI assistants | Yes - @svgrid/mcp, MIT: docs, examples, code check, scaffold, preview | Yes - @mui/mcp, free: docs and examples |\n| Inline editing | Yes | Yes - Community |\n| Design-system independence | Yes - --sg-* tokens, no UI framework dependency | Partial - Material UI, Emotion and the MUI system are peer dependencies |\n| Core licence | Yes - MIT | Yes - MIT (Community) |\n\n## When to choose SvGrid\n\n- You are on Svelte 5 and want a grid shaped by runes, not a React component.\n- You want pinning, master/detail, tree data, grouping and cell selection without buying Pro or Premium.\n- You do not want Material Design, Emotion or the MUI system in your bundle.\n- You want the in-grid AI helpers to talk to a model you choose and host.\n\n## When to choose MUI X DataGrid\n\n- Your app is already built on Material UI and React.\n- You need Premium grouping, aggregation, pivoting or Excel export as vendor-supported features with a support contract.\n- You want one grid that matches React teammates across the MUI X suite, including date pickers and charts.\n- You want a hosted AI assistant with nothing to run yourself.\n\n## Migration effort\n\nEstimated effort: 1-3 hours per grid.\n\nWhat you give up:\n\n- Material Design out of the box; SvGrid ships neutral tokens and you theme it.\n- The rest of MUI X in the same design system: date pickers, charts and the tree view.\n- A hosted AI assistant with starter credits; SvGrid's helpers need a model provider you register.\n- React-specific patterns such as slots and hooks; SvGrid uses snippets and props.\n\nMigration guide: moving from MUI X DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-mui-x/\n\n## Live example\n\nTree And Master Detail: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/08-tree-and-master-detail/\n\n## The bottom line\n\nIf your app already lives in Material UI and React, MUI X is the path of least resistance, and its Premium tier now includes a hosted AI assistant. On Svelte 5, SvGrid is the better fit: it puts pinning, master/detail, tree data, grouping and cell selection in the MIT core that MUI X reserves for Pro and Premium, keeps Material UI and Emotion out of the bundle, and runs its AI helpers against a model you choose.\n\n## Frequently asked questions\n\n### SvGrid vs MUI X DataGrid: which one for Svelte?\n\nSvGrid, if your stack is Svelte. MUI X is React-only and depends on Material UI, Emotion and the MUI system as peer dependencies; SvGrid is Svelte-5-native with no design-system dependency.\n\n### Which MUI X Pro and Premium features are free in SvGrid?\n\nColumn pinning, column virtualization, row reordering, master/detail and tree data (Pro in MUI X), and row grouping, aggregation and cell-range selection (Premium in MUI X) ship in the MIT core of SvGrid. Excel export and pivoting are paid on both sides: Premium in MUI X, @svgrid/enterprise in SvGrid.\n\n### Does MUI X have an AI assistant like SvGrid?\n\nYes, in Premium. mui.com describes a natural-language assistant (sort by name, show amounts larger than a value) that sends prompts through a proxy to MUI's hosted service with an API key, with starter credits included and the option to build your own processing service. SvGrid's natural-language filter, smart fill, summarise and classify helpers are free in @svgrid/grid and only run against a model provider you register, so nothing leaves your infrastructure unless you route it there.\n\n### Does MUI ship an MCP server?\n\nYes. @mui/mcp gives an AI client the official docs and code examples for Material UI and MUI X, including the Data Grid. @svgrid/mcp does the same for SvGrid and adds a code checker that validates props and imports against the real API surface, a scaffold tool and a preview.\n\n### Is SvGrid cheaper than MUI X Pro or Premium?\n\nThe prices mui.com listed on the date we read them are in the pricing line at the top of this page, per developer per year for Pro and Premium. SvGrid's core is MIT and @svgrid/enterprise is $599 per developer per year for the enterprise grid or $999 with the spreadsheet and Studio, both for unlimited applications. The difference is what the free tier holds: most features MUI X sells in Pro and Premium are in SvGrid's MIT core, so many teams never need the paid pack.\n\n### How long does a MUI X to SvGrid migration take?\n\nThe migration guide budgets one to three hours per grid. Column definitions and the row model map directly; the time goes into replacing React slots and renderCell functions with Svelte snippets and re-theming away from Material Design.\n\n### Is SvGrid a good MUI X DataGrid alternative for Svelte?\n\nMUI X DataGrid is React-only, so this is less an alternative than a port. The concepts carry over almost one to one: column definitions, a free tier and a paid tier, server-side rows, an imperative API. What does not carry over is Material Design: SvGrid is themed through CSS custom properties, so you bring your own look, and Emotion and Material UI stay out of the bundle.\n\n## Related comparisons and docs\n\n- [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/)\n- [SvGrid vs React Data Grid (adazzle)](https://svgrid.com/compare/react-data-grid/)\n- [SvGrid vs Glide Data Grid](https://svgrid.com/compare/glide-data-grid/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [AI assistant](https://svgrid.com/docs/help/ai/)\n- [Column pinning](https://svgrid.com/docs/help/columns/column-pinning/)\n- [Master / detail (nested grids)](https://svgrid.com/docs/help/rows/master-detail/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- mui-overview: Feature list with plan badges: CSV export, cell editing and row virtualization in Community; column pinning, column reordering, row reordering, tree data and column virtualization Pro; row grouping, aggregation, Excel export and pivoting Premium; React package with Material UI peer dependencies (checked 12 Sep 2026) https://mui.com/x/react-data-grid/\n- mui-master-detail: Master-detail row panels carry the Pro plan badge (checked 12 Sep 2026) https://mui.com/x/react-data-grid/master-detail/\n- mui-cell-selection: Cell selection carries the Premium plan badge: with the Data Grid Premium, you can apply the cellSelection prop (checked 12 Sep 2026) https://mui.com/x/react-data-grid/cell-selection/\n- mui-ai-assistant: AI Assistant is Premium: natural-language prompts such as sort by name or show amounts larger than 1000, sent through a server-side proxy to MUI's hosted service with an API key from MUI Console; Premium licence holders get starter credits; a self-built prompt service is optional (checked 12 Sep 2026) https://mui.com/x/react-data-grid/ai-assistant/\n- mui-mcp: Official MCP server (@mui/mcp) that quotes the official docs and code examples for MUI X components including the Data Grid; installed with npx, no payment (checked 12 Sep 2026) https://mui.com/x/introduction/mcp/\n- mui-pricing: Community free forever under MIT; Pro $299 per year per dev; Premium $599 per year per dev; Enterprise $1,399 per year per dev; perpetual and annual models both allow perpetual production use (checked 12 Sep 2026) https://mui.com/pricing/\n"
|
|
8675
8675
|
},
|
|
8676
8676
|
{
|
|
8677
8677
|
"slug": "compare/nocodb",
|
|
@@ -8692,7 +8692,7 @@ export const docs = [
|
|
|
8692
8692
|
"path": "docs/_data/comparisons/react-data-grid.json",
|
|
8693
8693
|
"title": "SvGrid vs React Data Grid (adazzle)",
|
|
8694
8694
|
"section": "Comparisons",
|
|
8695
|
-
"markdown": "# SvGrid vs React Data Grid (adazzle)\n\nCanonical URL: https://svgrid.com/compare/react-data-grid/\nFacts verified: 2026-09-12\nCompetitor package: react-data-grid\nCompetitor site: https://github.com/adazzle/react-data-grid\n\nreact-data-grid is a fast, Excel-like data grid for React, MIT-licensed.\n\n## Verdict\n\nreact-data-grid is a strong, lightweight React grid with great editing. SvGrid is the Svelte-5-native equivalent, with a similar feature set and no React dependency.\n\nMigration guide: moving from React Data Grid (adazzle) to SvGrid: https://svgrid.com/docs/help/migrating-from-react-data-grid/\n\n## At a glance\n\n| Fact | SvGrid | React Data Grid (adazzle) | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 7.0.0-beta.64 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 5 Nov 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (React) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 2,650,000 | 9 Nov 2026 |\n| Bundle, minified + gzip |
|
|
8695
|
+
"markdown": "# SvGrid vs React Data Grid (adazzle)\n\nCanonical URL: https://svgrid.com/compare/react-data-grid/\nFacts verified: 2026-09-12\nCompetitor package: react-data-grid\nCompetitor site: https://github.com/adazzle/react-data-grid\n\nreact-data-grid is a fast, Excel-like data grid for React, MIT-licensed.\n\n## Verdict\n\nreact-data-grid is a strong, lightweight React grid with great editing. SvGrid is the Svelte-5-native equivalent, with a similar feature set and no React dependency.\n\nMigration guide: moving from React Data Grid (adazzle) to SvGrid: https://svgrid.com/docs/help/migrating-from-react-data-grid/\n\n## At a glance\n\n| Fact | SvGrid | React Data Grid (adazzle) | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 7.0.0-beta.64 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 5 Nov 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (React) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 2,650,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 25.6 KB JS + 2.3 KB CSS, react + react-dom external | 9 Nov 2026 |\n| Frameworks | Svelte 5 | React | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | react-data-grid is MIT on npm and free; no licence is sold | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; react-data-grid 7.0.0-beta.64 entry `DataGrid component` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nreact-data-grid (the adazzle project) is a focused, performant React grid known for spreadsheet-style editing, virtualization, and a clean column API. It is MIT-licensed and React-only.\n\nSvGrid offers the same shape - virtualized DOM, typed columns, inline editing, custom cells - built on Svelte 5 runes and snippets rather than React components.\n\n## Looking for a React Data Grid alternative for Svelte?\n\nreact-data-grid is React-only, so this is a port rather than a swap, and the shapes line up well: both are Excel-like, both MIT, both driven by column definitions. Cell renderers become Svelte snippets and hooks become runes. If you are staying on React, there is no reason to move.\n\n## What they have in common\n\n- MIT-licensed.\n- Virtualized rows and columns.\n- Spreadsheet-style inline editing.\n- Typed column definitions.\n\n## Where SvGrid is stronger\n\n- Svelte 5 native - runes and snippets, not React.\n- Built-in Excel-style filter menu and the imperative API.\n- Grouping, tree data, and master/detail in the core.\n- @svgrid/mcp MCP server + optional Enterprise pack.\n\n## Where React Data Grid (adazzle) is stronger\n\n- First-class fit for a React codebase.\n- Mature, focused, and battle-tested in React apps.\n- Large React community.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | React Data Grid (adazzle) |\n| --- | --- | --- |\n| Svelte 5 native | Yes | No - React only |\n| Virtualization | Yes | Yes |\n| Inline editing | Yes | Yes |\n| Excel-style filter menu | Yes | Partial - BYO filter UI |\n| Grouping / tree | Yes | Yes - row grouping and a TreeDataGrid |\n| Master/detail | Yes | Partial - bring your own detail row |\n| Headless engine | Yes | No |\n| AI / MCP integration | Yes | No |\n| Fill handle and copy/paste | Yes | Yes - cell copy, paste and value dragging |\n\n## When to choose SvGrid\n\n- You are on Svelte 5 rather than React.\n- You want filters, grouping, and master/detail without building them.\n- You want a headless engine option and an MCP server.\n\n## When to choose React Data Grid (adazzle)\n\n- Your app is React and you want a focused, proven grid.\n- You want the React community and ecosystem around it.\n- You only need the feature set react-data-grid already covers.\n\n## Migration effort\n\nEstimated effort: 2-4 hours per grid.\n\nWhat you give up:\n\n- A very small React grid with the spreadsheet basics built in.\n- React 19 features such as the use hook in cell renderers.\n\nMigration guide: moving from React Data Grid (adazzle) to SvGrid: https://svgrid.com/docs/help/migrating-from-react-data-grid/\n\n## Live example\n\nFill Handle: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/95-fill-handle/\n\n## The bottom line\n\nreact-data-grid is a strong, focused choice in React. On Svelte 5, SvGrid is the equivalent - similar editing and virtualization - plus a built-in filter menu, grouping, and a headless core, with no React dependency.\n\n## Frequently asked questions\n\n### SvGrid vs react-data-grid - which for Svelte?\n\nSvGrid - it is Svelte-5-native, while react-data-grid is React-only. They share a similar editing and virtualization model.\n\n### Does SvGrid have built-in filtering unlike react-data-grid?\n\nYes - SvGrid ships an Excel-style filter menu and a global filter; react-data-grid leaves the filter UI to you.\n\n### Is SvGrid free like react-data-grid?\n\nYes, the core is MIT. SvGrid adds an optional Enterprise pack for export, import, pivot, and AI.\n\n### Is SvGrid a good React Data Grid alternative for Svelte?\n\nreact-data-grid is React-only, so this is a port rather than a swap, and the shapes line up well: both are Excel-like, both MIT, both driven by column definitions. Cell renderers become Svelte snippets and hooks become runes. If you are staying on React, there is no reason to move.\n\n## Related comparisons and docs\n\n- [SvGrid vs Glide Data Grid](https://svgrid.com/compare/glide-data-grid/)\n- [SvGrid vs MUI X DataGrid](https://svgrid.com/compare/mui-x-datagrid/)\n- [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Cell text selection](https://svgrid.com/docs/help/cells/cell-text-selection/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- rdg-readme: React 19.2+; virtualization of rows and columns, multi-column sorting, cell editing, row grouping and a TreeDataGrid, frozen columns, cell copy and paste, cell value dragging; light and dark mode through color-scheme (checked 12 Sep 2026) https://github.com/adazzle/react-data-grid\n- rdg-npm: The latest tag is a 7.0 beta line; licence MIT (checked 12 Sep 2026) https://www.npmjs.com/package/react-data-grid\n"
|
|
8696
8696
|
},
|
|
8697
8697
|
{
|
|
8698
8698
|
"slug": "compare/smart-grid",
|
|
@@ -8706,14 +8706,14 @@ export const docs = [
|
|
|
8706
8706
|
"path": "docs/_data/comparisons/svar-svelte-datagrid.json",
|
|
8707
8707
|
"title": "SvGrid vs SVAR Svelte DataGrid",
|
|
8708
8708
|
"section": "Comparisons",
|
|
8709
|
-
"markdown": "# SvGrid vs SVAR Svelte DataGrid\n\nCanonical URL: https://svgrid.com/compare/svar-svelte-datagrid/\nFacts verified: 2026-09-12\nCompetitor package: @svar-ui/svelte-grid\nCompetitor site: https://svar.dev/svelte/datagrid/\n\nSVAR Svelte DataGrid (@svar-ui/svelte-grid, formerly wx-svelte-grid) is a Svelte-native, MIT-licensed data grid from XB Software, the team behind Webix, with React and Vue versions of the same grid.\n\n## Verdict\n\nSVAR is the closest genuinely Svelte-native rival: both grids are MIT and both target Svelte 5. SvGrid has the wider capability surface (grouping with aggregation, master/detail, Excel-style range editing with a fill handle, integrated charts, a headless core, in-grid AI helpers and an MCP server); SVAR is the smaller grid with print in the free package, React and Vue versions, and the Webix team behind it.\n\nMigration guide: moving from SVAR Svelte DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-svar-svelte-datagrid/\n\n## At a glance\n\n| Fact | SvGrid | SVAR Svelte DataGrid | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 2.7.6 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 7 Nov 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Yes (peer svelte ^5.0.0) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 106,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 99.6 KB JS + 11.4 KB CSS | 53.1 KB JS, no separate stylesheet, svelte external | 9 Nov 2026 |\n| Engine alone, minified + gzip | 3.2 KB JS, no separate stylesheet (`createSvGrid` from `@svgrid/grid/core`) | the row above; the package is the engine | 10 Nov 2026 |\n| Frameworks | Svelte 5 | Svelte, React, Vue | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | The DataGrid is MIT and free for commercial use with no paid tier; svar.dev sells PRO editions of its Gantt, Calendar and Kanban components and offers paid consulting and custom development, with no price list for the grid | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.34 measured 10 Nov 2026 with packages/grid/scripts/measure-size.mjs; @svar-ui/svelte-grid 2.7.6 entry `Grid component` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nSVAR DataGrid (npm: @svar-ui/svelte-grid; the older wx-svelte-grid package is deprecated and points to it) is part of the SVAR suite from XB Software, the makers of Webix, and is one of the few grids built for Svelte rather than wrapped from another framework. Its docs list in-cell editing, header and advanced filtering, single and multi-column sorting, tree data, virtual scrolling for rows and columns, columns pinned to the left, column and row spans in the header and footer, auto-sized rows, undo and redo, a context menu, row reordering, CSV export, a print API and a REST data provider, all under MIT.\n\nSvGrid overlaps on the Svelte-native angle and reaches further: row grouping with aggregation, master/detail, Excel-style cell-range selection with clipboard and a fill handle, pinned rows and left and right column pinning, integrated charts, a server-side row model, a headless engine, in-grid AI helpers and the @svgrid/mcp server, all in the MIT package. Excel, PDF and print output, import, pivot tables and the Kanban and Scheduler views of the grid live in the paid @svgrid/enterprise pack, whereas SVAR keeps its grid entirely free and sells PRO editions of its Gantt, Calendar and Kanban instead.\n\n## Looking for a SVAR Svelte DataGrid alternative for Svelte?\n\nThe closest comparison on this list, since both are Svelte-native and both are MIT, so licensing does not decide it. The differences are depth and direction: SvGrid ships a larger feature surface, a UI component suite, in-grid AI helpers and an MCP server, while SVAR spans Svelte, React and Vue and keeps a smaller core. The At a glance table above has both measured bundle sizes; if a compact MIT grid with sorting, filtering, editing, tree data and CSV export is all you need, SVAR is a perfectly good answer.\n\n## What they have in common\n\n- Purpose-built for Svelte 5, not a cross-framework wrapper.\n- MIT-licensed and free for commercial use.\n- Sorting, filtering, in-cell editing, virtualization on rows and columns, tree data.\n- Auto-sized row heights, undo and redo, a context menu and drag-and-drop row reordering.\n- Themeable through CSS variables with light and dark themes, localization, WAI-ARIA markup and keyboard navigation.\n\n## Where SvGrid is stronger\n\n- Row grouping with aggregation and a drag-and-drop group panel; SVAR's docs list neither.\n- Master/detail and expandable detail rows; SVAR offers tree data only.\n- Excel-style cell-range selection with clipboard copy and paste and a fill handle; SVAR selects rows.\n- Pinned top and bottom rows, and columns pinned left and right; SVAR pins columns to the left only.\n- Integrated charts with no dependency, plus a chart wizard.\n- A server-side row model with cursor pagination, GraphQL, websocket and optimistic updates, beyond a REST data provider.\n- A headless engine (createSvGrid) you can compose, in addition to the render component.\n- In-grid AI helpers free in @svgrid/grid, and @svgrid/mcp with llms.txt so assistants answer and write code accurately.\n- A paid pack with Excel, PDF and styled-HTML export, print, pivot tables, Excel and CSV import and support. CSV, TSV and JSON export are free in the grid.\n\n## Where SVAR Svelte DataGrid is stronger\n\n- The whole grid is free, print API included; SvGrid puts print and Excel and PDF export in the paid pack. Both export CSV for free.\n- The same grid for React and Vue as well as Svelte; SvGrid is Svelte-only by design.\n- A smaller bundle: the At a glance table has both measured numbers.\n- XB Software and Webix behind it, a team that has built data grids for a long time.\n- Part of the wider SVAR suite, with paid consulting and custom development on offer.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | SVAR Svelte DataGrid |\n| --- | --- | --- |\n| Svelte 5 native | Yes | Yes - Svelte 5 compatible |\n| Licence | Yes - MIT core, paid enterprise pack | Yes - MIT, the grid is entirely free |\n| Headless engine | Yes - createSvGrid | No - component only |\n| Excel-style filter menu | Yes - built in | Yes - header filters plus the SVAR Filter component |\n| Cell-range selection and clipboard | Yes - built in | No - single and multiple row selection |\n| Fill handle | Yes | No - not in the feature list |\n| Row grouping with aggregation | Yes - with a group panel | No - not in the feature list |\n| Master/detail rows | Yes | No - tree data only |\n| Tree data | Yes | Yes |\n| Pinned columns | Yes - left and right | Partial - to the left |\n| Pinned rows (top and bottom) | Yes | No - not in the feature list |\n| Header and footer column spans | Yes | Yes |\n| Auto-sized row height | Yes - autoRowHeight | Yes |\n| Virtualization (rows and columns) | Yes | Yes |\n| Undo and redo, context menu, row drag | Yes | Yes |\n| Integrated charts | Yes - no dependency, plus a chart wizard | No - not in the feature list |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes - createServerDataSource: page or infinite block scroll, cursor, GraphQL, websocket | Partial - RestDataProvider and dynamic loading while scrolling |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise | No - not in the feature list |\n| CSV export | Yes - free, with TSV and JSON | Yes - free |\n| Excel and PDF export | Paid tier - @svgrid/enterprise | No - CSV only in the feature list |\n| Print | Paid tier - @svgrid/enterprise | Yes - print API, free |\n| Pivot tables | Paid tier - @svgrid/enterprise | No - not in the SVAR Svelte product list |\n| React and Vue versions | No - Svelte only | Yes |\n| In-grid AI helpers and MCP server | Yes - helpers free in @svgrid/grid; @svgrid/mcp, MIT | No - not mentioned in the docs |\n| Paid support | Yes - with @svgrid/enterprise, per developer per year | Partial - paid consulting and custom development; no support plan for the grid listed |\n\n## When to choose SvGrid\n\n- You need grouping with aggregation, master/detail, Excel-style range editing or pivot tables, which SVAR's docs do not list.\n- You want a headless engine plus a render component, not a component-only API.\n- You want integrated charts and a full server-side row model in one library.\n- You want in-grid AI helpers, an MCP server that checks generated code, and a paid support tier.\n\n## When to choose SVAR Svelte DataGrid\n\n- You want a fully free grid with print included and no paid tier at all.\n- You ship to React and Vue as well as Svelte and want one grid across them.\n- A smaller bundle matters more than grouping with aggregation, master/detail, range editing and the other features SvGrid adds.\n- You are already adopting the wider SVAR suite: Gantt, Calendar, Kanban, File Manager.\n\n## Migration effort\n\nEstimated effort: 2-4 hours per grid.\n\nWhat you give up:\n\n- Free printing: SVAR's print API is in the MIT grid, SvGrid's print view is in @svgrid/enterprise.\n- The React and Vue versions of the same grid.\n- A smaller bundle, by the measurements in the At a glance table.\n- The SVAR suite around the grid: Gantt, Calendar, Kanban and File Manager share its core.\n\nMigration guide: moving from SVAR Svelte DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-svar-svelte-datagrid/\n\n## Live example\n\nGrouping Aggregation: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/07-grouping-aggregation/\n\n## The bottom line\n\nBoth grids are Svelte-5-native and MIT, so this is not a licensing call. On capability SvGrid is the more complete grid: grouping, master/detail, range editing with a fill handle, charts, a server-side row model, a headless core, AI helpers and an MCP server. SVAR is the smaller, fully free, multi-framework option from the Webix team, and it prints for free where SvGrid charges for print and Excel and PDF export. Choose SvGrid when you need the deeper feature set or support; choose SVAR when a compact free grid covers your needs or you also ship React and Vue.\n\n## Frequently asked questions\n\n### SvGrid vs SVAR Svelte DataGrid: what is the difference?\n\nBoth are MIT-licensed, Svelte-5-native grids. SvGrid is the broader product: row grouping with aggregation, master/detail, Excel-style range selection with a fill handle, integrated charts, a server-side row model, a headless core, in-grid AI helpers and an MCP server. SVAR is a smaller, fully free grid with React and Vue versions from XB Software, with CSV export and a print API included.\n\n### Are SvGrid and SVAR both free?\n\nBoth are free under MIT, including commercial use. SVAR keeps the whole grid free, CSV export and print included, and sells PRO editions of its Gantt, Calendar and Kanban. SvGrid's grid is free too, including CSV, TSV and JSON export, charts and the AI helpers; Excel, PDF and print output, import, pivot tables, the Kanban and Scheduler views and support are in @svgrid/enterprise at $599 per developer per year.\n\n### Are both built for Svelte 5?\n\nYes. SvGrid is written in Svelte 5 runes, and svar.dev states the DataGrid is Svelte 5 compatible. Neither is a cross-framework wrapper, although SVAR also ships React and Vue versions of its grid.\n\n### Which grid is smaller?\n\nSVAR, by the measurements in the At a glance table: both packages were built alone with Vite, minified and gzipped with Svelte external, on the dates shown. SvGrid's extra size buys grouping, master/detail, range editing, charts and the server-side row model; features you never import, such as the date editors, menus and charts, load as separate chunks.\n\n### Does SVAR have row grouping, master/detail or cell-range selection?\n\nNot according to its docs overview on the date we read it, which lists tree data, single and multiple row selection, header and advanced filters, sorting, in-cell editing, columns pinned to the left, CSV export and a print API. SvGrid has all three in the MIT core, and the demos on this page show them.\n\n### How long does a SVAR to SvGrid migration take?\n\nThe migration guide budgets two to four hours per grid: a prop and event rename pass, since both use array-of-object column definitions, plus re-theming through --sg-* tokens.\n\n### Is SvGrid a good SVAR Svelte DataGrid alternative for Svelte?\n\nThe closest comparison on this list, since both are Svelte-native and both are MIT, so licensing does not decide it. The differences are depth and direction: SvGrid ships a larger feature surface, a UI component suite, in-grid AI helpers and an MCP server, while SVAR spans Svelte, React and Vue and keeps a smaller core. The At a glance table above has both measured bundle sizes; if a compact MIT grid with sorting, filtering, editing, tree data and CSV export is all you need, SVAR is a perfectly good answer.\n\n## Related comparisons and docs\n\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/)\n- [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/)\n- [SvGrid vs @vincjo/datatables](https://svgrid.com/compare/vincjo-datatables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Grouping & aggregation](https://svgrid.com/docs/help/grouping-aggregation/)\n- [Master / detail (nested grids)](https://svgrid.com/docs/help/rows/master-detail/)\n- [Build a table from scratch](https://svgrid.com/docs/help/headless/build-a-table/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- svar-datagrid: Licensed under MIT; Svelte 5 compatible; React and Vue versions available; lists multi-column sorting, header filters, in-cell editing, tree data, virtual scrolling, columns pinned to the left, context menu, row drag-and-drop, checkbox selection, pagination, hotkeys, WAI-ARIA, print, undo/redo (checked 12 Sep 2026) https://svar.dev/svelte/datagrid/\n- svar-overview: Feature list: in-cell editing, header and advanced filtering, sorting, single and multiple row selection, row reordering, context menu, undo/redo, tree data, pagination, colspans and rowspans in header and footer, collapsible column groups, pinned columns to the left, auto-sizing of rows and columns, localization, themes, export to CSV, print API, RestDataProvider, virtual scrolling for rows and columns, WAI-ARIA, keyboard navigation; no Excel export, row grouping, aggregation, master/detail, charts, AI or MCP (checked 12 Sep 2026) https://docs.svar.dev/svelte/grid/overview/\n- svar-svelte: DataGrid, Filter, Editor, File Manager and Core are MIT; Gantt, Calendar and Kanban have MIT cores with paid PRO editions; no pivot component in the list; no price list on the page (checked 12 Sep 2026) https://svar.dev/svelte/\n- svar-gantt: Offers paid consulting and custom development services; PRO edition pricing is on a separate page (checked 12 Sep 2026) https://svar.dev/svelte/gantt/\n"
|
|
8709
|
+
"markdown": "# SvGrid vs SVAR Svelte DataGrid\n\nCanonical URL: https://svgrid.com/compare/svar-svelte-datagrid/\nFacts verified: 2026-09-12\nCompetitor package: @svar-ui/svelte-grid\nCompetitor site: https://svar.dev/svelte/datagrid/\n\nSVAR Svelte DataGrid (@svar-ui/svelte-grid, formerly wx-svelte-grid) is a Svelte-native, MIT-licensed data grid from XB Software, the team behind Webix, with React and Vue versions of the same grid.\n\n## Verdict\n\nSVAR is the closest genuinely Svelte-native rival: both grids are MIT and both target Svelte 5. SvGrid has the wider capability surface (grouping with aggregation, master/detail, Excel-style range editing with a fill handle, integrated charts, a headless core, in-grid AI helpers and an MCP server); SVAR is the smaller grid with print in the free package, React and Vue versions, and the Webix team behind it.\n\nMigration guide: moving from SVAR Svelte DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-svar-svelte-datagrid/\n\n## At a glance\n\n| Fact | SvGrid | SVAR Svelte DataGrid | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 2.7.6 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 7 Nov 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Yes (peer svelte ^5.0.0) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 106,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 53.1 KB JS, no separate stylesheet, svelte external | 9 Nov 2026 |\n| Engine alone, minified + gzip | 3.2 KB JS, no separate stylesheet (`createSvGrid` from `@svgrid/grid/core`) | the row above; the package is the engine | 17 Nov 2026 |\n| Frameworks | Svelte 5 | Svelte, React, Vue | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | The DataGrid is MIT and free for commercial use with no paid tier; svar.dev sells PRO editions of its Gantt, Calendar and Kanban components and offers paid consulting and custom development, with no price list for the grid | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; @svar-ui/svelte-grid 2.7.6 entry `Grid component` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nSVAR DataGrid (npm: @svar-ui/svelte-grid; the older wx-svelte-grid package is deprecated and points to it) is part of the SVAR suite from XB Software, the makers of Webix, and is one of the few grids built for Svelte rather than wrapped from another framework. Its docs list in-cell editing, header and advanced filtering, single and multi-column sorting, tree data, virtual scrolling for rows and columns, columns pinned to the left, column and row spans in the header and footer, auto-sized rows, undo and redo, a context menu, row reordering, CSV export, a print API and a REST data provider, all under MIT.\n\nSvGrid overlaps on the Svelte-native angle and reaches further: row grouping with aggregation, master/detail, Excel-style cell-range selection with clipboard and a fill handle, pinned rows and left and right column pinning, integrated charts, a server-side row model, a headless engine, in-grid AI helpers and the @svgrid/mcp server, all in the MIT package. Excel, PDF and print output, import, pivot tables and the Kanban and Scheduler views of the grid live in the paid @svgrid/enterprise pack, whereas SVAR keeps its grid entirely free and sells PRO editions of its Gantt, Calendar and Kanban instead.\n\n## Looking for a SVAR Svelte DataGrid alternative for Svelte?\n\nThe closest comparison on this list, since both are Svelte-native and both are MIT, so licensing does not decide it. The differences are depth and direction: SvGrid ships a larger feature surface, a UI component suite, in-grid AI helpers and an MCP server, while SVAR spans Svelte, React and Vue and keeps a smaller core. The At a glance table above has both measured bundle sizes; if a compact MIT grid with sorting, filtering, editing, tree data and CSV export is all you need, SVAR is a perfectly good answer.\n\n## What they have in common\n\n- Purpose-built for Svelte 5, not a cross-framework wrapper.\n- MIT-licensed and free for commercial use.\n- Sorting, filtering, in-cell editing, virtualization on rows and columns, tree data.\n- Auto-sized row heights, undo and redo, a context menu and drag-and-drop row reordering.\n- Themeable through CSS variables with light and dark themes, localization, WAI-ARIA markup and keyboard navigation.\n\n## Where SvGrid is stronger\n\n- Row grouping with aggregation and a drag-and-drop group panel; SVAR's docs list neither.\n- Master/detail and expandable detail rows; SVAR offers tree data only.\n- Excel-style cell-range selection with clipboard copy and paste and a fill handle; SVAR selects rows.\n- Pinned top and bottom rows, and columns pinned left and right; SVAR pins columns to the left only.\n- Integrated charts with no dependency, plus a chart wizard.\n- A server-side row model with cursor pagination, GraphQL, websocket and optimistic updates, beyond a REST data provider.\n- A headless engine (createSvGrid) you can compose, in addition to the render component.\n- In-grid AI helpers free in @svgrid/grid, and @svgrid/mcp with llms.txt so assistants answer and write code accurately.\n- A paid pack with Excel, PDF and styled-HTML export, print, pivot tables, Excel and CSV import and support. CSV, TSV and JSON export are free in the grid.\n\n## Where SVAR Svelte DataGrid is stronger\n\n- The whole grid is free, print API included; SvGrid puts print and Excel and PDF export in the paid pack. Both export CSV for free.\n- The same grid for React and Vue as well as Svelte; SvGrid is Svelte-only by design.\n- A smaller bundle: the At a glance table has both measured numbers.\n- XB Software and Webix behind it, a team that has built data grids for a long time.\n- Part of the wider SVAR suite, with paid consulting and custom development on offer.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | SVAR Svelte DataGrid |\n| --- | --- | --- |\n| Svelte 5 native | Yes | Yes - Svelte 5 compatible |\n| Licence | Yes - MIT core, paid enterprise pack | Yes - MIT, the grid is entirely free |\n| Headless engine | Yes - createSvGrid | No - component only |\n| Excel-style filter menu | Yes - built in | Yes - header filters plus the SVAR Filter component |\n| Cell-range selection and clipboard | Yes - built in | No - single and multiple row selection |\n| Fill handle | Yes | No - not in the feature list |\n| Row grouping with aggregation | Yes - with a group panel | No - not in the feature list |\n| Master/detail rows | Yes | No - tree data only |\n| Tree data | Yes | Yes |\n| Pinned columns | Yes - left and right | Partial - to the left |\n| Pinned rows (top and bottom) | Yes | No - not in the feature list |\n| Header and footer column spans | Yes | Yes |\n| Auto-sized row height | Yes - autoRowHeight | Yes |\n| Virtualization (rows and columns) | Yes | Yes |\n| Undo and redo, context menu, row drag | Yes | Yes |\n| Integrated charts | Yes - no dependency, plus a chart wizard | No - not in the feature list |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes - createServerDataSource: page or infinite block scroll, cursor, GraphQL, websocket | Partial - RestDataProvider and dynamic loading while scrolling |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise | No - not in the feature list |\n| CSV export | Yes - free, with TSV and JSON | Yes - free |\n| Excel and PDF export | Paid tier - @svgrid/enterprise | No - CSV only in the feature list |\n| Print | Paid tier - @svgrid/enterprise | Yes - print API, free |\n| Pivot tables | Paid tier - @svgrid/enterprise | No - not in the SVAR Svelte product list |\n| React and Vue versions | No - Svelte only | Yes |\n| In-grid AI helpers and MCP server | Yes - helpers free in @svgrid/grid; @svgrid/mcp, MIT | No - not mentioned in the docs |\n| Paid support | Yes - with @svgrid/enterprise, per developer per year | Partial - paid consulting and custom development; no support plan for the grid listed |\n\n## When to choose SvGrid\n\n- You need grouping with aggregation, master/detail, Excel-style range editing or pivot tables, which SVAR's docs do not list.\n- You want a headless engine plus a render component, not a component-only API.\n- You want integrated charts and a full server-side row model in one library.\n- You want in-grid AI helpers, an MCP server that checks generated code, and a paid support tier.\n\n## When to choose SVAR Svelte DataGrid\n\n- You want a fully free grid with print included and no paid tier at all.\n- You ship to React and Vue as well as Svelte and want one grid across them.\n- A smaller bundle matters more than grouping with aggregation, master/detail, range editing and the other features SvGrid adds.\n- You are already adopting the wider SVAR suite: Gantt, Calendar, Kanban, File Manager.\n\n## Migration effort\n\nEstimated effort: 2-4 hours per grid.\n\nWhat you give up:\n\n- Free printing: SVAR's print API is in the MIT grid, SvGrid's print view is in @svgrid/enterprise.\n- The React and Vue versions of the same grid.\n- A smaller bundle, by the measurements in the At a glance table.\n- The SVAR suite around the grid: Gantt, Calendar, Kanban and File Manager share its core.\n\nMigration guide: moving from SVAR Svelte DataGrid to SvGrid: https://svgrid.com/docs/help/migrating-from-svar-svelte-datagrid/\n\n## Live example\n\nGrouping Aggregation: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/07-grouping-aggregation/\n\n## The bottom line\n\nBoth grids are Svelte-5-native and MIT, so this is not a licensing call. On capability SvGrid is the more complete grid: grouping, master/detail, range editing with a fill handle, charts, a server-side row model, a headless core, AI helpers and an MCP server. SVAR is the smaller, fully free, multi-framework option from the Webix team, and it prints for free where SvGrid charges for print and Excel and PDF export. Choose SvGrid when you need the deeper feature set or support; choose SVAR when a compact free grid covers your needs or you also ship React and Vue.\n\n## Frequently asked questions\n\n### SvGrid vs SVAR Svelte DataGrid: what is the difference?\n\nBoth are MIT-licensed, Svelte-5-native grids. SvGrid is the broader product: row grouping with aggregation, master/detail, Excel-style range selection with a fill handle, integrated charts, a server-side row model, a headless core, in-grid AI helpers and an MCP server. SVAR is a smaller, fully free grid with React and Vue versions from XB Software, with CSV export and a print API included.\n\n### Are SvGrid and SVAR both free?\n\nBoth are free under MIT, including commercial use. SVAR keeps the whole grid free, CSV export and print included, and sells PRO editions of its Gantt, Calendar and Kanban. SvGrid's grid is free too, including CSV, TSV and JSON export, charts and the AI helpers; Excel, PDF and print output, import, pivot tables, the Kanban and Scheduler views and support are in @svgrid/enterprise at $599 per developer per year.\n\n### Are both built for Svelte 5?\n\nYes. SvGrid is written in Svelte 5 runes, and svar.dev states the DataGrid is Svelte 5 compatible. Neither is a cross-framework wrapper, although SVAR also ships React and Vue versions of its grid.\n\n### Which grid is smaller?\n\nSVAR, by the measurements in the At a glance table: both packages were built alone with Vite, minified and gzipped with Svelte external, on the dates shown. SvGrid's extra size buys grouping, master/detail, range editing, charts and the server-side row model; features you never import, such as the date editors, menus and charts, load as separate chunks.\n\n### Does SVAR have row grouping, master/detail or cell-range selection?\n\nNot according to its docs overview on the date we read it, which lists tree data, single and multiple row selection, header and advanced filters, sorting, in-cell editing, columns pinned to the left, CSV export and a print API. SvGrid has all three in the MIT core, and the demos on this page show them.\n\n### How long does a SVAR to SvGrid migration take?\n\nThe migration guide budgets two to four hours per grid: a prop and event rename pass, since both use array-of-object column definitions, plus re-theming through --sg-* tokens.\n\n### Is SvGrid a good SVAR Svelte DataGrid alternative for Svelte?\n\nThe closest comparison on this list, since both are Svelte-native and both are MIT, so licensing does not decide it. The differences are depth and direction: SvGrid ships a larger feature surface, a UI component suite, in-grid AI helpers and an MCP server, while SVAR spans Svelte, React and Vue and keeps a smaller core. The At a glance table above has both measured bundle sizes; if a compact MIT grid with sorting, filtering, editing, tree data and CSV export is all you need, SVAR is a perfectly good answer.\n\n## Related comparisons and docs\n\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/)\n- [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/)\n- [SvGrid vs @vincjo/datatables](https://svgrid.com/compare/vincjo-datatables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Grouping & aggregation](https://svgrid.com/docs/help/grouping-aggregation/)\n- [Master / detail (nested grids)](https://svgrid.com/docs/help/rows/master-detail/)\n- [Build a table from scratch](https://svgrid.com/docs/help/headless/build-a-table/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- svar-datagrid: Licensed under MIT; Svelte 5 compatible; React and Vue versions available; lists multi-column sorting, header filters, in-cell editing, tree data, virtual scrolling, columns pinned to the left, context menu, row drag-and-drop, checkbox selection, pagination, hotkeys, WAI-ARIA, print, undo/redo (checked 12 Sep 2026) https://svar.dev/svelte/datagrid/\n- svar-overview: Feature list: in-cell editing, header and advanced filtering, sorting, single and multiple row selection, row reordering, context menu, undo/redo, tree data, pagination, colspans and rowspans in header and footer, collapsible column groups, pinned columns to the left, auto-sizing of rows and columns, localization, themes, export to CSV, print API, RestDataProvider, virtual scrolling for rows and columns, WAI-ARIA, keyboard navigation; no Excel export, row grouping, aggregation, master/detail, charts, AI or MCP (checked 12 Sep 2026) https://docs.svar.dev/svelte/grid/overview/\n- svar-svelte: DataGrid, Filter, Editor, File Manager and Core are MIT; Gantt, Calendar and Kanban have MIT cores with paid PRO editions; no pivot component in the list; no price list on the page (checked 12 Sep 2026) https://svar.dev/svelte/\n- svar-gantt: Offers paid consulting and custom development services; PRO edition pricing is on a separate page (checked 12 Sep 2026) https://svar.dev/svelte/gantt/\n"
|
|
8710
8710
|
},
|
|
8711
8711
|
{
|
|
8712
8712
|
"slug": "compare/svelte-headless-table",
|
|
8713
8713
|
"path": "docs/_data/comparisons/svelte-headless-table.json",
|
|
8714
8714
|
"title": "SvGrid vs svelte-headless-table",
|
|
8715
8715
|
"section": "Comparisons",
|
|
8716
|
-
"markdown": "# SvGrid vs svelte-headless-table\n\nCanonical URL: https://svgrid.com/compare/svelte-headless-table/\nFacts verified: 2026-09-12\nCompetitor package: svelte-headless-table\nCompetitor site: https://svelte-headless-table.bryanmylee.com/\n\nsvelte-headless-table is the Svelte-native headless table library by Bryan Lee, one of the earliest Svelte-specific table options, now deprecated on Svelte 4.\n\n## Verdict\n\nsvelte-headless-table popularised headless tables in Svelte and still works on Svelte 4. Its author states there are no plans for a Svelte 5 port, so a Svelte 5 upgrade forces the question. SvGrid keeps the headless approach on Svelte 5 runes, adds virtualization and a rendered grid, and the @humanspeak fork is the option if you want to stay headless with the same API.\n\nMigration guide: moving from svelte-headless-table to SvGrid: https://svgrid.com/docs/help/migrating-from-svelte-headless-table/\n\n## At a glance\n\n| Fact | SvGrid | svelte-headless-table | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 0.18.3 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 28 Oct 2024 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Svelte 4 range (peer svelte ^4.0.0) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 96,400 | 9 Nov 2026 |\n| Bundle, minified + gzip | 99.6 KB JS + 11.4 KB CSS | 5.7 KB JS, no separate stylesheet, svelte external | 9 Nov 2026 |\n| Engine alone, minified + gzip | 3.2 KB JS, no separate stylesheet (`createSvGrid` from `@svgrid/grid/core`) | the row above; the package is the engine | 10 Nov 2026 |\n| Frameworks | Svelte 5 | Svelte | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | svelte-headless-table is MIT and free; no paid licence or support is offered, and the author states there are no plans for a Svelte 5 port | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.34 measured 10 Nov 2026 with packages/grid/scripts/measure-size.mjs; svelte-headless-table 0.18.3 entry `whole package` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nsvelte-headless-table exposes a createTable function with composable plugins for sorting, filtering, column ordering and hiding, pagination, row selection, expansion, grouping with aggregation and column resizing, and leaves the markup to you. The npm package's peer range is Svelte 4, and the repository README states there are no current plans for a Svelte 5 port. A community fork, @humanspeak/svelte-headless-table, carries the same API on Svelte 5 runes; the At a glance table shows the original's registry facts, and the migration guide has the fork's.\n\nSvGrid takes the same headless approach but is written in Svelte 5 runes, adds a production render component, and covers virtualization, Excel-style filters, cell-range selection with a fill handle, inline editing, master/detail, a server-side row model and integrated charts natively.\n\n## Looking for a svelte-headless-table alternative for Svelte?\n\nThis is the clearest migration case on the list: the original package's peer range is Svelte 4, its last release was in 2024 and the README says there are no plans for a Svelte 5 port nor a maintenance schedule for Svelte 3 and 4. SvGrid keeps the headless approach you already chose and adds runes, virtualization and a render component if you want one. If you would rather keep the plugin API, the maintained community fork @humanspeak/svelte-headless-table targets Svelte 5, and its facts are in the guide.\n\n## What they have in common\n\n- Svelte-specific, not a port from another framework.\n- Headless-first composition: plugins in svelte-headless-table, a features object in SvGrid.\n- Sorting, filtering, pagination, row selection, expansion and grouping with aggregation in the engine.\n- MIT-licensed with a strong TypeScript story.\n\n## Where SvGrid is stronger\n\n- Built on Svelte 5 runes and released continuously; the original package is Svelte 4 only and its author has stopped.\n- A bundled <SvGrid /> component, so nobody assembles headers, body and virtualization by hand.\n- Virtualization on rows and columns built in; svelte-headless-table leaves it to a virtual-list library.\n- Excel-style filter menu, cell-range selection with a fill handle, inline editing, master/detail, a server-side row model and charts in the MIT package.\n- In-grid AI helpers free in @svgrid/grid and @svgrid/mcp for assistants, plus a paid support tier.\n\n## Where svelte-headless-table is stronger\n\n- A smaller bundle if all you want is the engine; the At a glance table has both measured sizes.\n- A plugin API many Svelte 4 codebases already know, and a documentation site that still reads well.\n- The @humanspeak fork keeps that API on Svelte 5 without a rewrite.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | svelte-headless-table |\n| --- | --- | --- |\n| Svelte 5 runes | Yes - native | No - Svelte 4 stores; no Svelte 5 port planned by the author |\n| Maintained release line | Yes | Partial - original deprecated; the @humanspeak fork is maintained on Svelte 5 |\n| Render component | Yes - <SvGrid /> | No - bring your own markup |\n| Headless engine | Yes - createSvGrid and a features object | Yes - createTable and plugins |\n| Sorting and column filtering | Yes | Yes - engine only |\n| Excel-style filter menu | Yes - built in | No - bring your own UI |\n| Cell-range selection and clipboard | Yes - built in, with a fill handle | No - row selection only |\n| Inline editing | Yes - built in | No - not a plugin |\n| Virtualization | Yes - rows and columns, built in | Partial - pair with a virtual-list library |\n| Pagination | Yes | Yes |\n| Row grouping with aggregation | Yes - engine and rendered group rows | Yes - engine only |\n| Row expansion and tree | Yes | Yes - expansion plugin |\n| Column ordering, hiding, resizing | Yes | Yes |\n| Master/detail | Yes | No - not a plugin |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes | No - not a plugin |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise | No - not a plugin |\n| Integrated charts | Yes - SvGridChart | No - not part of a headless engine |\n| In-grid AI helpers and MCP server | Yes - helpers free in @svgrid/grid; @svgrid/mcp, MIT | No - not in the docs |\n| Paid support | Yes - with @svgrid/enterprise, per developer per year | No - none offered |\n\n## When to choose SvGrid\n\n- You are moving to Svelte 5 and want a maintained grid that keeps the headless approach.\n- You want virtualization, an Excel-style filter menu, editing and cell selection without building them.\n- You want a rendered component for the common case and a headless core for the rest.\n- You want a support tier behind the library.\n\n## When to choose svelte-headless-table\n\n- You are staying on Svelte 4 for now and the plugin set already covers you.\n- You want the smallest possible engine and will keep writing the markup yourself.\n- You want the same plugin API on Svelte 5 and are happy to move to the @humanspeak fork.\n\n## Migration effort\n\nEstimated effort: 1-3 hours per grid.\n\nWhat you give up:\n\n- The plugin API and its documentation site, if your team knows it well.\n- The smallest engine-only bundle; the At a glance table has both measured sizes.\n- Nothing in maintenance terms on the original package, which is where most migrations start.\n\nMigration guide: moving from svelte-headless-table to SvGrid: https://svgrid.com/docs/help/migrating-from-svelte-headless-table/\n\n## Live example\n\nHeadless Table: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/186-headless-table/\n\n## The bottom line\n\nFor a Svelte 4 codebase that is not moving, svelte-headless-table still works. For a Svelte 5 codebase, the original package is not an option and its author says so; the choice is between the @humanspeak fork, which keeps the plugin API, and SvGrid, which keeps the headless approach and adds virtualization, filters, editing, selection and a rendered grid in the same MIT package.\n\n## Frequently asked questions\n\n### Does svelte-headless-table work with Svelte 5?\n\nThe original package's peer range is Svelte 4 and its README states there are no current plans for a Svelte 5 port nor a maintenance schedule for Svelte 3 and 4. The community fork @humanspeak/svelte-headless-table targets Svelte 5 with runes; SvGrid is written in Svelte 5 from the first line.\n\n### Can I keep a headless table with SvGrid?\n\nYes. createSvGrid plus the row-model factories is a headless engine; you can drive your own markup as before and adopt the SvGrid component only where you want it. The headless demos on this page show a plain table and a virtualized one.\n\n### Is SvGrid heavier than svelte-headless-table?\n\nYes, by the measurements in the At a glance table, because it ships a rendered grid, a virtualizer, filter menus and editors that a headless engine leaves to you. If you only need the engine and will write the rest, the difference is what you would otherwise write.\n\n### How long does a migration take?\n\nThe migration guide budgets one to three hours per grid; most of the time goes into deleting the markup and plugins the rendered grid replaces. Column definitions and the plugin concepts (sort, filter, page, select, expand, group) map one to one onto SvGrid's features.\n\n### Should I move to the @humanspeak fork instead?\n\nIf you want the same plugin API on Svelte 5 and are happy to keep writing the markup, yes, and its registry facts are in the migration guide. If the upgrade is also a chance to stop maintaining a table layer, SvGrid gives you the rendered grid and keeps the headless core for the cases that need it.\n\n### Is SvGrid a good svelte-headless-table alternative for Svelte?\n\nThis is the clearest migration case on the list: the original package's peer range is Svelte 4, its last release was in 2024 and the README says there are no plans for a Svelte 5 port nor a maintenance schedule for Svelte 3 and 4. SvGrid keeps the headless approach you already chose and adds runes, virtualization and a render component if you want one. If you would rather keep the plugin API, the maintained community fork @humanspeak/svelte-headless-table targets Svelte 5, and its facts are in the guide.\n\n## Related comparisons and docs\n\n- [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/)\n- [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/)\n- [SvGrid vs @vincjo/datatables](https://svgrid.com/compare/vincjo-datatables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Build a table from scratch](https://svgrid.com/docs/help/headless/build-a-table/)\n- [Headless virtualization](https://svgrid.com/docs/help/headless/virtualization/)\n- [Grouping & aggregation](https://svgrid.com/docs/help/grouping-aggregation/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- sht-github: README: there are no current plans to work on a Svelte 5 port of this project nor is there a maintenance schedule for Svelte 3/4; the project is flagged as deprecated and users are encouraged to seek alternatives or fork (checked 12 Sep 2026) https://github.com/bryanmylee/svelte-headless-table\n- sht-docs: Advertised plugins: multi-sorting, column filtering, global filtering, column reordering, hiding columns, pagination, row grouping and aggregation, row expansion, row selection, column resizing; headless, you write the markup (checked 12 Sep 2026) https://svelte-headless-table.bryanmylee.com/\n- sht-fork: MIT; part of the Humanspeak family of runes-native Svelte 5 packages; the npm package declares a Svelte 5 peer range (checked 12 Sep 2026) https://github.com/humanspeak/svelte-headless-table\n"
|
|
8716
|
+
"markdown": "# SvGrid vs svelte-headless-table\n\nCanonical URL: https://svgrid.com/compare/svelte-headless-table/\nFacts verified: 2026-09-12\nCompetitor package: svelte-headless-table\nCompetitor site: https://svelte-headless-table.bryanmylee.com/\n\nsvelte-headless-table is the Svelte-native headless table library by Bryan Lee, one of the earliest Svelte-specific table options, now deprecated on Svelte 4.\n\n## Verdict\n\nsvelte-headless-table popularised headless tables in Svelte and still works on Svelte 4. Its author states there are no plans for a Svelte 5 port, so a Svelte 5 upgrade forces the question. SvGrid keeps the headless approach on Svelte 5 runes, adds virtualization and a rendered grid, and the @humanspeak fork is the option if you want to stay headless with the same API.\n\nMigration guide: moving from svelte-headless-table to SvGrid: https://svgrid.com/docs/help/migrating-from-svelte-headless-table/\n\n## At a glance\n\n| Fact | SvGrid | svelte-headless-table | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 0.18.3 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 28 Oct 2024 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Svelte 4 range (peer svelte ^4.0.0) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 96,400 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 5.7 KB JS, no separate stylesheet, svelte external | 9 Nov 2026 |\n| Engine alone, minified + gzip | 3.2 KB JS, no separate stylesheet (`createSvGrid` from `@svgrid/grid/core`) | the row above; the package is the engine | 17 Nov 2026 |\n| Frameworks | Svelte 5 | Svelte | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | svelte-headless-table is MIT and free; no paid licence or support is offered, and the author states there are no plans for a Svelte 5 port | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; svelte-headless-table 0.18.3 entry `whole package` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nsvelte-headless-table exposes a createTable function with composable plugins for sorting, filtering, column ordering and hiding, pagination, row selection, expansion, grouping with aggregation and column resizing, and leaves the markup to you. The npm package's peer range is Svelte 4, and the repository README states there are no current plans for a Svelte 5 port. A community fork, @humanspeak/svelte-headless-table, carries the same API on Svelte 5 runes; the At a glance table shows the original's registry facts, and the migration guide has the fork's.\n\nSvGrid takes the same headless approach but is written in Svelte 5 runes, adds a production render component, and covers virtualization, Excel-style filters, cell-range selection with a fill handle, inline editing, master/detail, a server-side row model and integrated charts natively.\n\n## Looking for a svelte-headless-table alternative for Svelte?\n\nThis is the clearest migration case on the list: the original package's peer range is Svelte 4, its last release was in 2024 and the README says there are no plans for a Svelte 5 port nor a maintenance schedule for Svelte 3 and 4. SvGrid keeps the headless approach you already chose and adds runes, virtualization and a render component if you want one. If you would rather keep the plugin API, the maintained community fork @humanspeak/svelte-headless-table targets Svelte 5, and its facts are in the guide.\n\n## What they have in common\n\n- Svelte-specific, not a port from another framework.\n- Headless-first composition: plugins in svelte-headless-table, a features object in SvGrid.\n- Sorting, filtering, pagination, row selection, expansion and grouping with aggregation in the engine.\n- MIT-licensed with a strong TypeScript story.\n\n## Where SvGrid is stronger\n\n- Built on Svelte 5 runes and released continuously; the original package is Svelte 4 only and its author has stopped.\n- A bundled <SvGrid /> component, so nobody assembles headers, body and virtualization by hand.\n- Virtualization on rows and columns built in; svelte-headless-table leaves it to a virtual-list library.\n- Excel-style filter menu, cell-range selection with a fill handle, inline editing, master/detail, a server-side row model and charts in the MIT package.\n- In-grid AI helpers free in @svgrid/grid and @svgrid/mcp for assistants, plus a paid support tier.\n\n## Where svelte-headless-table is stronger\n\n- A smaller bundle if all you want is the engine; the At a glance table has both measured sizes.\n- A plugin API many Svelte 4 codebases already know, and a documentation site that still reads well.\n- The @humanspeak fork keeps that API on Svelte 5 without a rewrite.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | svelte-headless-table |\n| --- | --- | --- |\n| Svelte 5 runes | Yes - native | No - Svelte 4 stores; no Svelte 5 port planned by the author |\n| Maintained release line | Yes | Partial - original deprecated; the @humanspeak fork is maintained on Svelte 5 |\n| Render component | Yes - <SvGrid /> | No - bring your own markup |\n| Headless engine | Yes - createSvGrid and a features object | Yes - createTable and plugins |\n| Sorting and column filtering | Yes | Yes - engine only |\n| Excel-style filter menu | Yes - built in | No - bring your own UI |\n| Cell-range selection and clipboard | Yes - built in, with a fill handle | No - row selection only |\n| Inline editing | Yes - built in | No - not a plugin |\n| Virtualization | Yes - rows and columns, built in | Partial - pair with a virtual-list library |\n| Pagination | Yes | Yes |\n| Row grouping with aggregation | Yes - engine and rendered group rows | Yes - engine only |\n| Row expansion and tree | Yes | Yes - expansion plugin |\n| Column ordering, hiding, resizing | Yes | Yes |\n| Master/detail | Yes | No - not a plugin |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes | No - not a plugin |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise | No - not a plugin |\n| Integrated charts | Yes - SvGridChart | No - not part of a headless engine |\n| In-grid AI helpers and MCP server | Yes - helpers free in @svgrid/grid; @svgrid/mcp, MIT | No - not in the docs |\n| Paid support | Yes - with @svgrid/enterprise, per developer per year | No - none offered |\n\n## When to choose SvGrid\n\n- You are moving to Svelte 5 and want a maintained grid that keeps the headless approach.\n- You want virtualization, an Excel-style filter menu, editing and cell selection without building them.\n- You want a rendered component for the common case and a headless core for the rest.\n- You want a support tier behind the library.\n\n## When to choose svelte-headless-table\n\n- You are staying on Svelte 4 for now and the plugin set already covers you.\n- You want the smallest possible engine and will keep writing the markup yourself.\n- You want the same plugin API on Svelte 5 and are happy to move to the @humanspeak fork.\n\n## Migration effort\n\nEstimated effort: 1-3 hours per grid.\n\nWhat you give up:\n\n- The plugin API and its documentation site, if your team knows it well.\n- The smallest engine-only bundle; the At a glance table has both measured sizes.\n- Nothing in maintenance terms on the original package, which is where most migrations start.\n\nMigration guide: moving from svelte-headless-table to SvGrid: https://svgrid.com/docs/help/migrating-from-svelte-headless-table/\n\n## Live example\n\nHeadless Table: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/186-headless-table/\n\n## The bottom line\n\nFor a Svelte 4 codebase that is not moving, svelte-headless-table still works. For a Svelte 5 codebase, the original package is not an option and its author says so; the choice is between the @humanspeak fork, which keeps the plugin API, and SvGrid, which keeps the headless approach and adds virtualization, filters, editing, selection and a rendered grid in the same MIT package.\n\n## Frequently asked questions\n\n### Does svelte-headless-table work with Svelte 5?\n\nThe original package's peer range is Svelte 4 and its README states there are no current plans for a Svelte 5 port nor a maintenance schedule for Svelte 3 and 4. The community fork @humanspeak/svelte-headless-table targets Svelte 5 with runes; SvGrid is written in Svelte 5 from the first line.\n\n### Can I keep a headless table with SvGrid?\n\nYes. createSvGrid plus the row-model factories is a headless engine; you can drive your own markup as before and adopt the SvGrid component only where you want it. The headless demos on this page show a plain table and a virtualized one.\n\n### Is SvGrid heavier than svelte-headless-table?\n\nYes, by the measurements in the At a glance table, because it ships a rendered grid, a virtualizer, filter menus and editors that a headless engine leaves to you. If you only need the engine and will write the rest, the difference is what you would otherwise write.\n\n### How long does a migration take?\n\nThe migration guide budgets one to three hours per grid; most of the time goes into deleting the markup and plugins the rendered grid replaces. Column definitions and the plugin concepts (sort, filter, page, select, expand, group) map one to one onto SvGrid's features.\n\n### Should I move to the @humanspeak fork instead?\n\nIf you want the same plugin API on Svelte 5 and are happy to keep writing the markup, yes, and its registry facts are in the migration guide. If the upgrade is also a chance to stop maintaining a table layer, SvGrid gives you the rendered grid and keeps the headless core for the cases that need it.\n\n### Is SvGrid a good svelte-headless-table alternative for Svelte?\n\nThis is the clearest migration case on the list: the original package's peer range is Svelte 4, its last release was in 2024 and the README says there are no plans for a Svelte 5 port nor a maintenance schedule for Svelte 3 and 4. SvGrid keeps the headless approach you already chose and adds runes, virtualization and a render component if you want one. If you would rather keep the plugin API, the maintained community fork @humanspeak/svelte-headless-table targets Svelte 5, and its facts are in the guide.\n\n## Related comparisons and docs\n\n- [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/)\n- [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/)\n- [SvGrid vs @vincjo/datatables](https://svgrid.com/compare/vincjo-datatables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Build a table from scratch](https://svgrid.com/docs/help/headless/build-a-table/)\n- [Headless virtualization](https://svgrid.com/docs/help/headless/virtualization/)\n- [Grouping & aggregation](https://svgrid.com/docs/help/grouping-aggregation/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- sht-github: README: there are no current plans to work on a Svelte 5 port of this project nor is there a maintenance schedule for Svelte 3/4; the project is flagged as deprecated and users are encouraged to seek alternatives or fork (checked 12 Sep 2026) https://github.com/bryanmylee/svelte-headless-table\n- sht-docs: Advertised plugins: multi-sorting, column filtering, global filtering, column reordering, hiding columns, pagination, row grouping and aggregation, row expansion, row selection, column resizing; headless, you write the markup (checked 12 Sep 2026) https://svelte-headless-table.bryanmylee.com/\n- sht-fork: MIT; part of the Humanspeak family of runes-native Svelte 5 packages; the npm package declares a Svelte 5 peer range (checked 12 Sep 2026) https://github.com/humanspeak/svelte-headless-table\n"
|
|
8717
8717
|
},
|
|
8718
8718
|
{
|
|
8719
8719
|
"slug": "compare/svelte-ui-kit-tables",
|
|
@@ -8734,21 +8734,21 @@ export const docs = [
|
|
|
8734
8734
|
"path": "docs/_data/comparisons/tabulator.json",
|
|
8735
8735
|
"title": "SvGrid vs Tabulator",
|
|
8736
8736
|
"section": "Comparisons",
|
|
8737
|
-
"markdown": "# SvGrid vs Tabulator\n\nCanonical URL: https://svgrid.com/compare/tabulator/\nFacts verified: 2026-09-12\nCompetitor package: tabulator-tables\nCompetitor site: https://tabulator.info/\n\nTabulator is a feature-rich, framework-agnostic vanilla-JS interactive table library, MIT-licensed.\n\n## Verdict\n\nTabulator is enormously capable and free, but it is vanilla JS you wire into Svelte imperatively. SvGrid delivers a similar feature surface as a Svelte-5-native component with reactive data binding.\n\nMigration guide: moving from Tabulator to SvGrid: https://svgrid.com/docs/help/migrating-from-tabulator/\n\n## At a glance\n\n| Fact | SvGrid | Tabulator | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 6.7.1 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 22 Oct 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (JavaScript) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 826,000 | 9 Nov 2026 |\n| Bundle, minified + gzip |
|
|
8737
|
+
"markdown": "# SvGrid vs Tabulator\n\nCanonical URL: https://svgrid.com/compare/tabulator/\nFacts verified: 2026-09-12\nCompetitor package: tabulator-tables\nCompetitor site: https://tabulator.info/\n\nTabulator is a feature-rich, framework-agnostic vanilla-JS interactive table library, MIT-licensed.\n\n## Verdict\n\nTabulator is enormously capable and free, but it is vanilla JS you wire into Svelte imperatively. SvGrid delivers a similar feature surface as a Svelte-5-native component with reactive data binding.\n\nMigration guide: moving from Tabulator to SvGrid: https://svgrid.com/docs/help/migrating-from-tabulator/\n\n## At a glance\n\n| Fact | SvGrid | Tabulator | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 6.7.1 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 22 Oct 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | No Svelte package (JavaScript) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 826,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 109.5 KB JS + 3.8 KB CSS | 9 Nov 2026 |\n| Frameworks | Svelte 5 | JavaScript | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | Tabulator is MIT and free; no licence or support plan is sold | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; tabulator-tables 6.7.1 entry `TabulatorFull` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nTabulator packs a huge feature set - sorting, filtering, grouping, editing, tree data, formatters, and more - into a framework-agnostic vanilla-JS library. You instantiate it against a DOM element and drive it through its imperative API.\n\nSvGrid covers the same ground but as a Svelte 5 component: data is a reactive `$state` array, cells are snippets, and the imperative API is there when you want it - no manual mount/teardown or DOM bridging.\n\n## Looking for a Tabulator alternative for Svelte?\n\nTabulator is mature, MIT and framework-agnostic, and the reason people move is usually reactivity: it owns its own DOM, so Svelte state and table state have to be kept in sync by hand. SvGrid is driven by your runes directly. Tabulator still wins on breadth of built-in features and on being usable from plain HTML with no build step.\n\n## What they have in common\n\n- Broad feature set: sort, filter, group, edit, tree, format.\n- MIT-licensed / free for commercial use.\n- Virtualized rendering for large datasets.\n- Rich, mature documentation.\n\n## Where SvGrid is stronger\n\n- Svelte 5 native - reactive data binding, no imperative mount/teardown.\n- Custom cells are Svelte snippets, not HTML-string formatters.\n- Headless engine available in addition to the component.\n- @svgrid/mcp MCP server for AI assistants.\n\n## Where Tabulator is stronger\n\n- Framework-agnostic - the same library across vanilla, React, Vue, Angular.\n- Very large built-in formatter / editor catalogue.\n- Long track record and a big community.\n- No build step required to drop into a plain HTML page.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | Tabulator |\n| --- | --- | --- |\n| Svelte 5 native | Yes | No - vanilla JavaScript |\n| Reactive data binding | Yes - $state | Partial - Imperative setData() |\n| Custom cells | Yes - Snippets / components | Partial - HTML-string formatters |\n| Sort / filter / group | Yes | Yes |\n| Inline editing | Yes | Yes |\n| Tree data | Yes | Yes |\n| Virtualization | Yes | Yes |\n| Headless engine | Yes | No |\n| AI / MCP integration | Yes | No |\n\n## When to choose SvGrid\n\n- You are on Svelte 5 and want reactive data, not imperative setData calls.\n- You want Svelte snippets for custom cells instead of HTML strings.\n- You want a headless engine option and an MCP server.\n\n## When to choose Tabulator\n\n- You need one table library across vanilla JS, React, Vue, and Angular.\n- You want a no-build-step drop-in for a plain HTML page.\n- You rely on a specific Tabulator formatter / module.\n\n## Migration effort\n\nEstimated effort: 2-4 hours per grid.\n\nWhat you give up:\n\n- One library for plain JavaScript pages as well as React, Angular and Vue.\n- Built-in download to CSV, XLSX and PDF without a paid pack; SvGrid has CSV free and Excel and PDF in @svgrid/enterprise.\n\nMigration guide: moving from Tabulator to SvGrid: https://svgrid.com/docs/help/migrating-from-tabulator/\n\n## Live example\n\nExcel Filters: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/03-excel-filters/\n\n## The bottom line\n\nTabulator is a free, feature-packed table that runs anywhere. If your app is Svelte 5, SvGrid gives you a comparable feature set with reactive data binding and snippet cells instead of imperative setData and HTML-string formatters.\n\n## Frequently asked questions\n\n### SvGrid vs Tabulator for Svelte - which is better?\n\nFor Svelte 5, SvGrid: reactive $state data and Svelte snippet cells, with no imperative mount or teardown. Tabulator wins if you need one library across vanilla JS, React, Vue, and Angular.\n\n### Is SvGrid free like Tabulator?\n\nYes - the core is MIT, like Tabulator. Only the optional @svgrid/enterprise pack is paid.\n\n### Can I reuse Tabulator formatters in SvGrid?\n\nYou re-create them as Svelte snippets via renderSnippet, which is more flexible than HTML-string formatters.\n\n### Is SvGrid a good Tabulator alternative for Svelte?\n\nTabulator is mature, MIT and framework-agnostic, and the reason people move is usually reactivity: it owns its own DOM, so Svelte state and table state have to be kept in sync by hand. SvGrid is driven by your runes directly. Tabulator still wins on breadth of built-in features and on being usable from plain HTML with no build step.\n\n## Related comparisons and docs\n\n- [SvGrid vs Grid.js](https://svgrid.com/compare/gridjs/)\n- [SvGrid vs Smart.Grid (Smart Web Components)](https://svgrid.com/compare/smart-grid/)\n- [SvGrid vs AG Grid (community + enterprise)](https://svgrid.com/compare/ag-grid/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Cell components](https://svgrid.com/docs/help/cells/cell-components/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- tabulator-readme: MIT; a vanilla JavaScript library that builds interactive tables from HTML tables, arrays or JSON, with support for React, Angular and Vue; installed as tabulator-tables (checked 12 Sep 2026) https://github.com/olifolkerd/tabulator\n"
|
|
8738
8738
|
},
|
|
8739
8739
|
{
|
|
8740
8740
|
"slug": "compare/tanstack-table",
|
|
8741
8741
|
"path": "docs/_data/comparisons/tanstack-table.json",
|
|
8742
8742
|
"title": "SvGrid vs TanStack Table (Svelte)",
|
|
8743
8743
|
"section": "Comparisons",
|
|
8744
|
-
"markdown": "# SvGrid vs TanStack Table (Svelte)\n\nCanonical URL: https://svgrid.com/compare/tanstack-table/\nFacts verified: 2026-09-12\nCompetitor package: @tanstack/svelte-table\nCompetitor site: https://tanstack.com/table/latest\n\nTanStack Table is the headless table engine with adapters for React, Vue, Svelte, Solid, Qwik and Lit; you bring the markup.\n\n## Verdict\n\nThe closest peer to SvGrid's headless core. SvGrid ships a rendered component on top of the same kind of engine, in Svelte 5 runes; TanStack stays framework-agnostic and asks you to build and maintain the DOM, the virtualizer, the filter menus and the editors yourself.\n\nMigration guide: moving from TanStack Table (Svelte) to SvGrid: https://svgrid.com/docs/help/migrating-from-tanstack-table/\n\n## At a glance\n\n| Fact | SvGrid | TanStack Table (Svelte) | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 9.3.1 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 12 Oct 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Yes (peer svelte ^5.0.0) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 539,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 99.6 KB JS + 11.4 KB CSS | 36.5 KB JS, no separate stylesheet, svelte external | 9 Nov 2026 |\n| Engine alone, minified + gzip | 3.2 KB JS, no separate stylesheet (`createSvGrid` from `@svgrid/grid/core`) | the row above; the package is the engine | 10 Nov 2026 |\n| Frameworks | Svelte 5 | Svelte, React, Vue, Solid, Qwik, Lit | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.34 measured 10 Nov 2026 with packages/grid/scripts/measure-size.mjs; @tanstack/svelte-table 9.3.1 entry `whole package` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nTanStack Table is the canonical headless table library: it provides the data pipeline (filter, sort, group, expand, paginate, select) and leaves the markup to you. The v9 line ships a Svelte adapter, @tanstack/svelte-table, whose peer dependency range is Svelte 5, with createTable and getters for reactive data instead of the stores the v8 adapter used.\n\nSvGrid covers the same headless surface (createSvGrid, row models, a features object) and adds a full render component with virtualization, Excel-style filters, inline editing, cell-range selection with a fill handle, grouping with aggregation, master/detail, a server-side row model and integrated charts, all in the MIT package.\n\n## Looking for a TanStack Table alternative for Svelte?\n\nPeople arrive here wanting less glue code, and that is the trade: you keep a headless engine with row models and composable features, and you stop hand-building the DOM, the virtualizer, the filter menus and the editors. If you need one table engine across React and Svelte, stay where you are; that portability is exactly what SvGrid gives up.\n\n## What they have in common\n\n- Headless-first architecture with row-model factories and a features object.\n- Composable features: sorting, filtering, grouping, pagination, expansion, selection.\n- TypeScript-first, MIT-licensed, with paid support available from the maintainers.\n- A createTable / createSvGrid entry point that takes columns, data and features.\n- Svelte 5 in both: runes in SvGrid, a Svelte 5 peer range in the TanStack adapter.\n\n## Where SvGrid is stronger\n\n- Ships <SvGrid />: a production render component with virtualization, Excel-style filters, cell-range selection, inline editing, grouping, master/detail and pagination. With TanStack Table you build all of this.\n- The headless core is written in Svelte 5 runes; the TanStack adapter wraps a framework-agnostic core.\n- An imperative API (SvGridApi) for adding rows, setting filters and mutating columns from outside the component.\n- A gallery of runnable examples that covers every feature, and per-feature docs pages with embedded demos.\n- In-grid AI helpers free in @svgrid/grid, and @svgrid/mcp so assistants fetch real example sources and can check the code they write.\n- A paid pack with Excel, PDF and print output, import, pivot tables and support.\n\n## Where TanStack Table (Svelte) is stronger\n\n- A far larger community; the At a glance table has the download counts side by side.\n- Multi-framework parity: if your shop has React, Vue and Svelte apps, the API stays consistent.\n- A smaller bundle when all you want is the engine; the At a glance table has both measured sizes.\n- Framework-specific documentation for each adapter and years of production use in large companies.\n- Enterprise Support as private consulting, and sponsor perks such as priority issue requests.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | TanStack Table (Svelte) |\n| --- | --- | --- |\n| Headless engine | Yes - createSvGrid | Yes - createTable |\n| Render component (drop-in) | Yes - <SvGrid /> | No - bring your own markup |\n| Svelte 5 | Yes - runes throughout | Yes - the adapter's peer range is Svelte 5 |\n| Row virtualization | Yes - built in | Partial - pair with @tanstack/svelte-virtual |\n| Column virtualization | Yes - built in | Partial - pair with @tanstack/svelte-virtual |\n| Excel-style filter menu | Yes - built in | No - filtering logic only; the UI is yours |\n| Inline editing | Yes - enableInlineEditing | No - bring your own |\n| Cell-range selection and clipboard | Yes - enableCellSelection, fill handle | No - bring your own |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes - createServerDataSource: page or infinite block scroll | Yes - manual sorting, filtering and pagination flags |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise | No - the engine has no server row model; the app fetches per group |\n| Master/detail and tree | Yes | Yes - expansion and subRows |\n| Grouping with aggregation | Yes - engine and rendered group rows | Yes - engine only |\n| Integrated charts | Yes - SvGridChart | No - not part of a headless engine |\n| WAI-ARIA helpers | Yes - exported, and applied by <SvGrid /> | Partial - your markup, your ARIA |\n| In-grid AI helpers and MCP server | Yes - helpers free in @svgrid/grid; @svgrid/mcp, MIT | No - not in the docs |\n| Multi-framework support | No - Svelte only | Yes - React, Vue, Svelte, Solid, Qwik, Lit |\n| Paid support tier | Yes - with @svgrid/enterprise, per developer per year | Yes - Enterprise Support (private consulting) and sponsor perks such as priority issues |\n\n## Measured performance\n\nMeasured 28 Oct 2026 with the harness in the repository (pnpm bench:compare): 100,000 rows, fastest of 3 samples per operation, each grid in a fresh page, Chromium through Playwright, headless, on win32 10.0.26200 x64, Intel(R) Core(TM) Ultra 7 255U; a developer workstation, not a dedicated bench rig. Versions: @svgrid/grid 3.0.25, @tanstack/svelte-table 9.2.4. Lower is better. Tick: 1,000 of the rows replaced per tick with a new amount, the grid sorted by amount, on the update path each grid provides, timed until the changed cells paint; 180 ticks after 10 to warm up.\n\n| Operation | SvGrid | TanStack Table (Svelte) |\n| --- | --- | --- |\n| Mount | 30.7 ms | 170.2 ms |\n| Sort, text column | 77.4 ms | 360.9 ms |\n| Sort, numeric column | 32.8 ms | 178.2 ms |\n| Filter, one column (indicative only) | 34.5 ms | 51.1 ms |\n| Scroll, p95 frame | 34.3 ms | 34.3 ms |\n| Live tick, 1,000 rows replaced, sorted by that column, p95 | 48.6 ms | 563.4 ms |\n| Ticks over one 60 Hz frame, of 180 | 115 | 180 |\n| Rows kept in the DOM (virtualization on) | 36 | 27 |\n\nThe filter row is not like for like: each grid is driven through its own single-column filter API, and the amount of work differs. The comparison guide explains the method, what is left out and why.\n\nTanStack Table renders nothing, so its adapter draws the row model through a minimal fixed-height windowed table with no virtualizer library, filter UI or editors; the numbers are the engine plus that DOM.\n\n## When to choose SvGrid\n\n- You are on Svelte 5 and want a grid that uses runes idiomatically, headless or rendered.\n- You want a drop-in <SvGrid /> with virtualization, filters, editing and selection working in one prop pass.\n- You want AI tools to give accurate answers about your grid through MCP, and to have their code checked.\n- You want paid support available without switching libraries later.\n\n## When to choose TanStack Table (Svelte)\n\n- You ship to multiple frameworks (React, Vue, Svelte) and want one API across them.\n- You explicitly want a headless library and intend to build your own render layer.\n- You want the smallest possible engine and the largest possible community.\n- A shadcn-svelte data table built on TanStack already does what you need.\n\n## Migration effort\n\nEstimated effort: About 30 minutes per read-only grid, 2-4 hours for editing-heavy grids.\n\nWhat you give up:\n\n- One table engine across React, Vue, Svelte, Solid, Qwik and Lit.\n- The smallest engine-only bundle; the At a glance table has both measured sizes.\n- The TanStack ecosystem around the table: Virtual, Query and the shadcn-svelte data table recipe.\n\nMigration guide: moving from TanStack Table (Svelte) to SvGrid: https://svgrid.com/docs/help/migrating-from-tanstack-table/\n\n## Live example\n\nHeadless Table: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/186-headless-table/\n\n## The bottom line\n\nIf you build across React, Vue and Svelte and want one headless API, TanStack Table is the safer bet. If you are committed to Svelte 5 and want virtualization, Excel-style filters, editing and selection out of the box, SvGrid gets you there with far less code, and you keep a headless core when you need it.\n\n## Frequently asked questions\n\n### Is SvGrid better than TanStack Table for Svelte?\n\nFor a Svelte 5 app, SvGrid is usually the faster path: it ships a virtualized render component with built-in filters, editing and accessibility, so there is no DOM layer to write. The TanStack Svelte adapter is Svelte 5 in its v9 line, but it is headless by design; you still build and maintain the table, virtualization and editing UI. TanStack wins if you need one API across several frameworks, or if owning that markup is the point.\n\n### Can I keep a headless setup like TanStack Table?\n\nYes. createSvGrid plus the row-model factories is a headless engine; you can drive your own markup exactly as with TanStack and adopt the SvGrid component only where you want it. The headless docs and the headless demos on this page show both.\n\n### Does the TanStack Svelte adapter support Svelte 5?\n\nYes. The @tanstack/svelte-table package on npm declares a Svelte 5 peer range in its v9 line and its examples pass data through getters rather than stores. The At a glance table shows the version and the peer range as read from the registry.\n\n### How long is a TanStack Table to SvGrid migration?\n\nAbout thirty minutes for a read-only grid and two to four hours for editing-heavy ones. The row-model concepts map almost one to one; the migration guide walks through createTable to createSvGrid, the features object and the rendering options.\n\n### Which is smaller, TanStack Table or SvGrid?\n\nThe TanStack adapter, as an engine with no rendering. The At a glance table has both packages measured the same way on the same date. Add what you would write on top of TanStack (a virtualizer, filter UI, editors) before comparing, since that is what the extra size in SvGrid is.\n\n### Is SvGrid a good TanStack Table alternative for Svelte?\n\nPeople arrive here wanting less glue code, and that is the trade: you keep a headless engine with row models and composable features, and you stop hand-building the DOM, the virtualizer, the filter menus and the editors. If you need one table engine across React and Svelte, stay where you are; that portability is exactly what SvGrid gives up.\n\n## Related comparisons and docs\n\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/)\n- [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/)\n- [SvGrid vs Flowbite / Skeleton / shadcn-svelte tables](https://svgrid.com/compare/svelte-ui-kit-tables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Build a table from scratch](https://svgrid.com/docs/help/headless/build-a-table/)\n- [Server-side data (load on demand)](https://svgrid.com/docs/help/headless/server-side/)\n- [Headless virtualization](https://svgrid.com/docs/help/headless/virtualization/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- tanstack-svelte: The Svelte adapter is headless: build your own markup from the table instance's state and APIs; createTable takes features, columns and data through a getter; adapters exist for React, Vue, Solid, Qwik, Lit and Svelte (checked 12 Sep 2026) https://tanstack.com/table/latest/docs/framework/svelte/overview\n- tanstack-npm: The latest version's peerDependencies declare svelte ^5.0.0; licence MIT (checked 12 Sep 2026) https://www.npmjs.com/package/@tanstack/svelte-table\n- tanstack-home: Sponsor-supported with gold, silver and bronze sponsors; sponsors get private discord channels, priority issue requests and direct support; an Enterprise Support tier offers private consulting and expert support; no licence for the table is sold (checked 12 Sep 2026) https://tanstack.com/table/latest\n"
|
|
8744
|
+
"markdown": "# SvGrid vs TanStack Table (Svelte)\n\nCanonical URL: https://svgrid.com/compare/tanstack-table/\nFacts verified: 2026-09-12\nCompetitor package: @tanstack/svelte-table\nCompetitor site: https://tanstack.com/table/latest\n\nTanStack Table is the headless table engine with adapters for React, Vue, Svelte, Solid, Qwik and Lit; you bring the markup.\n\n## Verdict\n\nThe closest peer to SvGrid's headless core. SvGrid ships a rendered component on top of the same kind of engine, in Svelte 5 runes; TanStack stays framework-agnostic and asks you to build and maintain the DOM, the virtualizer, the filter menus and the editors yourself.\n\nMigration guide: moving from TanStack Table (Svelte) to SvGrid: https://svgrid.com/docs/help/migrating-from-tanstack-table/\n\n## At a glance\n\n| Fact | SvGrid | TanStack Table (Svelte) | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 9.3.1 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 12 Oct 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Yes (peer svelte ^5.0.0) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 539,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 36.5 KB JS, no separate stylesheet, svelte external | 9 Nov 2026 |\n| Engine alone, minified + gzip | 3.2 KB JS, no separate stylesheet (`createSvGrid` from `@svgrid/grid/core`) | the row above; the package is the engine | 17 Nov 2026 |\n| Frameworks | Svelte 5 | Svelte, React, Vue, Solid, Qwik, Lit | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | TanStack Table is MIT and free; tanstack.com is sponsor-supported and offers Enterprise Support as private consulting and expert support, with no licence sold for the table | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; @tanstack/svelte-table 9.3.1 entry `whole package` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\nTanStack Table is the canonical headless table library: it provides the data pipeline (filter, sort, group, expand, paginate, select) and leaves the markup to you. The v9 line ships a Svelte adapter, @tanstack/svelte-table, whose peer dependency range is Svelte 5, with createTable and getters for reactive data instead of the stores the v8 adapter used.\n\nSvGrid covers the same headless surface (createSvGrid, row models, a features object) and adds a full render component with virtualization, Excel-style filters, inline editing, cell-range selection with a fill handle, grouping with aggregation, master/detail, a server-side row model and integrated charts, all in the MIT package.\n\n## Looking for a TanStack Table alternative for Svelte?\n\nPeople arrive here wanting less glue code, and that is the trade: you keep a headless engine with row models and composable features, and you stop hand-building the DOM, the virtualizer, the filter menus and the editors. If you need one table engine across React and Svelte, stay where you are; that portability is exactly what SvGrid gives up.\n\n## What they have in common\n\n- Headless-first architecture with row-model factories and a features object.\n- Composable features: sorting, filtering, grouping, pagination, expansion, selection.\n- TypeScript-first, MIT-licensed, with paid support available from the maintainers.\n- A createTable / createSvGrid entry point that takes columns, data and features.\n- Svelte 5 in both: runes in SvGrid, a Svelte 5 peer range in the TanStack adapter.\n\n## Where SvGrid is stronger\n\n- Ships <SvGrid />: a production render component with virtualization, Excel-style filters, cell-range selection, inline editing, grouping, master/detail and pagination. With TanStack Table you build all of this.\n- The headless core is written in Svelte 5 runes; the TanStack adapter wraps a framework-agnostic core.\n- An imperative API (SvGridApi) for adding rows, setting filters and mutating columns from outside the component.\n- A gallery of runnable examples that covers every feature, and per-feature docs pages with embedded demos.\n- In-grid AI helpers free in @svgrid/grid, and @svgrid/mcp so assistants fetch real example sources and can check the code they write.\n- A paid pack with Excel, PDF and print output, import, pivot tables and support.\n\n## Where TanStack Table (Svelte) is stronger\n\n- A far larger community; the At a glance table has the download counts side by side.\n- Multi-framework parity: if your shop has React, Vue and Svelte apps, the API stays consistent.\n- A smaller bundle when all you want is the engine; the At a glance table has both measured sizes.\n- Framework-specific documentation for each adapter and years of production use in large companies.\n- Enterprise Support as private consulting, and sponsor perks such as priority issue requests.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | TanStack Table (Svelte) |\n| --- | --- | --- |\n| Headless engine | Yes - createSvGrid | Yes - createTable |\n| Render component (drop-in) | Yes - <SvGrid /> | No - bring your own markup |\n| Svelte 5 | Yes - runes throughout | Yes - the adapter's peer range is Svelte 5 |\n| Row virtualization | Yes - built in | Partial - pair with @tanstack/svelte-virtual |\n| Column virtualization | Yes - built in | Partial - pair with @tanstack/svelte-virtual |\n| Excel-style filter menu | Yes - built in | No - filtering logic only; the UI is yours |\n| Inline editing | Yes - enableInlineEditing | No - bring your own |\n| Cell-range selection and clipboard | Yes - enableCellSelection, fill handle | No - bring your own |\n| Server-side data, flat (sort, filter, paging, infinite scroll) | Yes - createServerDataSource: page or infinite block scroll | Yes - manual sorting, filtering and pagination flags |\n| Server-side row model (lazy grouping, tree, pivot, transactions, select-all across unloaded rows) | Paid tier - @svgrid/enterprise | No - the engine has no server row model; the app fetches per group |\n| Master/detail and tree | Yes | Yes - expansion and subRows |\n| Grouping with aggregation | Yes - engine and rendered group rows | Yes - engine only |\n| Integrated charts | Yes - SvGridChart | No - not part of a headless engine |\n| WAI-ARIA helpers | Yes - exported, and applied by <SvGrid /> | Partial - your markup, your ARIA |\n| In-grid AI helpers and MCP server | Yes - helpers free in @svgrid/grid; @svgrid/mcp, MIT | No - not in the docs |\n| Multi-framework support | No - Svelte only | Yes - React, Vue, Svelte, Solid, Qwik, Lit |\n| Paid support tier | Yes - with @svgrid/enterprise, per developer per year | Yes - Enterprise Support (private consulting) and sponsor perks such as priority issues |\n\n## Measured performance\n\nMeasured 28 Oct 2026 with the harness in the repository (pnpm bench:compare): 100,000 rows, fastest of 3 samples per operation, each grid in a fresh page, Chromium through Playwright, headless, on win32 10.0.26200 x64, Intel(R) Core(TM) Ultra 7 255U; a developer workstation, not a dedicated bench rig. Versions: @svgrid/grid 3.0.25, @tanstack/svelte-table 9.2.4. Lower is better. Tick: 1,000 of the rows replaced per tick with a new amount, the grid sorted by amount, on the update path each grid provides, timed until the changed cells paint; 180 ticks after 10 to warm up.\n\n| Operation | SvGrid | TanStack Table (Svelte) |\n| --- | --- | --- |\n| Mount | 30.7 ms | 170.2 ms |\n| Sort, text column | 77.4 ms | 360.9 ms |\n| Sort, numeric column | 32.8 ms | 178.2 ms |\n| Filter, one column (indicative only) | 34.5 ms | 51.1 ms |\n| Scroll, p95 frame | 34.3 ms | 34.3 ms |\n| Live tick, 1,000 rows replaced, sorted by that column, p95 | 48.6 ms | 563.4 ms |\n| Ticks over one 60 Hz frame, of 180 | 115 | 180 |\n| Rows kept in the DOM (virtualization on) | 36 | 27 |\n\nThe filter row is not like for like: each grid is driven through its own single-column filter API, and the amount of work differs. The comparison guide explains the method, what is left out and why.\n\nTanStack Table renders nothing, so its adapter draws the row model through a minimal fixed-height windowed table with no virtualizer library, filter UI or editors; the numbers are the engine plus that DOM.\n\n## When to choose SvGrid\n\n- You are on Svelte 5 and want a grid that uses runes idiomatically, headless or rendered.\n- You want a drop-in <SvGrid /> with virtualization, filters, editing and selection working in one prop pass.\n- You want AI tools to give accurate answers about your grid through MCP, and to have their code checked.\n- You want paid support available without switching libraries later.\n\n## When to choose TanStack Table (Svelte)\n\n- You ship to multiple frameworks (React, Vue, Svelte) and want one API across them.\n- You explicitly want a headless library and intend to build your own render layer.\n- You want the smallest possible engine and the largest possible community.\n- A shadcn-svelte data table built on TanStack already does what you need.\n\n## Migration effort\n\nEstimated effort: About 30 minutes per read-only grid, 2-4 hours for editing-heavy grids.\n\nWhat you give up:\n\n- One table engine across React, Vue, Svelte, Solid, Qwik and Lit.\n- The smallest engine-only bundle; the At a glance table has both measured sizes.\n- The TanStack ecosystem around the table: Virtual, Query and the shadcn-svelte data table recipe.\n\nMigration guide: moving from TanStack Table (Svelte) to SvGrid: https://svgrid.com/docs/help/migrating-from-tanstack-table/\n\n## Live example\n\nHeadless Table: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/186-headless-table/\n\n## The bottom line\n\nIf you build across React, Vue and Svelte and want one headless API, TanStack Table is the safer bet. If you are committed to Svelte 5 and want virtualization, Excel-style filters, editing and selection out of the box, SvGrid gets you there with far less code, and you keep a headless core when you need it.\n\n## Frequently asked questions\n\n### Is SvGrid better than TanStack Table for Svelte?\n\nFor a Svelte 5 app, SvGrid is usually the faster path: it ships a virtualized render component with built-in filters, editing and accessibility, so there is no DOM layer to write. The TanStack Svelte adapter is Svelte 5 in its v9 line, but it is headless by design; you still build and maintain the table, virtualization and editing UI. TanStack wins if you need one API across several frameworks, or if owning that markup is the point.\n\n### Can I keep a headless setup like TanStack Table?\n\nYes. createSvGrid plus the row-model factories is a headless engine; you can drive your own markup exactly as with TanStack and adopt the SvGrid component only where you want it. The headless docs and the headless demos on this page show both.\n\n### Does the TanStack Svelte adapter support Svelte 5?\n\nYes. The @tanstack/svelte-table package on npm declares a Svelte 5 peer range in its v9 line and its examples pass data through getters rather than stores. The At a glance table shows the version and the peer range as read from the registry.\n\n### How long is a TanStack Table to SvGrid migration?\n\nAbout thirty minutes for a read-only grid and two to four hours for editing-heavy ones. The row-model concepts map almost one to one; the migration guide walks through createTable to createSvGrid, the features object and the rendering options.\n\n### Which is smaller, TanStack Table or SvGrid?\n\nThe TanStack adapter, as an engine with no rendering. The At a glance table has both packages measured the same way on the same date. Add what you would write on top of TanStack (a virtualizer, filter UI, editors) before comparing, since that is what the extra size in SvGrid is.\n\n### Is SvGrid a good TanStack Table alternative for Svelte?\n\nPeople arrive here wanting less glue code, and that is the trade: you keep a headless engine with row models and composable features, and you stop hand-building the DOM, the virtualizer, the filter menus and the editors. If you need one table engine across React and Svelte, stay where you are; that portability is exactly what SvGrid gives up.\n\n## Related comparisons and docs\n\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/)\n- [SvGrid vs SVAR Svelte DataGrid](https://svgrid.com/compare/svar-svelte-datagrid/)\n- [SvGrid vs Flowbite / Skeleton / shadcn-svelte tables](https://svgrid.com/compare/svelte-ui-kit-tables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Build a table from scratch](https://svgrid.com/docs/help/headless/build-a-table/)\n- [Server-side data (load on demand)](https://svgrid.com/docs/help/headless/server-side/)\n- [Headless virtualization](https://svgrid.com/docs/help/headless/virtualization/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- tanstack-svelte: The Svelte adapter is headless: build your own markup from the table instance's state and APIs; createTable takes features, columns and data through a getter; adapters exist for React, Vue, Solid, Qwik, Lit and Svelte (checked 12 Sep 2026) https://tanstack.com/table/latest/docs/framework/svelte/overview\n- tanstack-npm: The latest version's peerDependencies declare svelte ^5.0.0; licence MIT (checked 12 Sep 2026) https://www.npmjs.com/package/@tanstack/svelte-table\n- tanstack-home: Sponsor-supported with gold, silver and bronze sponsors; sponsors get private discord channels, priority issue requests and direct support; an Enterprise Support tier offers private consulting and expert support; no licence for the table is sold (checked 12 Sep 2026) https://tanstack.com/table/latest\n"
|
|
8745
8745
|
},
|
|
8746
8746
|
{
|
|
8747
8747
|
"slug": "compare/vincjo-datatables",
|
|
8748
8748
|
"path": "docs/_data/comparisons/vincjo-datatables.json",
|
|
8749
8749
|
"title": "SvGrid vs @vincjo/datatables",
|
|
8750
8750
|
"section": "Comparisons",
|
|
8751
|
-
"markdown": "# SvGrid vs @vincjo/datatables\n\nCanonical URL: https://svgrid.com/compare/vincjo-datatables/\nFacts verified: 2026-09-12\nCompetitor package: @vincjo/datatables\nCompetitor site: https://github.com/vincjo/datatables\n\n@vincjo/datatables is a lightweight, headless Svelte datatable helper for sorting, filtering, and paginating your own markup.\n\n## Verdict\n\n@vincjo/datatables is a great minimal pick when you want to keep your own table markup and just need sort / filter / paginate. SvGrid is the fuller grid - virtualization, Excel filters, editing, a render component - for heavier apps.\n\nMigration guide: moving from @vincjo/datatables to SvGrid: https://svgrid.com/docs/help/migrating-from-vincjo-datatables/\n\n## At a glance\n\n| Fact | SvGrid | @vincjo/datatables | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 2.8.1 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 4 Jun 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Yes (peer svelte ^5.56.1) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 107,000 | 9 Nov 2026 |\n| Bundle, minified + gzip |
|
|
8751
|
+
"markdown": "# SvGrid vs @vincjo/datatables\n\nCanonical URL: https://svgrid.com/compare/vincjo-datatables/\nFacts verified: 2026-09-12\nCompetitor package: @vincjo/datatables\nCompetitor site: https://github.com/vincjo/datatables\n\n@vincjo/datatables is a lightweight, headless Svelte datatable helper for sorting, filtering, and paginating your own markup.\n\n## Verdict\n\n@vincjo/datatables is a great minimal pick when you want to keep your own table markup and just need sort / filter / paginate. SvGrid is the fuller grid - virtualization, Excel filters, editing, a render component - for heavier apps.\n\nMigration guide: moving from @vincjo/datatables to SvGrid: https://svgrid.com/docs/help/migrating-from-vincjo-datatables/\n\n## At a glance\n\n| Fact | SvGrid | @vincjo/datatables | Checked |\n| --- | --- | --- | --- |\n| Latest version | 3.0.32 | 2.8.1 | 9 Nov 2026 |\n| Licence field on npm | MIT | MIT | 9 Nov 2026 |\n| Last published | 3 Nov 2026 | 4 Jun 2026 | 9 Nov 2026 |\n| Svelte 5 support | Native (Svelte 5 runes) | Yes (peer svelte ^5.56.1) | 9 Nov 2026 |\n| npm downloads, 30 days to 8 Nov 2026 | 44,600 | 107,000 | 9 Nov 2026 |\n| Bundle, minified + gzip | 97.8 KB JS + 11.7 KB CSS | 10.2 KB JS, no separate stylesheet, svelte external | 9 Nov 2026 |\n| Engine alone, minified + gzip | 3.2 KB JS, no separate stylesheet (`createSvGrid` from `@svgrid/grid/core`) | the row above; the package is the engine | 17 Nov 2026 |\n| Frameworks | Svelte 5 | Svelte | 12 Sep 2026 |\n| Pricing | MIT core; @svgrid/enterprise from $299 per developer per year (Indie, under $1M revenue), $599 for Enterprise | @vincjo/datatables is MIT on npm and free; no licence is sold | 12 Sep 2026 |\n\nBundle sizes: each package built alone with Vite in library mode, minified, gzip level 9, Svelte kept external where a package uses it (it is a peer dependency). SvGrid 3.0.36 measured 17 Nov 2026 with packages/grid/scripts/measure-size.mjs; @vincjo/datatables 2.8.1 entry `whole package` measured 9 Nov 2026 with packages/grid/scripts/measure-competitor-bundles.mjs.\n\n## Overview\n\n@vincjo/datatables gives you a small, ergonomic handler that wraps your data with reactive sorting, filtering, and pagination while you keep full control of the markup. It is MIT-licensed and popular for its simplicity.\n\nSvGrid scales further up the curve: it keeps a headless engine but also ships a virtualized render component, an Excel-style filter menu, inline editing, cell selection, and an imperative API - for when a hand-rolled table stops being enough.\n\n## Looking for a @vincjo/datatables alternative for Svelte?\n\nIt is a helper for your own markup rather than a grid, which is exactly right until you need virtualization, inline editing or column pinning and start building them yourself. Moving to SvGrid keeps the headless option and adds those. If your table is a few hundred rows of your own HTML, staying put is the smaller dependency.\n\n## What they have in common\n\n- Svelte-native, not a port.\n- Headless-friendly: you can drive your own markup.\n- MIT-licensed.\n- Client- and server-side data modes.\n\n## Where SvGrid is stronger\n\n- Built-in virtualized render component - no need to author the table.\n- Excel-style filter menu, inline editing, and cell-range selection.\n- Row + column virtualization for large datasets.\n- Imperative SvGridApi + @svgrid/mcp MCP server.\n- Optional Enterprise pack for export, import, pivot, and AI.\n\n## Where @vincjo/datatables is stronger\n\n- Much smaller surface and bundle if all you need is sort / filter / paginate.\n- You keep 100% control of the table markup with zero render opinions.\n- Faster to learn for a simple table.\n\n## Feature by feature\n\nYes: shipped in the package. Partial: needs extra work or a companion package. Paid tier: only in a paid edition. No: not available. n/a: does not apply.\n\n| Feature | SvGrid | @vincjo/datatables |\n| --- | --- | --- |\n| Svelte native | Yes | Yes - Svelte 5 peer range |\n| Render component | Yes - <SvGrid /> | No - headless, you render the markup |\n| Virtualization | Yes | No |\n| Excel-style filters | Yes | Partial - Basic filtering |\n| Inline editing | Yes | No - BYO |\n| Cell selection + copy | Yes | No - BYO |\n| Grouping / tree / master-detail | Yes | No |\n| Footprint for a simple table | Partial - Larger | Yes - Tiny |\n| AI / MCP integration | Yes | No |\n\n## When to choose SvGrid\n\n- You need virtualization, editing, or Excel-style filtering.\n- You want a render component instead of hand-authoring the table.\n- You expect the grid to grow into grouping, tree, or master/detail.\n\n## When to choose @vincjo/datatables\n\n- You only need sort / filter / paginate over a small dataset.\n- You want to keep full control of your own table markup.\n- You want the smallest possible bundle for a simple table.\n\n## Migration effort\n\nEstimated effort: 30 minutes to 2 hours per table.\n\nWhat you give up:\n\n- A tiny dependency-free helper when a sortable, filterable list is all you need.\n- Full control of the markup without opting into a headless mode.\n\nMigration guide: moving from @vincjo/datatables to SvGrid: https://svgrid.com/docs/help/migrating-from-vincjo-datatables/\n\n## Live example\n\nHeadless Table: open it in the gallery for the source and the full-size version. https://svgrid.com/demos/186-headless-table/\n\n## The bottom line\n\nFor a small sort/filter/paginate list you keep full control over, @vincjo/datatables is delightfully light. The moment you need virtualization, Excel-style filters, editing, or grouping, SvGrid is the grid that already has them.\n\n## Frequently asked questions\n\n### SvGrid vs @vincjo/datatables - which to pick?\n\nPick @vincjo/datatables for a small, markup-controlled table; pick SvGrid when you need virtualization, editing, filters, or grouping. Both are MIT and Svelte-native.\n\n### Is @vincjo/datatables lighter than SvGrid?\n\nYes, for a simple table it is smaller. SvGrid carries more because it ships a virtualized render component and a full feature set.\n\n### Can SvGrid be headless like @vincjo/datatables?\n\nYes - its headless core lets you keep your own markup, the same way @vincjo/datatables does.\n\n### Is SvGrid a good @vincjo/datatables alternative for Svelte?\n\nIt is a helper for your own markup rather than a grid, which is exactly right until you need virtualization, inline editing or column pinning and start building them yourself. Moving to SvGrid keeps the headless option and adds those. If your table is a few hundred rows of your own HTML, staying put is the smaller dependency.\n\n## Related comparisons and docs\n\n- [SvGrid vs svelte-headless-table](https://svgrid.com/compare/svelte-headless-table/)\n- [SvGrid vs TanStack Table (Svelte)](https://svgrid.com/compare/tanstack-table/)\n- [SvGrid vs Flowbite / Skeleton / shadcn-svelte tables](https://svgrid.com/compare/svelte-ui-kit-tables/)\n- [Comparison: SvGrid vs AG Grid vs TanStack Table](https://svgrid.com/docs/help/comparison/)\n- [Build a table from scratch](https://svgrid.com/docs/help/headless/build-a-table/)\n\n## Sources and last verified\n\nEvery claim on this page was last checked on 12 Sep 2026. Versions, licences and download counts come from the npm registry; feature and pricing statements from the pages listed below.\n\n- vincjo-docs: A headless, SSR-friendly toolkit with no dependency: sort, filter, search and pagination in client-side and server-side modes; you render the markup (checked 12 Sep 2026) https://vincjo.fr/datatables/\n- vincjo-npm: MIT; the latest version declares a Svelte 5 peer range (checked 12 Sep 2026) https://www.npmjs.com/package/@vincjo/datatables\n"
|
|
8752
8752
|
}
|
|
8753
8753
|
];
|
|
8754
8754
|
export const apiReference = {
|
|
@@ -8825,8 +8825,8 @@ export const apiReference = {
|
|
|
8825
8825
|
]
|
|
8826
8826
|
};
|
|
8827
8827
|
export const apiSurface = {
|
|
8828
|
-
"gridVersion": "3.0.
|
|
8829
|
-
"enterpriseVersion": "3.1.
|
|
8828
|
+
"gridVersion": "3.0.36",
|
|
8829
|
+
"enterpriseVersion": "3.1.44",
|
|
8830
8830
|
"grid": {
|
|
8831
8831
|
"values": [
|
|
8832
8832
|
"ALL_FILTER_OPERATORS",
|
|
@@ -8847,6 +8847,7 @@ export const apiSurface = {
|
|
|
8847
8847
|
"PHONE_NATIONAL_LENGTHS",
|
|
8848
8848
|
"RANGE_OPERATOR_IDS",
|
|
8849
8849
|
"SET_OPERATOR_IDS",
|
|
8850
|
+
"SHEET_MAX_WIDTH",
|
|
8850
8851
|
"STRENGTH_LABELS",
|
|
8851
8852
|
"SvAccordion",
|
|
8852
8853
|
"SvAlert",
|
|
@@ -9289,6 +9290,7 @@ export const apiSurface = {
|
|
|
9289
9290
|
"pivotResultToChartSpec",
|
|
9290
9291
|
"polynomialFit",
|
|
9291
9292
|
"popIn",
|
|
9293
|
+
"popoverSheets",
|
|
9292
9294
|
"portalToBody",
|
|
9293
9295
|
"powerFit",
|
|
9294
9296
|
"presetWindow",
|
|
@@ -9372,6 +9374,7 @@ export const apiSurface = {
|
|
|
9372
9374
|
"setAutoHideSize",
|
|
9373
9375
|
"setManagerActive",
|
|
9374
9376
|
"setModalCloseLabel",
|
|
9377
|
+
"setPopoverSheets",
|
|
9375
9378
|
"setWindowMinimized",
|
|
9376
9379
|
"simpleMovingAverage",
|
|
9377
9380
|
"sliceChartWindow",
|
|
@@ -9831,6 +9834,7 @@ export const apiSurface = {
|
|
|
9831
9834
|
"Placement",
|
|
9832
9835
|
"PopoverSelect",
|
|
9833
9836
|
"PopoverSelectConfig",
|
|
9837
|
+
"PopoverSheetMode",
|
|
9834
9838
|
"PositionedEvent",
|
|
9835
9839
|
"PromiseMessages",
|
|
9836
9840
|
"RadioGroup",
|
|
@@ -11309,6 +11313,11 @@ export const apiSurface = {
|
|
|
11309
11313
|
"optional": true,
|
|
11310
11314
|
"type": "boolean"
|
|
11311
11315
|
},
|
|
11316
|
+
{
|
|
11317
|
+
"name": "maxPinnedColumnWidth",
|
|
11318
|
+
"optional": true,
|
|
11319
|
+
"type": "number"
|
|
11320
|
+
},
|
|
11312
11321
|
{
|
|
11313
11322
|
"name": "primaryField",
|
|
11314
11323
|
"optional": true,
|