TypeBox Superforms

SvelteKit superforms using TypeBox schemas, hitting API endpoints

UNDER DEVELOPMENT

Introduction

SvelteKit Superforms has made forms for SvelteKit super easy and super user friendly, but it is based on Zod schemas. When people choose TypeBox over Zod, it is because they are prioritizing backend performance. The present library is for those who want all the client-side benefits of Superforms while still maximizing backend performance. Rather than sending form data to the server to parse as a function of the schema, this library parses the form data on the client and submits the data as JSON to a backend endpoint. The library also supports HTTP query parameters, which it specially encodes for both readability and fast parsing into JSON.

create-svelte

Everything you need to build a Svelte library, powered by create-svelte.

Read more about creating a library in the docs.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of your library, everything inside src/routes can be used as a showcase or preview app.

Building

To build your library:

npm run package

To create a production version of your showcase app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Publishing

Go into the package.json and give your package the desired name through the "name" option. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

npm publish