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>
This commit is contained in:
Ken Kunz 2026-11-20 14:43:11 +01:00 committed by GitHub
parent d79f705483
commit c1a02a04d4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 60 additions and 24 deletions

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

@ -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.