export-svg-typescript
v0.1.23
Published
Export SVG to TypeScript
Readme
export-svg-typescript
Convert a folder of SVG icons into a color-customizable, tree-shakable TypeScript export index.ts that works with any component framework without SVG or Vite compiler issues.
- Barrel Roll: Exports all icons as named functions for tree shaking to only the ones actually used.
- Typescript Tooltip Previews: Each export includes a tooltip preview of icon.
- Customizable: Change icon colors, size, and dimensions at runtime. Can return SVG or IMG tag with SVG as source.
- CLI Tool: Use directly from the command line or in npm scripts.
Install
Global install:
npm install -g export-svg-typescriptOr add to package.json:
"icons": "npx export-svg-typescript -i ./src/icons",Or use npx without installing globally with index output file set
npx export-svg-typescript -i ./src/icons -o ./src/icons/index.tsExample
Clone this repo and run npm run demo to see icons in demo folder.
import { loadingDoubleRing } from './demo';
loadingDoubleRing({size: 200, colors: ["#5345bb"] })
