mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
6c53a28e3a
* Document className and Tailwind arbitrary value support All built-in components now accept a className prop (mint#10540), and dynamic Tailwind utilities work in className on MDX components (mint#6737). Two pages stated the opposite. - Correct the claims that Tailwind arbitrary values are unsupported in customize/custom-scripts and guides/custom-layouts - Add className and arbitrary value guidance to the Tailwind section of custom-scripts, including the runtime-class limitation and the Tab content-panel caveat - Add a Style components section to the components overview - Add className property rows to every component reference page that supports it, and note the three components that do not - Document inline Markdown support in component title props - Correct the callouts page, which said typed callouts accept only children - Replace inline style resizing with Tailwind classes in image embeds - Add a help center article for Tailwind classes not applying in the editor's live preview, and note the limitation in custom-layouts - Point skill.md at className before custom.css - Accept className, keyframes, and unstyled in the Vale vocabulary Resolves DOC-316, DOC-317 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Apply batched suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Apply batched suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
67 lines
1.9 KiB
Plaintext
67 lines
1.9 KiB
Plaintext
---
|
|
title: "Callouts"
|
|
description: "Add info, notes, tips, checks, warnings, danger, and custom callout components to highlight important information in your documentation."
|
|
keywords: ["callouts", "notes", "warnings", "info boxes", "tips", "emphasis", "highlight"]
|
|
boost: 3
|
|
---
|
|
|
|
import IconsOptional from "/snippets/icons-optional.mdx";
|
|
|
|
Use `Note`, `Warning`, `Info`, `Tip`, `Check`, or `Danger` callouts, or create a custom callout:
|
|
|
|
<Note>This adds a note in the content</Note>
|
|
|
|
```mdx
|
|
<Note>This adds a note in the content</Note>
|
|
```
|
|
|
|
<Warning>This raises a warning to watch out for</Warning>
|
|
|
|
```mdx
|
|
<Warning>This raises a warning to watch out for</Warning>
|
|
```
|
|
|
|
<Info>This draws attention to important information</Info>
|
|
|
|
```mdx
|
|
<Info>This draws attention to important information</Info>
|
|
```
|
|
|
|
<Tip>This suggests a helpful tip</Tip>
|
|
|
|
```mdx
|
|
<Tip>This suggests a helpful tip</Tip>
|
|
```
|
|
|
|
<Check>This brings us a checked status</Check>
|
|
|
|
```mdx
|
|
<Check>This brings us a checked status</Check>
|
|
```
|
|
|
|
<Danger>This is a danger callout</Danger>
|
|
|
|
```mdx
|
|
<Danger>This is a danger callout</Danger>
|
|
```
|
|
|
|
<Callout icon="key" color="#FFC107" iconType="regular"> This is a custom callout</Callout>
|
|
|
|
```mdx wrap
|
|
<Callout icon="key" color="#FFC107" iconType="regular">This is a custom callout</Callout>
|
|
```
|
|
|
|
## Custom callout properties
|
|
|
|
The generic `Callout` component supports custom icons and colors. The typed callouts (`Note`, `Warning`, `Info`, `Tip`, `Check`, `Danger`) use preset icons and colors and accept only `children` and `className`.
|
|
|
|
<IconsOptional />
|
|
|
|
<ResponseField name="color" type="string">
|
|
Custom color as a hex code (for example, `#FFC107`). Sets the border, background tint, and text color of the callout.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="className" type="string">
|
|
Additional CSS classes to apply to the callout. Accepted by the generic `Callout` and by the typed callouts.
|
|
</ResponseField>
|