logo

package
v0.3.27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package logo renders a Builder in a stylized way.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func LetterA

func LetterA(stretch bool) string

LetterA renders the letter A in a stylized way. It takes a boolean that determines whether to stretch the letter.

func LetterC

func LetterC(stretch bool) string

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

func LetterE(stretch bool) string

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

func LetterEAlt(stretch bool) string

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

func LetterH(stretch bool) string

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 LetterK

func LetterK(stretch bool) string

determines whether to stretch the letter.

func LetterL

func LetterL(stretch bool) string

LetterL renders the letter L in a stylized way. It takes a boolean that determines whether to stretch the letter.

func LetterP

func LetterP(stretch bool) string

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

func LetterR(stretch bool) string

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

func LetterSAlt(stretch bool) string

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

func LetterU(stretch bool) string

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

func LetterY(stretch bool) string

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

func LetterYAlt(stretch bool) string

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.

func Render

func Render(base lipgloss.Style, version string, compact bool, o Opts) string

Render renders the Sparkles logo. Set the argument to true to render the narrow version, intended for use in a sidebar.

The compact argument determines whether it renders compact for the sidebar or wider for the main pane.

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.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL