protip

Documentation

Overview

Package protip provides methods for displaying usage tips

Index

• Variables
• func Add(tips ...*Tip)
• func Show(force bool) bool
• type Tip
• type Tips

Examples

• Add
• Show

Variables

var ColorTag = "{#75}"

ColorTag is default panel color tag

var Options = panel.Options{panel.TOP_LINE, panel.BOTTOM_LINE}

Options contains default panel options

var Probability = 0.25

Probability is showing probability coefficient (0 ← less | more → 1)

Functions

func Add

func Add(tips ...*Tip)

Add adds one or more tips to collection

Example

// Add simple tip
Add(&Tip{
	Title:   "Tip #1",
	Message: `Tip message`,
})

// Add tip with custom weight (≠ 0.5)
Add(&Tip{
	Title:   "Tip #2",
	Message: `Tip message`,
	Weight:  0.1,
})

// Add tip with custom weight (≠ 0.5) and color
Add(&Tip{
	Title:    "Tip #3",
	Message:  `Tip message`,
	Weight:   0.8,
	ColorTag: "{b}",
})

func Show

func Show(force bool) bool

Show shows random tip if required

Example

// Add simple tip
Add(&Tip{
	Title:   "Tip #1",
	Message: `Tip message`,
})

// Increase default probability to 50%
Probability = 0.5

// Set default color to green
ColorTag = "{g}"

// Try to show tip
Show(false)

// Force show
Show(true)

Types

type Tip

type Tip struct {
	Title   string // Tip title (required)
	Message string // Tip message (required)

	ColorTag string  // Custom tip color (optional)
	Weight   float64 // Custom tip weight (optional)
}

Tip contains basic tip content

type Tips

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

Tips contains tips data