@spec frame(Cringe.Document.t(), Cringe.Renderer.render_opts()) :: Cringe.Frame.t()

Renders a terminal document to a frame.

@spec input(keyword()) :: Cringe.Document.t()

Builds a render-only text input widget.

@spec progress(keyword()) :: Cringe.Document.t()

Builds a render-only progress bar widget.

@spec render(Cringe.Document.t(), Cringe.Renderer.render_opts()) :: String.t()

Renders a terminal document to a string.

iex> Cringe.text("hello") |> Cringe.render(width: 3)
"hel"

@spec run(
  module(),
  keyword()
) :: GenServer.on_start()

Starts a Cringe runtime process linked to the caller.

@spec run_supervised(
  module(),
  keyword()
) :: Supervisor.on_start()

Starts a supervisor that owns a Cringe runtime process.

@spec select(keyword()) :: Cringe.Document.t()

Builds a render-only select/list widget.

@spec spinner(keyword()) :: Cringe.Document.t()

Builds a render-only spinner widget.

@spec text(
  IO.chardata(),
  keyword()
) :: Cringe.Document.Text.t()

Builds a text node.

iex> Cringe.text("hello")
%Cringe.Document.Text{content: "hello", opts: []}