Skip to content
This repository has been archived by the owner on Oct 17, 2021. It is now read-only.

Higly customizable custom cursor component, with transitions.

Notifications You must be signed in to change notification settings

timmilesdw/react-cursor-custom

Repository files navigation

react-cursor

ARCHIVED Component is not supported anymore, feel free to fork

React custom cursor component

NPM JavaScript Style Guide

Example

React Custom Cursor Demo

Installation

npm install --save react-cursor-custom

or

yarn add react-cursor-custom

Usage

import CursorProvider from 'react-cursor-custom' and wrap your main component with it.

import React from 'react'

import { CursorProvider } from 'react-cursor-custom'

const App = () => {
  return (
    <CursorProvider>
      <YourMainComponent/>
    <CursorProvider/>
  )
}

API

Prop name Description
color [string] color of ring and dot default is black
noRing [boolean] hide the outside ring
ringSize [number] size of the ring
transitionTime [number] transition time in ms

License

MIT © timmilesdw

About

Higly customizable custom cursor component, with transitions.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published