DEVELOPER REFERENCE · v4.0.0

Avatar API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

Avatar10 props0 callbacks0 methods

Avatar props
Name	Type	Description
`ariaLabel`Optional	`string \| undefined`	Accessible name announced by assistive technology.
`className`Optional	`string \| undefined`	Additional CSS classes applied to the component root.
`index`Optional	`number \| undefined`	Index used to identify or style the item.
`initials`Optional	`string \| undefined`	Fallback initials displayed when no avatar image is available.
`key`Optional	`string \| number \| undefined`	Stable identity used when rendering this item.
`label`Optional	`string \| undefined`	Label content or accessible name for the component, as rendered by this control.
`rectangular`Optional	`boolean \| undefined`	Uses a rectangular avatar instead of the circular presentation.
`size`Optional	`number \| undefined`	Visual size of this component; numeric icon/avatar sizes are in pixels, while controls use the declared named sizes.
`style`Optional	`Record<string, string \| number \| null \| undefined> \| undefined`Inspect type	Inline styles or style configuration applied to this component; expand the type for supported entries.
`value`Optional	`unknown`	Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.

No component-specific events or callbacks.

No component-specific imperative methods. Use props and callbacks to control this component.