andrewjk / svelte-toolkit

UI components for Svelte
MIT License
36 stars 2 forks source link

Svelte Toolkit

A collection of UI components for Svelte.

View the documentation.

Getting Started

The use of the yarn package manager is strongly recommended, as opposed to using npm.

yarn add -D svelte-toolkit

Consuming from SvelteKit

Import and add the Toolkit component in __layout.svelte to provide shared styles:

import { Toolkit } from "svelte-toolkit";
...
<Toolkit />

Import toolkit components in your svelte component:

import { Button } from "svelte-toolkit";

Consuming from Sapper

Import and add the Toolkit component in _layout.svelte to provide shared styles:

import { Toolkit } from "svelte-toolkit";
...
<Toolkit />

Import toolkit components in your svelte component:

import { Button } from "svelte-toolkit";

If you receive a warning about SSR, change it to:

import { Button } from "svelte-toolkit/main.js";

(I'm not 100% sure why this happens some times and not others)

Consuming from Electron

Import the SCSS styles in your renderer.js or renderer/index.js:

require("svelte-toolkit/main.scss");

Import toolkit components in your svelte component:

import { Button } from "svelte-toolkit";

Customising

TODO: