Skip to content

Commit 195780c

Browse files
authored
Merge branch 'main' into feat/react-added-aria-hidden-fallback-for-decorative-icons
2 parents 688ae7e + 5ca6bc3 commit 195780c

File tree

151 files changed

+5170
-4220
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+5170
-4220
lines changed

.github/workflows/close-issue-with-banned-phrases.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: Check for blocked phrases in issue title
1717
run: |
1818
ISSUE_TITLE=$(jq -r '.issue.title' "$GITHUB_EVENT_PATH")
19-
BLOCKED_PHRASES=("twitter" "whatsapp" "logo" "google" "tiktok" "facebook" "slack" "discord")
19+
BLOCKED_PHRASES=("twitter" "whatsapp" "logo" "google" "tiktok" "facebook" "slack" "discord" "bluesky")
2020
2121
# Check title and body for blocked phrases
2222
for PHRASE in "${BLOCKED_PHRASES[@]}"

.github/workflows/lucide-preact.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
paths:
66
- packages/lucide-preact/**
7+
- packages/shared/**
78
- tools/build-icons/**
89
- tools/rollup-plugins/**
910
- pnpm-lock.yaml

.github/workflows/lucide-react-native.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
paths:
66
- packages/lucide-react-native/**
7+
- packages/shared/**
78
- tools/build-icons/**
89
- tools/rollup-plugins/**
910
- pnpm-lock.yaml

.github/workflows/lucide-react.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
paths:
66
- packages/lucide-react/**
7+
- packages/shared/**
78
- tools/build-icons/**
89
- tools/rollup-plugins/**
910
- scripts/generateNextJSAliases.mjs

.github/workflows/lucide-shared.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Lucide Shared Checks
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- packages/shared/**
7+
- pnpm-lock.yaml
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: pnpm/action-setup@v2
15+
- uses: actions/setup-node@v3.8.1
16+
with:
17+
node-version: 18
18+
cache: 'pnpm'
19+
20+
- name: Install dependencies
21+
run: pnpm install --frozen-lockfile
22+
23+
- name: Test
24+
run: pnpm --filter lucide-react test

.github/workflows/lucide-solid.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
paths:
66
- packages/lucide-solid/**
7+
- packages/shared/**
78
- tools/build-icons/**
89
- tools/rollup-plugins/**
910
- pnpm-lock.yaml

.github/workflows/lucide-svelte.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
paths:
66
- packages/lucide-svelte/**
7+
- packages/shared/**
78
- tools/build-icons/**
89
- tools/rollup-plugins/**
910
- pnpm-lock.yaml

.github/workflows/lucide-vue-next.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
paths:
66
- packages/lucide-vue-next/**
7+
- packages/shared/**
78
- tools/build-icons/**
89
- tools/rollup-plugins/**
910
- pnpm-lock.yaml

.github/workflows/lucide-vue.yml

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
pull_request:
55
paths:
66
- packages/lucide-vue/**
7+
- packages/shared/**
78
- tools/build-icons/**
89
- tools/rollup-plugins/**
910
- pnpm-lock.yaml

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ outlined
1616
packages/**/src/icons/*.js
1717
packages/**/src/icons/*.ts
1818
packages/**/src/icons/*.tsx
19+
packages/**/src/aliases/*.ts
1920
packages/**/src/aliases.ts
21+
!packages/**/src/aliases/index.ts
2022
packages/**/src/dynamicIconImports.ts
2123
packages/**/dynamicIconImports.js
2224
packages/**/dynamicIconImports.d.ts

README.md

