CLI previewInstall commands shown on this site are not released yet.

DocsComponentsData Display

Avatar

React example follows below.
ts
import { Avatar, AvatarStack } from "@grassroot/ui-react";
<Avatar name="Alex Mercer" status="online" />
<AvatarStack>
<Avatar name="Alex Mercer" />
<Avatar name="Rae Kapoor" />
<Avatar initials="+5" />
</AvatarStack>
ts
<script setup lang="ts">
import { Avatar, AvatarStack } from "@grassroot/ui-vue";
</script>
<template>
<Avatar name="Alex Mercer" status="online" />
<AvatarStack
>
<Avatar name="Alex Mercer" />
<Avatar name="Rae Kapoor" />
<Avatar initials="+5" />
</AvatarStack>
</template>
ts
import { Component } from "@angular/core";
import { GrassrootAvatar, GrassrootAvatarStack } from "@grassroot/ui-angular";
@Component({
selector: "app-example",
standalone: true,
imports: [GrassrootAvatar, GrassrootAvatarStack],
template: `
<grassroot-avatar name="Alex Mercer" status="online" />
<grassroot-avatar-stack
>
<grassroot-avatar name="Alex Mercer" />
<grassroot-avatar name="Rae Kapoor" />
<grassroot-avatar initials="+5" />
</grassroot-avatar-stack>
`,
})
export class ExampleComponent {
}
ts
<script lang="ts">
import { Avatar, AvatarStack } from "@grassroot/ui-svelte";
</script>
<Avatar name="Alex Mercer" status="online" />
<AvatarStack
>
<Avatar name="Alex Mercer" />
<Avatar name="Rae Kapoor" />
<Avatar initials="+5" />
</AvatarStack>
ts
import { Avatar, AvatarStack } from "@grassroot/ui-solid";
export function Example() {
return (
<>
<Avatar name="Alex Mercer" status="online" />
<AvatarStack
>
<Avatar name="Alex Mercer" />
<Avatar name="Rae Kapoor" />
<Avatar initials="+5" />
</AvatarStack>
</>
);
}

Installation

bash
pnpm dlx grassroot add ui/avatar
bash
npx grassroot@latest add ui/avatar
bash
yarn dlx grassroot add ui/avatar
bash
bunx grassroot add ui/avatar

API Reference

AvatarProps
PropTypeDefault
srcImage URL; on error falls back to initials.string | undefined
nameFull name — initials are derived from it (also used as alt).string | undefined
initialsExplicit fallback text; overrides derived initials.string | undefined
size"sm" | "md" | "lg" | undefined"md"
statusPresence dot. Omit for none.AvatarStatus | undefined