code

Documentation

Overview

Package code implements a code bubble which renders syntax highlighted source code based on a filename.

Index

• func Highlight(content, extension, syntaxTheme string) (string, error)
• 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) SetSize(w, h int)
  • func (m *Model) SetSyntaxTheme(theme string)
  • func (m *Model) SetViewportDisabled(disabled bool)
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string

Functions

func Highlight

func Highlight(content, extension, syntaxTheme string) (string, error)

Highlight returns a syntax highlighted string of text.

Types

type Model

type Model struct {
	Viewport              viewport.Model
	Filename              string
	Content               string
	SyntaxTheme           string
	StatusMessage         string
	StatusMessageLifetime time.Duration

	ViewportDisabled bool
	// contains filtered or unexported fields
}

Model represents the properties of a code bubble.

func New

func New() Model

New creates a new instance of code.

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 code 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 current file to highlight.

func (*Model) SetSize

func (m *Model) SetSize(w, h int)

SetSize sets the size of the bubble.

func (*Model) SetSyntaxTheme

func (m *Model) SetSyntaxTheme(theme string)

SetSyntaxTheme sets the syntax theme of the rendered code.

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

func (Model) View

func (m Model) View() string

View returns a string representation of the code bubble.