Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/calasanmarko/svelte-untitled-ui-icons

Untitled UI icon component library for Svelte
https://github.com/calasanmarko/svelte-untitled-ui-icons

icons svelte typescript ui untitled-ui

Last synced: about 1 month ago
JSON representation

Untitled UI icon component library for Svelte

Awesome Lists containing this project

README

        

# svelte-untitled-ui-icons
*Untitled UI icon component library for Svelte*

## Installation
```bash
npm install --save-dev svelte-untitled-ui-icons
```
or
```bash
yarn add --dev svelte-untitled-ui-icons
```

## Usage
```svelte

import { AlarmClockIcon } from "svelte-untitled-ui-icons/AlarmClockIcon";

```

Exports are separated into subpaths because SvelteKit's dependency optimization would slow down page loading times on development builds to ~2-3 seconds if all exports were placed into the same file.

This causes auto-filling imports to be a little more inconvenient in IDEs, any suggestions on how this should be improved are welcome.

## Build
You can build this package using Bun
```bash
bun run build
```

or `tsx`
```
tsx build.ts
```

You can customize the icon selection by adding or removing icons from the `assets` directory. Make sure that filenames are in `kebab-case.svg`.

## Author

Made by **Marko Calasan**. Licensed under the **MIT License**.

All icons are created by [Untitled UI](https://www.untitledui.com).

Partially inspired by [svelte-feather-icons](https://github.com/dylanblokhuis/svelte-feather-icons) by [dylanblokhuis](https://github.com/dylanblokhuis).