Avataaars API Documentation - v3.1.0
    Preparing search index...

    Function default

    • Main Avatar component with optional animation features.

      This component renders an avatar with support for:

      • Customizable appearance through props
      • Optional idle animation (random expression changes)
      • Optional hover scale effect
      • Optional hover animation sequence

      Animation features are independent and can be combined. The component automatically manages state transitions and cleanup.

      Parameters

      • props: Props

        Avatar configuration and animation settings

      Returns Element

      React component rendering the avatar

      <Avatar
      avatarStyle={AvatarStyle.Circle}
      topType="LongHairStraight"
      eyeType="Happy"
      animationSpeed={2000}
      hoverScale={1.2}
      />