color

Documentation

Overview

Package color handles experimental GitHub CLI user experiences focused on color rendering concerns such as accessibility and color roles.

Note this is an experimental package where the API is subject to change.

Index

• Constants
• func IsAccessibleColorsEnabled() bool

Constants

const (
	// AccessibleColorsEnv is the name of the environment variable to enable accessibile color features.
	AccessibleColorsEnv = "GH_ACCESSIBLE_COLORS"

	// AccessibleColorsSetting is the name of the `gh config` setting to enable accessibile color features.
	AccessibleColorsSetting = "accessible_colors"
)

Functions

func IsAccessibleColorsEnabled

func IsAccessibleColorsEnabled() bool

IsAccessibleColorsEnabled returns true if accessible colors are enabled via environment variable or configuration setting with the environment variable having higher precedence.

If the environment variable is set, then any value other than the following will enable accessible colors: empty, "0", "false", or "no".