Custom Components

Callout

How to use callout


Callout

Velora make custom the callout component that inspired by GitHub callout markdown render. You can use it with this syntax:

mdx
<Callout type="note">
    Here is a note callout
</Callout>

And it will be rendered as:

Note

Here is a note callout

API Reference

PropTypeDefault
type"note" | "tip" | "important" | "warning" | "caution"-
titlestring-
descriptionColor"default" | "normal" | "muted"-

Basic Usage

See detail info about how to use callout.

Example Usage

mdx
<Callout type="note" title="Custom Title" descriptionColor="normal">
    Here is a note callout with custom title and description color muted
</Callout>

And it will be rendered as:

Custom Title

Here is a note callout with custom title and description color muted