mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-13 13:48:26 +00:00
* Update images * Adjust color * update accessebility * Add matrix hero * Add typescript documentation * Add basics section to vue pages * Add svelte docs * Fix dynamic sidebar * Add animation? * Some adjustments * Adjust animation * Updates docs * Add scaledown animation * Add docs for vue types * Fix layout accessibility page * fix framework select * adjust easing home animation * Write docs for Vue * Adjust animation home * Adjust home hero animation * Finish svelte docs * Add solid pages * remove spiral animation component * Add group icons * Added solid docs * update preact docs * Adjust examples preact docs * Add snackplayer * Get new editor * Save this * Add examples * Adjust styling * setup custom sandpack * Add script * Format files * Make sandpack plugin work * migrate react docs * Fix svelte and solid examples * Migrate to solid packages * Add darkmode package logos * Fix bug in selector * migrate vue examples * migrate advanced vue items * migrate preact and svelte examples * Add astro docs * adding more docs on guide for lucide library * Fix home animation * Cleanup * Added resources page, with more details and content * Add hero badge for Version 1 * Fix vercel json * Update missing paths * Fix build? * Replace lucide-vue-next * Fix build * Add some docs * update markdown * Setup angular docs * Add basic angular docs * Adjust code examples * Update title and descriptions * Update accessibility link * Update title and description * Add og image * Fix alignment * Add migration guides * Adjust version 1 markdown file * Add migration guide to the main list * Minor fixes * Update docs * Apply feedback * Select icons * Add pointer events none * Fix package links homepage * Format code * Fix types * Fix focus * Fix build * Fix focus * Apply feedback * Adjust imports * Adjust imports * Fix search * Apply feedback * Fix import in font docs * Small fixes * docs(guide): added easter egg icon. stay tuned, guys 😉 * Add llm txt plugin * Adjust logo top * docs(version-1): upgraded @lucide/angular guide for v1 website (#4144) * docs(guide/angular): rewrite some angular documentation * docs(guide/angular): extens angular guide with combining icons & icon provider guides * docs(guide/angular): fix angular sandbox, still needs @lucide/angular release tho * docs(guide/angular): rework the getting started page a bit more, refactor some more prop=>input occurences * docs(guide/angular): context provider => provideLucideConfig * Update docs/guide/angular/migration.md Co-authored-by: Eric Fennis <eric.fennis@gmail.com> * Update docs/guide/angular/advanced/combining-icons.md Co-authored-by: Eric Fennis <eric.fennis@gmail.com> * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(guide/angular): rework a11y for better flow & pacing * docs(guide/angular): salvage original phrase, it has better flow * docs(guide/angular): some more a11y nitpicking * docs(guide/angular): reduce llm fatigue * docs(guides/angular): fix app component selector * docs(guides/angular): fix angular sandpacks * Add sandpack angular to improve tree-shakable stack * Update docs/guide/angular/getting-started.md * docs(guides/angular): fix user import in combinding icons guide * docs(guides/angular): fix nested SVG phrasing * Update docs/guide/angular/advanced/with-lucide-lab.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/guide/angular/advanced/filled-icons.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs(guides/angular): fix createLucideIcon guide * docs(guides/angular): upgrade all relevant angular sandpack demos --------- Co-authored-by: Eric Fennis <eric.fennis@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix(docs): add autogenerated OG images to gitignore * fix(docs): unify the case of "Lucide" & "Lucide Lab" over all docs and readmes * Fix build * Add next tag to all installation guides * Add top bar notification * Minor fixes * Update text * Add todos * Update og image * Adjust install command * Color top bar * fix(docs): ignore all OG images, expect general.png * fix(docs): fix the package list, hide @lucide/icons, downgrade angular logo, link to v0 guide, fix package title alignment * Update docs/.vitepress/theme/components/base/LayoutTop.vue Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/guide/react/advanced/dynamic-icon-component.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/.vitepress/sidebar/resources.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix code example * fix(docs): version 1 => Version 1 * feat(docs): add angular to new features in v1 * Fix next line issue * feat(docs): fix typo (code example_s_) * Fix deadlink * feat(docs): fix some more typos and irky grammar * feat(docs): fix lowercase lucide in sidebar 😅 * Update docs/guide/version-1.md Co-authored-by: Karsa <contact@karsa.org> --------- Co-authored-by: Karsa <contact@karsa.org> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
251 lines
3.6 KiB
Markdown
251 lines
3.6 KiB
Markdown
---
|
|
title: Installation
|
|
description: A guide on how to install Lucide, an open-source icon library, for various platforms and frameworks.
|
|
---
|
|
|
|
# Installation
|
|
|
|
## Web
|
|
|
|
Implementation of the Lucide icon library for web applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm add lucide@next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide@next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide@next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide@next
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](./lucide/index.md).
|
|
|
|
## React
|
|
|
|
Implementation of the Lucide icon library for React applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm add lucide-react@next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-react@next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-react@next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-react@next
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](./react/index.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 add @lucide/vue
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add @lucide/vue
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install @lucide/vue
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add @lucide/vue
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](./vue/index.md).
|
|
|
|
## Svelte
|
|
|
|
Implementation of the Lucide icon library for Svelte applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm add @lucide/svelte@next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add @lucide/svelte@next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install @lucide/svelte@next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add @lucide/svelte@next
|
|
```
|
|
:::
|
|
> `@lucide/svelte` is only for Svelte 5, for Svelte 4 use the `lucide-svelte` package.
|
|
|
|
For more details, see the [documentation](./svelte/index.md).
|
|
|
|
## Solid
|
|
|
|
Implementation of the Lucide icon library for Solid applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm add lucide-solid@next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-solid@next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-solid@next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-solid@next
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](./solid/index.md).
|
|
|
|
## Angular
|
|
|
|
Implementation of the Lucide icon library for Angular applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm add @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](./angular/index.md).
|
|
|
|
## Preact
|
|
|
|
Implementation of the Lucide icon library for preact applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm add lucide-preact@next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-preact@next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-preact@next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-preact@next
|
|
```
|
|
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](./preact/index.md).
|
|
|
|
## Astro
|
|
|
|
Implementation of the Lucide icon library for Astro applications.
|
|
|
|
::: code-group
|
|
|
|
```sh [pnpm]
|
|
pnpm add @lucide/astro@next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add @lucide/astro@next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install @lucide/astro@next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add @lucide/astro@next
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](./astro/index.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 add lucide-static@next
|
|
```
|
|
|
|
```sh [yarn]
|
|
yarn add lucide-static@next
|
|
```
|
|
|
|
```sh [npm]
|
|
npm install lucide-static@next
|
|
```
|
|
|
|
```sh [bun]
|
|
bun add lucide-static@next
|
|
```
|
|
|
|
:::
|
|
|
|
For more details, see the [documentation](./static/index.md).
|
|
|
|
## Figma
|
|
|
|
The Lucide Figma plugin.
|
|
|
|
Visit [Figma community page](https://www.figma.com/community/plugin/939567362549682242/Lucide-Icons) to install the plugin.
|
|
|
|

|