# 停靠栏

- 页面: https://jiguang132.com/zh/resources/magic-ui/docs/dock
- 资源: 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/dock.json
```

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

## 使用与验证

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

## 来源

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

---


## 适用场景

指针靠近时放大停靠栏条目。

## 示例使用的原生参数

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

| 所属组件参数 | 说明 | 示例来源 |
| --- | --- | --- |
| `Dock.direction` (dock) | 原生方向枚举，不同组件的可选值不同。 | `examples/dock-demo.tsx`、`examples/dock-demo-2.tsx` |
| `Dock.children` (dock) | 原生子内容，保留所属组件对文本/元素的约束。 | `examples/dock-demo.tsx`、`examples/dock-demo-2.tsx`、`examples/dock-demo-3.tsx` |
| `DockIcon.children` (dock) | 原生子内容，保留所属组件对文本/元素的约束。 | `examples/dock-demo.tsx`、`examples/dock-demo-2.tsx`、`examples/dock-demo-3.tsx` |
| `Dock.iconMagnification` (dock) | Dock 放大后的图标尺寸。 | `examples/dock-demo-3.tsx` |
| `Dock.iconDistance` (dock) | Dock 图标响应指针的距离范围。 | `examples/dock-demo-3.tsx` |
| `DockIcon.className` (dock) | 当前原生组件的样式类，需先配置 Tailwind 与所需 CSS。 | `examples/dock-demo-3.tsx` |

## 交互与状态检查

- 停靠栏 · 默认示例 — `dock-demo`
- 停靠栏 · 示例 2 — `dock-demo-2`
- 停靠栏 · 示例 3 — `dock-demo-3`

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

## 业务接入边界

DockIcon 是原生组合辅助组件；内部使用有名称的真实链接/按钮，单独验证触屏和键盘行为。

## 宿主与动画配置

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


## 可用状态与示例

停靠栏 · 默认示例、停靠栏 · 示例 2、停靠栏 · 示例 3

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



## 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/dock
```

</TabsContent>

<TabsContent value="manual">

<Steps>

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



<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsContent>

</Tabs>

## Examples

### Custom Direction



### Custom magnification



## Usage

```tsx showLineNumbers
import { Home, Search, Settings } from "lucide-react"

import { Dock, DockIcon } from "@/components/ui/dock"
```

```tsx showLineNumbers
<Dock>
  <DockIcon>
    <Home />
  </DockIcon>
  <DockIcon>
    <Settings />
  </DockIcon>
  <DockIcon>
    <Search />
  </DockIcon>
</Dock>
```

## Props

### Dock

| Prop                   | Type        | Default    | Description                          |
| ---------------------- | ----------- | ---------- | ------------------------------------ |
| `className`            | `string`    | `-`        | Custom CSS class for styling         |
| `children`             | `ReactNode` | `-`        | Children elements                    |
| `iconSize`             | `number`    | `40`       | Size of the icon                     |
| `iconMagnification`    | `number`    | `60`       | Level of icon magnification          |
| `iconDistance`         | `number`    | `140`      | Distance from cursor to magnify icon |
| `direction`            | `string`    | `"middle"` | Direction of the dock                |
| `disableMagnification` | `boolean`   | `false`    | Disable Magnification on hover       |

### DockIcon

| Prop            | Type                | Default | Description                          |
| --------------- | ------------------- | ------- | ------------------------------------ |
| `size`          | `number`            | `40`    | Size of the icon                     |
| `magnification` | `number`            | `60`    | Level of icon magnification          |
| `distance`      | `number`            | `140`   | Distance from cursor to magnify icon |
| `mouseX`        | `any`               | `-`     | Mouse X position for magnification   |
| `className`     | `string`            | `-`     | Custom CSS class for styling         |
| `children`      | `React.ReactNode`   | `-`     | Children elements                    |
| `props`         | `PropsWithChildren` | `-`     | Additional props                     |

## Credits

- Credits to [Build UI](https://buildui.com/recipes/magnified-dock) for this fantastic component
- Credits to [Ritesh Bucha](https://twitter.com/bucha_ritesh) for finding and improving it




## 完整示例安装

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

### 停靠栏 · 默认示例

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

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

依赖: `@radix-ui/react-separator@1.1.11`, `@radix-ui/react-slot@1.3.0`, `@radix-ui/react-tooltip@1.2.12`, `class-variance-authority@0.7.1`, `clsx@2.1.1`, `lucide-react@1.24.0`, `motion@12.42.2`, `next@16.4.0`, `tailwind-merge@3.6.0`

### 停靠栏 · 示例 2

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

默认导入: `@/components/magicui/examples/dock-demo-2`

依赖: `class-variance-authority@0.7.1`, `clsx@2.1.1`, `motion@12.42.2`, `tailwind-merge@3.6.0`

### 停靠栏 · 示例 3

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

默认导入: `@/components/magicui/examples/dock-demo-3`

依赖: `class-variance-authority@0.7.1`, `clsx@2.1.1`, `motion@12.42.2`, `tailwind-merge@3.6.0`

### 最小使用与主题

```tsx
import Demo from '@/components/magicui/examples/dock-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
Dock({
      className,
      children,
      iconSize = DEFAULT_SIZE,
      iconMagnification = DEFAULT_MAGNIFICATION,
      disableMagnification = DEFAULT_DISABLEMAGNIFICATION,
      iconDistance = DEFAULT_DISTANCE,
      direction = "middle",
      ...props
    }, ref)

DockIcon({
  size = DEFAULT_SIZE,
  magnification = DEFAULT_MAGNIFICATION,
  disableMagnification,
  distance = DEFAULT_DISTANCE,
  mouseX,
  className,
  children,
  ...props
}: DockIconProps)
```



```ts
export interface DockProps extends VariantProps<typeof dockVariants> {
  className?: string
  iconSize?: number
  iconMagnification?: number
  disableMagnification?: boolean
  iconDistance?: number
  direction?: "top" | "middle" | "bottom"
  children: React.ReactNode
}

export interface DockIconProps extends Omit<
  MotionProps & React.HTMLAttributes<HTMLDivElement>,
  "children"
> {
  size?: number
  magnification?: number
  disableMagnification?: boolean
  distance?: number
  mouseX?: MotionValue<number>
  className?: string
  children?: React.ReactNode
  props?: PropsWithChildren
}
```


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

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


```ts
// Dock
iconSize = DEFAULT_SIZE

// Dock
iconMagnification = DEFAULT_MAGNIFICATION

// Dock
disableMagnification = DEFAULT_DISABLEMAGNIFICATION

// Dock
iconDistance = DEFAULT_DISTANCE

// Dock
direction = "middle"

// DockIcon
size = DEFAULT_SIZE

// DockIcon
magnification = DEFAULT_MAGNIFICATION

// DockIcon
distance = DEFAULT_DISTANCE
```


### 原生与外部类型

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


```ts
HTMLDivElement
VariantProps<typeof dockVariants>
React.ReactNode
Omit<
  MotionProps & React.HTMLAttributes<HTMLDivElement>,
  "children"
>
MotionProps
React.HTMLAttributes<HTMLDivElement>
MotionValue<number>
PropsWithChildren
```

---

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