Skip to main content

Quick Start

Let's discover react-cursorify in less than 5 minutes.

Getting Started​

Let's apply react-cursorify!

Install react-cursorify​

You can install react-cursorify in your React project using the two commands below.

via npm:

npm install @cursorify/react

or via yarn:

yarn add @cursorify/react

Apply to your react project​

To apply react-cursorify, simply wrap your React project with CursorifyProvider. It's easy, right?

import { CursorifyProvider } from '@cursorify/react'

const App = () => {
  return (
    <CursorifyProvider>
      <>{/*....your component */}</>
    </CursorifyProvider>
  )
}

export default App

And that's it! It's really simple, isn't it?

If you want to change the options of the default cursor, you can refer to Cursorify options.

If you want to apply styles to the cursor, you can refer to Apply cursor style.

And if you want to apply custom cursor component, you can check out Custom cursor!