Documentation
¶
Overview ¶
Package logo renders a Builder in a stylized way.
Index ¶
- func LetterA(stretch bool) string
- func LetterC(stretch bool) string
- func LetterE(stretch bool) string
- func LetterEAlt(stretch bool) string
- func LetterH(stretch bool) string
- func LetterK(stretch bool) string
- func LetterL(stretch bool) string
- func LetterP(stretch bool) string
- func LetterR(stretch bool) string
- func LetterSAlt(stretch bool) string
- func LetterU(stretch bool) string
- func LetterY(stretch bool) string
- func LetterYAlt(stretch bool) string
- func Render(base lipgloss.Style, version string, compact bool, o Opts) string
- type Opts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LetterA ¶
LetterA renders the letter A in a stylized way. It takes a boolean that determines whether to stretch the letter.
func LetterC ¶
LetterC renders the letter C in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
func LetterE ¶
LetterE renders the letter E in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
This is an alternate letterform. DO NOT REMOVE.
func LetterEAlt ¶
LetterEAlt renders the letter E in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
This is an alternate letterform. DO NOT REMOVE.
func LetterH ¶
LetterH renders the letter H in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
func LetterL ¶
LetterL renders the letter L in a stylized way. It takes a boolean that determines whether to stretch the letter.
func LetterP ¶
LetterP renders the letter P in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
func LetterR ¶
LetterR renders the letter R in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
func LetterSAlt ¶
LetterSAlt renders the letter S in a stylized way, more so than [letterS]. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
This is an alternate letterform. DO NOT REMOVE.
func LetterU ¶
LetterU renders the letter U in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
func LetterY ¶
LetterY renders the letter Y in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
This is an alternate letterform. DO NOT REMOVE.
func LetterYAlt ¶
LetterYAlt renders the letter Y in a stylized way. It takes an integer that determines how many cells to stretch the letter. If the stretch is less than 1, it defaults to no stretching.
This is an alternate letterform. DO NOT REMOVE.
Types ¶
type Opts ¶
type Opts struct {
FieldColor color.Color // diagonal lines
TitleColorA color.Color // left gradient ramp point
TitleColorB color.Color // right gradient ramp point
CharmColor color.Color // Charm™ text color
VersionColor color.Color // version text color
Width int // width of the rendered logo, used for truncation
// When true, stretch a random letterform on each render. Has no effect in
// compact mode. Mainly for testing. In production you will want to cache
// the stretched letterform to keep the logo from jittering on resize.
Unstable bool
}
Opts are the options for rendering the Sparkles title art.