@cebus/react-icon
v0.0.3
Published
A collection of Icons to provide user's clarity on an action.
Downloads
16
Readme
Icon
Icons help provide user's clarity on an action. They are especially helpful in Buttons, Menus, and other controls to further convey a text based definition.
Use
- Install the @cebus/react-icon component.
Using NPM
npm install @cebus/react-icon
Using Yarn
yarn add @cebus/react-icon
Install the @cebus/react-provider and our theme tokens from @cebus/react-theme
Set up the provider in your app:
import { Provider } from '@cebus/react-provider'
import { webLightTheme } from '@cebus/react-theme'
const MyApp = () => {
return (
<Provider theme={webLightTheme}>
<Provider>
)
}
- Integrate a Icon component.
import { Provider } from '@cebus/react-provider'
import { webLightTheme } from '@cebus/react-theme'
import { Icon } from '@cebus/react-icon'
const MyApp = () => {
return (
<Provider theme={webLightTheme}>
<Icon />
<Provider>
)
}
API
To learn more about the Icon API take a look at the Icon Interface file.