Banner

Displays an attention-grabbing message with a title and description. Useful for showing status messages, alerts, or contextual information.

ctx.ui.display.banner({ title, description, mode });

Config

The main heading of the banner.

Additional text providing more context or explanation.

Controls the visual style of the banner. Use:

• "info" for neutral messages
• "warning" for cautionary alerts
• "error" for critical issues
• "success" for confirmation or success messages

Usage

Use banners to communicate important messages clearly and consistently.

ctx.ui.page({
  title: "Account Status",
  content: [
    ctx.ui.display.banner({
      title: "Upgrade Required",
      description: "Your current plan does not support this feature.",
      mode: "warning",
    }),
  ],
});