Image

Props #

width

Type: number

height

Type: number

className optional

Type: string

fullHeight optional

Type: boolean

rounded optional

Type: boolean

src

Type: string | StaticImport

alt

Type: string

loading optional

Type: lazy | eager

key optional

Type: Key

crossOrigin optional

Type: CrossOrigin

decoding optional

Type: async | auto | sync

fetchPriority optional

Type: auto | high | low

referrerPolicy optional

Type: HTMLAttributeReferrerPolicy

sizes optional

Type: string

useMap optional

Type: string

defaultChecked optional

Type: boolean

defaultValue optional

Type: string | number | readonly string[]

suppressContentEditableWarning optional

Type: boolean

suppressHydrationWarning optional

Type: boolean

accessKey optional

Type: string

autoCapitalize optional

Type: off | none | on | sentences | words | characters | (string & {})

autoFocus optional

Type: boolean

contentEditable optional

Type: Booleanish | inherit | plaintext-only

contextMenu optional

Type: string

dir optional

Type: string

draggable optional

Type: Booleanish

enterKeyHint optional

Type: enter | done | go | next | previous | search | send

hidden optional

Type: boolean

id optional

Type: string

lang optional

Type: string

nonce optional

Type: string

slot optional

Type: string

spellCheck optional

Type: Booleanish

style optional

Type: CSSProperties

tabIndex optional

Type: number

title optional

Type: string

translate optional

Type: yes | no

radioGroup optional

Type: string

role optional

Type: AriaRole

about optional

Type: string

content optional

Type: string

datatype optional

Type: string

inlist optional

Type: any

prefix optional

Type: string

property optional

Type: string

rel optional

Type: string

resource optional

Type: string

rev optional

Type: string

typeof optional

Type: string

vocab optional

Type: string

autoCorrect optional

Type: string

autoSave optional

Type: string

color optional

Type: string

itemProp optional

Type: string

itemScope optional

Type: boolean

itemType optional

Type: string

itemID optional

Type: string

itemRef optional

Type: string

results optional

Type: number

security optional

Type: string

unselectable optional

Type: off | on

inputMode optional
Hints at the type of data that might be entered by the user while editing the element or its contents @see {@link https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute}
Type: none | search | text | tel | url | email | numeric | decimal

is optional
Specify that a standard HTML element should behave like a defined custom built-in element @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is}
Type: string

aria-activedescendant optional
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Type: string

aria-atomic optional
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.
Type: Booleanish

aria-autocomplete optional
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.
Type: none | list | inline | both

aria-braillelabel optional
Defines a string value that labels the current element, which is intended to be converted into Braille. @see aria-label.
Type: string

aria-brailleroledescription optional
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.
Type: string

aria-busy optional

Type: Booleanish

aria-checked optional
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected.
Type: boolean | true | false | mixed

aria-colcount optional
Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex.
Type: number

aria-colindex optional
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 @see aria-colspan.
Type: number

aria-colindextext optional
Defines a human readable text alternative of aria-colindex. @see aria-rowindextext.
Type: string

aria-colspan optional
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan.
Type: number

aria-controls optional
Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns.
Type: string

aria-current optional
Indicates the element that represents the current item within a container or set of related elements.
Type: boolean | true | false | page | step | location | date | time

aria-describedby optional
Identifies the element (or elements) that describes the object. @see aria-labelledby
Type: string

aria-description optional
Defines a string value that describes or annotates the current element. @see related aria-describedby.
Type: string

aria-details optional
Identifies the element that provides a detailed, extended description for the object. @see aria-describedby.
Type: string

aria-disabled optional
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly.
Type: Booleanish

aria-dropeffect optional
Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1
Type: none | link | copy | execute | move | popup

aria-errormessage optional
Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby.
Type: string

aria-expanded optional
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Type: Booleanish

aria-flowto optional
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.
Type: string

aria-grabbed optional
Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1
Type: Booleanish

aria-haspopup optional
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Type: boolean | true | false | dialog | grid | listbox | menu | tree

aria-hidden optional
Indicates whether the element is exposed to an accessibility API. @see aria-disabled.
Type: Booleanish

