@fenderdigital/react-image
v1.0.2
Published
Fender React UI Kit Image Component
Downloads
278
Readme
Image for Fender React UI Kit
Description
Progressive image loader
Installation and Usage
yarn add @fenderdigital/react-image --save
import Image from '@fenderdigital/react-image';
Props
alt
- Descriptive string of the image contents for accessibilitybgColor
- Tachyon class (withoutbg-
prefix) for image container background colorimages
- Array of image URLsintersectionOptions
- Object containing propters for the intersection observeronLoaded
- Callback to run after the higher fidelity image has loadedratio
- Aspect ratio of the imagetiny
- URL of a small version of the imagetransition
- CSS animation transition type
| propName | propType | defaultValue | isRequired | | ------------------- | ---------- | ------------------------------------------------- | ---------- | | alt | string | '' | false | | bgColor | string | 'near-white' | false | | images | array | [] | false | | intersectionOptions | object | { root: null, rootMargin: '0px', threshold: 0.5 } | false | | onLoaded | function | () => {} | false | | ratio | number | 9 / 16 | false | | tiny | string | null | false | | transition | string | null | false |
Development
Check the Monorepo README for development documentation.