https://github.com/Introvertuous/svelte-icons

Icon components for svelte
https://github.com/Introvertuous/svelte-icons

Last synced: 3 months ago
JSON representation

Icon components for svelte

• Host: GitHub
• URL: https://github.com/Introvertuous/svelte-icons
• Owner: Introvertuous
• Created: 2019-07-22T23:05:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-13T20:30:22.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T18:05:48.286Z (3 months ago)
• Language: Svelte
• Homepage: https://svelte-icons.vercel.app
• Size: 2.2 MB
• Stars: 292
• Watchers: 2
• Forks: 21
• Open Issues: 48
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![NPM: svelte-icons](https://badge.fury.io/js/svelte-icons.svg)](https://www.npmjs.com/package/svelte-icons)

[![Build Status](https://travis-ci.org/introvertuous/svelte-icons.svg?branch=master)](https://travis-ci.org/introvertuous/svelte-icons)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

### Svelte Icons

Icon components for svelte.

### Installation

```

npm install --save svelte-icons

```

### Usage

Visit the [icon navigator](https://svelte-icons-explorer.vercel.app/) to search through the available icon sets.

Click an icon to copy the import statement to your clipboard.

```

  import ChevronCircleUp from 'svelte-icons/fa/FaChevronCircleUp.svelte';

  .icon {

    color: red;

    width: 32px;

    height: 32px;

  }



  



```


### Running The Example (Icon Navigator)

Should be as simple as running `yarn` and then `yarn dev` at root and at `/example` (second terminal).

[ NOTE / TODO ]: Building the example takes a very long time, but technically hot-reloading should be fast, although it seems that rollup is not caching dynamic imports for some reason, which means dev with hot-reload is not possible atm. The current work around is to remove some number (ideally all but one) of dynamic imports from inside `store.js`, depending on which packages you need during development.

### Deploying

The deployment for the NPM package (svelte-icons) is automated via travis CI, whereas the example is deployed manually via the `examples` directory, by running `yarn deploy`.