Nuanced Pumpkin Mavens

    @commercetools-uikit/avatar
    TypeScript icon, indicating that this package has built-in type declarations

    15.3.0 • Public • Published

    Avatar

    Description

    A component for rendering profile images

    Installation

    yarn add @commercetools-uikit/avatar
    
    npm --save install @commercetools-uikit/avatar
    

    Additionally install the peer dependencies (if not present)

    yarn add react
    
    npm --save install react
    

    Usage

    import Avatar from '@commercetools-uikit/avatar';
    
    const Example = () => (
      <Avatar
        gravatarHash="20c9c1b252b46ab49d6f7a4cee9c3e68"
        firstName="John"
        lastName="Doe"
        size="s"
      />
    );
    
    export default Example;

    Properties

    Props Type Required Default Description
    firstName string '' The first name of the user.
    lastName string '' The last name of the user.
    gravatarHash string The hashed string of the user gravatar.
    isHighlighted boolean false Enhances the appearance of the avatar.
    size union
    Possible values:
    's' , 'm' , 'l'
    's' The size of the rendered avatar.

    Install

    npm i @commercetools-uikit/avatar

    DownloadsWeekly Downloads

    5,543

    Version

    15.3.0

    License

    MIT

    Unpacked Size

    63.3 kB

    Total Files

    12

    Last publish

    Collaborators

    • emmenko
    • commercetools-admin
    • tdeekens