Axon 911 Frontend DocsAxon 911 Frontend Docs
Axon 911 Frontend Docs
    Loading navigation…
U
User
Switch to light mode
  1. Primitives
  2. Circle
  3. API and Development

Circle

API and Development

View SourceOpens in a new tabSubmit IssueOpens in a new tab
@prepared911/ui does not export Circle or CircleColor. A round identity mark is Avatar from @prepared911/ui/avatar with AvatarShape.Circle. Counts and status tags use Badge. A status marker without a label uses StatusDot.
Props
NameTypeDefaultDescription
altAvatarName—Accessible name, such as the person's name. The first character is the default initials. Not allowed on a decorative avatar.
colorAvatarColor—Fill and initials color. Defaults to {@link AvatarColor.Default}.
decorativeboolean—When omitted or false, the avatar is meaningful and must supply alt. Hides the avatar from assistive technology.
fallbackAvatarName—Text shown when there is no image. Defaults to the first character of alt.
idstring—Element id of the root.
refRef<HTMLSpanElement>—Ref to the root span.
shapeAvatarShape—Outline. Defaults to {@link AvatarShape.Circle}.
sizeAvatarSize—Diameter and initials type role. Defaults to {@link AvatarSize.Regular}.
srcstring—Trusted image URL, rendered with Image. Without it, or when it fails to load, the initials show.
Storybook
Interactive examples and edge cases for this component are in Storybook.
DefaultOpens in a new tab
Initials
Color
Import
Import Avatar, AvatarColor, AvatarShape, and AvatarSize from @prepared911/ui/avatar.
Previous
Circle / Usage
Next
Circle / Accessibility
On this page
Props
Storybook
Initials
Color
Import