Merge branch 'main' into feat/added-dpi-preview

.github/pull_request_template.md

@@ -0,0 +1,55 @@
+<!-- Thank you for contributing! -->
+
+<!-- Insert `closes #issueNumber` here if merging this PR will resolve an existing issue -->
+
+## What is the purpose of this pull request? <!-- (put an "X" next to an item) -->
+
+- [ ] New Icon
+- [ ] Bug fix
+- [ ] New Feature
+- [ ] Documentation update
+- [ ] Other
+
+### Description
+<!-- Please insert your description here and provide info about the "what" this PR is contribution -->
+
+### Icon use case <!-- ONLY for new icons, remove this part if not icon PR -->
+<!-- What is the purpose of this icon? For each icon added, please insert at least two real life use cases (the more the better). Text like "it's a car icon" is not accepted. -->
+
+### Alternative icon designs <!-- ONLY for new icons, remove this part if not icon PR -->
+<!-- If you have any alternative icon designs, please attach them here. -->
+
+## Icon Design Checklist <!-- ONLY for new icons, remove this part if not icon PR -->
+
+#### Concept <!-- ONLY for new icons -->
+
+- [ ] I have provided valid use cases for each icon.
+- [ ] I have not added any a brand or logo icon.
+- [ ] I have not used any hate symbols.
+- [ ] I have not included any religious or political imagery.
+
+#### Author, credits & license<!-- ONLY for new icons -->
+<!-- Please choose one of the following -->
+- [ ] The icons are solely my own creation.
+- [ ] The icons were originally created in #<issueNumber> by @<githubUser>
+- [ ] I've based them on the following Lucide icons: <!-- provide the list of icons -->
+- [ ] I've based them on the following design: <!-- provide source URL and license permitting use -->
+
+#### Naming <!-- ONLY for new icons -->
+
+- [ ] I've read and followed the [naming conventions](https://lucide.dev/guide/design/icon-design-guide#naming-conventions)
+- [ ] I've named icons by what they are rather than their use case.
+- [ ] I've provided meta JSON files in `icons/[iconName].json`.
+
+#### Design <!-- ONLY for new icons -->
+
+- [ ] I've read and followed the [icon design guidelines](https://lucide.dev/guide/design/icon-design-guide)
+- [ ] I've made sure that the icons look sharp on low DPI displays.
+- [ ] I've made sure that the icons look consistent with the icon set in size, optical volume and density.
+- [ ] I've made sure that the icons are visually centered.
+- [ ] I've correctly optimized all icons to two points of precision.
+
+## Before Submitting <!-- For every PR! -->
+
+- [ ] I've read the [Contribution Guidelines](https://github.com/lucide-icons/lucide/blob/main/CONTRIBUTING.md).
+- [ ] I've checked if there was an existing PR that solves the same issue.

docs/guide/design/icon-design-guide.md

@@ -6,58 +6,111 @@ title: Icon Design Guide
 
 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.
+### 1. Icons must be designed on a **24 by 24 pixels** canvas.
 
 ![24px-24px](../../images/24px-24px.svg?raw=true "24px-24px")
 
-### 2. Icons must have at least 1 pixel padding within the canvas.
+## 2. Icons must have at least **1 pixel padding** within the canvas.
 
 ![1px-padding](../../images/1px-padding.svg?raw=true "1px-padding")
 
-### 3. Icons must have a stroke width of 2 pixels.
+## 3. Icons must have a **stroke width of 2 pixels**.
 
 ![2px-stroke](../../images/2px-stroke.svg?raw=true "2px-stroke")
 
-### 4. Icons must use round joins.
+## 4. Icons must use **round joins**.
 
 ![round-joints](../../images/round-joints.svg?raw=true "round-joints")
 
-### 5. Icons must use round caps.
+## 5. Icons must use **round caps**.
 
 ![round-caps](../../images/round-caps.svg?raw=true "round-caps")
 
-### 6. Icons must use centered strokes.
+## 6. Icons must use **centered strokes**.
 
 ![centered-strokes](../../images/centered-strokes.svg?raw=true "centered-strokes")
 
-### 7. Shapes (such as squares) in icons must have border radius of 2 pixels.
+## 7. Shapes (such as rectangles) must have a **border radius of**
+
+### C. **2 pixels** if they are at least 8 pixels in size
 
 ![2px-border-radius](../../images/2px-border-radius.svg?raw=true "2px-border-radius")
 
