vdux-avatar

Circular avatar component

Usage no npm install needed!

<script type="module">
  import vduxAvatar from 'https://cdn.skypack.dev/vdux-avatar';
</script>

README

avatar

js-standard-style

Circular avatar component

Installation

$ npm install vdux-avatar

Usage

Use it to render avatars.

<Avatar src='/images/cat.jpg' />

API - props

  • src - URL of the image
  • circle - Defaults to true. Makes it a circle.
  • size - Defaults to 32. Sets width/height simultaneously.

Theming

Avatar makes use of two themable properties, configurable in the context key baseTheme of vdux-base:

  • circularAvatars - Boolean. Defaults to true. If you set it to false, your avatars will default to being square.
  • avatarScale - Array of sizes. If you use this, you can set a scale for your avatars that your size prop may index into.

License

MIT