Skip to content

YCloud Icons Data

YCloud Icons Data exposes tree-shakable icon node data and helpers for custom renderers and framework integrations.

The package covers three asset families:

  • Generic icons are exported from @ycloud-web/icons-data as normalized node data for the generic builders.
  • Business icons are exported from @ycloud-web/icons-data/business as cleaned SVG definition objects and index data.
  • Illustrations are exported from @ycloud-web/icons-data/illustration as SVG definition objects and index data.

You can use it to:

  • Consume icon nodes without a framework component layer.
  • Build SVG strings, DOM elements, or data URLs from icon data.
  • Create custom integrations for frameworks that are not shipped by this repository.

Installation

sh
pnpm add @ycloud-web/icons-data@latest
sh
npm install @ycloud-web/icons-data@latest
sh
yarn add @ycloud-web/icons-data@latest
sh
bun add @ycloud-web/icons-data@latest

Version Requirements

No framework peer dependency.

Usage

ts
import { House } from '@ycloud-web/icons-data';
import { buildYCloudSvg } from '@ycloud-web/icons-data/build';

const svg = buildYCloudSvg(House);

Business icon data:

ts
import { businessIconNames, getBusinessIcon } from '@ycloud-web/icons-data/business';

const whatsapp = getBusinessIcon('whatsapp-outlined');
const rootAttrs = whatsapp.attrs;
const children = whatsapp.node;
const availableBusinessIcons = businessIconNames;

Business icons are structured SVG definitions. They are not generic stroke node data, so they do not support generic builder params such as strokeWidth or absoluteStrokeWidth.

Illustration data:

ts
import { getIllustration, illustrationNames } from '@ycloud-web/icons-data/illustration';

const emptyPage = getIllustration('empty-page');
const rootAttrs = emptyPage.attrs;
const children = emptyPage.node;
const availableIllustrations = illustrationNames;

Illustrations keep their source SVG colors and root attributes, so they are intended for empty states, result pages, permission pages, and similar artwork use cases.

Documentation

Read the full guide: YCloud Icons Data.

License

YCloud Icons is released under the ISC License. It is based on Lucide and keeps the required upstream license and third-party notices.

Released under the ISC License.