Avatar

Props

API reference for Avatar. For usage examples, see the React tab.

Avatar.Root

Name	Type	Default
children	`ReactNode`
The content or child elements nested within this component.
color	`"blue" \| "cream" \| "darkGray" \| "darkGreen" \| "darkPurple" \| "gray" \| "lightBlue" \| "lightGreen" \| "lightOrange" \| "lightYellow" \| "navy" \| "pink" \| "purple" \| "red" \| "yellow"`
Accent color for fallback initials, icons, and outlined borders. Omit to inherit brand colors from the surrounding app theme.
size	`"lg" \| "md" \| "sm" \| "xs"`	`md`
Size of the Avatar.
variant	`"filled" \| "outlined"`	`filled`
Filled or outlined Avatar.

Name	Type	Default
aria-describedby	`string`
Identifies the element (or elements) that describes the object.
aria-details	`string`
Identifies the element (or elements) that provide a detailed, extended description for the object.
aria-label	`string`
Defines a string value that labels the current element.
aria-labelledby	`string`
Identifies the element (or elements) that labels the current element.
id	`string`
The unique identifier for the DOM element.
role	`AriaRole`
The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc.

Name Type Default

key Key | null

ref Ref<HTMLSpanElement>

Name	Type	Default
key	`Key \| null`
ref	`Ref<HTMLSpanElement>`
Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). See: React Docs (opens in new tab)

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

See: React Docs (opens in new tab)

Name	Type	Default
className	`string`
CSS class names to apply custom styling.
style	`CSSProperties`
Inline styles specified as a React-compatible CSS properties object.

Avatar.Fallback

Name	Type	Default
children	`ReactNode`
The text, image, or icon of the Avatar.Fallback.

Avatar.Image

Name	Type	Default
about	`string`
accessKey	`string`
alt	`string`
autoSave	`string`
children	`ReactNode`
color	`string`
content	`string`
contextMenu	`string`
crossOrigin	`CrossOrigin`
dangerouslySetInnerHTML	`{ __html: string \| TrustedHTML; }`
datatype	`string`
decoding	`"async" \| "auto" \| "sync"`
defaultChecked	`boolean`
exportparts	`string`
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab)
fetchPriority	`"auto" \| "high" \| "low"`
height	`string \| number`
inlist	`any`
inputMode	`"decimal" \| "email" \| "none" \| "numeric" \| "search" \| "tel" \| "text" \| "url"`
Hints at the type of data that might be entered by the user while editing the element or its contents See: https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute (opens in new tab)
itemID	`string`
itemProp	`string`
itemRef	`string`
itemScope	`boolean`
itemType	`string`
loading	`"eager" \| "lazy"`
part	`string`
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab)
prefix	`string`
property	`string`
radioGroup	`string`
referrerPolicy	`HTMLAttributeReferrerPolicy`
rel	`string`
resource	`string`
results	`number`
rev	`string`
security	`string`
sizes	`string`
src	`string`
srcSet	`string`
title	`string`
typeof	`string`
unselectable	`"off" \| "on"`
useMap	`string`
vocab	`string`
width	`string \| number`

