Alaja.Components.Breadcrumbs (Alaja v1.0.0)

Copy Markdown View Source

Static breadcrumb navigation component for terminal output.

Renders a path-like list of items with a separator.

Usage

iex> Alaja.Components.Breadcrumbs.print(["Home", "Projects", "Alaja"])
# Home > Projects > Alaja

Summary

Functions

print(items, opts \\ [])

Prints breadcrumbs to stdout.

render(items, opts)

Renders breadcrumbs to iodata without printing.

Functions

print(items, opts \\ [])

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

Prints breadcrumbs to stdout.

Options

  • :separator - String between items (default: "›")
  • :item_color - RGB for non-current items (default: cyan)
  • :current_color - RGB for the last (current) item (default: white)
  • :separator_color - RGB for separator (default: gray)

render(items, opts)

@spec render(
  [String.t()],
  keyword()
) :: iodata()

Renders breadcrumbs to iodata without printing.