View Source Boxen (boxen v0.1.0)

Documentation for Boxen.

Link to this section Summary

Functions

Function to boxify a given text.

Link to this section Functions

Link to this function

boxify(input_text, opts \\ [])

View Source
@spec boxify(input_text :: String.t(), opts :: keyword()) ::
  {:ok, String.t()} | {:error, String.t()}

Function to boxify a given text.

Opts:

  • :box_type
  • :box
  • :title
  • :title_alignment
  • :text_alignment
  • :padding
  • :margin
  • :width
  • :border_color
  • :text_color

Example:

Simple: Boxen.boxify("Hello, world")

With title: Boxen.boxify("Hello, world", title: "Message")