badge

Documentation

Index

• Constants
• Variables
• type Badge
  • func GenerateBadge(label, message, color string) Badge
  • func (b Badge) Width() int
• type Text
  • func (t Text) Text() string
  • func (t Text) TextLength() int
  • func (t Text) Width() int
  • func (t Text) X() int

Constants

const (
	StyleFlat       = "flat"
	StyleFlatSquare = "flat-square"
)

Style follows https://shields.io/badges

const (
	DefaultColor      = "#9f9f9f" // Grey
	DefaultFontFamily = "DejaVu Sans,Verdana,Geneva,sans-serif"
	DefaultStyle      = StyleFlat
)

Variables

var GlobalVars = sync.OnceValue(func() (ret struct {
	StatusColorMap       map[actions_model.Status]string
	DejaVuGlyphWidthData map[rune]uint8
	AllStyles            []string
},
) {
	ret.StatusColorMap = map[actions_model.Status]string{
		actions_model.StatusSuccess:   "#4c1",
		actions_model.StatusSkipped:   "#dfb317",
		actions_model.StatusUnknown:   "#97ca00",
		actions_model.StatusFailure:   "#e05d44",
		actions_model.StatusCancelled: "#fe7d37",
		actions_model.StatusWaiting:   "#dfb317",
		actions_model.StatusRunning:   "#dfb317",
		actions_model.StatusBlocked:   "#dfb317",
	}
	ret.DejaVuGlyphWidthData = dejaVuGlyphWidthDataFunc()
	ret.AllStyles = []string{StyleFlat, StyleFlatSquare}
	return ret
})

Types

type Badge

type Badge struct {
	IDPrefix   string
	FontFamily string
	Color      string
	FontSize   int
	Label      Text
	Message    Text
}

func GenerateBadge

func GenerateBadge(label, message, color string) Badge

GenerateBadge generates badge with given template

func (Badge) Width

func (b Badge) Width() int

type Text

type Text struct {
	// contains filtered or unexported fields
}

func (Text) Text

func (t Text) Text() string

func (Text) TextLength

func (t Text) TextLength() int

func (Text) Width

func (t Text) Width() int

func (Text) X

func (t Text) X() int