1.1.1 • Published 4 years ago

preact-hoverbox v1.1.1

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

preact-hoverbox

HoverBox is a Preact component that allows your own component's render method to behave differently if certain parts of it are being hovered on. This can be useful when you need your component to respond to hover in ways that can't be done completely by CSS.

HoverBox accepts one prop: a render function, similar to the one you'd give any Preact component. However, this function has a parameter which is set to true when the component is currently being hovered on.

Example

ES6

var HoverBox = require("preact-hoverbox");

<HoverBox render = {hover => (
    <div>
        <SomeComponent showEffect = {hover} />
        <div>Look at the shiny hover effect!</div>
    </div>
)}/>

ES5

var HoverBox = require("preact-hoverbox");

<HoverBox render = {function(hover) {
    return (
        <div>
            <SomeComponent showEffect = {hover} />
            <div>Look at the shiny hover effect!</div>
        </div>
    );
}}/>

Installation

npm install preact-hoverbox