-### 8. Distinct elements must have 2 pixels of spacing between each other.
+### B. **1 pixel** if they are smaller than 8 pixels in size
+
+![1px-border-radius](../../images/1px-border-radius.svg?raw=true "1px-border-radius")
+
+## 8. Distinct elements must have **2 pixels of spacing between each other**
 
 ![2px-element-spacing](../../images/2px-element-spacing.svg?raw=true "2px-element-spacing")
 
-## Code Conventions
+## 9. Icons should have a similar optical volume to `circle` and `square`.
 
-Before an icon is added to the library, we like to have readable and optimized svg code.
+![optical-volume-ideal](../../images/optical-volume-ideal.svg?raw=true "optical-volume-ideal")
 
-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.
+![optical-volume-low](../../images/optical-volume-low.svg?raw=true "optical-volume-low")
+
+![optical-volume-high](../../images/optical-volume-high.svg?raw=true "optical-volume-high")
+
+**Tip:** place your icon next to circle or square and blur them both; your icon should not feel much darker than the base shape.
+
+## 10. Icons should be visually centered by their center of gravity.
+
+![visually-centered](../../images/visually-centered.svg?raw=true "visually-centered")
+
+![visually-centered-bad](../../images/visually-centered-bad.svg?raw=true "visually-centered-bad")
+
+**Tip:** place your icon both above/below and next to the square or circle icon and check if it feels off center. Symmetrical icons should always be aligned to the center.
+
+## 11. Icons should have similar visual density and level of detail.
+
+![density-ideal](../../images/density-ideal.svg?raw=true "density-ideal")
+
+![density-high](../../images/density-high.svg?raw=true "density-high")
+
+**Tip:** try to make abstractions to dense elements. Blur your icon, and when blurred it should not feel overly dark.
+
+## 12. Continuous curves should join smoothly.
+
+![curvature-smooth](../../images/curvature-smooth.svg?raw=true "curvature-smooth")
+
+![curvature-uneven](../../images/curvature-uneven.svg?raw=true "curvature-uneven")
 
-### Global Attributes
+**Tip:** make sure to use arcs or quadratic curves, when using cubic curves control points should have mirrored angles for smooth curves.
+
+## 13. Icons should aim to be pixel perfect so that they will be sharp on low DPI displays.
+
+![pixel-perfection-ideal](../../images/pixel-perfection-ideal.svg?raw=true "pixel-perfection-ideal")
+
+![pixel-perfection-bad](../../images/pixel-perfection-bad.svg?raw=true "pixel-perfection-bad")
+
+**Tip:** whenever possible align elements and arc centers to the grid.
+
+# Naming conventions
+
+1. Icon names use lower kebab case.\
+   For example: `arrow-up` instead of `Arrow Up`.
+
+2. Icon names use International English names, as opposed to local variants.\
+   For example:  `color` instead of `colour`.
+
+3. Icons should be named for what they depict rather than their use case or what they represent.\
+   For example: `save` instead of `floppy-disk` and `ban` rather than `circle-slash`.
+
+4. Icons that are part of a group are named `<group>-<variant>`.\
+   For example: `badge-plus` is based on `badge`.
+
+5. Icon names for alternate icons should represent what makes the alternate unique instead of being numbered.\
+   For example: `send-horizontal` instead of `send-2`.
+
+6. Names containing numerals are not allowed, unless the number itself is represented in the icon.\
+   For example: `arrow-down-0-to-1` contains both numerals.
+
+# Code Conventions
+
+Before an icon is added to the library, we like to have readable and optimized SVG code.
+
+## Global Attributes
 
 For each icon these attributes are applied, corresponding to the above rules.
 
@@ -77,20 +130,39 @@ For each icon these attributes are applied, corresponding to the above rules.
 </svg>
 ```
 
-### Minify paths
+## Minify paths
+
+The code of paths can sometimes get quite large. To reduce file size we like to minify the code.
+We recommend to use the [SVGOMG](https://jakearchibald.github.io/svgomg/) to minify paths to 2 points of precision.
 
-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.
+## Allowed elements
 
-### JSON metadata descriptor
+SVG files may only contain simple path and shape elements, which may not have any attributes other than sizing and spacing.\
+In practice only the following elements and attributes are allowed:
+  * `<path d>`
+  * `<line x1 x2>`
+  * `<polygon points>`
+  * `<polyline points>`
+  * `<circle cx cy r>`
+  * `<ellipse cx cy rx ry>`
+  * `<rect x y width height rx>`
+
+This also means that no transforms, filters, fills or explicit strokes are allowed.
+
+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.
+
+# 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",
+  "contributors": [
+    "github-username",
+    "another-github-username"
+  ],
   "tags": [
     "foo",
     "bar"