-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs, fix align issue and readme
- Loading branch information
Showing
5 changed files
with
45 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,82 @@ | ||
| /* | ||
| Package Box CLI Maker is a Highly Customized Terminal Box Creator written in Go. | ||
| It provides many styles and options to make Boxes. There are 8 inbuilt styles and Color support via RGB uint, RGB Array of [3]uint and string (given). | ||
| It provides many styles and options to make Boxes. There are 8 inbuilt styles and has Color support via RGB uint, RGB Array of [3]uint and string (given). | ||
| Inbuilt Box Styles: | ||
| Single | ||
| Double | ||
| Bold | ||
| Single Double | ||
| Double Single | ||
| Round | ||
| Hidden | ||
| Single, | ||
| Double, | ||
| Bold, | ||
| Single Double, | ||
| Double Single, | ||
| Round, | ||
| Hidden and | ||
| Classic | ||
| Inbuilt Colors: | ||
| Black | ||
| Blue | ||
| Red | ||
| Yellow | ||
| Green | ||
| Cyan | ||
| Magenta | ||
| HiBlack | ||
| HiBlue | ||
| HiRed | ||
| HiYellow | ||
| HiGreen | ||
| HiCyan | ||
| Black, | ||
| Blue, | ||
| Red, | ||
| Yellow, | ||
| Green, | ||
| Cyan, | ||
| Magenta, | ||
| HiBlack, | ||
| HiBlue, | ||
| HiRed, | ||
| HiYellow, | ||
| HiGreen, | ||
| HiCyan and | ||
| HiMagenta | ||
| It also has Unicode and Emoji support which works across all terminals though there might be some terminals which do not support | ||
| Unicode and Emoji like Windows CMD and Powershell. Unlike other terminals makers Box CLI Mkaer supports tab and multi line string. | ||
| Unicode and Emoji like Windows CMD and Powershell. Unlike other CLI Makers, Box CLI Maker supports tab and multi line string. | ||
| Note: As different terminals have different font by default so the right vertical alignment may not be aligned well. | ||
| You will have to change your font accordingly to make it work. | ||
| Basic Example: | ||
| Box := box.New(box.Config{Px: 2, Py: 5, Type: "Single", Color: "Cyan"}) | ||
| Box.Print("Box CLI Maker", "Highly Customized Terminal Box Maker") | ||
| You can specify and change the options by changing the above Config struct. | ||
| If "Style" isn't provided in box.Config struct then by default it will be "Single". | ||
| You can customize and change the TitlePos to Inside, Top, Bottom and ContentAlign to Left, Right and Center. | ||
| By default TitlePos is Inside and ContentAlign is Left. | ||
| Box := box.New(box.Config{Px: 2, Py: 5, Type: "Single", TitlePos: "Top", ContentAlign: "Left"}) | ||
| If you want the string representation of the Box then you can just use String() method of the Box: | ||
| You can also customize and change the TitlePos to Inside, Top, Bottom and ContentAlign to Left, Right and Center. | ||
| By default TitlePos is Inside, ContentAlign is Left and Style is Single. | ||
| If you want the Box to be printed correctly irrespective of it will form the correct color or not on Windows then you will have to add Box.Output | ||
| as the passing stream to Fprintf(), Fprintln() and etc to the passing stream functions: | ||
| You can also use the String() method for the string representation of the Box. | ||
| if runtime.GOOS == "windows" { | ||
| fmt.Fprintf(box.Output, box_str) | ||
| } | ||
| If you want the Box to be printed correctly irrespective of if it will form the correct Color or not on Windows (as Windows Console only supports 16 Colors) then you will have to add Box.Output | ||
| as the passing stream to stream based functions: | ||
| Box := box.New(box.Config{Px: 2, Py: 5, Type: "Single", Color: "Cyan"}) | ||
| b := Box.String("Box CLI Maker", "Highly Customized Terminal Box Maker") | ||
| ... // use it afterwards | ||
| fmt.Fprintf(box.Output, boxStr) | ||
| If you do not want the title and lines to be there then you can just leave i.e. put an empty in the both places.const | ||
| Box := box.New(box.Config{Px: 2, Py: 5, Type: "Single", Color: "Cyan"}) | ||
| boxStr := Box.String("Box CLI Maker", "Highly Customized Terminal Box Maker") | ||
| The following two will not be applicable for terminals which don't have 24 bit support i.e. True Color ANSI Code. | ||
| If used then the color effect will not be there. | ||
| The Custom Color option will not be applicable for terminals which don't have 24 bit support i.e. True Color ANSI Code. | ||
| If it is used then the Color effect will not be there. | ||
| RBG Uint Example: | ||
| RGB Uint Example: | ||
| Box := box.New(box.Config{Px: 2, Py: 5, Type: "Single", Color: uint(0x34562f)}) | ||
| Box.Print("Box CLI Maker", "Highly Customized Terminal Box Maker") | ||
| Note: Uint must be in a range of [0x000000, 0xFFFFFF] else it will panic. | ||
| RBG [3]uint Example: | ||
| RGB [3]uint Example: | ||
| Box := box.New(box.Config{Px: 2, Py: 5, Type: "Single", Color: [3]uint{23, 56, 78}}) | ||
| Box.Print("Box CLI Maker", "Highly Customized Terminal Box Maker") | ||
| Note: [3]uint array elements must be in a range of [0x0, 0xFF] else it will panic. | ||
| You can even make your custom Box Style by using box.Box struct: | ||
| You can even make your custom Box Style by using struct box.Box: | ||
| config := box.Config{Px: 2, Py: 3, Type: "", TitlePos: "Inside"} | ||
| boxNew := box.Box{TopRight: "*", TopLeft: "*", BottomRight: "*", BottomLeft: "*", Horizontal: "-", Vertical: "|", Config: config} | ||
| ... // use it afterwards | ||
| */ | ||
|
|
||
| package box |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters