Adding `text_box` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add text_box

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

text_box = "0.2.4"

The text_box library will be automatically available globally. Read the text_box library documentation.

Back to the crate overview.

Readme

Cargo.toml

In order to use this crate you have to add to deps list in Cargo.toml.

...

[dependencies]
text_box = "*"

...

Imports

Now you can import crate and features with:

extern crate text_box;

use text_box::TextBox;
use text_box::utils::{clear_screen, goto};

Full example

A complete usage example.

extern crate text_box;

use text_box::TextBox;
use text_box::utils::{clear_screen, goto};

fn main() {
	clear_screen();

	let box1 = TextBox::new(
		30, 10,
		15, 6,
		2,
		"Box 1",
		"This box have a border type 2. A first level message, must be checked quickly."
	).unwrap();
	let box2 = TextBox::new(
		10, 10,
		15, 6,
		0,
		"Box 2",
		"This box have a border type 0. Normal boxed text for alingment."
	).unwrap();
	let box3 = TextBox::new(
		10, 2,
		35, 6,
		1,
		"Box 3",
		"This box have a border type 1. A second level message. \n You can create multiple boxes, just be careful with console window size."
	).unwrap();
	let box4 = TextBox::new(
		47, 2,
		15, 14,
		2,
		"Box 4",
		"If you want a new line inside a box you need to put it between spaces like \n this: ' \\n '. Formatter identifies this as a new line word, so it can be printed. \n \n Right?"
	).unwrap();

	println!("{}{}{}{}", box1, box2, box3, box4);
	
	goto(1, 40);
}

This example should print out:

 ┌Box 3──────────────────────────────┐╔Box 4══════════╗
 │This box have a border type 1. A   │║If you want a  ║
 │second level message.              │║new line inside║
 │You can create multiple boxes, just│║a box you need ║
 │be careful with console window     │║to put it      ║
 │size.                              │║between spaces ║
 │                                   │║like           ║
 └───────────────────────────────────┘║this: ' \n '.  ║
  Box 2              ╔Box 1══════════╗║Formatter      ║
  This box have a    ║This box have a║║identifies this║
  border type 0.     ║border type 2. ║║as a new line  ║
  Normal boxed       ║A first level  ║║word, so it can║
  text for           ║message, must  ║║be printed.    ║
  alingment.         ║be checked     ║║               ║
                     ║quickly.       ║║Right?         ║
                     ╚═══════════════╝╚═══════════════╝

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Licensing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Adding text_box library as a dependency

Adding `text_box` library as a dependency