Skip to contentSkip to Content
ComponentsCallout

Callout

Highlighted message blocks for notes, warnings, tips, and other important information. Each type has a distinct color and icon to help readers quickly identify the nature of the message.

API

Callout

PropTypeDefaultDescription
type"note" | "warning" | "info" | "tip" | "check" | "danger""info"The visual style of the callout.
titlestringOptional bold title displayed above the content.
childrenReactNodeThe callout body content.

Available Types

TypeColorUse for
noteBlueGeneral notes and remarks.
warningAmberImportant warnings the reader should not miss.
infoSlateNeutral supplementary information.
tipEmeraldHelpful tips and best practices.
checkGreenSuccess states or confirmation of correct behavior.
dangerRedCritical warnings about destructive or breaking behavior.

Example

Python 3.10+

This library requires Python 3.10 or later.

This function modifies the input array in place.

Performance

Use batch mode for datasets larger than 10,000 rows.

All tests passing

The test suite completed successfully with 100% coverage.

Breaking Change

The legacy_mode parameter was removed in v2.0.

This is a neutral informational message with no title.

<Callout type="note" title="Python 3.10+"> This library requires Python 3.10 or later. </Callout> <Callout type="warning"> This function modifies the input array in place. </Callout> <Callout type="tip" title="Performance"> Use batch mode for datasets larger than 10,000 rows. </Callout> <Callout type="danger" title="Breaking Change"> The `legacy_mode` parameter was removed in v2.0. </Callout>