Reflex Logo

Intro

Gallery

Hosting

Components

New

Learn

Components

API Reference

Onboarding

Library

/

Datadisplay

/

Callout

A callout is a short message to attract user's attention.

You will need admin privileges to install and access this application.

rx.callout(
    "You will need admin privileges to install and access this application.",
    icon="info",
)

The icon prop allows an icon to be passed to the callout component. See the icon component for all icons that are available.

rx.callout(
    "Access denied. Please contact the network administrator to view this page.",
    icon="alert_triangle",
    color_scheme="red",
    role="alert",
)

Use the size prop to control the size.

You will need admin privileges to install and access this application.

You will need admin privileges to install and access this application.

You will need admin privileges to install and access this application.

rx.flex(
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        size="3",
    ),
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        size="2",
    ),
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        size="1",
    ),
    direction="column",
    spacing="3",
    align="start",
)

Use the variant prop to control the visual style. It is set to soft by default.

You will need admin privileges to install and access this application.

You will need admin privileges to install and access this application.

You will need admin privileges to install and access this application.

rx.flex(
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        variant="soft",
    ),
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        variant="surface",
    ),
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        variant="outline",
    ),
    direction="column",
    spacing="3",
)

Use the color_scheme prop to assign a specific color, ignoring the global theme.

You will need admin privileges to install and access this application.

You will need admin privileges to install and access this application.

You will need admin privileges to install and access this application.

rx.flex(
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        color_scheme="blue",
    ),
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        color_scheme="green",
    ),
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        color_scheme="red",
    ),
    direction="column",
    spacing="3",
)

Use the high_contrast prop to add additional contrast.

You will need admin privileges to install and access this application.

You will need admin privileges to install and access this application.

rx.flex(
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
    ),
    rx.callout(
        "You will need admin privileges to install and access this application.",
        icon="info",
        high_contrast=True,
    ),
    direction="column",
    spacing="3",
)

A short message to attract user's attention.

Basic Callout

PropTypeDescriptionValues
textstr

The text of the callout.

iconstr

The icon of the callout.

as_childbool

Change the default rendered element for the one passed as a child, merging their props and behavior.

sizeLiteral

Size "1" - "3"

variantLiteral

Variant of button: "soft" | "surface" | "outline"

color_schemeLiteral

Override theme color for button

high_contrastbool

Whether to render the button with higher contrast color against background

Event Triggers

No component specific event triggers

Groups Icon and Text parts of a Callout.

You will need admin privileges to install and access this application.

PropTypeDescriptionValues
as_childbool

Change the default rendered element for the one passed as a child, merging their props and behavior.

sizeLiteral

Size "1" - "3"

variantLiteral

Variant of button: "soft" | "surface" | "outline"

color_schemeLiteral

Override theme color for button

high_contrastbool

Whether to render the button with higher contrast color against background

Event Triggers

No component specific event triggers

Provides width and height for the icon associated with the callout.

Props

No component specific props

Event Triggers

No component specific event triggers

Renders the callout text. This component is based on the p element.

Props

No component specific props

Event Triggers

No component specific event triggers

← BadgeCodeblock →

Did you find this useful?