package text

Import Path
	github.com/jedib0t/go-pretty/v6/text (on go.dev)

Dependency Relation
	imports 11 packages, and imported by one package

Involved Source Files

	      align.go
	      ansi.go
	      ansi_unix.go
	      color.go
	      color_html.go
	      cursor.go
	      filter.go
	      format.go
	      string.go
	      transformer.go
	      valign.go
	      wrap.go
Package-Level Type Names (total 7, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Align int (basic type)
		Align denotes how text is to be aligned horizontally.

		Methods (total 5, in which 3 are exported)
			( T) Apply(text string, maxLength int) string
				Apply aligns the text as directed. For ex.:
				 * AlignDefault.Apply("Jon Snow", 12) returns "Jon Snow    "
				 * AlignLeft.Apply("Jon Snow",    12) returns "Jon Snow    "
				 * AlignCenter.Apply("Jon Snow",  12) returns "  Jon Snow  "
				 * AlignJustify.Apply("Jon Snow", 12) returns "Jon     Snow"
				 * AlignRight.Apply("Jon Snow",   12) returns "    Jon Snow"

			( T) HTMLProperty() string
				HTMLProperty returns the equivalent HTML horizontal-align tag property.

			( T) MarkdownProperty() string
				MarkdownProperty returns the equivalent Markdown horizontal-align separator.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			( T) justifyText(text string, textLength int, maxLength int) string
			( T) trimString(text string) string
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jedib0t/go-pretty/v6/table.(*Table).getAlign(colIdx int, hint table.renderHint) Align
		As Types Of (total 5, all are exported)
			const AlignCenter
			const AlignDefault
			const AlignJustify
			const AlignLeft
			const AlignRight

	 type Color int (basic type)
		Color represents a single color to render with.

		Methods (total 4, all are exported)
			( T) EscapeSeq() string
				EscapeSeq returns the ANSI escape sequence for the color.

			( T) HTMLProperty() string
				HTMLProperty returns the "class" attribute for the color.

			( T) Sprint(a ...interface{}) string
				Sprint colorizes and prints the given string(s).

			( T) Sprintf(format string, a ...interface{}) string
				Sprintf formats and colorizes and prints the given string(s).

		As Types Of (total 42, all are exported)
			const BgBlack
			const BgBlue
			const BgCyan
			const BgGreen
			const BgHiBlack
			const BgHiBlue
			const BgHiCyan
			const BgHiGreen
			const BgHiMagenta
			const BgHiRed
			const BgHiWhite
			const BgHiYellow
			const BgMagenta
			const BgRed
			const BgWhite
			const BgYellow
			const BlinkRapid
			const BlinkSlow
			const Bold
			const Concealed
			const CrossedOut
			const Faint
			const FgBlack
			const FgBlue
			const FgCyan
			const FgGreen
			const FgHiBlack
			const FgHiBlue
			const FgHiCyan
			const FgHiGreen
			const FgHiMagenta
			const FgHiRed
			const FgHiWhite
			const FgHiYellow
			const FgMagenta
			const FgRed
			const FgWhite
			const FgYellow
			const Italic
			const Reset
			const ReverseVideo
			const Underline

	 type Colors ([]T)
		Colors represents an array of Color objects to render with.
		Example: Colors{FgCyan, BgBlack}

		Methods (total 4, all are exported)
			( T) EscapeSeq() string
				EscapeSeq returns the ANSI escape sequence for the colors set.

			( T) HTMLProperty() string
				HTMLProperty returns the "class" attribute for the colors.

			( T) Sprint(a ...interface{}) string
				Sprint colorizes and prints the given string(s).

			( T) Sprintf(format string, a ...interface{}) string
				Sprintf formats and colorizes and prints the given string(s).

		As Outputs Of (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func github.com/jedib0t/go-pretty/v6/table.(*Table).getBorderColors(hint table.renderHint) Colors
			func github.com/jedib0t/go-pretty/v6/table.(*Table).getColumnColors(colIdx int, hint table.renderHint) Colors
			func github.com/jedib0t/go-pretty/v6/table.(*Table).getSeparatorColors(hint table.renderHint) Colors
		As Types Of (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			  var colorsNumberNegative
			  var colorsNumberPositive
			  var colorsNumberZero
			  var colorsURL

	 type Cursor rune (basic type)
		Cursor helps move the cursor on the console in multiple directions.

		Methods (total 2, both are exported)
			( T) Sprint() string
				Sprint prints the Escape Sequence to move the Cursor once.

			( T) Sprintn(n int) string
				Sprintn prints the Escape Sequence to move the Cursor "n" times.

		As Types Of (total 5, all are exported)
			const CursorDown
			const CursorLeft
			const CursorRight
			const CursorUp
			const EraseLine

	 type Format int (basic type)
		Format lets you transform the text in supported methods while keeping escape
		sequences in the string intact and untouched.

		Methods (only one, which is exported)
			( T) Apply(text string) string
				Apply converts the text as directed.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jedib0t/go-pretty/v6/table.(*Table).getFormat(hint table.renderHint) Format
		As Types Of (total 4, all are exported)
			const FormatDefault
			const FormatLower
			const FormatTitle
			const FormatUpper

	 type Transformer (func)
		Transformer helps format the contents of an object to the user's liking.

		As Outputs Of (at least 6, in which 5 are exported)
			func NewJSONTransformer(prefix string, indent string) Transformer
			func NewNumberTransformer(format string) Transformer
			func NewTimeTransformer(layout string, location *time.Location) Transformer
			func NewUnixTimeTransformer(layout string, location *time.Location) Transformer
			func NewURLTransformer() Transformer
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jedib0t/go-pretty/v6/table.(*Table).getColumnTransformer(colIdx int, hint table.renderHint) Transformer

	 type VAlign int (basic type)
		VAlign denotes how text is to be aligned vertically.

		Methods (total 3, all are exported)
			( T) Apply(lines []string, maxLines int) []string
				Apply aligns the lines vertically. For ex.:
				 * VAlignTop.Apply({"Game", "Of", "Thrones"},    5)
					    returns {"Game", "Of", "Thrones", "", ""}
				 * VAlignMiddle.Apply({"Game", "Of", "Thrones"}, 5)
					    returns {"", "Game", "Of", "Thrones", ""}
				 * VAlignBottom.Apply({"Game", "Of", "Thrones"}, 5)
					    returns {"", "", "Game", "Of", "Thrones"}

			( T) ApplyStr(text string, maxLines int) []string
				ApplyStr aligns the string (of 1 or more lines) vertically. For ex.:
				 * VAlignTop.ApplyStr("Game\nOf\nThrones",    5)
					    returns {"Game", "Of", "Thrones", "", ""}
				 * VAlignMiddle.ApplyStr("Game\nOf\nThrones", 5)
					    returns {"", "Game", "Of", "Thrones", ""}
				 * VAlignBottom.ApplyStr("Game\nOf\nThrones", 5)
					    returns {"", "", "Game", "Of", "Thrones"}

			( T) HTMLProperty() string
				HTMLProperty returns the equivalent HTML vertical-align tag property.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jedib0t/go-pretty/v6/table.(*Table).getVAlign(colIdx int, hint table.renderHint) VAlign
		As Types Of (total 4, all are exported)
			const VAlignBottom
			const VAlignDefault
			const VAlignMiddle
			const VAlignTop


Package-Level Functions (total 36, in which 21 are exported)

	 func DisableColors()
		DisableColors (forcefully) disables color coding globally.

	 func EnableColors()
		EnableColors (forcefully) enables color coding globally.

	 func Escape(str string, escapeSeq string) string
		Escape encodes the string with the ANSI Escape Sequence.
		For ex.:
		 Escape("Ghost", "") == "Ghost"
			Escape("Ghost", "\x1b[91m") == "\x1b[91mGhost\x1b[0m"
			Escape("\x1b[94mGhost\x1b[0mLady", "\x1b[91m") == "\x1b[94mGhost\x1b[0m\x1b[91mLady\x1b[0m"
			Escape("Nymeria\x1b[94mGhost\x1b[0mLady", "\x1b[91m") == "\x1b[91mNymeria\x1b[94mGhost\x1b[0m\x1b[91mLady\x1b[0m"
			Escape("Nymeria \x1b[94mGhost\x1b[0m Lady", "\x1b[91m") == "\x1b[91mNymeria \x1b[94mGhost\x1b[0m\x1b[91m Lady\x1b[0m"

	 func Filter(s []string, f func(string) bool) []string
		Filter filters the slice 's' to items which return truth when passed to 'f'.

	 func InsertEveryN(str string, runeToInsert rune, n int) string
		InsertEveryN inserts the rune every N characters in the string. For ex.:
		 InsertEveryN("Ghost", '-', 1) == "G-h-o-s-t"
		 InsertEveryN("Ghost", '-', 2) == "Gh-os-t"
		 InsertEveryN("Ghost", '-', 3) == "Gho-st"
		 InsertEveryN("Ghost", '-', 4) == "Ghos-t"
		 InsertEveryN("Ghost", '-', 5) == "Ghost"

	 func LongestLineLen(str string) int
		LongestLineLen returns the length of the longest "line" within the
		argument string. For ex.:
		 LongestLineLen("Ghost!\nCome back here!\nRight now!") == 15

	 func NewJSONTransformer(prefix string, indent string) Transformer
		NewJSONTransformer returns a Transformer that can format a JSON string or an
		object into pretty-indented JSON-strings.

	 func NewNumberTransformer(format string) Transformer
		NewNumberTransformer returns a number Transformer that:
		  * transforms the number as directed by 'format' (ex.: %.2f)
		  * colors negative values Red
		  * colors positive values Green

	 func NewTimeTransformer(layout string, location *time.Location) Transformer
		NewTimeTransformer returns a Transformer that can format a timestamp (a
		time.Time) into a well-defined time format defined using the provided layout
		(ex.: time.RFC3339).

		If a non-nil location value is provided, the time will be localized to that
		location (use time.Local to get localized timestamps).

	 func NewUnixTimeTransformer(layout string, location *time.Location) Transformer
		NewUnixTimeTransformer returns a Transformer that can format a unix-timestamp
		into a well-defined time format as defined by 'layout'. This can handle
		unix-time in Seconds, MilliSeconds, Microseconds and Nanoseconds.

		If a non-nil location value is provided, the time will be localized to that
		location (use time.Local to get localized timestamps).

	 func NewURLTransformer() Transformer
		NewURLTransformer returns a Transformer that can format and pretty print a string
		that contains an URL (the text is underlined and colored Blue).

	 func Pad(str string, maxLen int, paddingChar rune) string
		Pad pads the given string with as many characters as needed to make it as
		long as specified (maxLen). This function does not count escape sequences
		while calculating length of the string. Ex.:
		 Pad("Ghost", 0, ' ') == "Ghost"
		 Pad("Ghost", 3, ' ') == "Ghost"
		 Pad("Ghost", 5, ' ') == "Ghost"
		 Pad("Ghost", 7, ' ') == "Ghost  "
		 Pad("Ghost", 10, '.') == "Ghost....."

	 func RepeatAndTrim(str string, maxRunes int) string
		RepeatAndTrim repeats the given string until it is as long as maxRunes.
		For ex.:
		 RepeatAndTrim("", 5) == ""
		 RepeatAndTrim("Ghost", 0) == ""
		 RepeatAndTrim("Ghost", 5) == "Ghost"
		 RepeatAndTrim("Ghost", 7) == "GhostGh"
		 RepeatAndTrim("Ghost", 10) == "GhostGhost"

	 func RuneCount(str string) int
		RuneCount is similar to utf8.RuneCountInString, except for the fact that it
		ignores escape sequences while counting. For ex.:
		 RuneCount("") == 0
		 RuneCount("Ghost") == 5
		 RuneCount("\x1b[33mGhost\x1b[0m") == 5
		 RuneCount("\x1b[33mGhost\x1b[0") == 5

	 func RuneWidth(r rune) int
		RuneWidth returns the mostly accurate character-width of the rune. This is
		not 100% accurate as the character width is usually dependant on the
		typeface (font) used in the console/terminal. For ex.:
		 RuneWidth('A') == 1
		 RuneWidth('ツ') == 2
		 RuneWidth('⊙') == 1
		 RuneWidth('︿') == 2
		 RuneWidth(0x27) == 0

	 func Snip(str string, length int, snipIndicator string) string
		Snip returns the given string with a fixed length. For ex.:
		 Snip("Ghost", 0, "~") == "Ghost"
		 Snip("Ghost", 1, "~") == "~"
		 Snip("Ghost", 3, "~") == "Gh~"
		 Snip("Ghost", 5, "~") == "Ghost"
		 Snip("Ghost", 7, "~") == "Ghost  "
		 Snip("\x1b[33mGhost\x1b[0m", 7, "~") == "\x1b[33mGhost\x1b[0m  "

	 func StripEscape(str string) string
		StripEscape strips all ANSI Escape Sequence from the string.
		For ex.:
		 StripEscape("Ghost") == "Ghost"
			StripEscape("\x1b[91mGhost\x1b[0m") == "Ghost"
			StripEscape("\x1b[94mGhost\x1b[0m\x1b[91mLady\x1b[0m") == "GhostLady"
			StripEscape("\x1b[91mNymeria\x1b[94mGhost\x1b[0m\x1b[91mLady\x1b[0m") == "NymeriaGhostLady"
			StripEscape("\x1b[91mNymeria \x1b[94mGhost\x1b[0m\x1b[91m Lady\x1b[0m") == "Nymeria Ghost Lady"

	 func Trim(str string, maxLen int) string
		Trim trims a string to the given length while ignoring escape sequences. For
		ex.:
		 Trim("Ghost", 3) == "Gho"
		 Trim("Ghost", 6) == "Ghost"
		 Trim("\x1b[33mGhost\x1b[0m", 3) == "\x1b[33mGho\x1b[0m"
		 Trim("\x1b[33mGhost\x1b[0m", 6) == "\x1b[33mGhost\x1b[0m"

	 func WrapHard(str string, wrapLen int) string
		WrapHard wraps a string to the given length using a newline. Handles strings
		with ANSI escape sequences (such as text color) without breaking the text
		formatting. Breaks all words that go beyond the line boundary.

		For examples, refer to the unit-tests or GoDoc examples.

	 func WrapSoft(str string, wrapLen int) string
		WrapSoft wraps a string to the given length using a newline. Handles strings
		with ANSI escape sequences (such as text color) without breaking the text
		formatting. Tries to move words that go beyond the line boundary to the next
		line.

		For examples, refer to the unit-tests or GoDoc examples.

	 func WrapText(str string, wrapLen int) string
		WrapText is very similar to WrapHard except for one minor difference. Unlike
		WrapHard which discards line-breaks and respects only paragraph-breaks, this
		function respects line-breaks too.

		For examples, refer to the unit-tests or GoDoc examples.

	/* 15 unexporteds ... *//* 15 unexporteds: */
	 func appendChar(char rune, wrapLen int, lineLen *int, inEscSeq bool, lastSeenEscSeq string, out *strings.Builder)
	 func appendWord(word string, lineIdx *int, lastSeenEscSeq string, wrapLen int, out *strings.Builder)
	 func areANSICodesSupported() bool
	 func colorize(s string, escapeSeq string) string
	 func extractOpenEscapeSeq(str string) string
	 func isSeparator(r rune) bool
		isSeparator returns true if the given rune is a separator. This function is
		lifted straight out of the standard library @ strings/strings.go.

	 func terminateLine(wrapLen int, lineLen *int, lastSeenEscSeq string, out *strings.Builder)
	 func terminateOutput(lastSeenEscSeq string, out *strings.Builder)
	 func toTitle(text string) string
	 func toUpper(text string) string
	 func transformFloat(format string, val float64) string
	 func transformInt(format string, val int64) string
	 func transformUint(format string, val uint64) string
	 func wrapHard(paragraph string, wrapLen int, out *strings.Builder)
	 func wrapSoft(paragraph string, wrapLen int, out *strings.Builder)
Package-Level Variables (total 11, in which 1 are exported)

	  var ANSICodesSupported bool
		ANSICodesSupported will be true on consoles where ANSI Escape Codes/Sequences
		are supported.

	/* 10 unexporteds ... *//* 10 unexporteds: */
	  var colorCSSClassMap map[Color]string
		colorCSSClassMap contains the equivalent CSS-class for all colors

	  var colorsEnabled bool
	  var colorsNumberNegative Colors
		Transformer related variables

	  var colorsNumberPositive Colors
		Transformer related variables

	  var colorsNumberZero Colors
		Transformer related variables

	  var colorsSeqMap sync.Map
		colorsSeqMap caches the escape sequence for a set of colors

	  var colorsURL Colors
		Transformer related variables

	  var possibleTimeLayouts []string
		Transformer related variables

	  var rfc3339Micro string
		Transformer related variables

	  var rfc3339Milli string
		Transformer related variables


Package-Level Constants (total 68, in which 65 are exported)

	const AlignCenter Align = 2 // "   center   "
		Align enumerations

	const AlignDefault Align = 0 // same as AlignLeft
		Align enumerations

	const AlignJustify Align = 3 // "justify   it"
		Align enumerations

	const AlignLeft Align = 1 // "left        "
		Align enumerations

	const AlignRight Align = 4 // "       right"
		Align enumerations

	const BgBlack Color = 40
		Background colors

	const BgBlue Color = 44
		Background colors

	const BgCyan Color = 46
		Background colors

	const BgGreen Color = 42
		Background colors

	const BgHiBlack Color = 100
		Background Hi-Intensity colors

	const BgHiBlue Color = 104
		Background Hi-Intensity colors

	const BgHiCyan Color = 106
		Background Hi-Intensity colors

	const BgHiGreen Color = 102
		Background Hi-Intensity colors

	const BgHiMagenta Color = 105
		Background Hi-Intensity colors

	const BgHiRed Color = 101
		Background Hi-Intensity colors

	const BgHiWhite Color = 107
		Background Hi-Intensity colors

	const BgHiYellow Color = 103
		Background Hi-Intensity colors

	const BgMagenta Color = 45
		Background colors

	const BgRed Color = 41
		Background colors

	const BgWhite Color = 47
		Background colors

	const BgYellow Color = 43
		Background colors

	const BlinkRapid Color = 6
		Base colors -- attributes in reality

	const BlinkSlow Color = 5
		Base colors -- attributes in reality

	const Bold Color = 1
		Base colors -- attributes in reality

	const Concealed Color = 8
		Base colors -- attributes in reality

	const CrossedOut Color = 9
		Base colors -- attributes in reality

	const CursorDown Cursor = 66
		CursorDown helps move the Cursor Down X lines

	const CursorLeft Cursor = 68
		CursorLeft helps move the Cursor Left X characters

	const CursorRight Cursor = 67
		CursorRight helps move the Cursor Right X characters

	const CursorUp Cursor = 65
		CursorUp helps move the Cursor Up X lines

	const EraseLine Cursor = 75
		EraseLine helps erase all characters to the Right of the Cursor in the
		current line

	const EscapeReset = "\x1b[0m"
		Constants

	const EscapeStart = "\x1b["
		Constants

	const EscapeStartRune rune = 27 // \x1b
		Constants

	const EscapeStop = "m"
		Constants

	const EscapeStopRune = 109
		Constants

	const Faint Color = 2
		Base colors -- attributes in reality

	const FgBlack Color = 30
		Foreground colors

	const FgBlue Color = 34
		Foreground colors

	const FgCyan Color = 36
		Foreground colors

	const FgGreen Color = 32
		Foreground colors

	const FgHiBlack Color = 90
		Foreground Hi-Intensity colors

	const FgHiBlue Color = 94
		Foreground Hi-Intensity colors

	const FgHiCyan Color = 96
		Foreground Hi-Intensity colors

	const FgHiGreen Color = 92
		Foreground Hi-Intensity colors

	const FgHiMagenta Color = 95
		Foreground Hi-Intensity colors

	const FgHiRed Color = 91
		Foreground Hi-Intensity colors

	const FgHiWhite Color = 97
		Foreground Hi-Intensity colors

	const FgHiYellow Color = 93
		Foreground Hi-Intensity colors

	const FgMagenta Color = 35
		Foreground colors

	const FgRed Color = 31
		Foreground colors

	const FgWhite Color = 37
		Foreground colors

	const FgYellow Color = 33
		Foreground colors

	const FormatDefault Format = 0 // default_Case
		Format enumerations

	const FormatLower Format = 1 // lower
		Format enumerations

	const FormatTitle Format = 2 // Title
		Format enumerations

	const FormatUpper Format = 3 // UPPER
		Format enumerations

	const Italic Color = 3
		Base colors -- attributes in reality

	const Reset Color = 0
		Base colors -- attributes in reality

	const ReverseVideo Color = 7
		Base colors -- attributes in reality

	const Underline Color = 4
		Base colors -- attributes in reality

	const VAlignBottom VAlign = 3 // "\n\nbottom"
		VAlign enumerations

	const VAlignDefault VAlign = 0 // same as VAlignTop
		VAlign enumerations

	const VAlignMiddle VAlign = 2 // "\nmiddle\n"
		VAlign enumerations

	const VAlignTop VAlign = 1 // "top\n\n"
		VAlign enumerations

	/* 3 unexporteds ... *//* 3 unexporteds: */
	const unixTimeMinMicroseconds int64 = 10000000000000
		Transformer related constants

	const unixTimeMinMilliseconds int64 = 10000000000
		Transformer related constants

	const unixTimeMinNanoSeconds int64 = 10000000000000000
		Transformer related constants

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.