use-demo-pointer v0.0.2-beta.1

use-demo-pointer

This package provides a React hook that allows you to create a custom cursor for a specific component in your React application. The custom cursor can be an image or any other HTML element that you want to use.

Installation

To install the package, run the following command:

npm install use-demo-pointer

Usage

To use the custom cursor hook, import it into your React component and call it like this:

import React from 'react';
import useDemoPointer from 'use-demo-pointer';

function MyComponent() {
  const { ref } = useDemoPointer();

  return (
    <div ref={ref}>
      {/* Your component content */}
    </div>
  );
}

export default MyComponent;

The useDemoPointer hook returns an object with a ref property that you can attach to the component that you want to apply the custom cursor to.

By default, the custom cursor will be a small circle with a background color of white and a border color of black. You can customize the appearance of the cursor by passing an options object to the useDemoPointer hook like this:

const { ref } = useDemoPointer({
  cursor: 'url(cursor.png), auto',
  size: 20,
  borderRadius: '50%',
  backgroundColor: 'red',
  borderColor: 'blue',
});

The cursor option allows you to specify the CSS cursor property for the custom cursor. You can use any valid CSS value for this property, including URLs to images.

The size option allows you to specify the size of the custom cursor in pixels.

The borderRadius option allows you to specify the border radius of the custom cursor in CSS units.

The backgroundColor option allows you to specify the background color of the custom cursor.

The borderColor option allows you to specify the border color of the custom cursor.