@feverus/react-custom-cursor
TypeScript icon, indicating that this package has built-in type declarations

0.1.7 • Public • Published

Кастомные курсоры для React приложений

Установка

npm i @feverus/react-custom-cursor

Демо страница

https://react-custom-cursor-demo.vercel.app

Использование:

import { CustomCursor } from '@feverus/react-custom-cursor'
import '@feverus/react-custom-cursor/dist/style.css'

const muCursor = 'любой JSX элемент, строка или предустановленный курсор из списка ниже'

<CustomCursor cursor={muCursor}>
   <>ваш компонент</>
</CustomCursor>

Параметры:

Название Тип По умолчанию Описание
hoverClassName string style.css > .hover Стиль курсора при наведении на <a> или <button>
scale number 1 Изменяет масштаб курсора
rotating boolean | 'auto' | 'onMove' false Без вращения
true - Поворачивает курсор вокруг центра области. Обратите внимание, что угол в 0 радиан это направление от правого края к центру. Это важно для создания нового курсора.
onMove - поворачивает курсор при движении мыши.
auto - поворачивает курсор случайным образом раз в секунду.

Предустановленные курсоры

Стрелка

import { RotatingArrow } from '@feverus/react-custom-cursor'

Лазерная указка

import { LaserDot } from '@feverus/react-custom-cursor'

Текст по окружности

import { CircleWithText } from '@feverus/react-custom-cursor'

<CustomCursor cursor={<CircleWithText text={'any text'} color={'any color'} />}>
   ...
</CustomCursor>
Название Тип По умолчанию Описание
text string '...' Текст надписи (до 30 символоов)
color string 'black' Цвет надписи
donutColor string '#eeeeee90' Цвет подложки под текстом

Для замены курсора на всей странице

Оберните самый верхний компонент

<CustomCursor cursor={'🦝'}>
   <App />
</CustomCursor>

Возможно, понадобится добавить стиль для него

#root>div {
   width: 100vw;
   min-height: 100vh;
}

Package Sidebar

Install

npm i @feverus/react-custom-cursor

Weekly Downloads

11

Version

0.1.7

License

MIT

Unpacked Size

54.4 kB

Total Files

17

Last publish

Collaborators

  • feverus