deblan-mirror/gum
deblan-mirror/gum
1
0
Fork 0
mirror of https://github.com/charmbracelet/gum synced 2024-06-18 13:35:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add join comment with example

Browse source
This commit is contained in:
Maas Lalani 2022-07-08 10:23:45 -04:00
parent 9e483004fc
commit b58dc52fc8
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
gum.go
View file

@ -96,7 +96,20 @@ type Gum struct {
Style style.Options `cmd:"" help:"Style some text."`
// Join provides a shell script interface for the lipgloss JoinHorizontal
// and JoinVertical commands.
// and JoinVertical commands. It allows you to join multi-line text to
// build different layouts.
//
// For example, you can place two bordered boxes next to each other:
// Note: We wrap the variable in quotes to ensure the new lines are part of a
// single argument. Otherwise, the command won't work as expected.
//
// $ gum join --horizontal "$BUBBLE_BOX" "$GUM_BOX"
//
// ╔══════════════════════╗╔═════════════╗
// ║ ║║ ║
// ║ Bubble ║║ Gum ║
// ║ ║║ ║
// ╚══════════════════════╝╚═════════════╝
//
Join join.Options `cmd:"" help:"Join text horizontally or vertically."`
}