视频弹窗
Magic UI 的独立组件,请不要替换为 JGuang UI/Base UI 的同名 API。
安装
npx shadcn@latest add https://jiguang132.com/r/magic-ui/hero-video-dialog.json
Registry 将复制可编辑源码和依赖到独立命名空间。检查主题变量与 Tailwind CSS v4 配置;不要覆盖已有的项目组件。
使用与验证
在左侧选择组件,在预览中操作它的状态;使用“查看代码”检查真实源码。安装后执行类型检查和构建,再验证键盘焦点、手机布局与深浅色主题。
来源
https://github.com/magicuidesign/magicui/tree/cdb348cb4c72a9b54b554d8617801e479fbc8714 MIT 许可证;不包括付费内容。下方提供上游英文参考内容,中文使用指南已适配;上游详细参考暂保留英文。
适用场景
从缩略图打开带动画遮罩的视频。
示例使用的原生参数
从该组件全部本地示例的 JSX 提取,按导入模块及组件区分;包括复合示例中实际使用的其他 Magic UI 组件。不是全部属性清单,也不是宿主通用 variant API。展开对象需结合示例数据声明;完整类型与默认值见下方源码参考。
| 所属组件参数 | 说明 | 示例来源 |
|---|---|---|
HeroVideoDialog.className (hero-video-dialog) | 当前原生组件的样式类,需先配置 Tailwind 与所需 CSS。 | examples/hero-video-dialog-demo.tsx、examples/hero-video-dialog-demo-top-in-bottom-out.tsx |
HeroVideoDialog.animationStyle (hero-video-dialog) | 原生视频弹窗进入/退出预设。 | examples/hero-video-dialog-demo.tsx、examples/hero-video-dialog-demo-top-in-bottom-out.tsx |
HeroVideoDialog.videoSrc (hero-video-dialog) | 视频来源,仍受网络、格式和自动播放策略限制。 | examples/hero-video-dialog-demo.tsx、examples/hero-video-dialog-demo-top-in-bottom-out.tsx |
HeroVideoDialog.thumbnailSrc (hero-video-dialog) | 视频缩略图地址。 | examples/hero-video-dialog-demo.tsx、examples/hero-video-dialog-demo-top-in-bottom-out.tsx |
HeroVideoDialog.thumbnailAlt (hero-video-dialog) | 缩略图的有意义替代文本。 | examples/hero-video-dialog-demo.tsx、examples/hero-video-dialog-demo-top-in-bottom-out.tsx |
交互与状态检查
- 视频弹窗 · 默认示例 —
hero-video-dialog-demo - 视频弹窗 · 从上进入、向下退出 —
hero-video-dialog-demo-top-in-bottom-out
这些名称是实际示例入口,不是新增组件属性或独立组件数量。选择对应示例后,检查指针/键盘行为、深浅色、手机尺寸和加载失败;纯装饰特效不应伪造禁用、错误或提交状态。完整示例安装包含其真实依赖闭包。
业务接入边界
videoSrc 是嵌入视频地址;检查 iframe 权限、Escape/关闭、焦点恢复和媒体失败;组件不提供视频托管服务。
宿主与动画配置
初始化 Tailwind CSS v4、语义 CSS 变量及 dark 变体;按本地 Registry 的独立命名空间导入。复用已有 next-themes Provider,不混入 JGuang UI/Base UI/HeroUI API。进入视口再挂载特效,离开后卸载;为 Canvas/WebGL 不可用、网络媒体失败提供静态替代。遵循 prefers-reduced-motion,并验证计时器、RAF、观察器和事件监听已清理;不能仅凭 CSS 停止就宣称引擎已停止。示例不提供后端、登录、支付或真实 AI 流。这里的实用指南为双语,上游详细参考和演示文本仍保留原文。
可用状态与示例
视频弹窗 · 默认示例、视频弹窗 · 从上进入、向下退出
组件中的状态与数据为演示用途,不包含后端接口。接入实际项目时请检查源码中的公开参数,再连接业务数据。
Installation
<Tabs defaultValue="cli"> <TabsList> <TabsTrigger value="cli">CLI</TabsTrigger> <TabsTrigger value="manual">Manual</TabsTrigger> </TabsList> <TabsContent value="cli">npx shadcn@latest add @magicui/hero-video-dialog
</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
Top-in-bottom-out
Usage
import { HeroVideoDialog } from "@/components/ui/hero-video-dialog"
<HeroVideoDialog
className="block dark:hidden"
animationStyle="from-center"
videoSrc="https://www.example.com/dummy-video"
thumbnailSrc="https://www.example.com/dummy-thumbnail.png"
thumbnailAlt="Dummy Video Thumbnail"
/>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
animationStyle | string | "from-center" | Animation style for the dialog |
videoSrc | string | - | URL of the video to be played |
thumbnailSrc | string | - | URL of the thumbnail image |
thumbnailAlt | string | "Video thumbnail" | Alt text for the thumbnail image |
Animation Styles
The animationStyle prop accepts the following values:
"from-bottom": Dialog enters from the bottom and exits to the bottom"from-center": Dialog scales up from the center and scales down to the center"from-top": Dialog enters from the top and exits to the top"from-left": Dialog enters from the left and exits to the left"from-right": Dialog enters from the right and exits to the right"fade": Dialog fades in and out"top-in-bottom-out": Dialog enters from the top and exits to the bottom"left-in-right-out": Dialog enters from the left and exits to the right
Note
- If using a YouTube video, make sure to use the
embedversion of the video URL.
完整示例安装
组件安装命令只安装组件;下列示例命令还包含该示例实际导入的其他组件、原生辅助 UI、工具和固定版本依赖。辅助源码不算独立组件。
视频弹窗 · 默认示例
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/hero-video-dialog/hero-video-dialog-demo.json
默认导入: @/components/magicui/examples/hero-video-dialog-demo
依赖: clsx@2.1.1, lucide-react@1.24.0, motion@12.42.2, tailwind-merge@3.6.0
视频弹窗 · 从上进入、向下退出
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/hero-video-dialog/hero-video-dialog-demo-top-in-bottom-out.json
默认导入: @/components/magicui/examples/hero-video-dialog-demo-top-in-bottom-out
依赖: clsx@2.1.1, lucide-react@1.24.0, motion@12.42.2, tailwind-merge@3.6.0
最小使用与主题
import Demo from '@/components/magicui/examples/hero-video-dialog-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 引用,不是新增业务属性。此区域是原始类型参考,不是上游说明的全文翻译。
HeroVideoDialog({
animationStyle = "from-center",
videoSrc,
thumbnailSrc,
thumbnailAlt = "Video thumbnail",
className,
}: HeroVideoProps)
type AnimationStyle =
| "from-bottom"
| "from-center"
| "from-top"
| "from-left"
| "from-right"
| "fade"
| "top-in-bottom-out"
| "left-in-right-out"
interface HeroVideoProps {
animationStyle?: AnimationStyle
videoSrc: string
thumbnailSrc: string
thumbnailAlt?: string
className?: string
}
源码中的解构默认值
只列出直接写在参数或 props 解构中的默认表达式。条件表达式、运行时主题和其他计算值请结合源码;这里不是全部行为的默认值清单。
// HeroVideoDialog
animationStyle = "from-center"
// HeroVideoDialog
thumbnailAlt = "Video thumbnail"