Specs

fill(text :: String.t(), opts :: wrap_opts()) :: String.t()

Fills text to the given width.

The result is a String, with lines seperated by newline. The wrap/2 function does the same thing, except that it returns a list of Strings, one for each line.

See the docs for wrap/2 for details about the options it takes.

Examples

iex> Textwrap.fill("hello world", 5)
"hello\nworld"

iex> Textwrap.fill("hello world", width: 5)
"hello\nworld"

iex> Textwrap.fill("Antidisestablishmentarianism", width: 10)
"Antidisest\nablishment\narianism"

iex> Textwrap.fill("Antidisestablishmentarianism", width: 10, break_words: false)
"Antidisestablishmentarianism"

iex> Textwrap.fill("Antidisestablishmentarianism", width: 10, splitter: :en_us)
"Antidis-\nestablish-\nmentarian-\nism"

iex> Textwrap.fill("foo bar baz",
...>      width: 5,
...>      initial_indent: "> ",
...>      subsequent_indent: "  ")
"> foo\n  bar\n  baz"

iex> Textwrap.fill("Lorem ipsum dolor sit amet, consectetur adipisicing elit",
...>      width: 25,
...>      wrap_algorithm: :optimal_fit)
"Lorem ipsum dolor\nsit amet, consectetur\nadipisicing elit"

iex> Textwrap.fill("Lorem ipsum dolor sit amet, consectetur adipisicing elit",
...>      width: 25,
...>      wrap_algorithm: :first_fit)
"Lorem ipsum dolor sit\namet, consectetur\nadipisicing elit"