mirror of
https://github.com/lucide-icons/lucide.git
synced 2026-11-17 14:28:25 +00:00
* feat(packages): extract build logic to @lucide/shared, still wip * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * feat(packages): extract build logic to @lucide/shared, still wip * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * feat(): unify icon build logic some more, add nonScalingStroke option, marking absoluteStrokeWidth as deprecated * chore(icons): revert git hook changes made to icons * fix(packages/astro,react-native,vue): fix iconNode type fix(packages/vue): fix hasA11yProp * fix(packages/solid): make component reactive & add unit tests for checking prop changes * test(packages/vue): add reactivity tests to @lucide/vue * fix(packages): replace cpy-cli, accidentally removed during main merge * docs(packages): upgrade react documentation with nonScalingStroke * fix(tests): update snapshots for lucide-react * feat(docs): upgraded package guides with nonScalingStroke, dropping absoluteStrokeWidth * fix(vue,react-native): fix linting issues * fix(icons): add proper fallback for icon width in calculatedStrokeWidth * fix(packages/svelte): add globalProps.class to icons * fix(packages/shared): wrap width, height & size in isDefined * Update types.ts * fix(packages/svelte): do not pass propsClass to mergeClasses --------- Co-authored-by: Eric Fennis <eric.fennis@gmail.com>
96 lines
2.7 KiB
TypeScript
96 lines
2.7 KiB
TypeScript
'use client';
|
|
|
|
import { createElement, forwardRef } from 'react';
|
|
import { buildLucideIconForReact, hasA11yProp, mergeClasses } from '@lucide/shared';
|
|
import { LucideIconData, LucideIconNode, LucideProps } from './types';
|
|
import { useLucideContext } from './context';
|
|
|
|
type IconComponentProps = LucideProps &
|
|
(
|
|
| {
|
|
iconNode: LucideIconNode[];
|
|
icon?: never;
|
|
}
|
|
| {
|
|
icon: LucideIconData;
|
|
iconNode?: never;
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Lucide icon component
|
|
*
|
|
* @component Icon
|
|
* @param {object} props
|
|
* @param {string} props.color - The color of the icon
|
|
* @param {number} props.size - The size of the icon
|
|
* @param {number} props.strokeWidth - The stroke width of the icon
|
|
* @param {boolean} props.absoluteStrokeWidth - Whether to use absolute stroke width
|
|
* @param {boolean} props.nonScalingStroke - Whether to use non scaling strokes
|
|
* @param {string} props.className - The class name of the icon
|
|
* @param {LucideIconNode[]} props.children - The children of the icon
|
|
* @param {LucideIconNode[]} props.iconNode - The icon node of the icon
|
|
*
|
|
* @returns {ForwardRefExoticComponent} LucideIcon
|
|
*/
|
|
const Icon = forwardRef<SVGSVGElement, IconComponentProps>(
|
|
(
|
|
{
|
|
color,
|
|
size,
|
|
width,
|
|
height,
|
|
strokeWidth,
|
|
absoluteStrokeWidth,
|
|
nonScalingStroke,
|
|
className = '',
|
|
children,
|
|
iconNode = [],
|
|
icon = {
|
|
node: iconNode,
|
|
aliases: [],
|
|
size: 24,
|
|
},
|
|
...rest
|
|
},
|
|
ref,
|
|
) => {
|
|
const {
|
|
size: contextSize = 24,
|
|
strokeWidth: contextStrokeWidth = 2,
|
|
absoluteStrokeWidth: contextAbsoluteStrokeWidth = false,
|
|
nonScalingStroke: contextNonScalingStroke = false,
|
|
color: contextColor = 'currentColor',
|
|
className: contextClass = '',
|
|
} = useLucideContext() ?? {};
|
|
|
|
const hasAccessibleProp = Boolean(children) || hasA11yProp(rest);
|
|
|
|
const [name, svgAttributes, builtIconNode = []] = buildLucideIconForReact(icon, {
|
|
color: color ?? contextColor,
|
|
width: width ?? size ?? contextSize,
|
|
height: height ?? size ?? contextSize,
|
|
strokeWidth: strokeWidth ?? contextStrokeWidth,
|
|
absoluteStrokeWidth: absoluteStrokeWidth ?? contextAbsoluteStrokeWidth,
|
|
nonScalingStroke: nonScalingStroke ?? contextNonScalingStroke,
|
|
className: mergeClasses(contextClass, className),
|
|
hasA11yProp: hasAccessibleProp,
|
|
attributes: rest,
|
|
});
|
|
|
|
return createElement(
|
|
name,
|
|
{
|
|
ref,
|
|
...svgAttributes,
|
|
},
|
|
[
|
|
...builtIconNode.map(([tag, attrs]) => createElement(tag, attrs)),
|
|
...(Array.isArray(children) ? children : [children]),
|
|
],
|
|
);
|
|
},
|
|
);
|
|
|
|
export default Icon;
|