Logo

Getting Started

IntroductionInstallationQuick Start
Logo
DocumentationAPI ReferenceChangelog

Components

Callout

Highlight important information with customizable alert callouts

Overview

The <Callout> component displays highlighted messages to draw attention to important information like warnings, tips, errors, or notes. Built on Chakra UI's Alert component.

Basic Usage

This is an informational callout for general notices.

Status Types

This feature is available on all plans starting from v2.0.

This action cannot be undone. Make sure to backup your data first.

This endpoint has been deprecated and will be removed in v3.0.

Your configuration has been successfully saved.

With and Without Titles

Make sure you have Node.js 18+ installed before continuing.

Remember to restart the development server after changing configuration files.

Rich Content

Callouts support Markdown formatting within the content:

The default rate limit is 1000 requests per hour. Need more? Check out our Enterprise plans for higher limits.

Rate limit headers:

  • X-RateLimit-Limit - Total requests allowed
  • X-RateLimit-Remaining - Requests remaining
  • X-RateLimit-Reset - Time when limit resets

Props

status
string

The visual style and color of the callout.

Options: info, warning, error, success

<Callout status="warning">Your message here</Callout>
title
string

Optional title displayed before the message content.

<Callout status="info" title="Did you know?">
  Content here
</Callout>
children
ReactNoderequired

The content of the callout. Supports Markdown formatting.

<Callout status="info">
  You can use **bold**, *italic*, and [links](/docs).
</Callout>

Next, learn about the Steps Component for creating step-by-step guides.

Built with Chakra UI

On this page
OverviewBasic UsageStatus TypesWith and Without TitlesRich ContentProps