Lucide Svelte Package! (#476)

* init svelte project

* Add export script for lucide-svelte

* make lucide-svelte wokring

* make ready for first release

* update lock file

* bump version

* some fixes in the build

* Add tests

* Finish tests

* Update Readme

* update lock file

* Add svelte to gh actions

* Add svetle to website docs

* Add test ci script

* adjust action

* add on PR trigger

* remove dep

* fix tests

* Add svelte entry in package.json

* update snapshots
This commit is contained in:
Eric Fennis
2022-02-17 17:46:55 +01:00
committed by GitHub
parent 7f03a8195a
commit f964dff64d
36 changed files with 3239 additions and 1755 deletions
+1 -1
View File
@@ -17,7 +17,7 @@ When designing new icons, the community is working with a set of design rules. T
Beside design, code is also important. Assets like icons in for example web projects can increase the transferred bytes significantly. With the growing internet, lucide has the responsibility to keep their assets small as possible. To achieve this, lucide uses SVG compression and specific code architecture for three-shaking abilities. With three-shaking used you will only ship the icons you used, helps you to keep the software small as possible when distributed.
Lucide provides several official packages for: [Web (Vanilla)](https://lucide.dev/docs/lucide), [React](https://lucide.dev/docs/lucide-react), [Vue](https://lucide.dev/docs/lucide-vue), [Vue 3](https://lucide.dev/docs/lucide-vue-next), [Preact](https://lucide.dev/docs/lucide-preact), [Angular](https://lucide.dev/docs/lucide-angular), [NodeJS](https://lucide.dev/docs/lucide-static#nodejs) and [Flutter](https://lucide.dev/docs/lucide-flutter).
Lucide provides several official packages for: [Web (Vanilla)](https://lucide.dev/docs/lucide), [React](https://lucide.dev/docs/lucide-react), [Vue](https://lucide.dev/docs/lucide-vue), [Vue 3](https://lucide.dev/docs/lucide-vue-next), [Svelte](https://lucide.dev/docs/lucide-svelte),[Preact](https://lucide.dev/docs/lucide-preact), [Angular](https://lucide.dev/docs/lucide-angular), [NodeJS](https://lucide.dev/docs/lucide-static#nodejs) and [Flutter](https://lucide.dev/docs/lucide-flutter).
Any questions about lucide? Ask the community. Active on [GitHub](https://github.com/lucide-icons/lucide) and [Discord](https://discord.gg/EH6nSts).
+27 -13
View File
@@ -8,7 +8,7 @@ title: Installation
Implementation of the lucide icon library for web applications.
```sh
```bash
npm install lucide
#or
@@ -22,7 +22,7 @@ For more details, see the [documentation](packages/lucide).
Implementation of the lucide icon library for react applications.
```sh
```bash
yarn add lucide-react
# or
@@ -30,13 +30,13 @@ yarn add lucide-react
npm install lucide-react
```
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/master/packages/lucide-react#lucide-react).
For more details, see the [documentation](packages/lucide-react).
## Vue 2
Implementation of the lucide icon library for vue applications.
```sh
```bash
yarn add lucide-vue
# or
@@ -44,13 +44,13 @@ yarn add lucide-vue
npm install lucide-vue
```
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/master/packages/lucide-vue#lucide-vue).
For more details, see the [documentation](packages/lucide-vue).
## Vue 3
Implementation of the lucide icon library for vue applications.
```sh
```bash
yarn add lucide-vue-next
# or
@@ -58,11 +58,25 @@ yarn add lucide-vue-next
npm install lucide-vue-next
```
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/master/packages/lucide-vue-next#lucide-vue-next).
For more details, see the [documentation](packages/lucide-vue-next).
## Svelte
Implementation of the lucide icon library for vue applications.
```bash
yarn add lucide-svelte
# or
npm install lucide-svelte
```
For more details, see the [documentation](packages/lucide-svelte).
## Angular
```sh
```bash
yarn add lucide-angular
# or
@@ -70,13 +84,13 @@ yarn add lucide-angular
npm install lucide-angular
```
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/master/packages/lucide-angular#lucide-angular).
For more details, see the [documentation](packages/lucide-angular).
## Preact
Implementation of the lucide icon library for preact applications.
```sh
```bash
yarn add lucide-preact
# or
@@ -84,7 +98,7 @@ yarn add lucide-preact
npm install lucide-preact
```
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/master/packages/lucide-preact#lucide-preact).
For more details, see the [documentation](packages/lucide-preact).
## Figma
@@ -98,7 +112,7 @@ Visit [Figma community page](https://www.figma.com/community/plugin/939567362549
Implementation of Lucide icon's using `blade-icons` for Laravel based projects.
```sh
```bash
composer require mallardduck/blade-lucide-icons
```
@@ -108,7 +122,7 @@ For more details, see the [documentation](https://github.com/mallardduck/blade-l
Implementation of Lucide icon library for Flutter applications.
```sh
```bash
flutter pub add lucide_icons
```
+1 -1
View File
@@ -4,7 +4,7 @@ Implementation of the lucide icon library for react applications
## Installation
```sh
``` bash
yarn add lucide-react
# or
+89
View File
@@ -0,0 +1,89 @@
# Lucide Svelte
Implementation of the lucide icon library for svelte applications.
## Installation
```bash
yarn add lucide-svelte
# or
npm install lucide-svelte
```
## How to use
All the icons are Svelte components, that ouputs Svg elements. So each icon can be imported and used as a component. This also helps with the use of threeshaking so you only import the icons you use.
### Example
Default usage:
```html
<script>
import { Skull } from 'lucide-svelte'
</script>
<Skull/>
```
You can pass additional props to adjust the icon.
```html
<script>
import { Camera } from 'lucide-svelte'
</script>
<Camera />
```
### Available props
| name | type | default
| -------------- | -------- | --------
| `size` | *Number* | 24
| `color` | *String* | currentColor
| `strokeWidth` | *Number* | 2
| `*<SVGProps>` | *String* | -
\* All SVGProps are available to style the svgs. See the list of SVG Presentation Attributes on [MDN](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Presentation)
### Example of custom props
```html
<script>
import { Phone } from 'lucide-svelte'
</script>
<Phone fill="#333"/>
```
This results a filled phone icon.
### One generic icon component
It is possible to create one generic icon component to load icons.
> ⚠️ Example below importing all EsModules, caution using this example, not recommended when you bundle your application,the build size will grow strongly. Because it will import all the icons.
#### Icon Component Example
``` html
<script>
import * as icons from "lucide-svelte";
export let name;
</script>
<svelte:component this={icons[name]} {...$$props}/>
```
##### Then you can use it like this
``` html
<script>
import LucideIcon from "./LucideIcon";
</script>
<LucideIcon name="Menu" />
```