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() Model
  • func (m *Model) GotoBottom()
  • func (m *Model) GotoTop()
  • func (m Model) Init() tea.Cmd
  • func (m *Model) NewStatusMessageCmd(s string) tea.Cmd
  • func (m *Model) SetFileNameCmd(filename string) tea.Cmd
  • func (m *Model) SetSizeCmd(w, h int) tea.Cmd
  • func (m *Model) SetViewportDisabled(disabled bool)
  • 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
	ViewportDisabled      bool
	FileName              string
	ImageString           string
	StatusMessage         string
	StatusMessageLifetime time.Duration
	// contains filtered or unexported fields
}

Model represents the properties of a image bubble.

func New

func New() Model

New creates a new instance of an image.

func (*Model) GotoBottom

func (m *Model) GotoBottom()

GotoBottom jumps to the bottom of the viewport.

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 image bubble.

func (*Model) NewStatusMessageCmd

func (m *Model) NewStatusMessageCmd(s string) tea.Cmd

NewStatusMessage sets a new status message, which will show for a limited amount of time.

func (*Model) SetFileNameCmd

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

SetFileName sets the image file and converts it to a string.

func (*Model) SetSizeCmd

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

SetSize sets the size of the bubble.

func (*Model) SetViewportDisabled

func (m *Model) SetViewportDisabled(disabled bool)

SetViewportDisabled toggles the state of the viewport.

func (Model) Update

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

Update handles updating the UI of the image bubble.

func (Model) View

func (m Model) View() string

View returns a string representation of the image bubble.