You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Displays a yellow warning banner at the top of the page to indicate that the content is in beta or still being worked on. Set to `true` for a default message, or provide a custom message string.
Displays a banner at the top of the page content. Can be set to `true` for a default warning banner, a string for a warning banner with custom message, or an object for full customization with different intents and colors.
219
219
</ParamField>
220
220
221
-
<CodeBlock title="Example beta banner with default message">
221
+
### Simple usage
222
+
223
+
<CodeBlock title="Default warning banner">
224
+
```mdx
225
+
---
226
+
title: New Plant Species Guide
227
+
banner: true
228
+
---
229
+
```
230
+
</CodeBlock>
231
+
232
+
<CodeBlock title="Custom message">
233
+
```mdx
234
+
---
235
+
title: Experimental Plant Care API
236
+
banner: This plant care API is experimental and may change without notice.
237
+
---
238
+
```
239
+
</CodeBlock>
240
+
241
+
### Advanced usage with intents
242
+
243
+
<CodeBlock title="Info banner">
244
+
```mdx
245
+
---
246
+
title: Plant Database Migration
247
+
banner:
248
+
message: We're migrating to a new plant database. Some features may be temporarily unavailable.
249
+
intent: info
250
+
---
251
+
```
252
+
</CodeBlock>
253
+
254
+
<CodeBlock title="Success banner">
222
255
```mdx
223
256
---
224
-
title: New Feature Documentation
225
-
beta: true
257
+
title: New Plant Identification Feature
258
+
banner:
259
+
message: Our new AI-powered plant identification feature is now available!
260
+
intent: success
226
261
---
227
262
```
228
263
</CodeBlock>
229
264
230
-
<CodeBlock title="Example beta banner with custom message">
265
+
Available intents: `info`, `warning`, `success`, `error`, `note`, `launch`, `tip`, `check`
266
+
267
+
### Custom colors
268
+
269
+
<CodeBlock title="Banner with custom colors">
231
270
```mdx
232
271
---
233
-
title: Experimental API
234
-
beta: This API is experimental and may change without notice.
272
+
title: Seasonal Plant Guide
273
+
banner:
274
+
message: Spring planting season has begun! Check out our seasonal recommendations.
275
+
intent: tip
276
+
color:
277
+
background: "#e8f5e9"
278
+
text: "#1b5e20"
279
+
border: "#4caf50"
235
280
---
236
281
```
237
282
</CodeBlock>
238
283
284
+
<Warning>
285
+
Custom colors may not adapt well to dark mode. Use with caution and test in both light and dark themes.
**Deprecated.** Use `banner` instead. Displays a yellow warning banner at the top of the page to indicate that the content is in beta or still being worked on.
0 commit comments