Skip to content

SVAR Core library is a collection of essential UI components written with Svelte.

License

Notifications You must be signed in to change notification settings

svar-widgets/core

Repository files navigation

SVAR Svelte Core | UI Library

🌐 Website • 💡 Getting Started • 👀 Demos

npm License npm downloads

SVAR Core library offers a set of 20+ ready-made Svelte UI components: form controls, popups, date and time picker, toast notifications, and more. All components are lightweight, responsive, fast-performing, and available in light and dark skins.

SVAR Core Library - Dark Skin

In addition to the Core library, you can use the following SVAR components to build unified app UIs:

Versions for Svelte 4 and 5

There are two versions of the library:

  • version 1.x was designed to work with Svelte 4
  • version 2.x is created for Svelte 5 (please note that this version is in beta and may contain some instabilities)

To use SVAR Core v.2.0 beta for Svelte 5, install it as follows:

npm install wx-svelte-core

To use SVAR Core for Svelte 4:

npm install [email protected]

🛠️ How to Use

To use any of the Core components, simply import the package and include the desired component in your Svelte file:

<script>
	import { Button } from "wx-svelte-core";
</script>

<Button>Click me</Button>

See the getting started guide to quickly set up and begin using SVAR Core components in your Svelte projects.

💻 How to Modify

Typically, you don't need to modify the code. However, if you wish to do so, follow these steps:

  1. Run yarn to install dependencies. Note that this project is a monorepo using yarn workspaces, so npm will not work
  2. Start the project in development mode with yarn start

✅ Run Tests

To run the test:

  1. Start the test examples with:
    yarn start:tests
  2. In a separate console, run the end-to-end tests with:
    yarn test:cypress

💬 Need Help?

Post an Issue or use our community forum.