Package Exports

react-js-x-ray

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-js-x-ray) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

X-Ray In JavaScript By Amur

Install

npm i react-js-x-ray

Documentation

Default options

backgroundColor={'transparent'}
beyond={false}
diameter={150}
cursor={true}
type={'circle'}
responsive={false}
resize={[
    {
        screen: 1199,
        diameter: 130
    },
    {
        screen: 991,
        diameter: 100
    },
    {
        screen: 767,
        diameter: 80
    },
    {
        screen: 575,
        diameter: 50
    }
]}

Prototype and values

Props	Type	Value
backgroundColor	String	"transparent" or color
type	String	"circle" or "magnifyingGlass"
beyond	Boolean	true or false
diameter	Number	exp 150 (size circle)
responsive	Boolean	true or false
cursor	Boolean	true or false
resize	Array => object	[{ screen: 1199, diameter: 50}, ..., { screen: number, diameter: number}]

Example

import React from 'react';
import XRay from 'react-js-x-ray';
import img1 from './img/1.png';
import img2 from './img/2.png';

.........
.........
.........

<XRay
    images={
      [img1, img2]
    }
    beyond={false}
    diameter={100}
    cursor={true}
    responsive={true}
    type={'circle'}
    backgroundColor={'#00AAFF'}
    resize={[
        {
            screen: 1199,
            diameter: 100
        },
        {
            screen: 991,
            diameter: 50
        }
    ]}
/>