@qonsoll/icons
v1.1.6
Published
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Downloads
23
Maintainers
Keywords
Readme
@qonsoll/icons
Install
Install dependencies
npm install --save @qonsoll/react-design
or
yarn add @qonsoll/react-design
Install library
npm install --save @qonsoll/icons
or
yarn add @qonsoll/icons
Usage
How to import component?
import { Icon } from '@qonsoll/icons'
function App() {
return <Icon name="BookmarkAddOutlined" />
}
Documentation
Storybook
Configuration
You can configure qonsoll/icons props using
import { Icon } from '@qonsoll/icons'
function App() {
return <Icon name="BookmarkAddOutlined" size="24px" fill="#6648bf" />
}
| Key | Default | Notes |
| ----------- | --------------------- | ------------------------------- |
| fill
| black
| Inlined icons #424851
|
| size
| 24px
| Inlined icons 16px
|
How to update package step-by-step
You can write in terminal run storybook
, and see all changes on Storybook
- Add file.svg to src/icons/(Filled/Outline)
- Next create new IconComponent
- Go to src/components/SvgComponents(Filled/Outline)
- Create new IconComponent with two props: size, fill
- Add in return all content from file.svg (svg, path)
- Outline icons - change stroke="black" -> stroke={fill}
- Filled icons - change fill="black" -> fill={fill}
- Add in return all content from file.svg (svg, path)
- open index.js inside (src/components/SvgComponents(Filled/Outline))
- import Icon(Filled/Outlined) from "./IconComponent"
- export {...IconComponents, Icon(Filled/Outlined) }
- export default {...IconComponents, Icon(Filled/Outlined) }
- Go to src/components/index.js
- import {...IconComponents, Icon(Filled/Outlined) } from "./IconFolder"
- export {...IconComponents, Icon(Filled/Outlined) }
- Go to src/constants/iconPropTypes.js
- update PROP_TYPES.name, with new IconComponent
- Go to src/constants/namesMap.js
- import {...IconComponents, Icon(Filled/Outlined)} from "../components/SvgComponents(Filled/Outline)"
- const ICONS_NAMES = {...IconComponents, Icon(Filled/Outlined): <Icon(Filled/Outlined) />}