image

Documentation

Overview

Package image provides an image bubble which can render images as strings.

Index

• func ToString(width int, img image.Image) string
• type Model
  • func New(active, borderless bool, borderColor lipgloss.AdaptiveColor) Model
  • func (m *Model) GotoTop()
  • func (m Model) Init() tea.Cmd
  • func (m *Model) SetBorderColor(color lipgloss.AdaptiveColor)
  • func (m *Model) SetBorderless(borderless bool)
  • func (m *Model) SetFileName(filename string) tea.Cmd
  • func (m *Model) SetIsActive(active bool)
  • func (m *Model) SetSize(w, h int) tea.Cmd
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string

Functions

func ToString

func ToString(width int, img image.Image) string

ToString converts an image to a string representation of an image.

Types

type Model

type Model struct {
	Viewport    viewport.Model
	BorderColor lipgloss.AdaptiveColor
	Active      bool
	Borderless  bool
	FileName    string
	ImageString string
}

Model represents the properties of a code bubble.

func New

func New(active, borderless bool, borderColor lipgloss.AdaptiveColor) Model

New creates a new instance of code.

func (*Model) GotoTop

func (m *Model) GotoTop()

GotoTop jumps to the top of the viewport.

func (Model) Init

func (m Model) Init() tea.Cmd

Init initializes the code bubble.

func (*Model) SetBorderColor

func (m *Model) SetBorderColor(color lipgloss.AdaptiveColor)

SetBorderColor sets the current color of the border.

func (*Model) SetBorderless

func (m *Model) SetBorderless(borderless bool)

SetBorderless sets weather or not to show the border.

func (*Model) SetFileName

func (m *Model) SetFileName(filename string) tea.Cmd

SetFileName sets current file to highlight, this returns a cmd which will highlight the text.

func (*Model) SetIsActive

func (m *Model) SetIsActive(active bool)

SetIsActive sets if the bubble is currently active

func (*Model) SetSize

func (m *Model) SetSize(w, h int) tea.Cmd

SetSize sets the size of the bubble.

func (Model) Update

func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)

Update handles updating the UI of a code bubble.

func (Model) View

func (m Model) View() string

View returns a string representation of the code bubble.