charmutils

README

Charm Utils

A collection of utilities for working with the Charm ecosystem. See the GoDocs for more details.

Documentation

Index

• Variables
• func ConstructKeyBinding(keys []string, desc string) key.Binding
• func HuhIntRangeOptions(lower, upper int) []huh.Option[int]
• func Overlay(bg, overlay string, row, col int, ignoreMarginWhitespace bool) (string, error)
• func OverlayCenter(bg string, overlay string, ignoreMarginWhitespace bool) (string, error)
• func UpdateTypedModel[T tea.Model](model *T, msg tea.Msg) (tea.Cmd, error)

Variables

var (
	ErrInvalidTypeAssertion = errors.New("invalid type assertion")
)

Functions

func ConstructKeyBinding

func ConstructKeyBinding(keys []string, desc string) key.Binding

ConstructKeyBinding creates a new binding with the given keys and a help message with the description and each of the keys.

func HuhIntRangeOptions

func HuhIntRangeOptions(lower, upper int) []huh.Option[int]

HuhIntRangeOptions creates a new slice of integer options using the lower and upper bound (inclusive).

func Overlay

func Overlay(bg, overlay string, row, col int, ignoreMarginWhitespace bool) (string, error)

Overlay writes the overlay string onto the background string at the specified row and column. In this case, the row and column are zero indexed.

func OverlayCenter

func OverlayCenter(bg string, overlay string, ignoreMarginWhitespace bool) (string, error)

OverlayCenter writes the overlay string onto the background string such that the middle of the overlay string will be at the middle of the overlay will be at the middle of the background.

func UpdateTypedModel

func UpdateTypedModel[T tea.Model](model *T, msg tea.Msg) (tea.Cmd, error)

UpdateTypedModel performs an update on the model using the given msg. This enables easily storing models of a concrete type without having the clutter of frequent type assertions.