table

Documentation

Overview

ItemsTable 用于展示 Array 和 Slice 类型数据

支持以下特性：

样式

1. 设置边框格式
1. 自定义颜色
1. 开启/关闭表格内边框

列

1. 开启/关闭自动编号
1. 设置最大宽度

Index

• Variables
• type H
• type ItemsTable
  • func NewItemsTable(titles []string, items interface{}) *ItemsTable
  • func (t *ItemsTable) EnableAutoIndex() *ItemsTable
  • func (t *ItemsTable) Render() (string, error)
  • func (t *ItemsTable) SetColor(attributes ...color.Attribute) *ItemsTable
  • func (t *ItemsTable) SetStyle(style Style, colors ...color.Attribute) *ItemsTable
• type Style

Variables

var StyleBold = Style{
	"┏", "┳", "┓",
	"┣", "╋", "┫",
	"┗", "┻", "┛",
	"━", "┃",
}

StyleBold renders a table like below:

┏━━━━┳━━━━━━━┳━━━━━┓
┃ Id ┃ Name  ┃ Age ┃
┣━━━━╋━━━━━━━╋━━━━━┫
┃ 1  ┃ name1 ┃ 1   ┃
┃ 2  ┃ name2 ┃ 10  ┃
┗━━━━┻━━━━━━━┻━━━━━┛

var StyleDefault = Style{
	"+", "+", "+",
	"+", "+", "+",
	"+", "+", "+",
	"-", "|",
}

StyleDefault renders a table like below:

+----+-------+-----+
| Id | Name  | Age |
+----+-------+-----+
| 1  | name1 | 1   |
| 2  | name2 | 10  |
+----+-------+-----+

var StyleDouble = Style{
	"╔", "╦", "╗",
	"╠", "╬", "╣",
	"╚", "╩", "╝",
	"═", "║",
}

StyleBold renders a table like below:

╔════╦═══════╦═════╗
║ Id ║ Name  ║ Age ║
╠════╬═══════╬═════╣
║ 1  ║ name1 ║ 1   ║
║ 2  ║ name2 ║ 10  ║
╚════╩═══════╩═════╝

var StyleLight = Style{
	"┌", "┬", "┐",
	"├", "┼", "┤",
	"└", "┴", "┘",
	"─", "│",
}

StyleLight renders a table like below:

┌────┬───────┬─────┐
│ Id │ Name  │ Age │
├────┼───────┼─────┤
│ 1  │ name1 │ 1   │
│ 2  │ name2 │ 10  │
└────┴───────┴─────┘

var StyleRounded = Style{
	"╭", "┬", "╮",
	"├", "┼", "┤",
	"╰", "┴", "╯",
	"─", "│",
}

StyleRounded renders a table like below:

╭────┬───────┬─────╮
│ Id │ Name  │ Age │
├────┼───────┼─────┤
│ 1  │ name1 │ 1   │
│ 2  │ name2 │ 10  │
╰────┴───────┴─────╯

Types

type H

type H struct {
	Title    string
	Field    string
	MaxWidth int
	// contains filtered or unexported fields
}

type ItemsTable

type ItemsTable struct {
	Name    string
	Headers []H
	Items   interface{}

	InlineBorder bool
	AutoIndex    bool
	// contains filtered or unexported fields
}

func NewItemsTable

func NewItemsTable(titles []string, items interface{}) *ItemsTable

func (*ItemsTable) EnableAutoIndex

func (t *ItemsTable) EnableAutoIndex() *ItemsTable

func (*ItemsTable) Render

func (t *ItemsTable) Render() (string, error)

func (*ItemsTable) SetColor

func (t *ItemsTable) SetColor(attributes ...color.Attribute) *ItemsTable

func (*ItemsTable) SetStyle

func (t *ItemsTable) SetStyle(style Style, colors ...color.Attribute) *ItemsTable

type Style

type Style []string