stickers

package module
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 28, 2022 License: MIT Imports: 9 Imported by: 14

README

Stickers 👾

Is a collection of TUI elements, FlexBox and Table at the moment, its build for bubbletea using lipgloss.

Demo

Flex Box 📦

Responsive grid box insipred by CSS flexbox.
Easy to create responsive grids that scale using ratios between these elements. FlexBox Simple Demo

Table 🍰

Responsive, x/y scrollable, sortable table using FlexBox.
Tabel viewer with ability to get the content of the cell over which the cursor is placed at and sort the data by column. Sorting supports basic number and string type so number sorting is possible 🎉 Table Multi-Type Demo

TODO
  • filtering ✅
  • sorting ✅

Known issues

Table selected cell is not rendering background color correctly, will be fixed with https://github.com/charmbracelet/lipgloss/pull/69

Made with Charm.

The Charm logo

Documentation

Index

Constants

View Source 
const (
	TableSortingAscending  = 0
	TableSortingDescending = 1
)

Variables

This section is empty.

Functions

This section is empty.

Types

type FlexBox 

type FlexBox struct {
	// contains filtered or unexported fields
}

FlexBox responsive box grid insipred by CSS flexbox

func NewFlexBox 

func NewFlexBox(width, height int) *FlexBox

NewFlexBox initialize FlexBox object with defaults

func (*FlexBox) AddRows 

func (r *FlexBox) AddRows(rows []*FlexBoxRow) *FlexBox

AddRows appends additional rows to the FlexBox

func (*FlexBox) ForceRecalculate 

func (r *FlexBox) ForceRecalculate()

ForceRecalculate forces the recalculation for the box and all the rows

func (*FlexBox) GetHeight 

func (r *FlexBox) GetHeight() int

GetHeight yields current FlexBox height

func (*FlexBox) GetRow 

func (r *FlexBox) GetRow(index int) (row FlexBoxRow, exists bool)

GetRow returns the FlexBoxRow on the given index if it exists note: it does not return a pointer

func (*FlexBox) GetWidth 

func (r *FlexBox) GetWidth() int

GetWidth yields current FlexBox width

func (*FlexBox) LockRowHeight 

func (r *FlexBox) LockRowHeight(value int) *FlexBox

LockRowHeight sets the fixed height value for all the rows this will disable vertical scaling

func (*FlexBox) MustGetRow 

func (r *FlexBox) MustGetRow(index int) FlexBoxRow

MustGetRow same as GetRow only panics if row does not exist

func (*FlexBox) NewRow 

func (r *FlexBox) NewRow() *FlexBoxRow

NewRow initialize a new FlexBoxRow with width inherited from the FlexBox

func (*FlexBox) Render 

func (r *FlexBox) Render() string

Render initiates the recalculation of the rows dimensions(height) if the recalculate flag is on, and then it renders all the rows and combines them on the vertical axis

func (*FlexBox) Row 

func (r *FlexBox) Row(index int) *FlexBoxRow

Row returns the FlexBoxRow on the given index if it exists note: forces the recalculation if found

func (*FlexBox) RowsLen 

func (r *FlexBox) RowsLen() int

RowsLen returns the len of the rows slice

func (*FlexBox) SetHeight 

func (r *FlexBox) SetHeight(value int) *FlexBox

SetHeight sets the FlexBox height

func (*FlexBox) SetRows 

func (r *FlexBox) SetRows(rows []*FlexBoxRow) *FlexBox

SetRows replace rows on the FlexBox

func (*FlexBox) SetStyle 

func (r *FlexBox) SetStyle(style lipgloss.Style) *FlexBox

SetStyle replaces the style, it unsets width/height related keys

func (*FlexBox) SetWidth 

func (r *FlexBox) SetWidth(value int) *FlexBox

SetWidth sets the FlexBox width

func (*FlexBox) StylePassing 

func (r *FlexBox) StylePassing(value bool) *FlexBox

StylePassing set whether the style should be passed to the rows

func (*FlexBox) UpdateRow 

func (r *FlexBox) UpdateRow(index int, row *FlexBoxRow) *FlexBox

UpdateRow replaces the FlexBoxRow on the given index

type FlexBoxCell 

type FlexBoxCell struct {
	// contains filtered or unexported fields
}

FlexBoxCell is a building block object of the FlexBox, it represents a single cell within a box cells are stacked horizontally

func NewFlexBoxCell 

func NewFlexBoxCell(ratioX, ratioY int) *FlexBoxCell

