@spec default_config(String.t(), String.t(), String.t()) :: banner_config()

Creates a banner configuration map with default themes.

This is a convenience function for creating banner configurations with sensible defaults that can be customized as needed.

Parameters

• service_name - The name of your service
• service_description - Brief description of your service
• shoutout - Custom message or tagline

Example

config = BCUtils.Banner.default_config(
  "MyService",
  "Does amazing things",
  "✨ Magic included"
)

# Customize themes if needed
config = %{config | beam_theme: &BCUtils.BannerThemes.orange_on_true_black/1}

BCUtils.Banner.display_banner_with_config(config)

@spec display_banner(
  service_name :: String.t(),
  service_description :: String.t(),
  shoutout :: String.t(),
  beam_theme_func :: theme_function(),
  campus_theme_func :: theme_function(),
  description_theme_func :: theme_function()
) :: :ok

Displays a full ASCII art BEAM Campus banner with elaborate styling.

This function creates an impressive startup banner featuring ASCII art for both "BEAM" and "Campus" text, along with your service information. This is the recommended function for production applications that want to make a strong visual impression.

Parameters

• service_name - The name of your service or application
• service_description - A brief description of what your service does
• shoutout - A custom message, tagline, or shoutout (emoji supported!)
• beam_theme_func - Function to style the "BEAM" ASCII art (defaults to sky blue)
• campus_theme_func - Function to style the "Campus" ASCII art (defaults to lime green)
• description_theme_func - Function to style service info (defaults to indigo)

Examples

# Basic usage with defaults
BCUtils.Banner.display_banner(
  "EventStore",
  "Event sourcing database",
  "⚡ Lightning fast events!"
)

# Production-ready example
BCUtils.Banner.display_banner(
  "MyCompany API",
  "RESTful service platform",
  "🎆 Version 2.0 - Now with GraphQL!"
)

# Custom color themes
import BCUtils.BannerThemes

BCUtils.Banner.display_banner(
  "DevServer",
  "Local development environment",
  "🔥 Hot reloading enabled",
  &orange_on_true_black/1,    # Orange BEAM
  &violet_on_true_black/1,    # Violet Campus
  &amber_on_true_black/1      # Amber description
)

Visual Layout

The banner will display in this format:

[ASCII ART: BEAM]
[ASCII ART: CAMPUS]

                  Service Name
             Service Description  
                 Shoutout

Tips

• Use this for production applications and demos
• ASCII art looks best in terminals with good Unicode support
• Consider terminal width when choosing service names/descriptions
• Emojis in shoutouts add personality and visual interest

@spec display_banner_with_config(banner_config()) :: :ok

Displays a banner using a configuration map.

This provides a more structured way to configure banners, especially useful when banner configuration needs to be stored or passed around.

Parameters

• config - A banner_config map containing all banner settings

Example

config = %{
  service_name: "MyApp",
  service_description: "Awesome application",
  shoutout: "🚀 Ready to go!",
  beam_theme: &BCUtils.BannerThemes.sky_blue_on_true_black/1,
  campus_theme: &BCUtils.BannerThemes.lime_on_true_black/1,
  description_theme: &BCUtils.BannerThemes.purple_on_true_black/1
}

BCUtils.Banner.display_banner_with_config(config)

@spec display_text_banner(
  service_name :: String.t(),
  service_description :: String.t(),
  shoutout :: String.t(),
  beam_theme_func :: theme_function(),
  campus_theme_func :: theme_function(),
  description_theme_func :: theme_function()
) :: :ok

Displays a text-based BEAM Campus banner without ASCII art.

This function provides a simpler banner format using just the text "BEAM" and "Campus" without the elaborate ASCII art. Perfect for situations where you want a clean, minimal banner display.

Parameters

• service_name - The name of your service or application
• service_description - A brief description of what your service does
• shoutout - A custom message, tagline, or shoutout (emoji supported!)
• beam_theme_func - Function to style the "BEAM" text (defaults to sky blue)
• campus_theme_func - Function to style the "Campus" text (defaults to lime green)
• description_theme_func - Function to style service info (defaults to purple)

Examples

# Basic usage with defaults
BCUtils.Banner.display_text_banner(
  "MyApp",
  "Event sourcing framework",
  "🚀 Ready to launch!"
)

# Custom themes
import BCUtils.BannerThemes

BCUtils.Banner.display_text_banner(
  "DevTools",
  "Development utilities",
  "✨ Built with Elixir",
  &amber_on_true_black/1,
  &cyan_on_true_black/1,
  &green_on_true_black/1
)

Tips

• Use emojis in the shoutout for visual appeal
• Choose contrasting theme colors for better readability
• Keep service descriptions concise for better formatting