JSPM

@fluentui/react-avatar

0.0.0-nightly-20220309-0417.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 259218
  • Score
    100M100P100Q170816F
  • License MIT

React components for building Microsoft web experiences.

Package Exports

  • @fluentui/react-avatar

Readme

@fluentui/react-avatar

React Avatar components for Fluent UI

The Avatar component represents a person or entity. It displays the person's image, initials, or an icon, and can be either circular or square.

STATUS: WIP 🚧

These are not production-ready components and should never be used in product. This space is useful for testing new components whose APIs might change before final release.

Usage

To import Avatar:

import { Avatar } from '@fluentui/react-avatar';

Once the Avatar component graduates to a production release, the component will be available at:

import { Avatar } from '@fluentui/react-components';

Examples

<Avatar name="Miguel Garcia" />
<Avatar size={72} name="Mona Kane" image="./MonaKane.jpg" />
<Avatar shape="square" icon={<IDBadgeIcon />} />

Displaying a badge:

<Avatar name="Allan Munger" badge={<PresenceBadge status="busy">} />

With active state indication:

<Avatar name="Daisy Phillips" active={true} activeAppearance="ring-shadow" />
<Avatar name="Robin Counts" active={false} activeAppearance="ring-shadow" />