aria-invalid optional
Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage.
Type: boolean | true | false | grammar | spelling

aria-keyshortcuts optional
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Type: string

aria-label optional
Defines a string value that labels the current element. @see aria-labelledby.
Type: string

aria-labelledby optional
Identifies the element (or elements) that labels the current element. @see aria-describedby.
Type: string

aria-level optional
Defines the hierarchical level of an element within a structure.
Type: number

aria-live optional
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.
Type: off | assertive | polite

aria-modal optional
Indicates whether an element is modal when displayed.
Type: Booleanish

aria-multiline optional
Indicates whether a text box accepts multiple lines of input or only a single line.
Type: Booleanish

aria-multiselectable optional
Indicates that the user may select more than one item from the current selectable descendants.
Type: Booleanish

aria-orientation optional
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Type: horizontal | vertical

aria-owns optional
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.
Type: string

aria-placeholder optional
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.
Type: string

aria-posinset optional
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.
Type: number

aria-pressed optional
Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected.
Type: boolean | true | false | mixed

aria-readonly optional
Indicates that the element is not editable, but is otherwise operable. @see aria-disabled.
Type: Booleanish

aria-relevant optional
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic.
Type: text | additions | additions removals | additions text | all | removals | removals additions | removals text | text additions | text removals

aria-required optional
Indicates that user input is required on the element before a form may be submitted.
Type: Booleanish

aria-roledescription optional
Defines a human-readable, author-localized description for the role of an element.
Type: string

aria-rowcount optional
Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex.
Type: number

aria-rowindex optional
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 @see aria-rowspan.
Type: number

aria-rowindextext optional
Defines a human readable text alternative of aria-rowindex. @see aria-colindextext.
Type: string

aria-rowspan optional
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan.
Type: number

aria-selected optional
Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed.
Type: Booleanish

aria-setsize optional
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.
Type: number

aria-sort optional
Indicates if items in a table or grid are sorted in ascending or descending order.
Type: none | ascending | descending | other

aria-valuemax optional
Defines the maximum allowed value for a range widget.
Type: number

aria-valuemin optional
Defines the minimum allowed value for a range widget.
Type: number

aria-valuenow optional
Defines the current value for a range widget. @see aria-valuetext.
Type: number

aria-valuetext optional
Defines the human readable text alternative of aria-valuenow for a range widget.
Type: string

children optional

Type: ReactNode

dangerouslySetInnerHTML optional

Type: { __html: string | TrustedHTML; }

onCopy optional

Type: ClipboardEventHandler<HTMLImageElement>

onCopyCapture optional

Type: ClipboardEventHandler<HTMLImageElement>

onCut optional

Type: ClipboardEventHandler<HTMLImageElement>

onCutCapture optional

Type: ClipboardEventHandler<HTMLImageElement>

onPaste optional

Type: ClipboardEventHandler<HTMLImageElement>

onPasteCapture optional

Type: ClipboardEventHandler<HTMLImageElement>

onCompositionEnd optional

Type: CompositionEventHandler<HTMLImageElement>

onCompositionEndCapture optional

Type: CompositionEventHandler<HTMLImageElement>

onCompositionStart optional

Type: CompositionEventHandler<HTMLImageElement>

onCompositionStartCapture optional

Type: CompositionEventHandler<HTMLImageElement>

onCompositionUpdate optional

Type: CompositionEventHandler<HTMLImageElement>

onCompositionUpdateCapture optional

Type: CompositionEventHandler<HTMLImageElement>

onFocus optional

Type: FocusEventHandler<HTMLImageElement>

onFocusCapture optional

Type: FocusEventHandler<HTMLImageElement>

onBlur optional

Type: FocusEventHandler<HTMLImageElement>

onBlurCapture optional

Type: FocusEventHandler<HTMLImageElement>

onChange optional

Type: FormEventHandler<HTMLImageElement>

onChangeCapture optional

Type: FormEventHandler<HTMLImageElement>

onBeforeInput optional

Type: FormEventHandler<HTMLImageElement>

onBeforeInputCapture optional

Type: FormEventHandler<HTMLImageElement>

