0.1.6 • Published 3 years ago
@aeros-ui/icons v0.1.6
AEROS Icons Library
An icon library for ELANY's new AEROS system.
Built with React and Material UI to allow developers to access the ELANY custom icons for a faster workflow.
Contents
Installation
Install
//with npm
npm install @aeros-ui/icons//with yarn
yarn add @aeros-ui/iconsUpdate Package
//with npm
npm install @aeros-ui/icons@latest//with yarn
yarn add @aeros-ui/icons@latestPeer Dependencies
React
This package requires use of react version 17^ and react-dom version 17^
Material UI
This package requires use of Material UI version 5^
//with npm
npm install @emotion/react @emotion/styled @mui/material @mui/icons-material @mui/styles//with yarn
yarn add @emotion/react @emotion/styled @mui/material @mui/icons-material @mui/stylesIcons
Props
| Name | Type | Description | Options |
|---|---|---|---|
| color | string | theme color | defaultdisablederrorinfoprimarysecondarysuccesswarning |
| htmlColor | string | custom color | hex or rgb color |
| fontSize | string | font size of the icon | smallmediumlarge |
| viewBox | string | Allows you to redefine what the coordinates without units mean inside an SVG element. | |
| sx | object | The system prop that allows defining system overrides as well as additional CSS styles. See the sx page for more details. |
Carat Icon
Import
import { CaratIcon } from '@aeros-ui/icons'CBOR Icon
Import
import { CBORIcon } from '@aeros-ui/icons'Correction Icon
Import
import { CorrectionIcon } from '@aeros-ui/icons' Table Icons
Import
import { TableIcons } from '@aeros-ui/icons' Usage
The table icons will be passed as a prop to Material-Table component
<MaterialTable
icons={TableIcons}
/>