Package Exports

@martinse/svelte-heroicons

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@martinse/svelte-heroicons) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

svelte-heroicons

Svelte component for Heroicons.

Install

npm i -S @martinse/svelte-heroicons

Usage


<script>
    import Heroicon from '@martinse/svelte-heroicons';
    import {heart as solidHeart} from '@martinse/svelte-heroicons/dist/solid';
    import {heart as outlineHeart} from '@martinse/svelte-heroicons/dist/outline';
</script>


<Heroicon icon={outlineHeart}/>
<Heroicon icon={outlineHeart} size="2em"/>
<Heroicon icon={solidHeart} size="3em" class="red"/>


<style>
    :global(.red) {
        color: red;
    }
</style>

Will render:

output

Build / development

In order to build new versions of this package, there some prerequisites to be installed, and some commands to execute. The build process is executed within a Docker container.

Prerequisites

Building the Docker container

task build

Building the package

Building the package is composed of two stes:

Download and generate icon data from a specific Heroicons version
Build the NPM package

task generate-icon-data
task build-npm-dist

Publish to NPM

Update the version in package.json
Tag and push to GitHub
Publish to NPM:

task publish

Update Heroicons version

Update the HEROICONS_VERSION variable in Taskfile.yml and rebuild the Docker container + build/publish the NPM package.

Improvements

Avoid the /dist path when importing solid or outline
Investigate using this package with Svelte + Snowpack (or SvelteKit) as there seems to be an issue with the Rollup configuration
Add tests
Add linting
Create a proper demo page + figure out how to publish a Svelte app to GitHub pages
Sync version in Taskfile.yml and package.json automatically
Implement task publish
Add git tags for published versions
Probably a lot more, feel free to create issues on what can be improved!

License

MIT