common-intellisense
Version:
108 lines (107 loc) • 2.95 kB
JSON
{
"props": [
{
"Attribute": "src",
"Type": "`string`",
"Description": "The image source.",
"Default": "-"
},
{
"Attribute": "srcSet",
"Type": "`string`",
"Description": "The image srcSet.",
"Default": "-"
},
{
"Attribute": "sizes",
"Type": "`string`",
"Description": "The image sizes.",
"Default": "-"
},
{
"Attribute": "alt",
"Type": "`string`",
"Description": "The image alt.",
"Default": "-"
},
{
"Attribute": "width",
"Type": "`number`",
"Description": "The image width.",
"Default": "-"
},
{
"Attribute": "height",
"Type": "`number`",
"Description": "The image height.",
"Default": "-"
},
{
"Attribute": "radius",
"Type": "`none` | `sm` | `md` | `lg` | `full`",
"Description": "The image border radius.",
"Default": "`xl`"
},
{
"Attribute": "shadow",
"Type": "`none` | `sm` | `md` | `lg`",
"Description": "The image shadow.",
"Default": "`none`"
},
{
"Attribute": "loading",
"Type": "`eager` | `lazy`",
"Description": "A loading strategy to use for the image.",
"Default": "-"
},
{
"Attribute": "fallbackSrc",
"Type": "`string`",
"Description": "The fallback image source.",
"Default": "-"
},
{
"Attribute": "isBlurred",
"Type": "`boolean`",
"Description": "Whether the image should have a duplicated blurred image at the background.",
"Default": "`false`"
},
{
"Attribute": "isZoomed",
"Type": "`boolean`",
"Description": "Whether the image should be zoomed when hovered.",
"Default": "`false`"
},
{
"Attribute": "removeWrapper",
"Type": "`boolean`",
"Description": "Whether to remove the wrapper element. This will cause the image to be rendered as a direct child of the parent element. If you set this prop as `true` neither the skeleton nor the zoom effect will work.",
"Default": "`false`"
},
{
"Attribute": "disableSkeleton",
"Type": "`boolean`",
"Description": "Whether the image should disable the skeleton animation while loading.",
"Default": "`false`"
},
{
"Attribute": "classNames",
"Type": "`Record<\"img\"| \"wrapper\"| \"zoomedWrapper\"| \"blurredImg\", string>`",
"Description": "Allows to set custom class names for the image slots.",
"Default": "-"
}
],
"link": "https://nextui.org/docs/components/image",
"events": [
{
"Attribute": "onLoad",
"Type": "`ReactEventHandler<HTMLImageElement>`",
"Description": "Handler that is called when the image load."
},
{
"Attribute": "onError",
"Type": "`() => void`",
"Description": "Handler that is called when the image fails to load."
}
]
}