# 平滑光标

- 页面: https://jiguang132.com/zh/resources/magic-ui/docs/smooth-cursor
- 资源: Magic UI (https://jiguang132.com/zh/resources/magic-ui.md)
- 全部指南: https://jiguang132.com/zh/resources/magic-ui/docs.md

Magic UI 的独立组件，请不要替换为 JGuang UI/Base UI 的同名 API。

## 安装

```bash
npx shadcn@latest add https://jiguang132.com/r/magic-ui/smooth-cursor.json
```

Registry 将复制可编辑源码和依赖到独立命名空间。检查主题变量与 Tailwind CSS v4 配置；不要覆盖已有的项目组件。

## 使用与验证

在左侧选择组件，在预览中操作它的状态；使用“查看代码”检查真实源码。安装后执行类型检查和构建，再验证键盘焦点、手机布局与深浅色主题。

## 来源

https://github.com/magicuidesign/magicui/tree/cdb348cb4c72a9b54b554d8617801e479fbc8714
MIT 许可证；不包括付费内容。下方提供上游英文参考内容，中文使用指南已适配；上游详细参考暂保留英文。

---


## 适用场景

通过弹簧动画让光标平滑跟随指针。

## 示例使用的原生参数

从该组件全部本地示例的 JSX 提取，按导入模块及组件区分；包括复合示例中实际使用的其他 Magic UI 组件。不是全部属性清单，也不是宿主通用 variant API。展开对象需结合示例数据声明；完整类型与默认值见下方源码参考。

示例使用原生默认配置，不传入额外参数；可选 API 见源码参考。

## 交互与状态检查

- 平滑光标 · 默认示例 — `smooth-cursor-demo`

这些名称是实际示例入口，不是新增组件属性或独立组件数量。选择对应示例后，检查指针/键盘行为、深浅色、手机尺寸和加载失败；纯装饰特效不应伪造禁用、错误或提交状态。完整示例安装包含其真实依赖闭包。

## 业务接入边界

光标属于当前文档且仅作装饰；避免重复挂载光标引擎或隐藏必要的原生交互提示。

## 宿主与动画配置

初始化 Tailwind CSS v4、语义 CSS 变量及 dark 变体；按本地 Registry 的独立命名空间导入。复用已有 next-themes Provider，不混入 JGuang UI/Base UI/HeroUI API。进入视口再挂载特效，离开后卸载；为 Canvas/WebGL 不可用、网络媒体失败提供静态替代。遵循 prefers-reduced-motion，并验证计时器、RAF、观察器和事件监听已清理；不能仅凭 CSS 停止就宣称引擎已停止。示例不提供后端、登录、支付或真实 AI 流。这里的实用指南为双语，上游详细参考和演示文本仍保留原文。


## 可用状态与示例

平滑光标 · 默认示例

组件中的状态与数据为演示用途，不包含后端接口。接入实际项目时请检查源码中的公开参数，再连接业务数据。



## Features

- 🎯 Smooth physics-based cursor animations
- 🔄 Rotation effects based on movement direction
- ⚡ Performance optimized with RAF
- 🎨 Fully customizable cursor design
- 📦 Lightweight and easy to implement

## Installation

<Tabs defaultValue="cli">

<TabsList>
  <TabsTrigger value="cli">CLI</TabsTrigger>
  <TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent value="cli">

```bash
npx shadcn@latest add @magicui/smooth-cursor
```

</TabsContent>

<TabsContent value="manual">

<Steps>

<Step>Copy and paste the following code into your project.</Step>



<Step>Add the component to your page or layout.</Step>

```tsx showLineNumbers
import { SmoothCursor } from "@/components/ui/smooth-cursor"

export default function Page() {
  return (
    <>
      <SmoothCursor />
      {/* Your page content */}
    </>
  )
}
```

</Steps>

</TabsContent>

</Tabs>

## Usage

```tsx showLineNumbers
import { SmoothCursor } from "@/components/ui/smooth-cursor"
```

```tsx showLineNumbers
<SmoothCursor />
```

## Hiding Default Browser Cursor

To prevent the default browser cursor from overlapping with the custom cursor, add the following CSS globally:

```css showLineNumbers
* {
  cursor: none !important;
}
```

### Optional: Keep text cursor for inputs

```css showLineNumbers
input,
textarea,
select {
  cursor: text !important;
}
```

💡 If you're using Tailwind CSS, you can add cursor-none to your layout wrapper:

```tsx showLineNumbers
<div className="cursor-none">
  <SmoothCursor />
  {/* your app */}
</div>
```

## Props

| Prop           | Type              | Default                | Description                                            |
| -------------- | ----------------- | ---------------------- | ------------------------------------------------------ |
| `cursor`       | `React.ReactNode` | `<DefaultCursorSVG />` | Custom cursor component to replace the default cursor  |
| `springConfig` | `SpringConfig`    | See below              | Configuration object for the spring animation behavior |

### SpringConfig Type

```typescript showLineNumbers
interface SpringConfig {
  damping: number // Controls how quickly the animation settles
  stiffness: number // Controls the spring stiffness
  mass: number // Controls the virtual mass of the animated object
  restDelta: number // Controls the threshold at which animation is considered complete
}
```

### Default Spring Configuration

```typescript showLineNumbers
const defaultSpringConfig = {
  damping: 45,
  stiffness: 400,
  mass: 1,
  restDelta: 0.001,
}
```

## Browser Support

Compatible with all modern browsers that support:

- `requestAnimationFrame`
- CSS transforms
- Pointer events
- Hover-capable fine pointers (mouse or trackpad)

Touch-first devices are ignored automatically to prevent the custom cursor from appearing after taps.

## Accessibility

When using this component, consider that:

- Users navigating via keyboard will not see the custom cursor
- You may want to provide alternative visual cues for interactive elements
- Some users may have motion sensitivity, so consider providing a way to disable the animation

## Credits

- Credit to [@Code_Parth](https://twitter.com/Code_Parth) for the original concept and implementation




## 完整示例安装

组件安装命令只安装组件；下列示例命令还包含该示例实际导入的其他组件、原生辅助 UI、工具和固定版本依赖。辅助源码不算独立组件。

### 平滑光标 · 默认示例

```bash
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/smooth-cursor/smooth-cursor-demo.json
```

默认导入: `@/components/magicui/examples/smooth-cursor-demo`

依赖: `clsx@2.1.1`, `motion@12.42.2`, `tailwind-merge@3.6.0`

### 最小使用与主题

```tsx
import Demo from '@/components/magicui/examples/smooth-cursor-demo';
import { ThemeProvider } from 'next-themes';
export default function Example() {
  return <ThemeProvider attribute="class" defaultTheme="system" enableSystem><Demo /></ThemeProvider>;
}

```

项目须先配置 Tailwind CSS v4、语义颜色变量和 dark 变体。已有 next-themes Provider 时复用它，不要重复嵌套。Next Link 示例需要 Next.js 环境；静态 Vite 项目可保留原生组件代码，并自行将示例的页面链接改为项目路由。部分演示图片、视频和推文依赖网络；示例不包含登录或后端服务。实用指南与示例标签已提供中文，上游详细英文参考及演示数据未宣称全文翻译。


## 源码参数参考

以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制；不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用，不是新增业务属性。此区域是原始类型参考，不是上游说明的全文翻译。


```ts
SmoothCursor({
  cursor = <DefaultCursorSVG />,
  springConfig = {
    damping: 45,
    stiffness: 400,
    mass: 1,
    restDelta: 0.001,
  },
}: SmoothCursorProps)
```



```ts
export interface SmoothCursorProps {
  cursor?: React.ReactNode
  springConfig?: {
    damping: number
    stiffness: number
    mass: number
    restDelta: number
  }
}
```


### 源码中的解构默认值

只列出直接写在参数或 props 解构中的默认表达式。条件表达式、运行时主题和其他计算值请结合源码；这里不是全部行为的默认值清单。


```ts
// SmoothCursor
cursor = <DefaultCursorSVG />

// SmoothCursor
springConfig = {
    damping: 45,
    stiffness: 400,
    mass: 1,
    restDelta: 0.001,
  }
```


### 原生与外部类型

以下外部类型仍由 React 或资源自身依赖定义，没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。


```ts
React.ReactNode
```

---

JGuang 全部资源索引: https://jiguang132.com/llms.txt