NewFlexBoxCell initialize FlexBoxCell object with defaults

func (*FlexBoxCell) GetContent 

func (r *FlexBoxCell) GetContent() string

GetContent returns the cells raw content

func (*FlexBoxCell) GetHeight 

func (r *FlexBoxCell) GetHeight() int

GetHeight returns real height of the cell

func (*FlexBoxCell) GetStyle 

func (r *FlexBoxCell) GetStyle() lipgloss.Style

GetStyle returns the copy of the cells current style

func (*FlexBoxCell) GetWidth 

func (r *FlexBoxCell) GetWidth() int

GetWidth returns real width of the cell

func (*FlexBoxCell) SetContent 

func (r *FlexBoxCell) SetContent(content string) *FlexBoxCell

SetContent sets the cells content

func (*FlexBoxCell) SetID 

func (r *FlexBoxCell) SetID(id string) *FlexBoxCell

SetID sets the cells ID

func (*FlexBoxCell) SetMinWidth 

func (r *FlexBoxCell) SetMinWidth(value int) *FlexBoxCell

SetMinWidth sets the cells minimum width, this will not disable responsivness

func (*FlexBoxCell) SetStyle 

func (r *FlexBoxCell) SetStyle(style lipgloss.Style) *FlexBoxCell

SetStyle replaces the style, it unsets width/height related keys

type FlexBoxRow 

type FlexBoxRow struct {
	// contains filtered or unexported fields
}

FlexBoxRow is the container for the cells, this object has the least to do with the ratio of the construction as it takes all of the needed ratio information from the cell slice rows are stacked vertically

func (*FlexBoxRow) AddCells 

func (r *FlexBoxRow) AddCells(cells []*FlexBoxCell) *FlexBoxRow

AddCells appends the cells to the row if the cell ID is not set it will default to the index of the cell

func (*FlexBoxRow) Cell 

func (r *FlexBoxRow) Cell(index int) *FlexBoxCell

Cell returns the FlexBoxCell on the given index if it exists note: forces the recalculation if found

func (*FlexBoxRow) CellsLen 

func (r *FlexBoxRow) CellsLen() int

CellsLen returns the len of the cells slice

func (*FlexBoxRow) GetCellWithID 

func (r *FlexBoxRow) GetCellWithID(id string) (cell FlexBoxCell, exists bool)

GetCellWithID returns the cell with the given ID if existing

func (*FlexBoxRow) GetCellWithIndex 

func (r *FlexBoxRow) GetCellWithIndex(index int) (cell FlexBoxCell, exists bool)

GetCellWithIndex returns the cell with the given index if existing note: it does not return a pointer

func (*FlexBoxRow) MustGetCellWithIndex 

func (r *FlexBoxRow) MustGetCellWithIndex(index int) FlexBoxCell

MustGetCellWithIndex returns the cell with the given index if existing, panic if not note: it does not return a pointer

func (*FlexBoxRow) SetStyle 

func (r *FlexBoxRow) SetStyle(style lipgloss.Style) *FlexBoxRow

SetStyle replaces the style, it unsets width/height related keys

func (*FlexBoxRow) StylePassing 

func (r *FlexBoxRow) StylePassing(value bool) *FlexBoxRow

StylePassing set whether the style should be passed to the cells

func (*FlexBoxRow) UpdateCellWithIndex 

func (r *FlexBoxRow) UpdateCellWithIndex(index int, cell *FlexBoxCell)

UpdateCellWithIndex replaces the cell on the given index if it exists if its not existing no changes will apply

type Ordered 

type Ordered interface {
	int | int8 | int32 | int16 | int64 | float32 | float64 | string
}

type Table 

type Table struct {
	// contains filtered or unexported fields
}

Table responsive, x/y scrollable table that uses magic of FlexBox

func NewTable 

func NewTable(width, height int, columnHeaders []string) *Table

NewTable initialize Table object with defaults

func (*Table) AddRows 

func (r *Table) AddRows(rows [][]any) (*Table, error)

AddRows add multiple rows, will return error on the first instance of a row that does not match the type set on table will update rows only when there are no errors

func (*Table) CursorDown 

func (r *Table) CursorDown() *Table

CursorDown move table cursor down

func (*Table) CursorLeft 

func (r *Table) CursorLeft() *Table

CursorLeft move table cursor left

func (*Table) CursorRight 

func (r *Table) CursorRight() *Table

CursorRight move table cursor right

func (*Table) CursorUp 

func (r *Table) CursorUp() *Table

