# sverocons

> A simple svelte wrapper for the Heroicons Library taking inspiration from the component approach to svg icons by

Latest version **0.0.2** (published 2022-05-10) · 0 weekly downloads

## Install

```sh
npm install sverocons
pnpm add sverocons
yarn add sverocons
bun add sverocons
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-05-10 |
| First published | 2022-02-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 104.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | nontoxicjon |

## Links

- npm: https://www.npmjs.com/package/sverocons
- Repository: https://github.com/jonbitgood/sverocons
- Homepage: https://github.com/jonbitgood/sverocons#readme
- Issues: https://github.com/jonbitgood/sverocons/issues
- npm.io page: https://npm.io/package/sverocons

## Dependencies (1)

- [svelte2tsx](https://npm.io/package/svelte2tsx.md) ^0.5.8

## Recent versions

- 0.0.2 (latest) — 2022-05-10
- 0.0.1 — 2022-02-28

## README

# Sverocons

A simple svelte wrapper for the <a href="https://heroicons.com/" class="text-purple-800 bold">Heroicons Library</a> taking inspiration from the 
<a href="https://svelte.recipes/components/icon/">component approach</a> to svg icons by <a href="https://github.com/Wattenberger">Amelia Wattenberger</a>.

## Using an Icon

```jsx
<Icon name="arrow" type="solid" direction="w" class="h-8 w-8" />
```

All icons can receive three different inputs:

- **name** 
	- _required_
	- heroicon name in snake case
- **type**
	- one of: `outline` / `solid`
	- default: `outline`
- **direction**
	- one of: **`nw, n, ne, e, se, s, sw, w`**

Only Name is required with type defaulting to `outline` and and direction to `n`.
All directional icons have been removed IE arrow-right where they were identical.
The styles default to `h-6 w-6`, but this can be overridden by adding in a class.

---
_Source: https://npm.io/package/sverocons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._