onInput optional

Type: FormEventHandler<HTMLImageElement>

onInputCapture optional

Type: FormEventHandler<HTMLImageElement>

onReset optional

Type: FormEventHandler<HTMLImageElement>

onResetCapture optional

Type: FormEventHandler<HTMLImageElement>

onSubmit optional

Type: FormEventHandler<HTMLImageElement>

onSubmitCapture optional

Type: FormEventHandler<HTMLImageElement>

onInvalid optional

Type: FormEventHandler<HTMLImageElement>

onInvalidCapture optional

Type: FormEventHandler<HTMLImageElement>

onLoad optional

Type: ReactEventHandler<HTMLImageElement>

onLoadCapture optional

Type: ReactEventHandler<HTMLImageElement>

onError optional

Type: ReactEventHandler<HTMLImageElement>

onErrorCapture optional

Type: ReactEventHandler<HTMLImageElement>

onKeyDown optional

Type: KeyboardEventHandler<HTMLImageElement>

onKeyDownCapture optional

Type: KeyboardEventHandler<HTMLImageElement>

onKeyPress optional
@deprecated Use onKeyUp or onKeyDown instead
Type: KeyboardEventHandler<HTMLImageElement>

onKeyPressCapture optional
@deprecated Use onKeyUpCapture or onKeyDownCapture instead
Type: KeyboardEventHandler<HTMLImageElement>

onKeyUp optional

Type: KeyboardEventHandler<HTMLImageElement>

onKeyUpCapture optional

Type: KeyboardEventHandler<HTMLImageElement>

onAbort optional

Type: ReactEventHandler<HTMLImageElement>

onAbortCapture optional

Type: ReactEventHandler<HTMLImageElement>

onCanPlay optional

Type: ReactEventHandler<HTMLImageElement>

onCanPlayCapture optional

Type: ReactEventHandler<HTMLImageElement>

onCanPlayThrough optional

Type: ReactEventHandler<HTMLImageElement>

onCanPlayThroughCapture optional

Type: ReactEventHandler<HTMLImageElement>

onDurationChange optional

Type: ReactEventHandler<HTMLImageElement>

onDurationChangeCapture optional

Type: ReactEventHandler<HTMLImageElement>

onEmptied optional

Type: ReactEventHandler<HTMLImageElement>

onEmptiedCapture optional

Type: ReactEventHandler<HTMLImageElement>

onEncrypted optional

Type: ReactEventHandler<HTMLImageElement>

onEncryptedCapture optional

Type: ReactEventHandler<HTMLImageElement>

onEnded optional

Type: ReactEventHandler<HTMLImageElement>

onEndedCapture optional

Type: ReactEventHandler<HTMLImageElement>

onLoadedData optional

Type: ReactEventHandler<HTMLImageElement>

onLoadedDataCapture optional

Type: ReactEventHandler<HTMLImageElement>

onLoadedMetadata optional

Type: ReactEventHandler<HTMLImageElement>

onLoadedMetadataCapture optional

Type: ReactEventHandler<HTMLImageElement>

onLoadStart optional

Type: ReactEventHandler<HTMLImageElement>

onLoadStartCapture optional

Type: ReactEventHandler<HTMLImageElement>

onPause optional

Type: ReactEventHandler<HTMLImageElement>

onPauseCapture optional

Type: ReactEventHandler<HTMLImageElement>

onPlay optional

Type: ReactEventHandler<HTMLImageElement>

onPlayCapture optional

Type: ReactEventHandler<HTMLImageElement>

onPlaying optional

Type: ReactEventHandler<HTMLImageElement>

onPlayingCapture optional

Type: ReactEventHandler<HTMLImageElement>

onProgress optional

Type: ReactEventHandler<HTMLImageElement>

onProgressCapture optional

Type: ReactEventHandler<HTMLImageElement>

onRateChange optional

Type: ReactEventHandler<HTMLImageElement>

onRateChangeCapture optional

Type: ReactEventHandler<HTMLImageElement>

onResize optional

Type: ReactEventHandler<HTMLImageElement>

onResizeCapture optional

Type: ReactEventHandler<HTMLImageElement>

