mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-17 14:28:25 +00:00
* add new docs
* Add styling
* Move files
* Add active selection
* improve grid overview
* improve grid
* Add icon detail page
* Minor changes
* Fix icon preview
* optimize home card
* Add code examples
* Add gitignore
* correct temp directory
* Add first cusotmizer
* Add customizer
* fix images paths
* Add reset function
* Adjust category rendering
* Add packages section
* Some fixes
* Fix vercel build icon
* Small code adjustment
* move file
* Try this
* Add code groups with syntax highlighting
* Add search icon
* Cleanup
* update lockfile
* turnoff 404
* remove docs/iconMetaData.ts
* fix build
* Fix build 2
* cleanup
* Add icon customizer
* Fix build
* Add steps
* Add Button menu
* A lot off fixes!
* cleanup
* Fix build
* Css fixes
* Override menu icon
* try this to improve preformance
* minor improvements
* add comment
* add readme
* Add title
* minor fixes
* Fixes sliders + removes random backticks from index
* Added package list base, still WIP
* Added Guide+Source buttons to package list items
* Responsive support for XS screens
* Map categories count
* Adjust tooltip hover position
* Add see in action icon
* Add download options
* Aligns category list items to baseline and decreases category count weight
* Fixes event target error for categorylistitems
* Added icon release metadata builder
* Adds version badges to hero + icon detail overlay
* Added contributors.
Added Copy Angular.
Added release info to icon page.
* Centres contributor tooltip
* Fixed stroke step + added reset button
* Extracted reset button as a separate component for reusability
* Makes HomeIconCustomizerIcons less dense
* Fixes Button menu
* adjust versions and contributors styling on detail page
* Fix build?
* Fix build 2?
* Fix build 3
* Fix build 4
* Fix build 5?
* Add latest gh-icon changes
* Add comment
* Try fetch tags to retrieve release data
* try fetch all tags
* Add related icons
* Add stikcy search bar
* Add no results components
* Try to fix animation
* Try optimizing for categories
* Hide buggy animated icon
* minor fixes
* Add footer
* Add contributute link in footer
* Add copy name
* Add 100% preview icons
* remove site directory
* clean up
* Add redirects
* Fix build?
* fix redirect?
* minor improvements
* Fix icons preview on mobile
* Small preformance improvement
* Dark mode fixes for package icons
* Sort related icons by similarity + somewhat better name similarity matching
* Replace icon design guide images with uniform SVGs
* update lockfile
* Adds git clone to manually fetch the main repository for creating release metadata
* Remove initial v0.0.0 from release metadata
* Add extra CTA to no results behaviour
* Remove tags, as they are too overused
* Revert "Remove tags, as they are too overused"
This reverts commit 909b7563c0.
* Checkout icons from main
* Add absoluteStrokeWidth switch
* Add absolute strokewidth to home customizer
* Add absolute strokewidth to copy code button
* remove unused import
* compare build time
* improve build speed
* Try new release meta data script
* add fetch tags
* try with branch and remote
* try with url
* try without ssh
* Fix fetch tags in build file
* Cleanup
* Fix fallback
* improve release data
* delete relatedIcons.json, because it should be gitignored
* Add icon details
* Fix import
* minor fixes
* Try running script parallel
* Revert icon details
* include aliases in release meta data
* Final fixes
* Final fixes 2
* minor code adjustment
* Fix build
* test
* Revert concurrent build flow
* switch back to concurrent build strategy
* revert icon changes
* update package.json
* update package.json
* dedube packages
---------
Co-authored-by: Karsa <karsa@karsa.org>
103 lines
2.8 KiB
Markdown
103 lines
2.8 KiB
Markdown
---
|
|
title: Icon Design Guide
|
|
---
|
|
|
|
# Icon Design Principles
|
|
|
|
Here are rules that should be followed to keep quality and consistency when making icons for Lucide.
|
|
|
|
## Summary of the rules we have
|
|
|
|
1. Icons must be designed on a **24 by 24 pixels** canvas.
|
|
2. Icons must have at least **1 pixel padding** within the canvas.
|
|
3. Icons must have a **stroke width of 2 pixels**.
|
|
4. Icons must use **round joins**.
|
|
5. Icons must use **round caps**.
|
|
6. Icons must use **centered strokes**.
|
|
7. Shapes (such as rectangles) in icons must have **border radius of 2 pixels**.
|
|
8. Distinct elements must have **2 pixels of spacing between each other**.
|
|
|
|
## The Rules Visualized
|
|
|
|
### 1. Icons must be designed on a 24 by 24 pixels canvas.
|
|
|
|

|
|
|
|
### 2. Icons must have at least 1 pixel padding within the canvas.
|
|
|
|

|
|
|
|
### 3. Icons must have a stroke width of 2 pixels.
|
|
|
|

|
|
|
|
### 4. Icons must use round joins.
|
|
|
|

|
|
|
|
### 5. Icons must use round caps.
|
|
|
|

|
|
|
|
### 6. Icons must use centered strokes.
|
|
|
|

|
|
|
|
### 7. Shapes (such as squares) in icons must have border radius of 2 pixels.
|
|
|
|

|
|
|
|
### 8. Distinct elements must have 2 pixels of spacing between each other.
|
|
|
|

|
|
|
|
## Code Conventions
|
|
|
|
Before an icon is added to the library, we like to have readable and optimized svg code.
|
|
|
|
Never use [`<use>`](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/use). While it may sometimes seem like a good way to optimize file size, there's no way to ensure that the referenced element IDs will be unique once the SVGs are embedded in HTML documents.
|
|
|
|
### Global Attributes
|
|
|
|
For each icon these attributes are applied, corresponding to the above rules.
|
|
|
|
```xml
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
width="24"
|
|
height="24"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="2"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
>
|
|
<!-- SVGElements -->
|
|
</svg>
|
|
```
|
|
|
|
### Minify paths
|
|
|
|
Code of paths can get really big.
|
|
To reduce file size we like to minify the code.
|
|
We recommend to use the [SVGOMG](https://jakearchibald.github.io/svgomg/) to minify paths.
|
|
|
|
### JSON metadata descriptor
|
|
|
|
Each icon added must also come with a matching JSON file listing tags and categories for the icon.
|
|
Please use the following template:
|
|
|
|
```json
|
|
{
|
|
"$schema": "../icon.schema.json",
|
|
"tags": [
|
|
"foo",
|
|
"bar"
|
|
],
|
|
"categories": [
|
|
"devices"
|
|
]
|
|
}
|
|
```
|