+27-234
Original file line numberDiff line numberDiff line change
@@ -8,185 +8,39 @@
88
</p>
99
<p align="center">
1010
<a href="https://github.com/lucide-icons/lucide/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/lucide" alt="license"></a>
11-
<a href="https://www.npmjs.com/package/lucide"><img src="https://img.shields.io/npm/v/lucide" alt="npm package"></a>
12-
<a href="https://www.figma.com/community/plugin/939567362549682242/Lucide-Icons"><img src="https://img.shields.io/endpoint?logo=figma&label=installs&url=https://yuanqing.github.io/figma-plugins-stats/plugin/939567362549682242/installs.json" alt="figma installs"></a>
11+
<a href="https://www.figma.com/community/plugin/939567362549682242/Lucide-Icons"><img src="https://img.shields.io/badge/Figma-F24E1E?logo=figma&logoColor=white" alt="figma installs"></a>
1312
<a href="https://github.com/lucide-icons/lucide/actions/workflows/release.yml"><img src="https://github.com/lucide-icons/lucide/actions/workflows/release.yml/badge.svg" alt="build status"></a>
1413
<a href="https://discord.gg/EH6nSts"><img src="https://img.shields.io/discord/723074157486800936?label=chat&logo=discord&logoColor=%23ffffff&colorB=%237289DA" alt="discord chat"></a>
1514
</p>
15+
<p align="center">
16+
<a href="https://lucide.dev/icons/">Icons</a>
17+
·
18+
<a href="https://lucide.dev/guide/">Guide</a>
19+
·
20+
<a href="https://lucide.dev/packages">Packages</a>
21+
·
22+
<a href="https://lucide.dev/license">License</a>
23+
·
24+
<a href="https://lucide.dev/showcase">Showcase</a>
25+
</p>
1626

1727
# Lucide
1828

