imageengine-reactnative
v0.1.1
Published
imageengine support for react-native
Downloads
4
Maintainers
Readme
ImageEngine React Native
This project provides a React Native package for building optimized image URLs using ImageEngine. It includes utility functions and components to handle responsive images efficiently.
Installation
npm install imageengine-reactnative
Usage
Utilities (src/utils.ts
)
generateOptimizedImageUrl
: Constructs an optimized image URL based on the providedsrcSet
,deliveryAddress
, and other parameters.chooseAppropriateImage
: Selects the best image from asrcSet
that fits the available screen width.processUrl
: Cleans up the URL by removing unwanted parts and checks for supported image formats.constructUrl
: Builds the final image URL using the provided source and directives.
Responsive Component (src/responsive_comp.tsx
)
ResponsiveImage
: A React component that renders an image optimized for the current screen size. It usesgenerateOptimizedImageUrl
to determine the best image URL to use.
Example Application (example/src/App.tsx
)
App
: Demonstrates the usage of theResponsiveImage
component with a predefinedsrcSet
. It logs when the component is rendered and displays a sample image.
Types
IEFormat
: Enum for supported image formats.IEFit
: Enum for image fit options.IEDirectives
: Class defining image transformation directives.