Links
Comment on page

BulletList

The bullet list printer can be used to display a bullet list

Basic Usage

pterm.DefaultBulletList.WithItems([]pterm.BulletListItem{
{Level: 0, Text: "Level 0"},
{Level: 1, Text: "Level 1"},
{Level: 2, Text: "Level 2"},
}).Render()

Options

Name
Type
Description
Items
[]BulletListItem
Items of the bullet list
TextStyle
*Style
Style of the text
Bullet
string
Character that is used in front of the items
BulletStyle
*Style
Style of the character that is used in front of the items
Writer
io.Writer
Custom output writer

Using Options

Methods

This printer implements the RenderablePrinter interface.
Method
Description
Render()
Prints to the terminal or uses the specified Writer
Srender()
Returns the rendered string

Full Specification

pkg.go.dev contains the full specification for this printer and more technical descriptions.
Last modified 1yr ago