π Introducing Universal Image Component: The Ultimate React/NextJS Image Solution! πΈ
Are you looking for a flexible solution to handle images in your React projects? Universal Image Component is here to simplify your image management, offering a range of modes to suit your needs. From Base64 conversion to CDN optimization, and more, this library is designed to make working with images effortless.
SH20RAJ / universal-image-component
universal-img-component is a versatile React component that simplifies handling images in various modes, including Base64, CDN, text-based images, and Next.js optimization. Perfect for any project needing dynamic image handling!
Universal Image Component πΈ
universal-img-component
is a versatile React component that simplifies handling images in various modes, including Base64, CDN, text-based images, and Next.js optimization. Perfect for any project needing dynamic image handling!
Features β¨
- Normal Mode: Display images using standard URLs.
- Cloudinary Mode (Recommended): Use Cloudinary for image transformations and optimizations.
- Base64 Mode: Convert images to Base64 format.
- CDN Mode: Optimize images using a CDN service.
- Text Mode: Create text-based images with Staticallyβs Open Graph service.
- TextBase Mode: Convert text-based image URLs to Base64.
-
Next Mode: Use Next.js
Image
component for optimization (in a Next.js environment).
Installation π
To get started, install the package via npm or yarn:
npm install universal-img-component
# or
yarn add universal-img-component
Usage π
Importing the Component
Import the Img
component:
import Img from 'universal-img-component';
Normal Mode πΌοΈ
Displays an image using the standard URL:
<Img src
β¦π― Key Modes Explained
- Base64 Conversion π Convert images to Base64 format directly in your application. This is useful for embedding images inline or when you need to ensure that images are included with your HTML or CSS.
Sample Code:
import Img from 'universal-img-component';
function App() {
return (
<div>
<h2>Base64 Mode</h2>
<Img
src="https://via.placeholder.com/150"
alt="placeholder"
mode="base64"
width="300px"
height="300px"
/>
</div>
);
}
- CDN Optimization π Leverage the ImageCDN service to optimize and deliver images efficiently. This mode is ideal for improving performance and scalability, especially when handling a large number of images.
Sample Code:
import Img from 'universal-img-component';
function App() {
return (
<div>
<h2>CDN Mode</h2>
<Img
src="https://via.placeholder.com/150"
alt="placeholder"
mode="cdn"
width="300px"
height="300px"
/>
</div>
);
}
- Text-Based Images π Create dynamic images with custom text using the Statically service. This mode allows you to generate images on-the-fly with personalized text and styling options.
Sample Code:
import Img from 'universal-img-component';
function App() {
return (
<div>
<h2>Text-Based Image Mode</h2>
<Img
text="Hello World"
mode="textbase"
fontsize="40px"
width="300px"
height="150px"
/>
</div>
);
}
-
Next.js Optimization π
For Next.js projects, this mode uses the built-in
Image
component from Next.js for optimized image loading and performance.
Sample Code:
import Img from 'universal-img-component';
function App() {
return (
<div>
<h2>Next.js Mode</h2>
<Img
src="https://via.placeholder.com/150"
alt="placeholder"
mode="next"
width="300px"
height="300px"
/>
</div>
);
}
-
Normal Mode (Default) π
Displays the image using the standard
img
tag. This mode is used when no special processing is required.
Sample Code:
import Img from 'universal-img-component';
function App() {
return (
<div>
<h2>Normal Mode</h2>
<Img
src="https://via.placeholder.com/150"
alt="placeholder"
mode="normal"
width="300px"
height="300px"
/>
</div>
);
}
π How to Get Started
- Install the Package:
npm install universal-img-component
or
yarn add universal-img-component
Use the Component:
Import and use theImg
component in your React project with the mode of your choice.Customize as Needed: Adjust props such as
mode
,format
,fit
,text
,fontsize
, and others to suit your project's requirements.
π Why Choose Universal Image Component?
- Versatility: Handles various image modes and formats.
- Simplicity: Easy to use with minimal configuration.
- Performance: Optimizes image delivery and display.
- Flexibility: Supports different projects, from standard React apps to Next.js applications.
π Try It Out Today!
Upgrade your image handling with Universal Image Component and experience a new level of ease and efficiency. Check out our GitHub repository for more details, documentation, and to contribute!
Feel free to reach out to us at sh20raj@gmail.com for any questions or feedback. Happy coding! π
Top comments (0)