横幅

在您的网站添加横幅

Historical Fumadocs template

旧模板文档为历史链接保留，内容不作为当前 ClaudeSkills 产品指南。

这里保留既有编辑译文；如有最新完整官方参考，会在下方独立提供英文原文。

查看来源

本页目录

使用方法

使用方法

将元素放在根布局的顶部，您可以用它来显示公告。

import { Banner } from 'fumadocs-ui/components/banner';

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}): React.ReactElement {
  return (
    <html lang="en">
      <body>
        <Banner>Hello World</Banner>
        {children}
      </body>
    </html>
  );
}

变体

更改默认变体。

import { Banner } from 'fumadocs-ui/components/banner';

<Banner variant="rainbow">Hello World</Banner>;

更改布局

默认情况下，横幅使用 style 标签来修改 Fumadocs 布局（例如减少侧边栏高度）。您可以通过以下方式禁用它：

import { Banner } from 'fumadocs-ui/components/banner';

<Banner changeLayout={false}>Hello World</Banner>;

关闭

要允许用户关闭横幅，请给横幅一个 ID。

import { Banner } from 'fumadocs-ui/components/banner';

<Banner id="hello-world">Hello World</Banner>;

状态将自动保持。