Skip to content

fix: correct AddBgRGB godoc and tighten both RGB examples #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
c-tonneslan wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −4
Open

fix: correct AddBgRGB godoc and tighten both RGB examples #287

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions color.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,15 +193,17 @@ func BgRGB(r, g, b int) *Color {
return New(background, 2, Attribute(r), Attribute(g), Attribute(b))
}

// AddRGB is used to chain foreground RGB SGR parameters. Use as many as parameters to combine
// and create custom color objects. Example: .Add(34, 0, 12).Add(255, 128, 0).
// AddRGB chains a 24-bit RGB foreground color onto the current color object,
// so it can be combined with other attributes. Example:
// New(Bold).AddRGB(255, 128, 0).
func (c *Color) AddRGB(r, g, b int) *Color {
c.params = append(c.params, foreground, 2, Attribute(r), Attribute(g), Attribute(b))
return c
}

// AddRGB is used to chain background RGB SGR parameters. Use as many as parameters to combine
// and create custom color objects. Example: .Add(34, 0, 12).Add(255, 128, 0).
// AddBgRGB chains a 24-bit RGB background color onto the current color object,
// so it can be combined with other attributes. Example:
// RGB(255, 255, 255).AddBgRGB(0, 0, 0).
func (c *Color) AddBgRGB(r, g, b int) *Color {
c.params = append(c.params, background, 2, Attribute(r), Attribute(g), Attribute(b))
return c
Expand Down