Image

Does this page need improvement? Let us know.

Sometimes we miss things. We rely on user feedback to tell us how we're doing.

LiftKit's Image component wraps around the Next.js Image component and adds a few convenience props for things like aspect-ratio.

Example Instance

<Image
  src="/testimage.png"
  alt={size}
  lk-image-width={size}
  lk-image-height={size}
  className="shadow5"
/>

content_copy

warning

Note: The above snippet omits import statements and surrounding markup. It's assumed you'd be pasting this inside the return block of an existing functional component.

Installation

Next.js

Note: Other React frameworks are not currently supported, but they might still work. Try at your own risk.

Method	Instructions
LiftKit CLI	From any Next.js project, run the following command in your terminal. `npm run add image` content_copy
Github	open_in_new View on Github

No-Code Tools

Method	Instructions
Webflow	open_in_new Clone from Made In Webflow
Figma	open_in_new Clone from Figma Community

Props

Unique

Props unique to this component.

Name	Required	Type	Description	Default Val
aspect	no	"auto" \| "1/1" \| "2.39/1" \| "2/1" \| "16/9" \| "3/2" \| "4/3" \| "5/4" \| "1/2.39" \| "1/2" \| "9/16" \| "4/5"	Sets the aspect ratio of the image	undefined
borderRadius	no	LkSizeUnit \| "none" \| "zero"	Controls the border radius applied to the image	undefined
height	no	LkSizeUnit \| "auto"	Specifies the height of the image	undefined
objectFit	no	CSSProperties["objectFit"]	Sets how the image should fit its container	undefined
width	no	LkSizeUnit \| "auto"	Specifies the width of the image	undefined

Common

Props with globally-defined behavior that are used in multiple components.

Common Props	Status
{children}	Not Supported
Native HTML attributes	Supported

Ask the LiftKit Devs