API Reference

Core API

createSvgSpriteBuilder

The main API for building SVG sprites. Creates a new SVG sprite builder instance.

import { createSvgSpriteBuilder } from '@neodx/svg';

const builder = createSvgSpriteBuilder({
  inputRoot: 'src/shared/ui/icon/assets',
  output: 'public/sprites',
  metadata: 'src/sprite.gen.ts',
  group: true
});

await builder.load('**/*.svg');
await builder.build();

For detailed information about the builder API and its parameters, see Builder API.

Features

Metadata

Generates TypeScript types and runtime information about your sprites.

const builder = createSvgSpriteBuilder({
  metadata: 'src/sprite.gen.ts'
});

For detailed information, see Metadata Guide.

Grouping

Controls how sprites are grouped.

const builder = createSvgSpriteBuilder({
  group: true // Group by directory
});

For detailed information, see Group and Hash Guide.

Optimization

Provides SVG optimization capabilities through SVGO.

const builder = createSvgSpriteBuilder({
  optimize: true
});

For detailed information, see Optimization Guide.

Color Reset

Allows you to modify or reset colors in SVG files.

const builder = createSvgSpriteBuilder({
  resetColors: true
});

For detailed information, see Color Reset Guide.

Inlining

Controls sprite inlining behavior.

const builder = createSvgSpriteBuilder({
  inline: 'auto'
});

For detailed information, see Inlining Guide.

Cleanup

Manages sprite file cleanup.

const builder = createSvgSpriteBuilder({
  cleanup: 'auto'
});

For detailed information, see Cleanup Guide.