@channel.io/bezier-icons
v0.36.0
Published
Icon library that implements Bezier design system.
Downloads
899
Readme
Bezier Icons
Bezier Icons is a icon library that implements Bezier design system.
Installation
- (Recommend) Install
@channel.io/bezier-react
if you haven’t already. - Install
@channel.io/bezier-icons
as a dependency.
npm
npm i @channel.io/bezier-icons
yarn
yarn add @channel.io/bezier-icons
Usage
All icons are available as individual React components. We recommend using them with the Icon
component from our @channel.io/bezier-react
library.
import { Icon } from '@channel.io/bezier-react'
import { AllIcon } from '@channel.io/bezier-icons'
function Component() {
return (
<div>
<Icon source={AllIcon} />
</div>
)
}
You can also use them individually.
import { AllIcon } from '@channel.io/bezier-icons'
function Component() {
return (
<div>
<AllIcon />
</div>
)
}
If you need to validate the icon source component, use the utility function isBezierIcon
.
import { isBezierIcon, AllIcon } from '@channel.io/bezier-icons'
function FooIcon() {
return <svg />
}
console.log(isBezierIcon(AllIcon)) // true
console.log(isBezierIcon(FooIcon)) // false
Contributing
See contribution guide.
Maintainers
This package is mainly contributed by Channel Corp. Although feel free to contribution, or raise concerns!