cursor-flashlight 🔦

A tiny library to add flashlight effect to your website 🔦

Try it on CodeSandbox

!demo

> Note:
> The effect won't show on devices without mouse (e.g.: smartphones)

Usage

Simply import the module and enable the flashlight with the size of the flashlight circle.

``ts
import { enable } from 'cursor-flashlight';

enable({ size: '15vmax' });
`

$3

`tsx
import React from 'react';
import {
enable,
disable,
isEnabled,
} from 'cursor-flashlight';

const App = () => {
const handleToggleFlashlight = () => {
if (isEnabled()) {
disable()
} else {
enable({ size: '15vmax' })
}
}

return (

Lorem ipsum stuffs
Toggle flashlight

)
};
``