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.
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
Add BlockBorder, OuterHalfBlockBorder, and InnerHalfBlockBorder border styles #120
Conversation
This is great; thanks for the PR. My only thought here is the name, since the effect you're going for in your example could also be done with inner padding. I wonder if there's anything else that's perhaps more clear. Maybe |
If I'm not mistaken, inner padding + background would create a larger border effect (notice the size of the top/bottom border):
My reasoning behind the name was that by organizing the characters differently and changing corners blocks, you would get some kind of outer border, and by using a full-width block character, you would get another effect too ( I'm of course all open to renaming it to something else, but at least you have more context now 😊 The characters come from here, if needed: https://en.wikipedia.org/wiki/Box-drawing_character#Block_Elements Here's a new version of the demo, with a standardized width to easily compare them together: package main
import (
"fmt"
"github.com/charmbracelet/lipgloss"
)
var (
fullBorder = lipgloss.Border{
Top: "█",
Bottom: "█",
Left: "█",
Right: "█",
TopLeft: "█",
TopRight: "█",
BottomLeft: "█",
BottomRight: "█",
}
outerBorder = lipgloss.Border{
Top: "▀",
Bottom: "▄",
Left: "▌",
Right: "▐",
TopLeft: "▛",
TopRight: "▜",
BottomLeft: "▙",
BottomRight: "▟",
}
innerBorder = lipgloss.Border{
Top: "▄",
Bottom: "▀",
Left: "▐",
Right: "▌",
TopLeft: "▗",
TopRight: "▖",
BottomLeft: "▝",
BottomRight: "▘",
}
)
func main() {
fmt.Println()
color := lipgloss.Color("#00f5d4)")
testBorders := lipgloss.NewStyle().Foreground(lipgloss.Color("#333")).Background(color).BorderForeground(color).Width(15)
fmt.Println(testBorders.Copy().Border(lipgloss.NormalBorder()).Render("NormalBorder"))
fmt.Println(testBorders.Copy().Border(lipgloss.RoundedBorder()).Render("RoundedBorder"))
fmt.Println(testBorders.Copy().Border(fullBorder).Render("FullBorder"))
fmt.Println(testBorders.Copy().Border(innerBorder).Render("InnerBorder"))
fmt.Println(testBorders.Copy().Border(outerBorder).Render("OuterBorder"))
fmt.Println(testBorders.Copy().Border(lipgloss.ThickBorder()).Render("ThickBorder"))
fmt.Println(testBorders.Copy().Border(lipgloss.DoubleBorder()).Render("DoubleBorder"))
fmt.Println(testBorders.Copy().Border(lipgloss.HiddenBorder()).Render("HiddenBorder"))
fmt.Println(testBorders.Copy().Padding(1).Render("WithPadding1"))
} |
Not 100% sure on this but maybe this could be called Thinking about this a bit more, I think |
Love the names! I will edit my PR and add the new ones too. |
Thanks so much @VictorBersy, this looks great! |
…s to v0.7.1 (#7) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/charmbracelet/lipgloss](https://togithub.com/charmbracelet/lipgloss) | require | minor | `v0.6.0` -> `v0.7.1` | --- ### Release Notes <details> <summary>charmbracelet/lipgloss</summary> ### [`v0.7.1`](https://togithub.com/charmbracelet/lipgloss/releases/tag/v0.7.1) [Compare Source](https://togithub.com/charmbracelet/lipgloss/compare/v0.7.0...v0.7.1) This bugfix release fixes a problem introduced in v0.7.0 where applications could freeze or hang on start-up. #### What's Changed - fix(renderer): use termenv default renderer by [@​aymanbagabas](https://togithub.com/aymanbagabas) in [charmbracelet/lipgloss#179 - chore: bump termenv to v0.15.1 by [@​muesli](https://togithub.com/muesli) in [charmbracelet/lipgloss#180 **Full Changelog**: charmbracelet/lipgloss@v0.7.0...v0.7.1 ### [`v0.7.0`](https://togithub.com/charmbracelet/lipgloss/releases/tag/v0.7.0) [Compare Source](https://togithub.com/charmbracelet/lipgloss/compare/v0.6.0...v0.7.0) ### Custom Renderers We're pleased to introduce custom renders for Lip Gloss! Custom renderers allow you to render to a specific outputs, which is particularly important when you want to detect the color profile and dark background status for multiple different outputs at runtime, such as in a server-client situation. Here's what it looks like: ```go func myLittleHandler(sess ssh.Session) { // Create a renderer for the client. renderer := lipgloss.NewRenderer(sess) // Create a new style on the renderer. style := renderer.NewStyle().Background(lipgloss.AdaptiveColor{Light: "63", Dark: "228"}) // Render. The color profile and dark background state will be correctly detected. io.WriteString(sess, style.Render("Heyyyyyyy")) } ``` For a full example on using a custom renderer over SSH with [Wish](https://togithub.com/charmbracelet/wish) see the [SSH example](https://togithub.com/charmbracelet/lipgloss/blob/master/examples/ssh). #### New API Stuff - `type Renderer struct` - `NewRenderer(io.Writer)` - `DefaultRenderer()` - `SetDefaultRenderer(*lipgloss.Renderer)` - `style.Renderer(*lipgloss.Renderer) Style` #### What's Changed ##### New - lipgloss renderer by [@​aymanbagabas](https://togithub.com/aymanbagabas) in [charmbracelet/lipgloss#140 and [charmbracelet/lipgloss#174 - add BlockBorder, OuterHalfBlockBorder, and InnerHalfBlockBorder border styles by [@​VictorBersy](https://togithub.com/VictorBersy) in [charmbracelet/lipgloss#120 ##### Fixed - RGBA implementations for non-hex color values by [@​muesli](https://togithub.com/muesli) in [charmbracelet/lipgloss#126 - unify get border size function names by [@​nerg4l](https://togithub.com/nerg4l) in [charmbracelet/lipgloss#148 - reduce dependencies by [@​caarlos0](https://togithub.com/caarlos0) in [charmbracelet/lipgloss#146 - don't concurrently change output profiles by [@​muesli](https://togithub.com/muesli) in [charmbracelet/lipgloss#172 #### New Contributors - [@​dependabot](https://togithub.com/dependabot) made their first contribution in [charmbracelet/lipgloss#133 - [@​winder](https://togithub.com/winder) made their first contribution in [charmbracelet/lipgloss#147 - [@​VictorBersy](https://togithub.com/VictorBersy) made their first contribution in [charmbracelet/lipgloss#120 - [@​nervo](https://togithub.com/nervo) made their first contribution in [charmbracelet/lipgloss#156 - [@​caarlos0](https://togithub.com/caarlos0) made their first contribution in [charmbracelet/lipgloss#146 - [@​Isti115](https://togithub.com/Isti115) made their first contribution in [charmbracelet/lipgloss#170 - [@​nerg4l](https://togithub.com/nerg4l) made their first contribution in [charmbracelet/lipgloss#148 **Full Changelog**: charmbracelet/lipgloss@v0.6.0...v0.7.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 3am on Monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/sheldonhull/az-pr). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4yMi4xIiwidXBkYXRlZEluVmVyIjoiMzUuMjIuMSJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
By having the same color for the border and the background of the element, it gives some cool results:
For context, in a game where you can buy upgrades, you can show the user the ones that have been already bought, the ones they can buy, and the ones still locked:
I think it could be a useful addition, for example when you want to highlight something as if it was a button.
Quick testing: