边框光束
Magic UI 的独立组件,请不要替换为 JGuang UI/Base UI 的同名 API。
安装
npx shadcn@latest add https://jiguang132.com/r/magic-ui/border-beam.json
Registry 将复制可编辑源码和依赖到独立命名空间。检查主题变量与 Tailwind CSS v4 配置;不要覆盖已有的项目组件。
使用与验证
在左侧选择组件,在预览中操作它的状态;使用“查看代码”检查真实源码。安装后执行类型检查和构建,再验证键盘焦点、手机布局与深浅色主题。
来源
https://github.com/magicuidesign/magicui/tree/cdb348cb4c72a9b54b554d8617801e479fbc8714 MIT 许可证;不包括付费内容。下方提供上游英文参考内容,中文使用指南已适配;上游详细参考暂保留英文。
适用场景
沿定位容器边缘展示移动光束。
示例使用的原生参数
从该组件全部本地示例的 JSX 提取,按导入模块及组件区分;包括复合示例中实际使用的其他 Magic UI 组件。不是全部属性清单,也不是宿主通用 variant API。展开对象需结合示例数据声明;完整类型与默认值见下方源码参考。
| 所属组件参数 | 说明 | 示例来源 |
|---|---|---|
BorderBeam.duration (border-beam) | 原生动画时长;数值/CSS 单位随所属组件不同,见源码默认值。 | examples/border-beam-demo.tsx、examples/border-beam-demo-2.tsx、examples/border-beam-demo-3.tsx |
BorderBeam.size (border-beam) | 原生光束尺寸,不是通用按钮尺寸 API。 | examples/border-beam-demo.tsx、examples/border-beam-demo-2.tsx、examples/border-beam-demo-3.tsx、examples/border-beam-demo-4.tsx |
BorderBeam.className (border-beam) | 当前原生组件的样式类,需先配置 Tailwind 与所需 CSS。 | examples/border-beam-demo-2.tsx、examples/border-beam-demo-3.tsx、examples/border-beam-demo-4.tsx |
BorderBeam.delay (border-beam) | 原生开始延迟,不能混用 Motion 秒与打字/终端毫秒。 | examples/border-beam-demo-2.tsx |
BorderBeam.borderWidth (border-beam) | 光束边框厚度,单位像素。 | examples/border-beam-demo-2.tsx |
BorderBeam.reverse (border-beam) | 反转所属特效的运动方向。 | examples/border-beam-demo-3.tsx |
BorderBeam.initialOffset (border-beam) | BorderBeam 路径上的初始百分比偏移。 | examples/border-beam-demo-4.tsx |
BorderBeam.transition (border-beam) | 原生 Motion 过渡对象,保留其支持类型。 | examples/border-beam-demo-4.tsx |
交互与状态检查
- 边框光束 · 默认示例 —
border-beam-demo - 边框光束 · 示例 2 —
border-beam-demo-2 - 边框光束 · 示例 3 —
border-beam-demo-3 - 边框光束 · 示例 4 —
border-beam-demo-4
这些名称是实际示例入口,不是新增组件属性或独立组件数量。选择对应示例后,检查指针/键盘行为、深浅色、手机尺寸和加载失败;纯装饰特效不应伪造禁用、错误或提交状态。完整示例安装包含其真实依赖闭包。
业务接入边界
挂载在相对定位且圆角匹配的容器内;size/duration/delay 属于特效,不是宿主卡片参数。
宿主与动画配置
初始化 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、边框光束 · 示例 4
组件中的状态与数据为演示用途,不包含后端接口。接入实际项目时请检查源码中的公开参数,再连接业务数据。
Installation
<Tabs defaultValue="cli"> <TabsList> <TabsTrigger value="cli">CLI</TabsTrigger> <TabsTrigger value="manual">Manual</TabsTrigger> </TabsList> <TabsContent value="cli">npx shadcn@latest add @magicui/border-beam
</TabsContent>
<TabsContent value="manual">
<Steps>
<Step>Copy and paste the following code into your project.</Step>
</Steps> </TabsContent> </Tabs>Examples
2 Border Beams
Reverse
Spring Animation
Usage
import { BorderBeam } from "@/components/ui/border-beam"
<div className="relative h-[500px] w-full overflow-hidden">
<BorderBeam />
</div>
Props
Border Beam
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | Custom class to apply to the component |
size | number | 50 | Size of the beam |
duration | number | 6 | Duration of the animation in seconds |
delay | number | 0 | Delay before the animation starts |
colorFrom | string | #ffaa40 | Start color of the beam gradient |
colorTo | string | #9c40ff | End color of the beam gradient |
transition | Transition | - | Custom motion transition configuration |
style | React.CSSProperties | - | Custom CSS styles to apply |
reverse | boolean | false | Whether to reverse animation direction |
initialOffset | number | 0 | Initial offset position (0-100) |
borderWidth | number | 1 | Border width of the beam |
完整示例安装
组件安装命令只安装组件;下列示例命令还包含该示例实际导入的其他组件、原生辅助 UI、工具和固定版本依赖。辅助源码不算独立组件。
边框光束 · 默认示例
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/border-beam/border-beam-demo.json
默认导入: @/components/magicui/examples/border-beam-demo
依赖: @radix-ui/react-label@2.1.11, @radix-ui/react-slot@1.3.0, class-variance-authority@0.7.1, clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0
边框光束 · 示例 2
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/border-beam/border-beam-demo-2.json
默认导入: @/components/magicui/examples/border-beam-demo-2
依赖: @radix-ui/react-slot@1.3.0, class-variance-authority@0.7.1, clsx@2.1.1, lucide-react@1.24.0, motion@12.42.2, tailwind-merge@3.6.0
边框光束 · 示例 3
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/border-beam/border-beam-demo-3.json
默认导入: @/components/magicui/examples/border-beam-demo-3
依赖: @radix-ui/react-label@2.1.11, @radix-ui/react-slot@1.3.0, class-variance-authority@0.7.1, clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0
边框光束 · 示例 4
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/border-beam/border-beam-demo-4.json
默认导入: @/components/magicui/examples/border-beam-demo-4
依赖: @radix-ui/react-slot@1.3.0, class-variance-authority@0.7.1, clsx@2.1.1, motion@12.42.2, tailwind-merge@3.6.0
最小使用与主题
import Demo from '@/components/magicui/examples/border-beam-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 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。
BorderBeam({
className,
size = 50,
delay = 0,
duration = 6,
colorFrom = "#ffaa40",
colorTo = "#9c40ff",
transition,
style,
reverse = false,
initialOffset = 0,
borderWidth = 1,
}: BorderBeamProps)
interface BorderBeamProps {
/**
* The size of the border beam.
*/
size?: number
/**
* The duration of the border beam.
*/
duration?: number
/**
* The delay of the border beam.
*/
delay?: number
/**
* The color of the border beam from.
*/
colorFrom?: string
/**
* The color of the border beam to.
*/
colorTo?: string
/**
* The motion transition of the border beam.
*/
transition?: Transition
/**
* The class name of the border beam.
*/
className?: string
/**
* The style of the border beam.
*/
style?: React.CSSProperties
/**
* Whether to reverse the animation direction.
*/
reverse?: boolean
/**
* The initial offset position (0-100).
*/
initialOffset?: number
/**
* The border width of the beam.
*/
borderWidth?: number
}
源码中的解构默认值
只列出直接写在参数或 props 解构中的默认表达式。条件表达式、运行时主题和其他计算值请结合源码;这里不是全部行为的默认值清单。
// BorderBeam
size = 50
// BorderBeam
delay = 0
// BorderBeam
duration = 6
// BorderBeam
colorFrom = "#ffaa40"
// BorderBeam
colorTo = "#9c40ff"
// BorderBeam
reverse = false
// BorderBeam
initialOffset = 0
// BorderBeam
borderWidth = 1
原生与外部类型
以下外部类型仍由 React 或资源自身依赖定义,没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。
Transition
React.CSSProperties