https://github.com/imgeng/imageengine-react
Provides custom components for integrating ImageEngine into React web apps
https://github.com/imgeng/imageengine-react
Last synced: 2 months ago
JSON representation
Provides custom components for integrating ImageEngine into React web apps
- Host: GitHub
- URL: https://github.com/imgeng/imageengine-react
- Owner: imgeng
- License: mit
- Created: 2021-03-09T10:37:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-02T01:30:04.000Z (3 months ago)
- Last Synced: 2025-03-19T03:06:46.677Z (2 months ago)
- Language: TypeScript
- Size: 90.8 KB
- Stars: 2
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React components for ImageEngine integration
Hassle-free way to deliver optimized responsive images in your React applications.
## Quick start
The package includes four components:
* `ImageEngineProvider`
* `Image`
* `Picture`
* `Source`
To start using provided image tags in your application, place `ImageEngineProvider` somewhere above them in the DOM tree with the `deliveryAddress` prop set to your [ImageEngine Delivery Address](https://support.imageengine.io/hc/en-us/articles/360059238371-Quick-Start):
```jsx
import { ImageEngineProvider } from "@imageengine/react"
function App () {
return (
...
)
}
```
```jsx
import { Image } from "@imageengine/react"
function ShoppingCart () {
return (
...
)
}
```
[Demo app on CodeSandbox](https://codesandbox.io/p/sandbox/imageenginereactdemo-pjfp7z)
## Component props reference
### ImageEngineProvider
`deliveryAddress` - [ImageEngine Delivery Address](https://support.imageengine.io/hc/en-us/articles/360059238371-Quick-Start):
```ts
deliveryAddress: string
```
`stripFromSrc` - Strip away a portion of a source string in all ImageEngine's components. Particularly useful if your images are coming from a headless CMS and you need to erase something in received URL path (origin, for example):
```ts
stripFromSrc?: string
```
### Image
`src` - Relative path to the image:
```ts
src: string
```
`directives` - ImageEngine directives:
```ts
directives?: {
// Define desired width.
width?: number
// Set width to auto (with fallback).
autoWidthWithFallback?: number
// Define desired height.
height?: number
// Adjust compression.
// Possible range: 0-100.
compression?: number
// Define desired output format.
outputFormat?:
| "png"
| "gif"
| "jpg"
| "bmp"
| "webp"
| "jp2"
| "svg"
| "mp4"
| "jxr"
| "avif"
| "jxl"
// Define desired fit method.
fitMethod?: "stretch" | "box" | "letterbox" | "cropbox"
// Don't apply any optimizations to the origin image.
noOptimization?: true
// Adjust sharpness.
// Possible range: 0-100.
sharpness?: number
// Define rotation.
// Possible range: -360 to 360.
rotate?: number
// Use WURFL to calculate screen's width and then scale the image accordingly.
// Possible range: 0-100 (float).
scaleToScreenWidth?: number
// Crop the image [width, height, left, top].
crop?: number[]
// Convert the image into a data url.
inline?: true
// Keep EXIF data.
keepMeta?: true
force_download?: true;
max_device_pixel_ratio?: 2.1; // 1-4 float
}
```
`srcSet` - List of image variations for the image source set:
```ts
srcSet?: [{
// Relative path to the image.
src: string
// Width descriptor.
width: string
// Custom optimization instructions.
directives?: TDirectives
}]
```
### Source
`srcSet` - List of image variations for the image source set:
```ts
srcSet?: [{
// Relative path to the image.
src: string
// Width descriptor.
width: string
directives?: TDirectives
}]
```