Lucide Solid

为 Solid 应用实现 lucide 图标库。

¥Implementation of the lucide icon library for solid applications.

安装

¥Installation

pnpm

pnpm install lucide-solid

yarn

yarn add lucide-solid

npm

npm install lucide-solid

bun

bun add lucide-solid

如何使用

¥How to use

Lucide 基于 ES 模块构建，因此完全支持 tree-shaking。

¥Lucide is built with ES Modules, so it's completely tree-shakable.

每个图标都可以作为 Solid 组件导入，该组件会渲染一个内联 SVG 元素。这样，只有导入到项目中的图标才会包含在最终的软件包中。其余图标已通过 tree-shaking 移除。

¥Each icon can be imported as a Solid component, which renders an inline SVG element. This way, only the icons that are imported into your project are included in the final bundle. The rest of the icons are tree-shaken away.

示例

¥Example

可以传递其他属性来调整图标：

¥Additional props can be passed to adjust the icon:

import { Camera } from 'lucide-solid';

// Usage
const App = () => {
  return <Camera color="red" size={48} />;
};

export default App;

可以通过直接从 lucide-solid/icons 目录导入图标来解决 Vite 与开发服务器的加载/执行问题：

¥Vite loading/performing issues with the dev server can be resolved by import icons directly from the lucide-solid/icons directory:

import Camera from 'lucide-solid/icons/camera';

// Usage
const App = () => {
  return <Camera color="red" size={48} />;
};

export default App;

属性

¥Props

name	type	default
size	number	24
color	string	currentColor
strokeWidth	number	2
absoluteStrokeWidth	布尔值	false

应用属性

¥Applying props

要自定义图标的外观，你可以将自定义属性作为 props 直接传递给组件。该组件接受所有 SVG 属性作为属性，从而允许灵活地设置 SVG 元素的样式。请参阅 MDN 上的 SVG 展示属性列表。

¥To customize the appearance of an icon, you can pass custom properties as props directly to the component. The component accepts all SVG attributes as props, which allows flexible styling of the SVG elements. See the list of SVG Presentation Attributes on MDN.

// Usage
const App = () => {
  return <Camera fill="red" stroke-linejoin="bevel" />;
};

使用 Lucide Lab 或自定义图标

¥With Lucide lab or custom icons

Lucide Lab 是一个图标集合，不属于 Lucide 主库。

¥Lucide lab is a collection of icons that are not part of the Lucide main library.

它们可以通过 Icon 组件使用。所有与常规 Lucide 图标类似的属性都可以通过传递来调整图标外观。

¥They can be used by using the Icon component. All props like the regular Lucide icons can be passed to adjust the icon appearance.

使用 Icon 组件

¥Using the Icon component

这将根据传递的 iconNode 创建一个图标，并渲染一个 Lucide 图标组件。

¥This creates a single icon based on the iconNode passed and renders a Lucide icon component.

import { Icon } from 'lucide-solid';
import { sausage } from '@lucide/lab';

const App = () => (
  <Icon iconNode={sausage} color="red"/>
);

一个通用图标组件

¥One generic icon component

可以创建一个通用的图标组件来加载图标。不推荐使用。

¥It is possible to create one generic icon component to load icons. It's not recommended.

危险

以下示例导入了所有 ES 模块，因此使用时请谨慎。导入所有图标将显著增加应用的构建大小，从而对其性能产生负面影响。在使用 Webpack、Rollup 或 Vite 等打包器时，这一点尤为重要。

¥The example below imports all ES Modules, so exercise caution when using it. Importing all icons will significantly increase the build size of the application, negatively affecting its performance. This is especially important to keep in mind when using bundlers like Webpack, Rollup, or Vite.

图标组件示例

¥Icon Component Example

import { icons, type LucideProps } from 'lucide-solid';
import { splitProps } from 'solid-js';
import { Dynamic } from 'solid-js/web';

interface IconProps extends LucideProps {
  name: keyof typeof icons;
}

const Icon = (props: IconProps) => {
  const [local, others] = splitProps(props, ["name"]);

  return <Dynamic component={icons[local.name]} {...others} />
};

export default Icon;

使用图标组件

¥Using the Icon Component

import Icon from './Icon';

const App = () => {
  return <Icon name="home" />;
};

export default App;