Skip to content
/ qalam Public
forked from iskaa02/qalam

an easy to use terminal styling library

Notifications You must be signed in to change notification settings

4cecoder/qalam

 
 

Repository files navigation

Qalam ✏️

Qalam is a Go library for easy terminal styling. Example for what qalam can do

Installation

go get github.com/iskaa02/qalam

Usage

func main(){
	// this will output "a red text" with red in terminal
	// you can use qalam.Sprintf() if you don't want to print yet
	qalam.Printf("[red]a red %s[/red]","text")
}
Code Style
b/bold bold text
i/italic italic text
u/underline underline text
s/strikethrough strikethrough text
#hexcode change the color
bg#hexcode change the background color
red change the color to red
yellow change the color to yellow
magenta change the color to magenta
white change the color to white
black change the color to black
green change the color to green
cyan change the color to cyan
bg.(color) change the background color to any color mentioned above

Examples

Multiple styles

qalam.Printf("[b s]bold and strikethrough[/b s]")

outputs: bold and strikethrough

Composing styles

qalam.Printf("[b]bold only [i]bold and italic[/i][/b]")

outputs: bold only bold and italic

Emoji

// outputs "this is a vampire -> 🧛"
qalam.Printf("this is a vampire ->[:vampire:]")

Style

You can use style function to apply style to string

// this is equivalent for qalam.Sprintf("[bold]this text is bold[/bold]") 
qalam.Style("this text is bold","bold")

Emoji

You can use get emoji function to return an emoji

// returns '🍎'
qalam.Emoji("red_apple")

What does the Qalam mean

Qalam in Arabic means pencil

Compatibility

ANSI work a bit different depending on the operating system, this implementation should work for MacOS, Linux and Windows, Although it's only been tested on Linux.

About

an easy to use terminal styling library

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%