0.0.2 • Published 2 years ago

@cebus/react-avatar v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Avatar

The Avatar provides a recognizable icon for a user.

Use

  1. Install the @cebus/react-avatar component.

Using NPM

npm install @cebus/react-avatar

Using Yarn

yarn add @cebus/react-avatar
  1. Install the @cebus/react-provider and our theme tokens from @cebus/react-theme

  2. 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>
  )
}
  1. Integrate the Avatar component.
import { Provider } from '@cebus/react-provider'
import { webLightTheme } from '@cebus/react-theme'
import { Avatar } from '@cebus/react-avatar'

const MyApp = () => {
  return (
    <Provider theme={webLightTheme}>
        <Avatar name="Your Name"/>
    <Provider>
  )
}

API

To learn more about the Avatar API take a look at the Avatar Interface file.