jarm-icons
v1.0.63
Published
A lightweight collection of customizable React SVG icons
Readme
jarm-icons
A lightweight collection of customizable React SVG icons built with TypeScript, typed, tree-shakable, and easily styleable.
Installation
npm install jarm-icons
# or
yarn add jarm-iconsUsage
import { AnglesDown } from "jarm-icons";
function MyComponent() {
return (
...
<AnglesDown width={16} height={16} color={colors.success} />
)
}Props
Each icon supports the following props:
| Prop | Type | Default | Description |
| ------ | -------- | ------- | ----------------------- |
| width | number | 24 | Width of the icon (px) |
| height | number | 24 | Height of the icon (px) |
| color | string | "black" | Stroke & fill color |
Tree shaking
This package supports tree-shaking. Import only the icons you use to keep your bundle size small.
Contributing
- Create a corresponding React component for your icon(s) in
src/icons - Make sure to use valid jsx syntax - so replace
fill-rulewithfillRuleorstroke-widthwithstrokeWidthe.t.c - Export it in
src/index.ts - Run
npm run build - Submit a PR
