https://github.com/illright/attractions

A pretty cool UI kit for Svelte
https://github.com/illright/attractions

svelte ui-kit

Last synced: 21 days ago
JSON representation

A pretty cool UI kit for Svelte

• Host: GitHub
• URL: https://github.com/illright/attractions
• Owner: illright
• License: mit
• Created: 2020-04-17T20:48:30.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T13:38:59.000Z (about 1 month ago)
• Last Synced: 2024-10-15T02:31:55.622Z (21 days ago)
• Topics: svelte, ui-kit
• Language: Svelte
• Homepage: https://illright.github.io/attractions
• Size: 3.68 MB
• Stars: 1,040
• Watchers: 12
• Forks: 34
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-svelte - attractions - A pretty cool and modern UI kit. _(pre-v5)_ (UI Libraries / Mobile)
• awesome-starred - illright/attractions - A pretty cool UI kit for Svelte (svelte)

README

        


# Attractions

[![Inactively Maintained](https://img.shields.io/badge/Maintenance%20Level-Inactively%20Maintained-yellowgreen.svg)](https://gist.github.com/cheerfulstoic/d107229326a01ff0f333a1d3476e068d)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/illright/attractions/auto-release.yml)](https://github.com/illright/attractions/actions?query=workflow%3ARelease)

[![npm](https://img.shields.io/npm/v/attractions)](https://www.npmjs.com/package/attractions)

[![npm bundle size](https://img.shields.io/bundlephobia/min/attractions)](https://bundlephobia.com/result?p=attractions)

[![npm bundle zipped size](https://img.shields.io/bundlephobia/minzip/attractions)](https://bundlephobia.com/result?p=attractions)

[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://open.vscode.dev/illright/attractions)

A pretty cool UI kit for Svelte.

Refer to the main documentation: 

## Installation

**Step 1.** Install the library with your favorite package manager:

```bash

npm install --save-dev attractions

# -- or --

yarn add --dev attractions

# -- or --

pnpm add --save-dev attractions

```

**Step 2.** Install `svelte-preprocess`, Dart Sass and PostCSS:

```bash

npm install --save-dev svelte-preprocess sass postcss

# -- or --

yarn add --dev svelte-preprocess sass postcss

# -- or --

pnpm add --save-dev svelte-preprocess sass postcss

```

**Step 3.** Add `svelte-preprocess` to your preprocessor chain ([as shown here](https://github.com/sveltejs/svelte-preprocess/blob/main/docs/usage.md)):

```js

// rollup.config.js

import sveltePreprocess from 'svelte-preprocess';

export default {

  // ...,

  plugins: [

    svelte({

      preprocess: sveltePreprocess(),

    }),

  ],

};

```

**Step 4.** Import the desired components as named imports and use wherever you like!

```svelte

  import { Button } from 'attractions';

click me

```

For more information on how to customize/theme your installation, see [the docs](https://illright.github.io/attractions/docs/theming).

---

Alternatively, the library can be used from a CDN, such as [unpkg](https://unpkg.com/attractions), and then the components will be registered as custom elements. This is especially useful for quick prototypes that do not need all the features provided.

Example usage:

```html

  

  My button

```

For more details, check out [the docs](https://illright.github.io/attractions/docs/custom-elements).

## License

This project is [MIT licensed](./LICENSE).