@fayegram-ai/faye-ui/display/avatar
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { Avatar } from '@fayegram-ai/faye-ui/display/avatar';Usage and behavior guide · API JSON
This entry declares a client boundary. Follow the rendering guide for framework integration.
Public exports
| Name | Kind | Resolved declaration type |
|---|---|---|
Avatar | value | { readonly Root: { (input: Omit<import("@base-ui/react").AvatarRootProps, "ref"> & import("react").RefAttributes<HTMLSpanElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "tone"> | undefined; } | undefined; }): import("react").ReactElement; displayName: string; }; readonly Image: { (input: Omit<import("@base-ui/react").AvatarImageProps, "ref"> & import("react").RefAttributes<HTMLImageElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").Visua… (full type in API JSON) |
Avatar
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Avatar.Root
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: AvatarRootState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AvatarRootState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: AvatarRootState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Avatar.Image
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: AvatarImageState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
keepMounted | No | boolean | undefined | Whether the image element stays mounted and loads in place instead of being preloaded. Supports loading="lazy" and optimized image components such as next/image. |
onLoadingStatusChange | No | ((status: ImageLoadingStatus) => void) | undefined | Callback fired when the loading status changes. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<DetailedHTMLProps<ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, AvatarImageState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: AvatarImageState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Avatar.Fallback
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: AvatarFallbackState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
delay | No | number | undefined | How long to wait before showing the fallback. Specified in milliseconds. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AvatarFallbackState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: AvatarFallbackState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"avatar", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Defaults and customization
Descriptor defaults: {"size":"md","tone":"neutral"}. Parts: root, image, fallback. Explicit instance props take precedence over configured defaults.
Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.
State, events and accessibility
For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.
Declaration authority
Generated from packages/faye-ui/dist/display/avatar.d.ts after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. React DOM attributes and Base UI component contracts describe the inherited foundations.