1.1.0 • Published 9 months ago

@react-sandbox/cursor-loader v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

Usage

Install

Install the @react-sandbox/cursor-loader package:

npm install @react-sandbox/cursor-loader

Import

Import the CursorLoader component:

import React, { useState } from 'react'
import CursorLoader from '@react-sandbox/cursor-loader'

function App() {
  const [load, setLoad] = useState(0)

  return (
    <div>
      <CursorLoader load={load} />
    </div>
  )
}

Props

PropTypeDefaultDescription
loadnumberrequiredLoad/progress (between 0 and 100)
colorstring'#01D45B'Color of loader
size'sm' \| 'md' \| 'lg''sm'Size of loader
trailDelay0 \| 100 \| 200 \| 300 \| 500300Cursor trail delay
onCompletefunction-Callback function on completion
classNamestring-CSS classes
styleReact.CSSProperties-CSS styles

Development

Local

pnpm install
pnpm dev

Tests

pnpm test

Example

Inside test/:

pnpm install
pnpm dev

License

MIT