@canvas-components/icons
v0.1.2
Published
Framework-agnostic SVG icon definitions shared across canvas-components packages.
Readme
@canvas-components/icons
@canvas-components/icons 提供与框架无关的 SVG 图标定义,供 Canvas 绘制和各框架适配包复用。包内只包含图标数据及查询方法,不依赖 React。
安装
pnpm add @canvas-components/icons使用
import {
getIconDefinition,
iconDefinitionCount,
iconNames,
type IconName,
} from "@canvas-components/icons";
const name: IconName = "HomeOutlined";
const definition = getIconDefinition(name);
if (definition) {
console.log(definition.theme); // outlined、filled 或 twotone
console.log(definition.icon); // SVG 节点树
}
console.log(iconNames.includes(name), iconDefinitionCount);getIconDefinition(name) 接受图标名称字符串;名称不存在时返回 undefined。iconNames 是可用图标名称列表,iconDefinitionCount 是图标总数,iconDefinitions 是按名称索引的完整定义集合。
每个 IconDefinition 包含 name、theme 和 icon。icon 是由 tag、attrs、可选 children 组成的 SVG 节点树,可交给 Canvas 绘制器或其他渲染层处理。本包不提供 DOM 或 React 图标组件;React 项目可使用 @canvas-components/react-components 的图标组件。
版权
图标路径数据来自 Ant Design Icons,详见 第三方版权声明。
