style

Documentation

Index

• Variables
• func FillBorder(image image.Image, row, col, rows, cols int, border Border)
• func GhostCursor(image image.Image, row, col int)
• type Border
  • func NewBorder(border lipgloss.Border) Border
  • func (b *Border) MarshalJanet() interface{}
  • func (b Border) None() bool
  • func (b Border) Smoothable() bool
  • func (b *Border) UnmarshalJanet(value *janet.Value) (err error)
• type Color
  • func NewColor(c string) *Color
  • func (c *Color) Emu() emu.Color
  • func (c *Color) MarshalJanet() interface{}
  • func (c *Color) UnmarshalJanet(value *janet.Value) (err error)
• type ColorMap
  • func NewColorMap(mapping map[lipgloss.Color]lipgloss.Color) *ColorMap
  • func (c *ColorMap) Apply(i image.Image)
  • func (c *ColorMap) MarshalJanet() interface{}
  • func (c *ColorMap) UnmarshalJanet(value *janet.Value) (err error)
• type Style
  • func (s *Style) UnmarshalJanet(value *janet.Value) (err error)
• type Unfiltered

Variables

var (
	KEYWORD_NORMAL     = janet.Keyword("normal")
	KEYWORD_ROUNDED    = janet.Keyword("rounded")
	KEYWORD_BLOCK      = janet.Keyword("block")
	KEYWORD_OUTER_HALF = janet.Keyword("outer-half")
	KEYWORD_INNER_HALF = janet.Keyword("inner-half")
	KEYWORD_THICK      = janet.Keyword("thick")
	KEYWORD_DOUBLE     = janet.Keyword("double")
	KEYWORD_HIDDEN     = janet.Keyword("hidden")

	// Special border behavior
	KEYWORD_NONE = janet.Keyword("none")
)

var (
	KEYWORD_RIGHT  = janet.Keyword("right")
	KEYWORD_LEFT   = janet.Keyword("left")
	KEYWORD_CENTER = janet.Keyword("center")
	KEYWORD_TOP    = janet.Keyword("top")
	KEYWORD_BOTTOM = janet.Keyword("bottom")
)

var Borders = []Border{
	NewBorder(lipgloss.NormalBorder()),
	NewBorder(lipgloss.RoundedBorder()),
	NewBorder(lipgloss.BlockBorder()),
	NewBorder(lipgloss.OuterHalfBlockBorder()),
	NewBorder(lipgloss.InnerHalfBlockBorder()),
	NewBorder(lipgloss.ThickBorder()),
	NewBorder(lipgloss.DoubleBorder()),
	NewBorder(lipgloss.HiddenBorder()),
}

var DefaultBorder = NewBorder(lipgloss.RoundedBorder())

Functions

func FillBorder

func FillBorder(
	image image.Image,
	row, col, rows, cols int,
	border Border,
)

FillBorder detects whether the cell specified by row and col can be replaced with a different border glyph that links its adjacent border cells together nicely.

func GhostCursor

func GhostCursor(image image.Image, row, col int)

GhostCursor adds a (standardized) "ghost" cursor to an image. This shows the user where the cursor actually is.

Types

type Border

type Border struct {
	lipgloss.Border
	// contains filtered or unexported fields
}

func NewBorder

func NewBorder(border lipgloss.Border) Border

func (*Border) MarshalJanet

func (b *Border) MarshalJanet() interface{}

func (Border) None

func (b Border) None() bool

None reports whether this Border is none, or should not be rendered.

func (Border) Smoothable

func (b Border) Smoothable() bool

func (*Border) UnmarshalJanet

func (b *Border) UnmarshalJanet(value *janet.Value) (err error)

type Color

type Color struct {
	lipgloss.Color
}

func NewColor

func NewColor(c string) *Color

func (*Color) Emu

func (c *Color) Emu() emu.Color

func (*Color) MarshalJanet

func (c *Color) MarshalJanet() interface{}

func (*Color) UnmarshalJanet

func (c *Color) UnmarshalJanet(value *janet.Value) (err error)

type ColorMap

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

func NewColorMap

func NewColorMap(mapping map[lipgloss.Color]lipgloss.Color) *ColorMap

func (*ColorMap) Apply

func (c *ColorMap) Apply(i image.Image)

Apply applies the color mapping to the Image.

func (*ColorMap) MarshalJanet

func (c *ColorMap) MarshalJanet() interface{}

func (*ColorMap) UnmarshalJanet

func (c *ColorMap) UnmarshalJanet(value *janet.Value) (err error)

type Style

type Style struct {
	lipgloss.Style
}

func (*Style) UnmarshalJanet

func (s *Style) UnmarshalJanet(value *janet.Value) (err error)

type Unfiltered

type Unfiltered interface {
	UnfilteredState() *tty.State
}

Unfiltered allows Screens to return their original visual state unaltered by a color map.