Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rmoralp/rm-react-image
Minimalistic, blazing fast and seo friendly component for React ⚛️
https://github.com/rmoralp/rm-react-image
Last synced: about 1 month ago
JSON representation
Minimalistic, blazing fast and seo friendly component for React ⚛️
- Host: GitHub
- URL: https://github.com/rmoralp/rm-react-image
- Owner: rmoralp
- Created: 2021-05-15T16:18:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-26T05:44:01.000Z (over 3 years ago)
- Last Synced: 2024-11-02T01:32:49.054Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://rm-react-image.surge.sh
- Size: 372 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
Awesome Lists containing this project
- awesome-blazingly-fast - rm-react-image - Minimalistic, blazing fast and seo friendly component for React ⚛️ (JavaScript)
README
# rm React image ⚡
[](https://badge.fury.io/js/rm-react-image)
[](https://www.npmjs.com/package/rm-react-image)
[](#contributors-)
🟢 Minimalistic, blazing fast and seo friendly component for React ⚛️
The main objective is to achieve the best possible performance without penalizing SEO. Also, it use W3C img attributes.
## Features
- ⚡️ Optimized for performance
- 📈 SEO friendly
- 😪 Lazy load support
- 🌇 Loading and error placeholders
- 🔁 Server side support (SSR)
- ☝ No dependencies, just one possible polyfill: intersection-observer polyfill
- 🗜️ 5KB gzipped (plus 1KB if you need intersection-observer)
Overview
React Slidy is a simple and minimal slider component. The main objective is to achieve the best performance and smoothness on React apps, specially on mobile 📱.
## Installation
```
# Yarn
$ yarn add rm-react-image
# NPM
$ npm i --save rm-react-image
```
## Usage
> Common usage with lazy loading for `loading="lazy"`
```javascript
import React from 'react';
import { Image } from 'rm-react-image';
const deviceUserAgent = 'googlebot'
const MyImage = ({ alt, height, src, width }) => (
);
export default MyImage;
```
Loading "lazy" attribute will act differently depends on User-Agent.
- If Image detects that User-Agent is a bot, the image will be rendered on SSR and will use [native browser lazy loading](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-loading)
- If the image detects that User-Agent is a user, the image will render when it enters to the viewport.
For that reason, it is important to pass userAgent prop on client and server-side.
### Props
| Prop | Type | Default | Description |
|:---|:---|:---|:---|
| alt | `String` | | Indicate the alternate fallback content to be displayed if the image has not been loaded |
| base64Placeholders | `Object` | `{loading: undefined, error: undefined}` | Define Base64 placeholder |
| className | `String` | | Element class name |
| decoding | `String` | | Represents a hint given to the browser on how it should decode the image. |
| height | `String` or `Number` | | Indicates the rendered height of the image in CSS pixels. |
| loading | `String` | | Determine whether to load the image immediately (`eager`) or on an as-needed basis (`lazy`). |
| onError | `Function` | | Callback triggered if an error occurs while loading an external file. |
| onLoad | `Function` | | Callback triggered if image load successfully. |
| sizes | `String` | | This string specifies a list of comma-separated conditional sizes for the image; that is, for a given viewport size, a particular image size is to be used. Read the documentation on the sizes page for details on the format of this string. |
| src | `String` | | Contains the full URL of the image including base URI. |
| srcSet | `String` | | This specifies a list of candidate images, separated by commas (`',', U+002C COMMA`). Each candidate image is a URL followed by a space, followed by a specially-formatted string indicating the size of the image. The size may be specified either the width or a size multiple. Read the srcset page for specifics on the format of the size substring. |
| style | `Object` | | CSS style properties to inline them. |
| userAgent | `String` | | Device user agent used for improve rendering strategy. |
| width | `String` or `Number` | | Indicates the rendered width of the image in CSS pixels. |
### How to
> Use error placeholder
```javascript
import React from 'react';
import { Image } from 'rm-react-image';
const deviceUserAgent = 'googlebot'
const imageProps = {
base64Placeholders: {
error: 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7'
},
onError: () => console.log('Image can not be found')
}
const MyImage = ({ alt, height, src, width }) => (
);
export default MyImage;
```
> Use loading placeholder
```javascript
import React from 'react';
import { Image } from 'rm-react-image';
const deviceUserAgent = 'googlebot'
const imageProps = {
base64Placeholders: {
loading: 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7'
},
onLoad: () => console.log('Image has been loaded'),
}
const MyImage = ({ alt, height, src, width }) => (
);
export default MyImage;
```
> Not lazy load image for `loading="eager"`
```javascript
import React from 'react';
import { Image } from 'rm-react-image';
const deviceUserAgent = 'googlebot'
const MyImage = ({ alt, height, src, width }) => (
);
export default MyImage;
```
## Browser compatibility
Supported browsers are:
- Chrome
- Firefox
- Safari 6+
- Internet Explorer 11+
- Microsoft Edge 12+
**If some of them doesn't work, please fill an issue.**
## Contribution
See [Contributing Guide](https://github.com/rmoralp/rm-react-image/tree/main/.github/contributing.md).
## License
MIT
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
