@svgrid/create
v2.7.0
Published
Scaffold a Svelte app powered by SvGrid in one command: npm create @svgrid@latest
Maintainers
Readme
Scaffold a Svelte app powered by SvGrid - the Svelte 5 data grid and data table - in one command.
npm create @svgrid@latest
# or
pnpm create @svgrid
# or
yarn create @svgridInteractive by default. Or pass a directory and template directly:
npm create @svgrid@latest my-app -- --template admin-dashboard
pnpm create @svgrid my-app -t minimalTemplates
| Template | Stack | Best for |
| --- | --- | --- |
| minimal | Vite + Svelte 5 + SvGrid | Dropping a grid into something quickly |
| sveltekit | SvelteKit, server load + form actions | Learning how a grid fits SvelteKit, or starting one |
| admin-dashboard | SvelteKit + Tailwind + SvGrid, deploy to Vercel | A real dashboard / internal tool |
| headless | Vite + Svelte 5 + @svgrid/grid/core, a hand-written <table> | Your own renderer and your own CSS |
The first three render <SvGrid>. headless uses the engine underneath it -
createSvGrid computes the rows, you emit the markup - so it ships no grid CSS
and nothing styles itself.
Options
| Flag | Description |
| --- | --- |
| --template, -t | minimal, sveltekit, admin-dashboard, or headless |
| --theme <id> | One of @svgrid/grid's 20 built-in presets - shadcn, Tailwind, Material, Excel, Fluent, and more (default: ember, the theme the demos use). Ignored by headless |
| --dark / --light | Pin the starting mode. minimal and sveltekit follow the visitor's OS when neither is given |
| --force, -f | Scaffold into a non-empty directory |
| --help, -h | Show usage |
The <SvGrid> templates prompt for a theme and a light/dark mode when run
interactively, or take them as flags:
npm create @svgrid@latest my-app -- -t admin-dashboard --theme material --light
npm create @svgrid@latest my-app -- -t minimal --theme nord --darkAll three ship a working toggle, so the choice is a starting point rather than
something you are stuck with. sveltekit goes further and puts all 20 presets
in a picker in the header, so you can try them against your own data without
rescaffolding. headless is neither asked nor told: it has no stylesheet for a
preset to land in.
Then:
cd my-app
npm install
npm run devAll templates use the free MIT @svgrid/grid core. Add
@svgrid/enterprise for Excel/PDF export, import,
print, pivot, and AI helpers.
SvGrid(TM) is a trademark of jQWidgets Ltd. This package is MIT-licensed.
