横幅
为您的站点添加横幅
Be careful, Fumadocs v99 has released
Using the
rainbow variantcustomise the
rainbow variantInstall to your codebase
Easier customisation & control.
用法
将元素放置在根布局的顶部,您可以用它来显示公告。
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>;
// 自定义颜色
<Banner
variant="rainbow"
rainbowColors={[
'rgba(255,100,0, 0.5)',
'rgba(255,100,0, 0.5)',
'transparent',
'rgba(255,100,0, 0.5)',
'transparent',
'rgba(255,100,0, 0.5)',
'transparent',
]}
>
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>;状态将自动持久化。
How is this guide?
Last updated on
