Compare commits

..

4 commits

Author SHA1 Message Date
Ken Kunz
c1a02a04d4
fix(packages): allow string values for size and strokeWidth in global icon config (#4870)
* Allow string values for `size` and `strokeWidth` in icon contexts

The global icon context types declare `size` and `strokeWidth` as `number`,
while the component props they supply defaults for accept `number | string`.
The context value is passed through to the component untouched, so a CSS
length that works on a single icon is rejected when set as a default:

    setLucideProps({ size: '1em' });  // Type 'string' is not assignable to 'number'
    <Moon size="1em" />               // same value, same code path, no error

* Accept a string `size` on vue icon components

@lucide/vue types the component prop as `size?: 24 | number`, so it rejects the
CSS lengths its own `strokeWidth?: number | string` accepts, and that every other
framework accepts. The value goes straight to the `width`/`height` attributes,
so a string already works at runtime.

* Allow string `size` and `strokeWidth` in the icon context

Copilot's PR comment correctly surfaced a gap in the PR - the same type
bug exists in the lucide-react-native project and wasn't fixed there.

Same narrowing as the other framework contexts: `LucideProps` accepts
`size?: string | number`, and `strokeWidth` resolves to react-native-svg's
`NumberProp` (`string | number`), but the context and `LucideProviderProps`
declared both as `number`. `Icon.ts` passes the context value straight through
— `width: width ?? size ?? contextSize` — so nothing downstream needs a number.

* Don't emit NaN stroke width for non-numeric absolute lengths

`absoluteStrokeWidth` scales the stroke by `Number(size)`, so a CSS unit such
as `1em` produced `NaN` and a size of `0` produced `Infinity` – both invalid as
a `stroke-width` attribute. Fall back to the unscaled stroke width whenever the
conversion isn't finite, so the deprecated prop degrades rather than breaking
the rendered icon.

* fix(packages/angular): allow a string `strokeWidth` in the global config

`LucideConfig` already types `size` as `string | number` but left `strokeWidth`
as `number`, while `LucideIconBase` accepts `string | number` for both and
passes the configured value straight to the shared builder. So
`provideLucideConfig({ strokeWidth: '1em' })` was rejected for no reason.

* refactor(shared): keep absolute stroke scaling inside its branch

The finite-value fallback added in b65ee945 computed the scaled width before
testing `absoluteStrokeWidth`, so the default path paid for three `Number`
conversions and a division it never used. Start from the unscaled width and
overwrite it only when scaling both applies and yields a finite result, which
also states the rule more directly.

---------

Co-authored-by: Eric Fennis <eric.fennis@gmail.com>
2026-11-20 14:43:11 +01:00
Faris Basha TM
d79f705483
docs(lucide-static): link to the packages page instead of listing packages (#5253)
* docs(lucide-static): fix dead links to the Vue and Angular packages

* docs(lucide-static): link to the packages page instead of listing packages
2026-11-20 13:41:36 +01:00
Felipe
742ea78395
feat(lab): added shuttlecock icon (#3707)
* Added icons/shuttlecock.svg

* Added icons/shuttlecock.json

* Moved icon to lab

---------

Co-authored-by: Eric <eric.fennis@gmail.com>
2026-11-19 18:12:04 +01:00
Bulgymizi
891daab994
feat(lab): added floorball icon (#5213)
* Add files via upload

* Update icons/floorball-ball.json

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update icons/floorball-ball.json

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Move icon to lab

* Add floorball word

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric <eric.fennis@gmail.com>
2026-11-19 17:08:22 +00:00
16 changed files with 144 additions and 25 deletions

View file

@ -13,6 +13,7 @@ ungroup
toc
sunlounger
monstera
floorball
# Search tags and terms used in icon and category metadata
checkmark

28
lab/floorball.json Normal file
View file

@ -0,0 +1,28 @@
{
"$schema": "../icon.schema.json",
"contributors": [
"Bulgymizi"
],
"use-cases": [
"Labeling floorball sessions in workout logs",
"Identifying floorball equipment in sporting goods catalogs",
"Labeling floorball practices and matches in club calendars"
],
"tags": [
"ball",
"innebandy",
"unihockey",
"salibandy",
"equipment",
"perforated",
"plastic",
"hollow",
"indoor",
"team",
"match",
"training"
],
"categories": [
"sports"
]
}

18
lab/floorball.svg Normal file
View file

@ -0,0 +1,18 @@
<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"
>
<path d="M14.5 21.682a1 1 0 00-5 0" />
<path d="M2.318 14.5a1 1 0 000-5" />
<path d="M21.682 9.5a1 1 0 000 5" />
<path d="M9.5 2.318a1 1 0 005 0" />
<circle cx="12" cy="12" r="10" />
<circle cx="12" cy="12" r="2.5" />
</svg>

After

Width:  |  Height:  |  Size: 438 B

20
lab/shuttlecock.json Normal file
View file

@ -0,0 +1,20 @@
{
"$schema": "../icon.schema.json",
"contributors": [
"felipeajzanetti"
],
"use-cases": [],
"tags": [
"sport",
"badminton",
"racket",
"shuttlecock",
"game",
"sports",
"equipment"
],
"categories": [
"sports",
"gaming"
]
}

16
lab/shuttlecock.svg Normal file
View file

@ -0,0 +1,16 @@
<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"
>
<path d="m14 10 1-5" />
<path d="M3 5a3 3 0 016 0 3 3 0 016 0 3 3 0 016 0l-5 9H8z" />
<path d="M8 18a4 4 0 008 0z" />
<path d="m9 5 1 5" />
</svg>

After

Width:  |  Height:  |  Size: 356 B

View file

@ -18,7 +18,7 @@ export interface LucideConfig {
* Stroke width
* @default 2
*/
strokeWidth: number;
strokeWidth: string | number;
/**
* Whether to use absolute stroke width.
* @deprecated Use `nonScalingStroke` instead.

View file

@ -2,9 +2,9 @@ import { createContext, h, type ComponentChildren } from 'preact';
import { useContext, useMemo } from 'preact/hooks';
const LucideContext = createContext<{
size?: number;
size?: number | string;
color?: string;
strokeWidth?: number;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/
@ -22,9 +22,9 @@ const LucideContext = createContext<{
interface LucideProviderProps {
children: ComponentChildren;
size?: number;
size?: number | string;
color?: string;
strokeWidth?: number;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/

View file

@ -1,9 +1,9 @@
import { createContext, createElement, type ReactNode, useContext, useMemo } from 'react';
const LucideContext = createContext<{
size?: number;
size?: number | string;
color?: string;
strokeWidth?: number;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/
@ -21,9 +21,9 @@ const LucideContext = createContext<{
interface LucideProviderProps {
children: ReactNode;
size?: number;
size?: number | string;
color?: string;
strokeWidth?: number;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/

View file

@ -4,9 +4,9 @@ import { createContext, createElement, type ReactNode, useContext, useMemo } fro
import { LucideProps } from './types';
type LucideConfig = {
size: number;
size: number | string;
color: string;
strokeWidth: number;
strokeWidth: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/

View file

@ -1,9 +1,9 @@
import { createContext, splitProps, type JSXElement } from 'solid-js';
export const LucideContext = createContext<{
size?: number;
size?: number | string;
color?: string;
strokeWidth?: number;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/
@ -21,9 +21,9 @@ export const LucideContext = createContext<{
interface LucideProviderProps {
children: JSXElement;
size?: number;
size?: number | string;
color?: string;
strokeWidth?: number;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/

View file

@ -41,7 +41,7 @@ This package include the following Lucide implementations:
This package is suitable for very specific use cases for example if you want to use icon fonts, svg sprites, normal svgs or Common.js Svg strings in your javascript project.
> [!WARNING]
> It is not recommended to use this package for svg sprites or icon fonts for web pages/applications, for prototyping it is ok. We recommend to bundlers for web applications to make sure you only bundle the used icons from this icon library (Threeshaking). Otherwise it will load all the icons, making you webpage loading slower. Threeshaking is only available in the packages: [lucide](https://github.com/lucide-icons/lucide/tree/main/packages/lucide), [lucide-react](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-react), [lucide-vue](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue), [lucide-vue-next](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-vue-next), [lucide-angular](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-angular), [lucide-preact](https://github.com/lucide-icons/lucide/tree/main/packages/lucide-preact)
> It is not recommended to use this package for SVG sprites or icon fonts for web pages/applications; for prototyping, it is ok. We recommend that bundlers for web applications make sure you only bundle the used icons from this icon library (tree-shaking). Otherwise, it will load all the icons, making your webpage load more slowly. Tree-shaking is available in our other [packages](https://lucide.dev/packages).
## Installation

View file

@ -30,11 +30,18 @@ function buildLucideIconNode(icon: LucideIconData, params: LucideBuildParams = {
? mergeClasses(...classNamesFromClassName)
: mergeClasses('lucide', ...iconClassNames, ...classNamesFromClassName);
const calculatedStrokeWidth = params.absoluteStrokeWidth
? (Number(params.strokeWidth ?? defaultAttributes['stroke-width']) *
let calculatedStrokeWidth = params.strokeWidth ?? defaultAttributes['stroke-width'];
if (params.absoluteStrokeWidth) {
const scaled =
(Number(calculatedStrokeWidth) *
Number(icon.size ?? icon.width ?? defaultAttributes['width'])) /
Number(params.size ?? params.width ?? defaultAttributes['width'])
: (params.strokeWidth ?? defaultAttributes['stroke-width']);
Number(params.size ?? params.width ?? defaultAttributes['width']);
// Only numeric lengths can be scaled; a CSS unit such as `1em`, or a size of `0`, makes the
// conversion non-finite, so the unscaled width stands rather than emitting `NaN`.
if (Number.isFinite(scaled)) calculatedStrokeWidth = scaled;
}
const attributes = {
...Object.entries(defaultAttributes).reduce((attrs, [attrName, value]) => {

View file

@ -0,0 +1,29 @@
import { describe, it, expect } from 'vitest';
import buildLucideIconNode from '../src/build/buildLucideIconNode';
const icon = { name: 'circle', size: 24, node: [] };
const strokeWidthOf = (params: Parameters<typeof buildLucideIconNode>[1]) =>
buildLucideIconNode(icon, params)[1]['stroke-width'];
describe('buildLucideIconNode absoluteStrokeWidth', () => {
it('scales the stroke width for numeric sizes', () => {
expect(strokeWidthOf({ absoluteStrokeWidth: true, strokeWidth: 2, size: 48 })).toBe(1);
});
it('falls back to the unscaled width for a CSS unit size', () => {
expect(strokeWidthOf({ absoluteStrokeWidth: true, strokeWidth: 2, size: '1em' })).toBe(2);
});
it('falls back to the unscaled width for a non-numeric stroke width', () => {
expect(strokeWidthOf({ absoluteStrokeWidth: true, strokeWidth: '1em', size: 48 })).toBe('1em');
});
it('falls back to the unscaled width for a zero size', () => {
expect(strokeWidthOf({ absoluteStrokeWidth: true, strokeWidth: 2, size: 0 })).toBe(2);
});
it('leaves the stroke width alone when not absolute', () => {
expect(strokeWidthOf({ strokeWidth: 2, size: 48 })).toBe(2);
});
});

View file

@ -4,8 +4,8 @@ const LucideContext = Symbol('lucide-context');
export interface LucideGlobalContext {
color?: string;
size?: number;
strokeWidth?: number;
size?: number | string;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/

View file

@ -3,9 +3,9 @@ import { provide, inject } from 'vue';
export const LUCIDE_CONTEXT = Symbol('lucide-icons');
interface LucideIconsContext {
size?: number;
size?: number | string;
color?: string;
strokeWidth?: number;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.
*/

View file

@ -5,7 +5,7 @@ import type {
} from '@lucide/shared/types';
export interface LucideProps extends Partial<SVGAttributes> {
size?: 24 | number;
size?: 24 | number | string;
strokeWidth?: number | string;
/**
* @deprecated Use `nonScalingStroke` instead.