JSPM – react-flashlight@1.0.6

Package Exports

react-flashlight

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-flashlight) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

travis

`<ReactFlashlight>`

A <ReactFlashlight> adds a flashlight effect to an element.

Click here to see a demo.

Demo source.

Installing

$ npm install react-flashlight

Exports

The default export is <ReactFlashlight>. To use it:

import { ReactFlashlight } from 'react-flashlight';

React Search Autocomplete Usage

import React from "react";
import { ReactFlashlight } from "react-flashlight";
import logo from "./logo.svg";
import './App.css';
 
const style = {
  backgroundImage: `url(${logo})`,
  height: "90vh",
  width: "90vw",
} 
 
function App() {
  
  return (
    <div className="App">
      <header className="App-header"> 
        <ReactFlashlight>
          <div style={style}>
            Hello, I am a child element.
          </div>
        </ReactFlashlight>
      </header>
    </div> 
  ); 
}

export default App;

`<ReactFlashlight>` Props:

//
// Props:
//
{
  // If true, the flashlight effect will be active (by default)
  enabled
  // Show or hide the cursor, defaults to false
  showCursor
  // Set the light size, defaults to 150px
  size
  // Set initial position, defaults to 0, 0
  initialPosition
  // Move programmatically the light to a location {x: value, y: value}
  moveTo
  // The speed of the movement transition, defaults to 1000ms
  speed
  // Let the user control the light with the mouse, defaults to true
  enableMouse
  // The "room" darkness (opacity), defaults to 0.9
  darkness
}

License

MIT

react-flashlight