@stemui/icons
v0.1.31
Published
Stem UI icon library generated from SVG sources.
Downloads
2,624
Readme
@stemui/icons
Icon package for the workspace monorepo. SVG source files are converted into typed React components and published as @stemui/icons.
Install
npm install @stemui/iconsUsage
import { LineFileSaveIcon } from "@stemui/icons";
export function Example() {
return <LineFileSaveIcon size={20} color="currentColor" />;
}Props
All generated icons support the same base props:
size?: number | stringcolor?: stringtitle?: string- all standard
svgprops such asclassName,style,strokeWidth
For Maintainers
The commands below are for maintainers working inside this monorepo, not for consumers installing the package from npm.
Daily Workflow
- Drop SVG files into
svg/. - Start the linked preview workflow from the workspace root:
npm run dev:icons:playgroundThis runs two processes together:
npm run dev:iconsnpm run dev:playground
When SVG files are added, changed, renamed, or removed:
- the icon package regenerates components incrementally
- the playground reloads automatically
Build Commands
For a one-off incremental build:
npm run build:incremental --workspace @stemui/iconsFor a full publish build:
npm run build --workspace @stemui/iconsPublish
From the workspace root:
npm run publish:iconsThat command will:
- bump the package patch version
- run the full build
- publish the package to npm
If the version has already been bumped and you only need to retry publish:
npm run publish:icons:manualNaming
- Keep source files in SVG format.
- Prefer snake_case or kebab-case file names.
- Avoid spaces in file names. The build script normalizes spaces to
_, and fails if that target name already exists.
Examples:
line_file_save.svg->LineFileSaveIconline-trash-delete.svg->LineTrashDeleteIcon