19-
Community-run fork of [Feather Icons](https://github.com/feathericons/feather), open for anyone to contribute icons.
20-
21-
It began after growing dissatisfaction with the [Feather Icons](https://github.com/feathericons/feather) project moderation. With over 300+ open issues and over 100+ open PRs, the Feather Icons project has been abandoned. This unfortunately means that hundreds of developers and designers wasted their time contributing to Feather Icons with no chance of PRs being accepted.
22-
23-
Lucide is trying to expand the icon set as much as possible while staying faithful to the original simplistic design language. We do this as a community of devs and designers and hope that you'll join us!
24-
25-
### Why choose Lucide over Feather Icons
26-
27-
- More icons to work with: Lucide already has hundreds of icons more than Feather does.
28-
- Official libraries and integrations with popular frameworks and design tools.
29-
- Well maintained code base.
30-
- Active community, regularly growing and improving the set.
31-
32-
## Table of Contents
33-
34-
- [Usage](#usage)
35-
- [Web](#web)
36-
- [React](#react)
37-
- [React Native](#react-native)
38-
- [Vue 2](#vue-2)
39-
- [Vue 3](#vue-3)
40-
- [Angular](#angular)
41-
- [Preact](#preact)
42-
- [Static (svg sprite, font, icons ..)](#static-svg-sprite-font-icons-)
43-
- [Figma](#figma)
44-
- [Laravel](#laravel)
45-
- [Svelte](#svelte)
46-
- [Solid](#solid)
47-
- [Hyva](#hyva)
48-
- [Eleventy](#eleventy)
49-
- [Contributing](#contributing)
50-
- [Community](#community)
51-
- [License](#license)
52-
- [Credits](#credits)
53-
- [Sponsors](#sponsors)
54-
55-
## Usage
56-
57-
At its core, Lucide is a collection of [SVG](https://svgontheweb.com/#svg) files. This means that you can use Lucide icons in all the same ways you can use SVGs (e.g. `img`, `background-image`, `inline`, `object`, `embed`, `iframe`). Here's a helpful article detailing the many ways SVGs can be used on the web: [SVG on the Web – Implementation Options](https://svgontheweb.com/#implementation)
58-
59-
The following are additional ways you can use Lucide.
60-
With the Javascript library you can easily incorporate the icon you want in your webpage.
61-
62-
### Web
63-
64-
Implementation of the lucide icon library for web applications.
65-
66-
```sh
67-
npm install lucide
68-
```
69-
70-
or
71-
72-
```sh
73-
yarn add lucide
74-
```
75-
76-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide#lucide).
77-
78-
### React
79-
80-
Implementation of the lucide icon library for react applications.
81-
82-
```sh
83-
yarn add lucide-react
84-
```
85-
86-
or
87-
88-
```sh
89-
npm install lucide-react
90-
```
91-
92-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-react#lucide-react).
93-
94-
### React Native
95-
96-
Implementation of the lucide icon library for React Native applications.
97-
98-
```sh
99-
yarn add lucide-react-native
100-
```
101-
102-
or
103-
104-
```sh
105-
npm install lucide-react-native
106-
```
107-
108-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-react-native#lucide-react-native).
109-
110-
### Vue 2
111-
112-
Implementation of the lucide icon library for vue applications.
113-
114-
```sh
115-
yarn add lucide-vue
116-
```
117-
118-
or
119-
120-
```sh
121-
npm install lucide-vue
122-
```
123-
124-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue#lucide-vue).
125-
126-
### Vue 3
127-
128-
Implementation of the lucide icon library for vue applications.
129-
130-
```sh
131-
yarn add lucide-vue-next
132-
```
133-
134-
or
135-
136-
```sh
137-
npm install lucide-vue-next
138-
```
29+
Lucide is an open-source icon library that provides 1000+ vector (svg) files for displaying icons and symbols in digital and non-digital projects. The library aims to make it easier for designers and developers to incorporate icons into their projects by providing several official [packages](https://lucide.dev/packages) to make it easier to use these icons in your project.
13930

140-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue-next#lucide-vue-next).
31+
## Packages
14132

142-
### Angular
143-
144-
```sh
145-
yarn add lucide-angular
146-
```
147-
148-
or
149-
150-
```sh
151-
npm install lucide-angular
152-
```
153-
154-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-angular#lucide-angular).
155-
156-
### Preact
157-
158-
Implementation of the lucide icon library for preact applications.
159-
160-
```sh
161-
yarn add lucide-preact
162-
```
163-
164-
or
165-
166-
```sh
167-
npm install lucide-preact
168-
```
169-
170-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-preact#lucide-preact).
171-
172-
### Static (svg sprite, font, icons ..)
173-
174-
Assets:
175-
[Font Files](https://github.com/lucide-icons/lucide/releases/latest)
176-
[SVG Files](https://github.com/lucide-icons/lucide/releases/latest)
177-
[SVG Sprite](https://cdn.jsdelivr.net/npm/lucide-static@latest/sprite.svg)
178-
179-
NPM package
180-
181-
```sh
182-
yarn add lucide-static
183-
```
184-
185-
or
186-
187-
```sh
188-
npm install lucide-static
189-
```
33+
| | Package | Version & Downloads | Links |
34+
| --- | --- | --- | --- |
35+
| <img src="https://lucide.dev/framework-logos/js.svg" alt="JS logo" width="48"> | `lucide` | [![npm](https://img.shields.io/npm/v/lucide)](https://www.npmjs.com/package/lucide) ![NPM Downloads](https://img.shields.io/npm/dw/lucide) | [Docs](https://lucide.dev/guide/packages/lucide) [Source](./packages/lucide) |
36+
| <img src="https://lucide.dev/framework-logos/react.svg" alt="React logo" width="48"> | `lucide-react` | [![npm](https://img.shields.io/npm/v/lucide-react)](https://www.npmjs.com/package/lucide-react) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react) | [Docs](https://lucide.dev/guide/packages/lucide-react) [Source](./packages/lucide-react) |
37+
| <img src="https://lucide.dev/framework-logos/vue.svg" alt="Vue logo" width="48"> | `lucide-vue-next` | [![npm](https://img.shields.io/npm/v/lucide-vue-next)](https://www.npmjs.com/package/lucide-vue-next) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-vue-next) | [Docs](https://lucide.dev/guide/packages/lucide-vue-next) [Source](./packages/lucide-vue-next) |
38+
| <img src="https://lucide.dev/framework-logos/svelte.svg" alt="Svelte logo" width="48"> | `lucide-svelte` | [![npm](https://img.shields.io/npm/v/lucide-svelte)](https://www.npmjs.com/package/lucide-svelte) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-svelte) | [Docs](https://lucide.dev/guide/packages/lucide-svelte) [Source](./packages/lucide-svelte) |
39+
| <img src="https://lucide.dev/framework-logos/solid.svg" alt="Solid logo" width="48"> | `lucide-solid` | [![npm](https://img.shields.io/npm/v/lucide-solid)](https://www.npmjs.com/package/lucide-solid) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-solid) | [Docs](https://lucide.dev/guide/packages/lucide-solid) [Source](./packages/lucide-solid) |
40+
| <img src="https://lucide.dev/framework-logos/preact.svg" alt="Preact logo" width="48"> | `lucide-preact` | [![npm](https://img.shields.io/npm/v/lucide-preact)](https://www.npmjs.com/package/lucide-preact) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-preact) | [Docs](https://lucide.dev/guide/packages/lucide-preact) [Source](./packages/lucide-preact) |
41+
| <img src="https://lucide.dev/framework-logos/react-native.svg" alt="React Native logo" width="48"> | `lucide-react-native` | [![npm](https://img.shields.io/npm/v/lucide-react-native)](https://www.npmjs.com/package/lucide-react-native) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-react-native) | [Docs](https://lucide.dev/guide/packages/lucide-react-native) [Source](./packages/lucide-react-native) |
42+
| <img src="https://lucide.dev/framework-logos/angular.svg" alt="Angular logo" width="48"> | `lucide-angular` | [![npm](https://img.shields.io/npm/v/lucide-angular)](https://www.npmjs.com/package/lucide-angular) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-angular) | [Docs](https://lucide.dev/guide/packages/lucide-angular) [Source](./packages/lucide-angular) |
43+
| <img src="https://lucide.dev/framework-logos/svg.svg" alt="SVG logo" width="48"> | `lucide-static` | [![npm](https://img.shields.io/npm/v/lucide-static)](https://www.npmjs.com/package/lucide-static) ![NPM Downloads](https://img.shields.io/npm/dw/lucide-static) | [Docs](https://lucide.dev/guide/packages/lucide-static) [Source](./packages/lucide-static) |
19044

19145
### Figma
19246

@@ -196,68 +50,6 @@ Visit [Figma community page](https://www.figma.com/community/plugin/939567362549
19650

19751
<img width="420" src="https://www.figma.com/community/plugin/939567362549682242/thumbnail" alt="Figma Lucide Cover">
19852

199-
### Laravel
200-
201-
Implementation of Lucide icon's using `blade-icons` for Laravel based projects.
202-
203-
```sh
204-
composer require mallardduck/blade-lucide-icons
205-
```
206-
207-
For more details, see the [documentation](https://github.com/mallardduck/blade-lucide-icons/blob/main/README.md).
208-
209-
### Svelte
210-
211-
Implementation of the lucide icon library for Svelte applications.
212-
213-
```sh
214-
yarn add lucide-svelte
215-
```
216-
217-
or
218-
219-
```sh
220-
npm install lucide-svelte
221-
```
222-
223-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-svelte#lucide-svelte).
224-
225-
### Solid
226-
227-
Implementation of the lucide icon library for solid applications.
228-
229-
```sh
230-
yarn add lucide-solid
231-
```
232-
233-
or
234-
235-
```sh
236-
npm install lucide-solid
237-
```
238-
239-
For more details, see the [documentation](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-solid#lucide-solid).
240-
241-
### Hyva
242-
243-
Implementation of Lucide icon's using Hyvä's svg php viewmodal to render icons for Magento 2 Hyva theme based projects.
244-
245-
```sh
246-
composer require siteation/magento2-hyva-icons-lucide
247-
```
248-
249-
For more details, see the [documentation](https://github.com/Siteation/magento2-hyva-icons-lucide/blob/main/README.md).
250-
251-
### Eleventy
252-
253-
Using this plugin, Eleventy projects can incorporate Lucide icons. it makes it simple to use Lucide icons into your themes via shortcodes, improving your website's overall usability and visual appeal.
254-
255-
```sh
256-
npm install @grimlink/eleventy-plugin-lucide-icons
257-
```
258-
259-
For more details, see the [documentation](https://github.com/GrimLink/eleventy-plugin-lucide-icons/blob/main/README.md).
260-
26153
## Contributing
26254

26355
For more info on how to contribute please see the [contribution guidelines](https://github.com/lucide-icons/lucide/blob/main/CONTRIBUTING.md).
@@ -287,6 +79,7 @@ Thank you to all the people who contributed to Lucide!
28779

28880
<a href="https://www.digitalocean.com/?refcode=b0877a2caebd&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge"><img src="docs/public/digitalocean.svg" width="200" alt="DigitalOcean Referral Badge" /></a>
28981

290-
### Awesome backer 🍺
82+
### Awesome backers 🍺
29183

29284
<a href="https://www.scipress.io?utm_source=lucide"><img src="docs/public/sponsors/scipress.svg" width="180" alt="Scipress sponsor badge" /></a>
85+
<a href="https://github.com/pdfme/pdfme"><img src="docs/public/sponsors/pdfme.svg" width="180" alt="pdfme sponsor badge" /></a>

comment-markup.md

Whitespace-only changes.

0 commit comments

Comments
 (0)