package ui

Import Path
	github.com/carapace-sh/carapace/third_party/github.com/elves/elvish/pkg/ui (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 4 packages

Involved Source Files

	    color.go
	    parse_sgr.go
	    style.go
	    styling.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Color (interface)
		Color represents a color.

		Methods (only one)
			( Color) String() string
		Implements (at least 2)
			 Color : expvar.Var
			 Color : fmt.Stringer
		As Outputs Of (at least 2)
			func TrueColor(r, g, b uint8) Color
			func XTerm256Color(i uint8) Color
		As Inputs Of (at least 2)
			func Bg(c Color) Styling
			func Fg(c Color) Styling
		As Types Of (total 16)
			  var Black
			  var Blue
			  var BrightBlack
			  var BrightBlue
			  var BrightCyan
			  var BrightGreen
			  var BrightMagenta
			  var BrightRed
			  var BrightWhite
			  var BrightYellow
			  var Cyan
			  var Green
			  var Magenta
			  var Red
			  var White
			  var Yellow

	 type Style (struct)
		Style specifies how something (mostly a string) shall be displayed.

		Fields (total 8)
			Background Color
			Blink bool
			Bold bool
			Dim bool
			Foreground Color
			Inverse bool
			Italic bool
			Underlined bool
		Methods (total 2)
			(*Style) MergeFromOptions(options map[string]interface{}) error
				MergeFromOptions merges all recognized values from a map to the current
				Style.

			( Style) SGR() string
				SGR returns SGR sequence for the style.

		As Outputs Of (at least 3)
			func ApplyStyling(s Style, ts ...Styling) Style
			func StyleFromSGR(s string) Style
			func github.com/carapace-sh/carapace/pkg/style.Parse(s string) Style
		As Inputs Of (at least one exported)
			func ApplyStyling(s Style, ts ...Styling) Style

	 type Styling (interface)
		Styling specifies how to change a Style. It can also be applied to a Segment
		or Text.

		As Outputs Of (at least 5)
			func Bg(c Color) Styling
			func Fg(c Color) Styling
			func ParseStyling(s string) Styling
			func StylingFromSGR(s string) Styling
			func Stylings(ts ...Styling) Styling
		As Inputs Of (at least 2)
			func ApplyStyling(s Style, ts ...Styling) Style
			func Stylings(ts ...Styling) Styling
		As Types Of (total 53)
			  var BgBlack
			  var BgBlue
			  var BgBrightBlack
			  var BgBrightBlue
			  var BgBrightCyan
			  var BgBrightGreen
			  var BgBrightMagenta
			  var BgBrightRed
			  var BgBrightWhite
			  var BgBrightYellow
			  var BgCyan
			  var BgDefault
			  var BgGreen
			  var BgMagenta
			  var BgRed
			  var BgWhite
			  var BgYellow
			  var Blink
			  var Bold
			  var Dim
			  var FgBlack
			  var FgBlue
			  var FgBrightBlack
			  var FgBrightBlue
			  var FgBrightCyan
			  var FgBrightGreen
			  var FgBrightMagenta
			  var FgBrightRed
			  var FgBrightWhite
			  var FgBrightYellow
			  var FgCyan
			  var FgDefault
			  var FgGreen
			  var FgMagenta
			  var FgRed
			  var FgWhite
			  var FgYellow
			  var Inverse
			  var Italic
			  var NoBlink
			  var NoBold
			  var NoDim
			  var NoInverse
			  var NoItalic
			  var NoUnderlined
			  var Reset
			  var ToggleBlink
			  var ToggleBold
			  var ToggleDim
			  var ToggleInverse
			  var ToggleItalic
			  var ToggleUnderlined
			  var Underlined


Package-Level Functions (total 9)

	 func ApplyStyling(s Style, ts ...Styling) Style
		ApplyStyling returns a new Style with the given Styling's applied.

	 func Bg(c Color) Styling
		Bg returns a Styling that sets the background color.

	 func Fg(c Color) Styling
		Fg returns a Styling that sets the foreground color.

	 func ParseStyling(s string) Styling
		ParseStyling parses a text representation of Styling, which are kebab
		case counterparts to the names of the builtin Styling's. For example,
		ToggleInverse is expressed as "toggle-inverse".
		
		Multiple stylings can be joined by spaces, which is equivalent to calling
		Stylings.
		
		If the given string is invalid, ParseStyling returns nil.

	 func StyleFromSGR(s string) Style
		StyleFromSGR builds a Style from an SGR sequence.

	 func StylingFromSGR(s string) Styling
		StylingFromSGR builds a Style from an SGR sequence.

	 func Stylings(ts ...Styling) Styling
		Stylings joins several transformers into one.

	 func TrueColor(r, g, b uint8) Color
		TrueColor returns a 24-bit true color.

	 func XTerm256Color(i uint8) Color
		XTerm256Color returns a color from the xterm 256-color palette.


Package-Level Variables (total 69)

	  var BgBlack Styling
		Common stylings.

	  var BgBlue Styling
		Common stylings.

	  var BgBrightBlack Styling
		Common stylings.

	  var BgBrightBlue Styling
		Common stylings.

	  var BgBrightCyan Styling
		Common stylings.

	  var BgBrightGreen Styling
		Common stylings.

	  var BgBrightMagenta Styling
		Common stylings.

	  var BgBrightRed Styling
		Common stylings.

	  var BgBrightWhite Styling
		Common stylings.

	  var BgBrightYellow Styling
		Common stylings.

	  var BgCyan Styling
		Common stylings.

	  var BgDefault Styling
		Common stylings.

	  var BgGreen Styling
		Common stylings.

	  var BgMagenta Styling
		Common stylings.

	  var BgRed Styling
		Common stylings.

	  var BgWhite Styling
		Common stylings.

	  var BgYellow Styling
		Common stylings.

	  var Black Color
		Builtin ANSI colors.

	  var Blink Styling
		Common stylings.

	  var Blue Color
		Builtin ANSI colors.

	  var Bold Styling
		Common stylings.

	  var BrightBlack Color
		Builtin ANSI colors.

	  var BrightBlue Color
		Builtin ANSI colors.

	  var BrightCyan Color
		Builtin ANSI colors.

	  var BrightGreen Color
		Builtin ANSI colors.

	  var BrightMagenta Color
		Builtin ANSI colors.

	  var BrightRed Color
		Builtin ANSI colors.

	  var BrightWhite Color
		Builtin ANSI colors.

	  var BrightYellow Color
		Builtin ANSI colors.

	  var Cyan Color
		Builtin ANSI colors.

	  var Dim Styling
		Common stylings.

	  var FgBlack Styling
		Common stylings.

	  var FgBlue Styling
		Common stylings.

	  var FgBrightBlack Styling
		Common stylings.

	  var FgBrightBlue Styling
		Common stylings.

	  var FgBrightCyan Styling
		Common stylings.

	  var FgBrightGreen Styling
		Common stylings.

	  var FgBrightMagenta Styling
		Common stylings.

	  var FgBrightRed Styling
		Common stylings.

	  var FgBrightWhite Styling
		Common stylings.

	  var FgBrightYellow Styling
		Common stylings.

	  var FgCyan Styling
		Common stylings.

	  var FgDefault Styling
		Common stylings.

	  var FgGreen Styling
		Common stylings.

	  var FgMagenta Styling
		Common stylings.

	  var FgRed Styling
		Common stylings.

	  var FgWhite Styling
		Common stylings.

	  var FgYellow Styling
		Common stylings.

	  var Green Color
		Builtin ANSI colors.

	  var Inverse Styling
		Common stylings.

	  var Italic Styling
		Common stylings.

	  var Magenta Color
		Builtin ANSI colors.

	  var NoBlink Styling
		Common stylings.

	  var NoBold Styling
		Common stylings.

	  var NoDim Styling
		Common stylings.

	  var NoInverse Styling
		Common stylings.

	  var NoItalic Styling
		Common stylings.

	  var NoUnderlined Styling
		Common stylings.

	  var Red Color
		Builtin ANSI colors.

	  var Reset Styling
		Common stylings.

	  var ToggleBlink Styling
		Common stylings.

	  var ToggleBold Styling
		Common stylings.

	  var ToggleDim Styling
		Common stylings.

	  var ToggleInverse Styling
		Common stylings.

	  var ToggleItalic Styling
		Common stylings.

	  var ToggleUnderlined Styling
		Common stylings.

	  var Underlined Styling
		Common stylings.

	  var White Color
		Builtin ANSI colors.

	  var Yellow Color
		Builtin ANSI colors.

The pages are generated with Golds v0.8.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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.