Name	Type	Default
aria-activedescendant	`string`
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomic	`Booleanish`
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete	`"both" \| "inline" \| "list" \| "none"`
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-braillelabel	`string`
Defines a string value that labels the current element, which is intended to be converted into Braille. See: aria-label.
aria-brailleroledescription	`string`
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. See: aria-roledescription.
aria-busy	`Booleanish`
aria-checked	`"false" \| "mixed" \| "true" \| boolean`
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed aria-selected.
aria-colcount	`number`
Defines the total number of columns in a table, grid, or treegrid. See: aria-colindex.
aria-colindex	`number`
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. See: aria-colcount aria-colspan.
aria-colindextext	`string`
Defines a human readable text alternative of aria-colindex. See: aria-rowindextext.
aria-colspan	`number`
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. See: aria-colindex aria-rowspan.
aria-controls	`string`
Identifies the element (or elements) whose contents or presence are controlled by the current element. See: aria-owns.
aria-current	`"date" \| "false" \| "location" \| "page" \| "step" \| "time" \| "true" \| boolean`
Indicates the element that represents the current item within a container or set of related elements.
aria-describedby	`string`
Identifies the element (or elements) that describes the object. See: aria-labelledby
aria-description	`string`
Defines a string value that describes or annotates the current element. See: related aria-describedby.
aria-details	`string`
Identifies the element that provides a detailed, extended description for the object. See: aria-describedby.
aria-disabled	`Booleanish`
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See: aria-hidden aria-readonly.
aria-errormessage	`string`
Identifies the element that provides an error message for the object. See: aria-invalid aria-describedby.
aria-expanded	`Booleanish`
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowto	`string`
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-haspopup	`"dialog" \| "false" \| "grid" \| "listbox" \| "menu" \| "tree" \| "true" \| boolean`
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hidden	`Booleanish`
Indicates whether the element is exposed to an accessibility API. See: aria-disabled.
aria-invalid	`"false" \| "grammar" \| "spelling" \| "true" \| boolean`
Indicates the entered value does not conform to the format expected by the application. See: aria-errormessage.
aria-keyshortcuts	`string`
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-label	`string`
Defines a string value that labels the current element. See: aria-labelledby.
aria-labelledby	`string`
Identifies the element (or elements) that labels the current element. See: aria-describedby.
aria-level	`number`
Defines the hierarchical level of an element within a structure.
aria-live	`"assertive" \| "off" \| "polite"`
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modal	`Booleanish`
Indicates whether an element is modal when displayed.
aria-multiline	`Booleanish`
Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectable	`Booleanish`
Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation	`"horizontal" \| "vertical"`
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-owns	`string`
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. See: aria-controls.
aria-placeholder	`string`
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinset	`number`
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See: aria-setsize.
aria-pressed	`"false" \| "mixed" \| "true" \| boolean`
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected.
aria-readonly	`Booleanish`
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled.
aria-relevant	`"additions" \| "additions removals" \| "additions text" \| "all" \| "removals" \| "removals additions" \| "removals text" \| "text" \| "text additions" \| "text removals"`
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See: aria-atomic.
aria-required	`Booleanish`
Indicates that user input is required on the element before a form may be submitted.
aria-roledescription	`string`
Defines a human-readable, author-localized description for the role of an element.
aria-rowcount	`number`
Defines the total number of rows in a table, grid, or treegrid. See: aria-rowindex.
aria-rowindex	`number`
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. See: aria-rowcount aria-rowspan.
aria-rowindextext	`string`
Defines a human readable text alternative of aria-rowindex. See: aria-colindextext.
aria-rowspan	`number`
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. See: aria-rowindex aria-colspan.
aria-selected	`Booleanish`
Indicates the current "selected" state of various widgets. See: aria-checked aria-pressed.
aria-setsize	`number`
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See: aria-posinset.
aria-sort	`"ascending" \| "descending" \| "none" \| "other"`
Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemax	`number`
Defines the maximum allowed value for a range widget.
aria-valuemin	`number`
Defines the minimum allowed value for a range widget.
aria-valuenow	`number`
Defines the current value for a range widget. See: aria-valuetext.
aria-valuetext	`string`
Defines the human readable text alternative of aria-valuenow for a range widget.
id	`string`
role	`AriaRole`
aria-dropeffectDeprecated	`"copy" \| "execute" \| "link" \| "move" \| "none" \| "popup"`
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1
aria-grabbedDeprecated	`Booleanish`
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1

Name	Type	Default
autoCapitalize	`"characters" \| "none" \| "off" \| "on" \| "sentences" \| "words" \| (string & {})`
autoCorrect	`string`
autoFocus	`boolean`
contentEditable	`"inherit" \| "plaintext-only" \| Booleanish`
dir	`string`
draggable	`Booleanish`
enterKeyHint	`"done" \| "enter" \| "go" \| "next" \| "previous" \| "search" \| "send"`
hidden	`boolean`
inert	`boolean`
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
is	`string`
Specify that a standard HTML element should behave like a defined custom built-in element See: https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is (opens in new tab)
key	`Key \| null`
lang	`string`
nonce	`string`
popover	`"" \| "auto" \| "hint" \| "manual"`
popoverTarget	`string`
popoverTargetAction	`"hide" \| "show" \| "toggle"`
ref	`Ref<HTMLImageElement>`
Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). See: React Docs (opens in new tab)
slot	`string`
spellCheck	`Booleanish`
suppressContentEditableWarning	`boolean`
suppressHydrationWarning	`boolean`
tabIndex	`number`
translate	`"no" \| "yes"`

Name	Type	Default
onAbort	`ReactEventHandler<HTMLImageElement>`
onAbortCapture	`ReactEventHandler<HTMLImageElement>`
onAnimationEnd	`AnimationEventHandler<HTMLImageElement>`
onAnimationEndCapture	`AnimationEventHandler<HTMLImageElement>`
onAnimationIteration	`AnimationEventHandler<HTMLImageElement>`
onAnimationIterationCapture	`AnimationEventHandler<HTMLImageElement>`
onAnimationStart	`AnimationEventHandler<HTMLImageElement>`
onAnimationStartCapture	`AnimationEventHandler<HTMLImageElement>`
onAuxClick	`MouseEventHandler<HTMLImageElement>`
onAuxClickCapture	`MouseEventHandler<HTMLImageElement>`
onBeforeInput	`InputEventHandler<HTMLImageElement>`
onBeforeInputCapture	`FormEventHandler<HTMLImageElement>`
onBeforeToggle	`ToggleEventHandler<HTMLImageElement>`
onBlur	`FocusEventHandler<HTMLImageElement>`
onBlurCapture	`FocusEventHandler<HTMLImageElement>`
onCanPlay	`ReactEventHandler<HTMLImageElement>`
onCanPlayCapture	`ReactEventHandler<HTMLImageElement>`
onCanPlayThrough	`ReactEventHandler<HTMLImageElement>`
onCanPlayThroughCapture	`ReactEventHandler<HTMLImageElement>`
onChange	`FormEventHandler<HTMLImageElement>`
onChangeCapture	`FormEventHandler<HTMLImageElement>`
onClick	`MouseEventHandler<HTMLImageElement>`
onClickCapture	`MouseEventHandler<HTMLImageElement>`
onCompositionEnd	`CompositionEventHandler<HTMLImageElement>`
onCompositionEndCapture	`CompositionEventHandler<HTMLImageElement>`
onCompositionStart	`CompositionEventHandler<HTMLImageElement>`
onCompositionStartCapture	`CompositionEventHandler<HTMLImageElement>`
onCompositionUpdate	`CompositionEventHandler<HTMLImageElement>`
onCompositionUpdateCapture	`CompositionEventHandler<HTMLImageElement>`
onContextMenu	`MouseEventHandler<HTMLImageElement>`
onContextMenuCapture	`MouseEventHandler<HTMLImageElement>`
onCopy	`ClipboardEventHandler<HTMLImageElement>`
onCopyCapture	`ClipboardEventHandler<HTMLImageElement>`
onCut	`ClipboardEventHandler<HTMLImageElement>`
onCutCapture	`ClipboardEventHandler<HTMLImageElement>`
onDoubleClick	`MouseEventHandler<HTMLImageElement>`
onDoubleClickCapture	`MouseEventHandler<HTMLImageElement>`
onDrag	`DragEventHandler<HTMLImageElement>`
onDragCapture	`DragEventHandler<HTMLImageElement>`
onDragEnd	`DragEventHandler<HTMLImageElement>`
onDragEndCapture	`DragEventHandler<HTMLImageElement>`
onDragEnter	`DragEventHandler<HTMLImageElement>`
onDragEnterCapture	`DragEventHandler<HTMLImageElement>`
onDragExit	`DragEventHandler<HTMLImageElement>`
onDragExitCapture	`DragEventHandler<HTMLImageElement>`
onDragLeave	`DragEventHandler<HTMLImageElement>`
onDragLeaveCapture	`DragEventHandler<HTMLImageElement>`
onDragOver	`DragEventHandler<HTMLImageElement>`
onDragOverCapture	`DragEventHandler<HTMLImageElement>`
onDragStart	`DragEventHandler<HTMLImageElement>`
onDragStartCapture	`DragEventHandler<HTMLImageElement>`
onDrop	`DragEventHandler<HTMLImageElement>`
onDropCapture	`DragEventHandler<HTMLImageElement>`
onDurationChange	`ReactEventHandler<HTMLImageElement>`
onDurationChangeCapture	`ReactEventHandler<HTMLImageElement>`
onEmptied	`ReactEventHandler<HTMLImageElement>`
onEmptiedCapture	`ReactEventHandler<HTMLImageElement>`
onEncrypted	`ReactEventHandler<HTMLImageElement>`
onEncryptedCapture	`ReactEventHandler<HTMLImageElement>`
onEnded	`ReactEventHandler<HTMLImageElement>`
onEndedCapture	`ReactEventHandler<HTMLImageElement>`
onError	`ReactEventHandler<HTMLImageElement>`
onErrorCapture	`ReactEventHandler<HTMLImageElement>`
onFocus	`FocusEventHandler<HTMLImageElement>`
onFocusCapture	`FocusEventHandler<HTMLImageElement>`
onGotPointerCapture	`PointerEventHandler<HTMLImageElement>`
onGotPointerCaptureCapture	`PointerEventHandler<HTMLImageElement>`
onInput	`FormEventHandler<HTMLImageElement>`
onInputCapture	`FormEventHandler<HTMLImageElement>`
onInvalid	`FormEventHandler<HTMLImageElement>`
onInvalidCapture	`FormEventHandler<HTMLImageElement>`
onKeyDown	`KeyboardEventHandler<HTMLImageElement>`
onKeyDownCapture	`KeyboardEventHandler<HTMLImageElement>`
onKeyUp	`KeyboardEventHandler<HTMLImageElement>`
onKeyUpCapture	`KeyboardEventHandler<HTMLImageElement>`
onLoad	`ReactEventHandler<HTMLImageElement>`
onLoadCapture	`ReactEventHandler<HTMLImageElement>`
onLoadedData	`ReactEventHandler<HTMLImageElement>`
onLoadedDataCapture	`ReactEventHandler<HTMLImageElement>`
onLoadedMetadata	`ReactEventHandler<HTMLImageElement>`
onLoadedMetadataCapture	`ReactEventHandler<HTMLImageElement>`
onLoadStart	`ReactEventHandler<HTMLImageElement>`
onLoadStartCapture	`ReactEventHandler<HTMLImageElement>`
onLostPointerCapture	`PointerEventHandler<HTMLImageElement>`
onLostPointerCaptureCapture	`PointerEventHandler<HTMLImageElement>`
onMouseDown	`MouseEventHandler<HTMLImageElement>`
onMouseDownCapture	`MouseEventHandler<HTMLImageElement>`
onMouseEnter	`MouseEventHandler<HTMLImageElement>`
onMouseLeave	`MouseEventHandler<HTMLImageElement>`
onMouseMove	`MouseEventHandler<HTMLImageElement>`
onMouseMoveCapture	`MouseEventHandler<HTMLImageElement>`
onMouseOut	`MouseEventHandler<HTMLImageElement>`
onMouseOutCapture	`MouseEventHandler<HTMLImageElement>`
onMouseOver	`MouseEventHandler<HTMLImageElement>`
onMouseOverCapture	`MouseEventHandler<HTMLImageElement>`
onMouseUp	`MouseEventHandler<HTMLImageElement>`
onMouseUpCapture	`MouseEventHandler<HTMLImageElement>`
onPaste	`ClipboardEventHandler<HTMLImageElement>`
onPasteCapture	`ClipboardEventHandler<HTMLImageElement>`
onPause	`ReactEventHandler<HTMLImageElement>`
onPauseCapture	`ReactEventHandler<HTMLImageElement>`
onPlay	`ReactEventHandler<HTMLImageElement>`
onPlayCapture	`ReactEventHandler<HTMLImageElement>`
onPlaying	`ReactEventHandler<HTMLImageElement>`
onPlayingCapture	`ReactEventHandler<HTMLImageElement>`
onPointerCancel	`PointerEventHandler<HTMLImageElement>`
onPointerCancelCapture	`PointerEventHandler<HTMLImageElement>`
onPointerDown	`PointerEventHandler<HTMLImageElement>`
onPointerDownCapture	`PointerEventHandler<HTMLImageElement>`
onPointerEnter	`PointerEventHandler<HTMLImageElement>`
onPointerLeave	`PointerEventHandler<HTMLImageElement>`
onPointerMove	`PointerEventHandler<HTMLImageElement>`
onPointerMoveCapture	`PointerEventHandler<HTMLImageElement>`
onPointerOut	`PointerEventHandler<HTMLImageElement>`
onPointerOutCapture	`PointerEventHandler<HTMLImageElement>`
onPointerOver	`PointerEventHandler<HTMLImageElement>`
onPointerOverCapture	`PointerEventHandler<HTMLImageElement>`
onPointerUp	`PointerEventHandler<HTMLImageElement>`
onPointerUpCapture	`PointerEventHandler<HTMLImageElement>`
onProgress	`ReactEventHandler<HTMLImageElement>`
onProgressCapture	`ReactEventHandler<HTMLImageElement>`
onRateChange	`ReactEventHandler<HTMLImageElement>`
onRateChangeCapture	`ReactEventHandler<HTMLImageElement>`
onReset	`FormEventHandler<HTMLImageElement>`
onResetCapture	`FormEventHandler<HTMLImageElement>`
onScroll	`UIEventHandler<HTMLImageElement>`
onScrollCapture	`UIEventHandler<HTMLImageElement>`
onScrollEnd	`UIEventHandler<HTMLImageElement>`
onScrollEndCapture	`UIEventHandler<HTMLImageElement>`
onSeeked	`ReactEventHandler<HTMLImageElement>`
onSeekedCapture	`ReactEventHandler<HTMLImageElement>`
onSeeking	`ReactEventHandler<HTMLImageElement>`
onSeekingCapture	`ReactEventHandler<HTMLImageElement>`
onSelect	`ReactEventHandler<HTMLImageElement>`
onSelectCapture	`ReactEventHandler<HTMLImageElement>`
onStalled	`ReactEventHandler<HTMLImageElement>`
onStalledCapture	`ReactEventHandler<HTMLImageElement>`
onSubmit	`FormEventHandler<HTMLImageElement>`
onSubmitCapture	`FormEventHandler<HTMLImageElement>`
onSuspend	`ReactEventHandler<HTMLImageElement>`
onSuspendCapture	`ReactEventHandler<HTMLImageElement>`
onTimeUpdate	`ReactEventHandler<HTMLImageElement>`
onTimeUpdateCapture	`ReactEventHandler<HTMLImageElement>`
onToggle	`ToggleEventHandler<HTMLImageElement>`
onTouchCancel	`TouchEventHandler<HTMLImageElement>`
onTouchCancelCapture	`TouchEventHandler<HTMLImageElement>`
onTouchEnd	`TouchEventHandler<HTMLImageElement>`
onTouchEndCapture	`TouchEventHandler<HTMLImageElement>`
onTouchMove	`TouchEventHandler<HTMLImageElement>`
onTouchMoveCapture	`TouchEventHandler<HTMLImageElement>`
onTouchStart	`TouchEventHandler<HTMLImageElement>`
onTouchStartCapture	`TouchEventHandler<HTMLImageElement>`
onTransitionCancel	`TransitionEventHandler<HTMLImageElement>`
onTransitionCancelCapture	`TransitionEventHandler<HTMLImageElement>`
onTransitionEnd	`TransitionEventHandler<HTMLImageElement>`
onTransitionEndCapture	`TransitionEventHandler<HTMLImageElement>`
onTransitionRun	`TransitionEventHandler<HTMLImageElement>`
onTransitionRunCapture	`TransitionEventHandler<HTMLImageElement>`
onTransitionStart	`TransitionEventHandler<HTMLImageElement>`
onTransitionStartCapture	`TransitionEventHandler<HTMLImageElement>`
onVolumeChange	`ReactEventHandler<HTMLImageElement>`
onVolumeChangeCapture	`ReactEventHandler<HTMLImageElement>`
onWaiting	`ReactEventHandler<HTMLImageElement>`
onWaitingCapture	`ReactEventHandler<HTMLImageElement>`
onWheel	`WheelEventHandler<HTMLImageElement>`
onWheelCapture	`WheelEventHandler<HTMLImageElement>`
onKeyPressDeprecated	`KeyboardEventHandler<HTMLImageElement>`
Use `onKeyUp` or `onKeyDown` instead
onKeyPressCaptureDeprecated	`KeyboardEventHandler<HTMLImageElement>`
Use `onKeyUpCapture` or `onKeyDownCapture` instead

Avatar

Props

Avatar.Root

Accessibility (6)(6 props)

Advanced (2)(2 props)

Styling (2)(2 props)

Avatar.Fallback

Avatar.Image

Accessibility (55)(55 props)

Advanced (23)(23 props)

Events (168)(168 props)

Forms (1)(1 prop)

Styling (2)(2 props)