@vnkr-labs/icons-react
v1.0.0
Published
A set of free MIT-licensed high-quality SVG icons for you to use in your web projects.
Readme
AXQ Icons for React
Installation
npm install @axqdesign/icons-reactyarn add @axqdesign/icons-reactpnpm add @axqdesign/icons-reactYou can also download the latest release from GitHub.
Usage
The package is built with ES modules, so unused icons are tree-shaken from your bundle. Each icon is exported as a component.
import { IconArrowLeft } from '@axqdesign/icons-react';
const App = () => {
return <IconArrowLeft />;
};
export default App;Pass props to adjust the icon:
<IconArrowLeft color="red" size={48} stroke={1.5} />Props
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| size | number | string | 24 | Width and height of the icon |
| color | string | currentColor | Stroke color for outline icons, fill color for filled icons |
| stroke | number | string | 2 | Stroke width, outline icons only |
| title | string | – | Adds a <title> element for accessibility |
| className | string | – | Extra classes added to AXQ Design-icon AXQ Design-icon-{{name}} |
Any other attribute is forwarded to the rendered <svg> element. Components forward refs to the <svg> element and ship with TypeScript declarations.
License
AXQ Icons is proprietary software. See LICENSE for details.
