1.1.3 • Published 7 months ago

ymage v1.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Ymage

Package is in beta - in production use is not recomended for now Ymage is react zero dependencies component that takes care of loading optimization, neat presentation, copyright protection,caching and some extras with just one line of code.

✅ Advenced progressive JPEG recognition - image is rendered on first progressive scan avaiable - before onLoad. ✅ Sized, neat image placeholders for loading, error and copyright ✅ Short props for styling ✅ Image copy protection ✅ All image formats are compatible - progressive JPEG is just recommended way ✅ Callback with image dimensions onSize

Installation

$ npm install ymage

Import module to yourcode.js:

import Ymage from 'ymage'

Usage

<Ymage url="fruit.jpg" w={300} h={200} r={10}/>

Using onSize callback:

function sizeHandler(size) 
	console.log("Image is " + size.x + " / " + size.y)
	
<Ymage copyright url={"fruit.jpg"} wh={2/3} h={200} onSize={sizeHandler} />

Styling

In order to properly create the loading shape of the Ymage, you can size it with two of the three properties (w + h), (w + wh) or (h + wh)

PropertyCSS
wwidth
hheight
whaspect-ratio (width / height)
rborder-radius
bgbackground-color
coloricons color

Behavior

In addition to following you can use other html props on Ymage like id, className, onClick etc.

PropertyDefaultDescription
url-Image url
lazy200pxViewport distance from the image that trigges loading (values like css margin). Set to false to start loading immediately.
copyrightfalseBasic anti-copy protection
typeimgHTML syntax tag to render image (img or div).
onLoad-Callback function on image fully fetched
onSize-Callback function with size (when using progressive jpeg it fires on first scan ready) returned as object in first argument onLoad={(size) => ... size.x /size.y ...}
1.1.1

7 months ago

1.1.0

7 months ago

1.1.3

7 months ago

1.1.2

7 months ago

1.0.3

8 months ago

1.0.2

8 months ago

1.0.1

8 months ago

1.0.0

8 months ago