Skip to content

RtkAvatar

Last updated View as MarkdownAgent setup

Avatar component which renders a participant's image or their initials.

Properties

Property Type Required Default Description
iconPack IconPack defaultIconPack Icon pack
participant Peer | WaitlistedParticipant | { name: string; picture: string } - Participant object
size Size - Size
t RtkI18n useLanguage() Language
variant AvatarVariant - Avatar type

Usage Examples

Basic Usage

import { RtkAvatar } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return <RtkAvatar />;
}

With Properties

import { RtkAvatar } from '@cloudflare/realtimekit-react-ui';

function MyComponent() {
  return (
    <RtkAvatar
      participant="example"
      size="md"
      variant="circular"
    />
  );
}

Was this helpful?