@pongo-ui/react-icon
TypeScript icon, indicating that this package has built-in type declarations

0.1.13 • Public • Published

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

  1. Install the @pongo-ui/react-icon component.

Using NPM

npm install @pongo-ui/react-icon

Using Yarn

yarn add @pongo-ui/react-icon
  1. Install the @pongo-ui/react-provider and our theme tokens from @pongo-ui/react-theme

  2. Set up the provider in your app:

import { Provider } from '@pongo-ui/react-provider'
import { webLightTheme } from '@pongo-ui/react-theme'

const MyApp = () => {
  return (
    <Provider theme={webLightTheme}>
    <Provider>
  )
}
  1. Integrate a Icon component.
import { Provider } from '@pongo-ui/react-provider'
import { webLightTheme } from '@pongo-ui/react-theme'
import { Icon } from '@pongo-ui/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.

Readme

Keywords

none

Package Sidebar

Install

npm i @pongo-ui/react-icon

Weekly Downloads

1

Version

0.1.13

License

MIT

Unpacked Size

2.29 MB

Total Files

354

Last publish

Collaborators

  • pongobuild
  • czearing