common-intellisense/scripts/nextui/Avatar.json

%description%

{
  "props": [
    {
      "Attribute": "src",
      "Type": "`string`",
      "Description": "The source URL of the image to be displayed.",
      "Default": "-"
    },
    {
      "Attribute": "color",
      "Type": "`default` | `primary` | `secondary` | `success` | `warning` | `danger`",
      "Description": "Sets the avatar background color.",
      "Default": "`default`"
    },
    {
      "Attribute": "radius",
      "Type": "`none` | `sm` | `md` | `lg` | `full`",
      "Description": "Sets the avatar border radius.",
      "Default": "`full`"
    },
    {
      "Attribute": "size",
      "Type": "`sm` | `md` | `lg`",
      "Description": "Sets the avatar size.",
      "Default": "`md`"
    },
    {
      "Attribute": "name",
      "Type": "`string`",
      "Description": "Displays the initials if the image is not provided or fails to load.",
      "Default": "-"
    },
    {
      "Attribute": "icon",
      "Type": "`ReactNode`",
      "Description": "Displays a custom icon inside the avatar.",
      "Default": "-"
    },
    {
      "Attribute": "fallback",
      "Type": "`ReactNode`",
      "Description": "A custom fallback component to display when the image fails to load.",
      "Default": "-"
    },
    {
      "Attribute": "isBordered",
      "Type": "`boolean`",
      "Description": "If `true`, adds a border around the avatar.",
      "Default": "`false`"
    },
    {
      "Attribute": "isDisabled",
      "Type": "`boolean`",
      "Description": "If `true`, disables the avatar and applies a disabled styling.",
      "Default": "`false`"
    },
    {
      "Attribute": "isFocusable",
      "Type": "`boolean`",
      "Description": "If `true`, makes the avatar focusable for keyboard navigation.",
      "Default": "`false`"
    },
    {
      "Attribute": "showFallback",
      "Type": "`boolean`",
      "Description": "If `true`, shows the fallback icon or initials when the image fails to load.",
      "Default": "`false`"
    },
    {
      "Attribute": "ImgComponent",
      "Type": "`React.ElementType`",
      "Description": "The component to be used as the image element.",
      "Default": "`img`"
    },
    {
      "Attribute": "imgProps",
      "Type": "`ImgComponentProps`",
      "Description": "Props to be passed to the image element.",
      "Default": "-"
    },
    {
      "Attribute": "classNames",
      "Type": "`Record<\"base\"｜ \"img\"｜ \"fallback\"｜ \"name\"｜ \"icon\", string>`",
      "Description": "Allows to set custom class names for the avatar slots.",
      "Default": "-"
    }
  ],
  "link": "https://nextui.org/docs/components/avatar"
}