Skip to content

view on a desktop screen for a better experience.

callout

Callout

An aside between paragraphs — a caveat, a tip, a warning. The body is Markdown. A quote is Quote.

warning

type sets the frame title and the glyph. The body is Markdown — write it like a paragraph.

[ warning ]

The CLI copies files into registry/default. It does not add an npm dependency, so there is nothing to update later — edit the source.

MDX

```
+----------------------- [ WARNING ] ------------------------+
|                                                            |
| !  The CLI copies files into registry/default. It does not |
|    add an npm                                              |
|    dependency, so there is nothing to update later — edit  |
|    the source.                                             |
|                                                            |
+------------------------------------------------------------+
```

install

command

tip with a title

title overrides the type on the frame. Lists work.

[ Palette ]

One accent is the default. Opt in when a second series needs its own hue:

  • palette="duo" for two series
  • palette="multi" for three

MDX

```
+----------------------- [ PALETTE ] -----------------------+
|                                                           |
| +  One accent is the default. Opt in when a second series |
|    needs its own hue:                                     |
|    - palette="duo" for two series                         |
|    - palette="multi" for three                            |
|                                                           |
+-----------------------------------------------------------+
```
[ PROPS ]
PropTypeDefaultDescription
type"note" | "tip" | "warning" | "danger""note"Sets the frame title and the glyph in the margin.
titlestringOverrides the frame title. Defaults to the type.
childrenReactNodeMarkdown. Paragraphs, lists, inline code, links.
cornerstring"+"Character at each corner of the frame.
classNamestringPassed to the outer frame.