pdf

Documentation

Overview

Package pdf provides an pdf bubble which can render pdf files as strings.

Index

• func ReadPDF(name 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) SetViewportDisabled(disabled bool)
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string

Functions

func ReadPDF

func ReadPDF(name string) (string, error)

ReadPDF reads the content of a PDF and returns it as a string.

Types

type Model

type Model struct {
	Viewport              viewport.Model
	ViewportDisabled      bool
	FileName              string
	StatusMessage         string
	StatusMessageLifetime time.Duration
	// contains filtered or unexported fields
}

Model represents the properties of a pdf bubble.

func New

func New() Model

New creates a new instance of a PDF.

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 PDF 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 render, this returns a cmd which will render the pdf.

func (*Model) SetSize

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

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

func (Model) View

func (m Model) View() string

View returns a string representation of the markdown bubble.