onSeeked optional

Type: ReactEventHandler<HTMLImageElement>

onSeekedCapture optional

Type: ReactEventHandler<HTMLImageElement>

onSeeking optional

Type: ReactEventHandler<HTMLImageElement>

onSeekingCapture optional

Type: ReactEventHandler<HTMLImageElement>

onStalled optional

Type: ReactEventHandler<HTMLImageElement>

onStalledCapture optional

Type: ReactEventHandler<HTMLImageElement>

onSuspend optional

Type: ReactEventHandler<HTMLImageElement>

onSuspendCapture optional

Type: ReactEventHandler<HTMLImageElement>

onTimeUpdate optional

Type: ReactEventHandler<HTMLImageElement>

onTimeUpdateCapture optional

Type: ReactEventHandler<HTMLImageElement>

onVolumeChange optional

Type: ReactEventHandler<HTMLImageElement>

onVolumeChangeCapture optional

Type: ReactEventHandler<HTMLImageElement>

onWaiting optional

Type: ReactEventHandler<HTMLImageElement>

onWaitingCapture optional

Type: ReactEventHandler<HTMLImageElement>

onAuxClick optional

Type: MouseEventHandler<HTMLImageElement>

onAuxClickCapture optional

Type: MouseEventHandler<HTMLImageElement>

onClick optional

Type: MouseEventHandler<HTMLImageElement>

onClickCapture optional

Type: MouseEventHandler<HTMLImageElement>

onContextMenu optional

Type: MouseEventHandler<HTMLImageElement>

onContextMenuCapture optional

Type: MouseEventHandler<HTMLImageElement>

onDoubleClick optional

Type: MouseEventHandler<HTMLImageElement>

onDoubleClickCapture optional

Type: MouseEventHandler<HTMLImageElement>

onDrag optional

Type: DragEventHandler<HTMLImageElement>

onDragCapture optional

Type: DragEventHandler<HTMLImageElement>

onDragEnd optional

Type: DragEventHandler<HTMLImageElement>

onDragEndCapture optional

Type: DragEventHandler<HTMLImageElement>

onDragEnter optional

Type: DragEventHandler<HTMLImageElement>

onDragEnterCapture optional

Type: DragEventHandler<HTMLImageElement>

onDragExit optional

Type: DragEventHandler<HTMLImageElement>

onDragExitCapture optional

Type: DragEventHandler<HTMLImageElement>

onDragLeave optional

Type: DragEventHandler<HTMLImageElement>

onDragLeaveCapture optional

Type: DragEventHandler<HTMLImageElement>

onDragOver optional

Type: DragEventHandler<HTMLImageElement>

onDragOverCapture optional

Type: DragEventHandler<HTMLImageElement>

onDragStart optional

Type: DragEventHandler<HTMLImageElement>

onDragStartCapture optional

Type: DragEventHandler<HTMLImageElement>

onDrop optional

Type: DragEventHandler<HTMLImageElement>

onDropCapture optional

Type: DragEventHandler<HTMLImageElement>

onMouseDown optional

Type: MouseEventHandler<HTMLImageElement>

onMouseDownCapture optional

Type: MouseEventHandler<HTMLImageElement>

onMouseEnter optional

Type: MouseEventHandler<HTMLImageElement>

onMouseLeave optional

Type: MouseEventHandler<HTMLImageElement>

onMouseMove optional

Type: MouseEventHandler<HTMLImageElement>

onMouseMoveCapture optional

Type: MouseEventHandler<HTMLImageElement>

onMouseOut optional

Type: MouseEventHandler<HTMLImageElement>

onMouseOutCapture optional

Type: MouseEventHandler<HTMLImageElement>

onMouseOver optional

Type: MouseEventHandler<HTMLImageElement>

onMouseOverCapture optional

Type: MouseEventHandler<HTMLImageElement>

onMouseUp optional

Type: MouseEventHandler<HTMLImageElement>

onMouseUpCapture optional

Type: MouseEventHandler<HTMLImageElement>

onSelect optional

Type: ReactEventHandler<HTMLImageElement>

onSelectCapture optional

