package style

Import Path
	github.com/carapace-sh/carapace/pkg/style (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 11 packages

Involved Source Files

	    config.go
	    keyword.go
	    loglevel.go
	    path.go
	  d style.go
		Package style provide display coloring
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Context (interface)

		Methods (total 3)
			( Context) Abs(s string) (string, error)
			( Context) Getenv(key string) string
			( Context) LookupEnv(key string) (string, bool)
		Implemented By (at least 3)
			 github.com/carapace-sh/carapace/pkg/traverse.Context (interface)
			 github.com/carapace-sh/carapace/pkg/uid.Context (interface)
			 github.com/carapace-sh/carapace.Context
		Implements (at least 2)
			 Context : github.com/carapace-sh/carapace/pkg/traverse.Context
			 Context : github.com/carapace-sh/carapace/pkg/uid.Context
		As Inputs Of (at least 5)
			func ForExtension(path string, sc Context) string
			func ForKeyword(s string, _ Context) string
			func ForLogLevel(s string, _ Context) string
			func ForPath(path string, sc Context) string
			func ForPathExt(path string, sc Context) string


Package-Level Functions (total 12)

	 func ForExtension(path string, sc Context) string
		ForExtension returns the style for given extension
		
			json

	 func ForKeyword(s string, _ Context) string
		ForKeyword returns the style for given keyword.

	 func ForLogLevel(s string, _ Context) string
		ForLogLevel returns the style for given log level.

	 func ForPath(path string, sc Context) string
		ForPath returns the style for given path
		
			/tmp/locally/reachable/file.txt

	 func ForPathExt(path string, sc Context) string
		ForPath returns the style for given path by extension only
		
			/tmp/non/existing/file.txt

	 func Of(s ...string) string
		Of combines different styles.

	 func Parse(s string) ui.Style
	 func Register(name string, i interface{})
		Register a style configuration
		
			var Carapace = struct {
				Value       string `description:"default style for values"`
				Description string `description:"default style for descriptions"`
			}{
				Value:       Default,
				Description: Gray,
			}
		
			func init() {
				Register("carapace", &Carapace)
			}

	 func Set(key, value string) error
		Set a style
		
			Set("carapace.Value", "bold magenta")

	 func SGR(s string) string
		SGR returns the SGR sequence for given style.

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

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


Package-Level Variables (total 40)

	  var BgBlack string
	  var BgBlue string
	  var BgBrightBlack string
	  var BgBrightBlue string
	  var BgBrightCyan string
	  var BgBrightGreen string
	  var BgBrightMagenta string
	  var BgBrightRed string
	  var BgBrightWhite string
	  var BgBrightYellow string
	  var BgCyan string
	  var BgGreen string
	  var BgMagenta string
	  var BgRed string
	  var BgWhite string
	  var BgYellow string
	  var Black string
	  var Blink string
	  var Blue string
	  var Bold string
	  var BrightBlack string
	  var BrightBlue string
	  var BrightCyan string
	  var BrightGreen string
	  var BrightMagenta string
	  var BrightRed string
	  var BrightWhite string
	  var BrightYellow string
	  var Carapace carapace
	  var Cyan string
	  var Default string
	  var Dim string
	  var Green string
	  var Inverse string
	  var Italic string
	  var Magenta string
	  var Red string
	  var Underlined string
	  var White string
	  var Yellow string

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.