mirror of
https://github.com/lucide-icons/lucide.git
synced 2025-12-24 04:39:21 +01:00
9fa525e8c6
* feat(lucide-astro): initial commit * test: add test suite * fix module resolution issue * chore: update lock file * chore: update lock file * chore: fix precommit hook failing * sync icons generated by precommit hook * remove useless tab in template * style: add space for readability * docs: add bun installation instructions * fix `clean` script * fix testing setup * remove unnecessary `key` props in Astro icons * fix jest matchers types and undefined behavior * chore: update lock file * setup prettier for formatting Astro files * remove mistakenly added prop from the `Icon` component * docs: add documentation for new Astro package * fix incorrect types in `Icon` component * refactor: use `stroke-width` over `strokeWidth` * fix unexpected module resolution behavior * remove hack in test types * remove review marker * docs: progress on documentation of lucide-astro * chore: remove unnecessary .gitignore * docs: add sidebar entry * edit package description * fix uneven icon heights in homepage packages list * docs: add package to readme table * add workflows for lucide-astro package * docs: add package-logos * use the appropriate Astro logo in light and dark mode * Remove inadvertently added class * Update snapshots to reflect removed class `lucide-icon` * remove dependency on internal `@lucide/shared` package * fix: revert changes * revert grid-2x2-x.json * revert grid-2x2-check.json * revert picture-in-picture svg * add package in labeler workflow * add previously uncommited utils.ts file * fix dom type errors * up one major from legacy package * add package to issue and feature request templates * docs: add acknowledgement of Aviortheking as original creator of the package * format * optimization: more lightweight component footprint * refactor: simplify removal of `data-astro-source` debugging attributes * format * style: fix linting error once again 😠 * wip: rename package to `@lucide/astro` * remove acknowledgment of `lucide-astro` * fix error caused by change in build tooling * chore: upgrade dependencies * chore: rename lucide-astro folder * further renaming * use correct package name in key * more renaming * chore: update lock file * apply review suggestions (#1) set correct path for package in actions * apply suggestions from code review (#2) Co-authored-by: Eric Fennis <eric.fennis@gmail.com> * apply @dotspencer's review resolve correct link to package docs page and github source * Format files --------- Co-authored-by: realguse <realguse@icloud.com> Co-authored-by: Eric Fennis <eric.fennis@gmail.com>
258 lines
3.6 KiB
Markdown
258 lines
3.6 KiB
Markdown
---
|
|
title: Installation
|
|
---
|
|
|
|
# Installation
|
|
|
|
## Web
|
|
|
|
Implementation of the lucide icon library for web applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide.md).
|
|
|
|
## React
|
|
|
|
Implementation of the lucide icon library for React applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide-react
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-react
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-react
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-react
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide-react.md).
|
|
For React Native use the `lucide-react-native` package.
|
|
|
|
## Vue
|
|
|
|
Implementation of the lucide icon library for Vue applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide-vue-next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-vue-next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-vue-next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-vue-next
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide-vue-next.md).
|
|
For Vue 2 use the `lucide-vue` package.
|
|
|
|
## Svelte
|
|
|
|
Implementation of the lucide icon library for Svelte applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide-svelte
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-svelte
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-svelte
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-svelte
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide-svelte.md).
|
|
|
|
## Solid
|
|
|
|
Implementation of the lucide icon library for Solid applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide-solid
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-solid
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-solid
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-solid
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide-solid.md).
|
|
|
|
## Angular
|
|
|
|
Implementation of the lucide icon library for Angular applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide-angular
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-angular
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-angular
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-angular
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide-angular.md).
|
|
|
|
## Preact
|
|
|
|
Implementation of the lucide icon library for preact applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide-preact
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-preact
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-preact
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-preact
|
|
```
|
|
|
|
:::
|
|
|
|
## Astro
|
|
|
|
Implementation of the lucide icon library for Astro applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install @lucide/astro
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add @lucide/astro
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install @lucide/astro
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add @lucide/astro
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide-astro.md).
|
|
|
|
## Static usage
|
|
|
|
Implementation of the lucide icon library for multiple usages that like to use: SVG files icons, SVG Sprite, Icon Fonts and static SVG strings export in Common JS modules (for NodeJS).
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm install lucide-static
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-static
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-static
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-static
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](packages/lucide-static.md).
|
|
|
|
## Figma
|
|
|
|
The lucide figma plugin.
|
|
|
|
Visit [Figma community page](https://www.figma.com/community/plugin/939567362549682242/Lucide-Icons) to install the plugin.
|
|
|
|
|
|
|
|
## Flutter
|
|
|
|
Implementation of Lucide icon library for Flutter applications.
|
|
|
|
```bash
|
|
flutter pub add lucide_icons
|
|
```
|
|
|
|
For more details, see the [pub.dev](https://pub.dev/packages/lucide_icons).
|