join

Documentation

Overview

Package join provides a shell script interface for the lipgloss JoinHorizontal 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 ║ ║ ║║ ║ ╚══════════════════════╝╚═════════════╝

Index

• type Options
  • func (o Options) Run() error

Types

type Options

type Options struct {
	Text []string `arg:"" help:"Text to join."`

	Align      string `help:"Text alignment" enum:"left,center,right,bottom,middle,top" default:"left"`
	Horizontal bool   `help:"Join (potentially multi-line) strings horizontally"`
	Vertical   bool   `help:"Join (potentially multi-line) strings vertically"`
}

Options is the set of options that can configure a join.

func (Options) Run

func (o Options) Run() error

Run is the command-line interface for the joining strings through lipgloss.