sigilUI

Sigil Cursor

Apply the active preset's custom pointer treatment.

@sigil-ui/componentsReact

Preview

Live preview Interactive

Import

import { SigilCursor } from "@sigil-ui/components";

Usage

<div className="relative w-full h-32 border border-[color:var(--s-border)] flex items-center justify-center text-sm text-[var(--s-text-muted)]">
    <SigilCursor variant="dot" />
    Hover this surface to see the custom cursor
  </div>

Props

PropTypeDefaultDescription
enabledbooleantrueEnable the custom cursor.
hideNativebooleantrueHide the native cursor while this component is mounted.
variantSigilCursorVariantsigilCursor drawing style.
sizenumber | string—Cursor outer size. Accepts a number of pixels or any CSS length.
dotSizenumber | string—Center dot size. Accepts a number of pixels or any CSS length.
colorstring—Primary cursor color.
ringColorstring—Ring stroke color.
dotColorstring—Center dot color.
blendModeCSSProperties["mixBlendMode"]—CSS mix-blend-mode value.

Token integration

CSS VariablePurpose
--s-cursor-sizeCursor size
--s-cursor-colorCursor color
--s-primaryPrimary
--s-cursor-blend-modeCursor blend mode
--s-duration-fastDuration fast
--s-ease-defaultEase default
--s-cursor-opacityCursor opacity
--s-cursor-stroke-widthCursor stroke width
--s-cursor-ring-colorCursor ring color
--s-cursor-radiusCursor radius
--s-radius-fullRadius full
--s-cursor-glowCursor glow