fe04a2973e
- Introduced multiple new MDX files covering various topics including comparisons, customization, internationalization, manual installation, markdown usage, and component documentation. - Enhanced the overall structure and organization of the documentation to improve user experience and accessibility. - Added a meta JSON file to define the documentation structure and navigation. - Implemented new layout files for different document types, improving the flexibility of the documentation framework.
61 lines
1.1 KiB
Plaintext
61 lines
1.1 KiB
Plaintext
---
|
|
title: 横幅
|
|
description: 在您的网站添加横幅
|
|
preview: banner
|
|
---
|
|
|
|
## 使用方法
|
|
|
|
将元素放在根布局的顶部，您可以用它来显示公告。
|
|
|
|
```tsx
|
|
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>
|
|
);
|
|
}
|
|
```
|
|
|
|
### 变体
|
|
|
|
更改默认变体。
|
|
|
|
```tsx
|
|
import { Banner } from 'fumadocs-ui/components/banner';
|
|
|
|
<Banner variant="rainbow">Hello World</Banner>;
|
|
```
|
|
|
|
### 更改布局
|
|
|
|
默认情况下，横幅使用 `style` 标签来修改 Fumadocs 布局（例如减少侧边栏高度）。
|
|
您可以通过以下方式禁用它：
|
|
|
|
```tsx
|
|
import { Banner } from 'fumadocs-ui/components/banner';
|
|
|
|
<Banner changeLayout={false}>Hello World</Banner>;
|
|
```
|
|
|
|
### 关闭
|
|
|
|
要允许用户关闭横幅，请给横幅一个 ID。
|
|
|
|
```tsx
|
|
import { Banner } from 'fumadocs-ui/components/banner';
|
|
|
|
<Banner id="hello-world">Hello World</Banner>;
|
|
```
|
|
|
|
状态将自动保持。 |