🚧 Rspress 2.0 文档还在开发中
close

HomeBackground eject-only

Warning

该组件是 eject-only 组件,专门为 wrap/eject 设计,不建议在 MDX 文件中直接使用

该组件是 首页 的一部分,HomeBackground 用于在首页渲染背景效果,同时会自动将导航栏设置为透明样式。

用法

可通过 eject 来进行修改。

index.mdx
import { HomeBackground } from '@rspress/core/theme';

<HomeBackground className="my-custom-bg" />

Props

该组件继承所有 React.HTMLAttributes<HTMLDivElement> 属性。

className

  • 类型: string

添加自定义 CSS 类名来自定义背景样式。

工作原理

  • 组件会自动将导航栏切换为透明模式
  • 你可以通过 CSS 自定义 .rp-home-background 类来调整背景效果