An open API service indexing awesome lists of open source software.

https://github.com/perfect-things/ui

Perfect UI components
https://github.com/perfect-things/ui

components svelte ui-components

Last synced: 8 months ago
JSON representation

Perfect UI components

Awesome Lists containing this project

README

          

PerfectThings/UI
================

A set of simple, but perfect, UI components, written in Svelte (the only front-end framework worth learning).

[![Tests](https://github.com/perfect-things/ui/actions/workflows/node.js.yml/badge.svg)](https://github.com/perfect-things/ui/actions/workflows/node.js.yml)

### Github pages site with docs
https://ui.perfectthings.dev

![Screenshot](screen.png)

## Install & Setup

### Firstly, install the module as a dev dependency:
```sh
npm i -D @perfectthings/ui
```

### Svelte components
Just `import` them from the module, as normal:
```js
import { Button } from '@perfectthings/ui';
```

## Usage with SvelteKit

Available from **v6.4.0.**.

Because this is a purely front-end framework and requires browser to work, it will not work with SSR so you need to disable it. Create a file: `src/routes/+layout.js` and add this:
```js
export const ssr = false;
```

Once that's done, you can import the components as normal.

## Development

You need node & npm (obviously). Run these:
```sh
git clone git@github.com:perfect-things/ui.git perfectthings-ui
cd perfectthings-ui
npm i && npm start
```
A browser window should open with the demo of the components.

## Resources

- [Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/components/) from Apple
- Icons from [Tabler Icons](https://tablericons.com)
- *Prime Light* font from [Fontfabric](www.fontfabric.com)

## Support

Donate with PayPal Buy Me A Coffee Donate using Liberapay