Type: ReactEventHandler<HTMLImageElement>

onTouchCancel optional

Type: TouchEventHandler<HTMLImageElement>

onTouchCancelCapture optional

Type: TouchEventHandler<HTMLImageElement>

onTouchEnd optional

Type: TouchEventHandler<HTMLImageElement>

onTouchEndCapture optional

Type: TouchEventHandler<HTMLImageElement>

onTouchMove optional

Type: TouchEventHandler<HTMLImageElement>

onTouchMoveCapture optional

Type: TouchEventHandler<HTMLImageElement>

onTouchStart optional

Type: TouchEventHandler<HTMLImageElement>

onTouchStartCapture optional

Type: TouchEventHandler<HTMLImageElement>

onPointerDown optional

Type: PointerEventHandler<HTMLImageElement>

onPointerDownCapture optional

Type: PointerEventHandler<HTMLImageElement>

onPointerMove optional

Type: PointerEventHandler<HTMLImageElement>

onPointerMoveCapture optional

Type: PointerEventHandler<HTMLImageElement>

onPointerUp optional

Type: PointerEventHandler<HTMLImageElement>

onPointerUpCapture optional

Type: PointerEventHandler<HTMLImageElement>

onPointerCancel optional

Type: PointerEventHandler<HTMLImageElement>

onPointerCancelCapture optional

Type: PointerEventHandler<HTMLImageElement>

onPointerEnter optional

Type: PointerEventHandler<HTMLImageElement>

onPointerLeave optional

Type: PointerEventHandler<HTMLImageElement>

onPointerOver optional

Type: PointerEventHandler<HTMLImageElement>

onPointerOverCapture optional

Type: PointerEventHandler<HTMLImageElement>

onPointerOut optional

Type: PointerEventHandler<HTMLImageElement>

onPointerOutCapture optional

Type: PointerEventHandler<HTMLImageElement>

onGotPointerCapture optional

Type: PointerEventHandler<HTMLImageElement>

onGotPointerCaptureCapture optional

Type: PointerEventHandler<HTMLImageElement>

onLostPointerCapture optional

Type: PointerEventHandler<HTMLImageElement>

onLostPointerCaptureCapture optional

Type: PointerEventHandler<HTMLImageElement>

onScroll optional

Type: UIEventHandler<HTMLImageElement>

onScrollCapture optional

Type: UIEventHandler<HTMLImageElement>

onWheel optional

Type: WheelEventHandler<HTMLImageElement>

onWheelCapture optional

Type: WheelEventHandler<HTMLImageElement>

onAnimationStart optional

Type: AnimationEventHandler<HTMLImageElement>

onAnimationStartCapture optional

Type: AnimationEventHandler<HTMLImageElement>

onAnimationEnd optional

Type: AnimationEventHandler<HTMLImageElement>

onAnimationEndCapture optional

Type: AnimationEventHandler<HTMLImageElement>

onAnimationIteration optional

Type: AnimationEventHandler<HTMLImageElement>

onAnimationIterationCapture optional

Type: AnimationEventHandler<HTMLImageElement>

onTransitionEnd optional

Type: TransitionEventHandler<HTMLImageElement>

onTransitionEndCapture optional

Type: TransitionEventHandler<HTMLImageElement>

loader optional

Type: ImageLoader

quality optional

Type: number | ${number}``

priority optional

Type: boolean

placeholder optional

Type: PlaceholderValue

blurDataURL optional

Type: string

unoptimized optional

Type: boolean

overrideSrc optional

Type: string

onLoadingComplete optional
@deprecated Use onLoad instead. @see https://nextjs.org/docs/app/api-reference/components/image#onload
Type: OnLoadingComplete

layout optional
@deprecated Use fill prop instead of layout="fill" or change import to next/legacy/image. @see https://nextjs.org/docs/api-reference/next/legacy/image
Type: string

objectFit optional
@deprecated Use style prop instead.
Type: string

objectPosition optional
@deprecated Use style prop instead.
Type: string

lazyBoundary optional
@deprecated This prop does not do anything.
Type: string

lazyRoot optional
@deprecated This prop does not do anything.
Type: string