# svelte-ux

**Repository Path**: ttoa/svelte-ux

## Basic Information

- **Project Name**: svelte-ux
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-22
- **Last Updated**: 2024-01-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img alt="svelte-ux logo" height="100px" src="./static/logos/logo.jpg" />  
</p>
<h1 align="center">Svelte UX</h1>

![](https://img.shields.io/github/license/techniq/svelte-ux?style=flat)
[![](https://img.shields.io/github/actions/workflow/status/techniq/svelte-ux/ci.yml?style=flat)](https://github.com/techniq/svelte-ux/actions/workflows/ci.yml)
[![](https://img.shields.io/npm/v/svelte-ux?style=flat)](https://www.npmjs.com/package/svelte-ux)
![npm](https://img.shields.io/npm/dw/svelte-ux?style=flat&color=orange)

[![](https://img.shields.io/badge/Open_in-SvelteLab-black?logo=svelte&color=%23FF3E00)](https://www.sveltelab.dev/?provider=github&owner=techniq&repo=svelte-ux&branch=main&path=%2Fpackages%2Fcreate-svelte-ux%2Ftemplates%2Fstarter) [![](https://img.shields.io/badge/Open_in-StackBlitz-black?logo=stackblitz&color=%231269D3)](https://stackblitz.com/github/techniq/svelte-ux/tree/main/packages/create-svelte-ux/templates/starter) [![](https://img.shields.io/badge/Open_in-CodeSandbox-black?logo=codesandbox&color=%23151515)](https://codesandbox.io/p/sandbox/github/techniq/svelte-ux/tree/main/packages/create-svelte-ux/templates/starter)

![](https://img.shields.io/github/license/svelte-ux?style=flat)
[![](https://dcbadge.vercel.app/api/server/697JhMPD3t?style=flat)](https://discord.gg/697JhMPD3t)

The projects aims to simplify building highly interactive and visual applications. It provides over 200 components, actions, stores, and utils, with many more planned.

The components are built using Tailwind with extensibility and customization in mind through the use of theming, variants, granular class overrides, and slots. A rich design token system is also currently in the works.

See also the companion library [LayerChart](https://layerchart.com) for a large collection of composable chart components to build a wide range of visualizations.

## Contributing

### Install dependencies

```
pnpm i
```

### Run dev server for `svelte-ux` package

```
cd packages/svelte-ux
pnpm dev
```

### Run test for `svelte-ux` package

```
cd packages/svelte-ux
pnpm test:unit
```

### Run tests for all packages

```
pnpm -r test:unit
```

### Run a script from the root

```
pnpm -F svelte-ux dev
```

### Add changeset to include change in changelog and determine next version

```
pnpm changeset
```