nejcm / react-image

React image and background image component.

🖼️ React image

A simple react image and background image component with support for responsive images, fallback image, lazy loading and loader.

Table of Contents

• Installation
• Usage
• Docs & Examples
• Issues
  • 🐛 Bugs
  • 💡 Feature Requests
  • ❓ Questions
• Authors
• Contributors
• Support
• LICENSE

Installation

Peer dependencies

react-image requires the following peer dependencies to work. Make sure to have them installed in your project.

You can skip this step if those packages are already installed in your project.

# with styled-components
$ npm install react react-dom styled-components --save
# with emotion
$ npm install react react-dom @emotion/styled @emotion/core --save

Package

# with styled-components
$ npm install @nejcm/react-image --save
# with emotion
$ npm install @nejcm/react-image-emotion --save

Usage

// with styled-components
import {Image, BackgroundImage} from '@nejcm/react-image';
// with emotion
import {Image, BackgroundImage} from '@nejcm/react-image-emotion';

For more examples check the docs.

Docs & Examples

Docs & Examples

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

❓ Questions

For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

Authors

• Nejc Muršič ( GitHub, LinkedIn )

Contributors

Nejc Muršič 💻 📖 🚇 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

Support

Reach out to us at one of the following places:

• 🌐 Website
• 📧 Email

LICENSE

MIT