Skip to content

radiium/svxui

Repository files navigation

svxui

A small SvelteJs library for building applications inspired by radix ui

Documentation and demo

Credits

Some parts of this lib come from the following:
(thanks to the developers for their incredible work!)

Installation

npm install svxui
pnpm install svxui
yarn add svxui

Developing

pnpm install
pnpm run dev

# or start the server and open the app in a new browser tab
pnpm 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 lib:

pnpm run package

To build doc site and lib:

pnpm run build

You can preview the production build with pnpm 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:

pnpm publish