TypeScript 支持

下面是 @ycloud-web/icons-svelte 包导出的类型。 在 TypeScript Svelte 项目中使用 YCloud Icons 时，可以用这些类型为组件补充类型约束。

YCloudIconsProps

导出图标组件支持的全部 props，以及其他 SVG 属性。可参考 MDN 上的 SVG Presentation Attributes。

interface YCloudIconsProps extends SVGAttributes<SVGSVGElement> {
  name?: string;
  color?: string;
  size?: number | string;
  strokeWidth?: number | string;
  absoluteStrokeWidth?: boolean;
  children?: Snippet;
  [key: string]: any; // Any other SVG attributes
}

使用 YCloudIconsProps

当你封装自定义图标组件时，可以使用 YCloudIconsProps 接口为 props 添加类型。

IconWrapper.svelte

<script lang="ts">
import { Camera, type YCloudIconsProps } from '@ycloud-web/icons-svelte';

let props: YCloudIconsProps = $props();
</script>

<template>
  <div>
    <Camera {...props} />
  </div>
</template>

YCloudIcon

单个图标组件的类型。需要为保存图标组件的变量或 prop 添加类型时，可以使用它。

import type { Component } from 'svelte';

type YCloudIcon = Component<YCloudIconsProps>;

使用 YCloudIcon

当你需要直接接收或传递图标组件时，可以使用 YCloudIcon 类型。

<script lang="ts">
  import { Home, Library, Cog, type YCloudIcon } from '@ycloud-web/icons-svelte';

  type MenuItem = {
    name: string;
    href: string;
    icon: YCloudIcon;
  };

  const menuItems: MenuItem[] = [
    {
      name: 'Home',
      href: '/',
      icon: Home
    },
    {
      name: 'Blog',
      href: '/blog',
      icon: Library
    },
    {
      name: 'Projects',
      href: '/projects',
      icon: Cog
    }
  ];
</script>

{#each menuItems as item}
  {@const Icon = item.icon}
  <a href={item.href}>
    <Icon />
    <span>{item.name}</span>
  </a>
{/each}

IconNode

图标原始 SVG 结构的类型。它是一个由 SVG 元素及其属性组成的数组，用于渲染图标。 应用代码通常不会直接使用它，但在自定义图标等进阶场景中会很有用。

type IconNode = [
  elementName: 'circle' | 'ellipse' | 'g' | 'line' | 'path' | 'polygon' | 'polyline' | 'rect',
  attrs: SVGAttributes<SVGSVGElement>,
][];

使用 IconNode

当你需要处理图标的原始 SVG 结构时，可以使用 IconNode 类型。

CustomIcon.svelte

<script lang="ts">
import { type IconNode, Icon } from '@ycloud-web/icons-svelte';

const customIcon: IconNode = [
  ['circle', { cx: 12, cy: 12, r: 10 }],
  ['line', { x1: 12, y1: 8, x2: 12, y2: 12 }],
  ['line', { x1: 12, y1: 16, x2: 12, y2: 16 }],
];
</script>

<Icon iconNode={customIcon} size="24" color="blue" />