# SketchIcon

> Deterministic, customizable hand-drawn SVG icons for React, based on Lucide and Hugeicons Core Free geometry.

SketchIcon provides tree-shakeable React icons rendered as accessible inline SVG. Use the documentation below to install the package, render icons, and find canonical icon export names and slugs.

## Documentation

- [Installation and usage](/icons/usage.md): package imports, component properties, accessibility, and framework-independent rendering.
- [Icon catalog](/icons/catalog.md): compact alphabetical indexes of available icons and aliases.
- [Interactive icon browser](/): search, preview, customize, and copy icon code.

## External Resources

- [npm package](https://www.npmjs.com/package/sketchicon)
- [Source repository](https://github.com/MayankBansal12/sketchicon)

## Notes

- Import the renderer from `sketchicon`.
- Import Lucide icons with named imports from `@sketchicon/lucide` by default. Direct `@sketchicon/lucide/icons/<slug>` imports remain available.
- Import Hugeicons with named imports from `@sketchicon/hugeicons` by default. Direct `@sketchicon/hugeicons/icons/<slug>` imports remain available.
- Do not reproduce SVG path data. Import the icon geometry supplied by the package.
- Give meaningful icons an accessible name with `aria-label` or `title`. Hide decorative icons with `aria-hidden="true"`.