CursorUp move table cursor up

func (*Table) GetCursorLocation 

func (r *Table) GetCursorLocation() (int, int)

GetCursorLocation returns the current x,y position of the cursor

func (*Table) GetCursorValue 

func (r *Table) GetCursorValue() string

GetCursorValue returns the string of the cell under the cursor

func (*Table) GetFilter 

func (r *Table) GetFilter() (columnIndex int, s string)

GetFilter returns string used for filtering and the column index TODO: enable multi column filtering

func (*Table) MustAddRows 

func (r *Table) MustAddRows(rows [][]any) *Table

MustAddRows executes AddRows and panics if there is an error

func (*Table) OrderByColumn 

func (r *Table) OrderByColumn(index int) *Table

OrderByColumn orders rows by a column with the index n, simple bubble sort, nothing too fancy does not apply when there is less than 2 row in a table TODO: this messes up numbering that one might use, implement automatic indexing of rows TODO: allow user to disable ordering

func (*Table) Render 

func (r *Table) Render() string

Render renders the table into the string

func (*Table) SetFilter 

func (r *Table) SetFilter(columnIndex int, s string) *Table

SetFilter sets filtering string on a column

func (*Table) SetHeight 

func (r *Table) SetHeight(value int) *Table

SetHeight sets the height of the table including the header and footer

func (*Table) SetMinWidth 

func (r *Table) SetMinWidth(values []int) *Table

SetMinWidth replaces the minimum width slice, it has to be exactly the len of the headers/rows slices if it's not matching len it will trigger fatal error

func (*Table) SetRatio 

func (r *Table) SetRatio(values []int) *Table

SetRatio replaces the ratio slice, it has to be exactly the len of the headers/rows slices also each value have to be greater than 0, if either fails we panic

func (*Table) SetStyles 

func (r *Table) SetStyles(styles map[TableStyleKey]lipgloss.Style) *Table

SetStyles allows overrides of styling elements of the table When only a partial set of overrides are provided, the default styling will be used

func (*Table) SetTypes 

func (r *Table) SetTypes(columnTypes ...any) (*Table, error)

SetTypes sets the column type, setting this will remove all the rows so make sure you do it when instantiating Table object or add new rows after this, types have to be one of Ordered interface types

func (*Table) SetWidth 

func (r *Table) SetWidth(value int) *Table

SetWidth sets the width of the table

func (*Table) UnsetFilter 

func (r *Table) UnsetFilter() *Table

UnsetFilter resets filtering

type TableBadCellTypeError 

type TableBadCellTypeError struct {
	// contains filtered or unexported fields
}

TableBadCellTypeError type of cell does not match type of column

func (TableBadCellTypeError) Error 

func (e TableBadCellTypeError) Error() string

type TableBadTypeError 

type TableBadTypeError struct {
	// contains filtered or unexported fields
}

TableBadTypeError type does not match Ordered interface types

func (TableBadTypeError) Error 

func (e TableBadTypeError) Error() string

type TableRowLenError 

type TableRowLenError struct {
	// contains filtered or unexported fields
}

TableRowLenError row length is not matching headers len

func (TableRowLenError) Error 

func (e TableRowLenError) Error() string

type TableSingleType 

type TableSingleType[T Ordered] struct {
	Table
}

TableSingleType is Table that is using only 1 type for rows allowing for easier AddRows with fewer errors

func NewTableSingleType 

func NewTableSingleType[T Ordered](width, height int, columnHeaders []string) *TableSingleType[T]

NewTableSingleType initialize TableSingleType object with defaults

func (*TableSingleType[T]) AddRows 

func (r *TableSingleType[T]) AddRows(rows [][]T) *TableSingleType[T]

func (*TableSingleType[T]) MustAddRows 

func (r *TableSingleType[T]) MustAddRows(rows [][]T) *TableSingleType[T]

func (*TableSingleType[T]) SetTypes 

func (r *TableSingleType[T]) SetTypes()

SetTypes overridden for TableSimple

type TableSortingOrderKey 

type TableSortingOrderKey int

type TableStyleKey 

type TableStyleKey int
const (
	TableHeaderStyleKey TableStyleKey = iota
	TableFooterStyleKey
	TableRowsStyleKey
	TableRowsSubsequentStyleKey
	TableRowsCursorStyleKey
	TableCellCursorStyleKey
)

Source Files

View all Source files

Directories

Path Synopsis
example
flex-box-simple
flex-box-with-table
table-multi-type
table-simple-string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.