Alaja.Components.Header (Alaja v2.0.0)

Static header component for terminal output.

Renders a centered title with optional subtitle and decorative lines.

Usage

iex> Alaja.Components.Header.print("My App", subtitle: "v1.0.0")
iex> Alaja.Components.Header.render("My App", size: :large)

As of v0.3.0, render/2 returns an Alaja.Buffer.t/0 (height 3 or 4 depending on subtitle presence).

color()

size()

Prints a header directly to stdout.

Renders a header to an Alaja.Buffer.t/0.

@type color() :: {0..255, 0..255, 0..255} | nil

@type size() :: :small | :medium | :large

@spec print(
  String.t(),
  keyword()
) :: :ok

Prints a header directly to stdout.

@spec render(
  String.t(),
  keyword()
) :: Alaja.Buffer.t()

Renders a header to an Alaja.Buffer.t/0.