table

package

v0.14.0 Latest Latest Go to latest Published: Apr 26, 2024 License: MIT Imports: 9 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/charmbracelet/gum

Links

Open Source Insights

Documentation ¶

Overview ¶

Package table provides a shell script interface for the table bubble. https://github.com/charmbracelet/bubbles/tree/master/table

It is useful to render tabular (CSV) data in a terminal and allows the user to select a row from the table.

Let's render a table of gum flavors:

$ gum table <<< "Flavor,Price\nStrawberry,$0.50\nBanana,$0.99\nCherry,$0.75"

Flavor      Price
Strawberry  $0.50
Banana      $0.99
Cherry      $0.75

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	Separator string   `short:"s" help:"Row separator" default:","`
	Columns   []string `short:"c" help:"Column names"`
	Widths    []int    `short:"w" help:"Column widths"`
	Height    int      `help:"Table height" default:"10"`
	Print     bool     `short:"p" help:"static print" default:"false"`
	File      string   `short:"f" help:"file path" default:""`
	Border    string   `short:"b" help:"border style" default:"rounded" enum:"rounded,thick,normal,hidden,double,none"`

	BorderStyle   style.Styles `embed:"" prefix:"border." envprefix:"GUM_TABLE_BORDER_"`
	CellStyle     style.Styles `embed:"" prefix:"cell." envprefix:"GUM_TABLE_CELL_"`
	HeaderStyle   style.Styles `embed:"" prefix:"header." envprefix:"GUM_TABLE_HEADER_"`
	SelectedStyle style.Styles `embed:"" prefix:"selected." set:"defaultForeground=212" envprefix:"GUM_TABLE_SELECTED_"`
}

Options is the customization options for the table command.

func (Options) Run ¶

func (o Options) Run() error

Run provides a shell script interface for rendering tabular data (CSV).

Source Files ¶

View all Source files

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