cropviewport

README

Crop Viewport

A component for bubbletea.

Crops view from string given position and size.
With ANSI SGR support.

For Usage checkout examples

Keymap

Keymaps are inside the model struct, can be changed if you want to.

Default keymaps:

• j move down 1 line
• k move up 1 line
• ctrl+d move down half page
• ctrl+u move up half page
• h move left 1 column
• l move right 1 column
• H move left half row
• L move right half row

wcwidth related

• if not enough place for a char width over 1, the char will not display and replaced to (multiple) white space.
• TAB(\t) will be replaced by 4 SPACE( ), and it's hard coded, not sure if processRune should be available to access from the outside

Others

So, this is actually the first time i use go to make stuffs for others to use.
Any suggestion is welcomed here

Documentation

Index

• Variables
• func CropView(atablelist *process.ANSITableList, lines []*SubLine, x, y, width, height int) string
• func NewCropViewportModel() tea.Model
• type CropViewportModel
  • func (c *CropViewportModel) BackToLeft()
  • func (c *CropViewportModel) BackToTop()
  • func (c *CropViewportModel) Init() tea.Cmd
  • func (c *CropViewportModel) NextCol(step int)
  • func (c *CropViewportModel) NextLine(step int)
  • func (c *CropViewportModel) PrevCol(step int)
  • func (c *CropViewportModel) PrevLine(step int)
  • func (c *CropViewportModel) SetBlock(x, y, width, height int)
  • func (c *CropViewportModel) SetContent(s string) (*process.ANSITableList, []*SubLine)
  • func (c *CropViewportModel) SetContentGivenData(tableList *process.ANSITableList, lines []*SubLine)
  • func (c *CropViewportModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (c *CropViewportModel) View() string
• type RuneData
  • func (r *RuneData) GetBounds() [2]int
• type RuneDataList
  • func (r *RuneDataList) Init(s []rune) *RuneDataList
• type SubLine
  • func ProcessContent(s string) (*process.ANSITableList, []*SubLine)
  • func SplitLines(raw string) []*SubLine

Variables

var (
	SPACE_HODLER   = []byte(" ")
	SPACE_RUNEDATA = &RuneData{
		Byte: SPACE_HODLER,
	}
)

var NO_CONTENT_TABLE, NO_CONTENT_SUBLINES = ProcessContent("No content available")

const NO_CONTENT = "No content available" var NO_CONTENT_TABLE, NO_CONTENT_SUBLINES = process.ProcessContent("No content available")

Functions

func CropView

func CropView(atablelist *process.ANSITableList, lines []*SubLine, x, y, width, height int) string

extract certain area of the given lines, and render ansi sequence

func NewCropViewportModel

func NewCropViewportModel() tea.Model

Types

type CropViewportModel

type CropViewportModel struct {
	ANSITableList *process.ANSITableList
	KeyMap        map[string]func() tea.Cmd
	Sublines      []*SubLine
	Block         [4]int
}

func (*CropViewportModel) BackToLeft

func (c *CropViewportModel) BackToLeft()

func (*CropViewportModel) BackToTop

func (c *CropViewportModel) BackToTop()

func (*CropViewportModel) Init

func (c *CropViewportModel) Init() tea.Cmd

* returns nil

func (*CropViewportModel) NextCol

func (c *CropViewportModel) NextCol(step int)

func (*CropViewportModel) NextLine

func (c *CropViewportModel) NextLine(step int)

func (*CropViewportModel) PrevCol

func (c *CropViewportModel) PrevCol(step int)

func (*CropViewportModel) PrevLine

func (c *CropViewportModel) PrevLine(step int)

func (*CropViewportModel) SetBlock

func (c *CropViewportModel) SetBlock(x, y, width, height int)

func (*CropViewportModel) SetContent

func (c *CropViewportModel) SetContent(s string) (*process.ANSITableList, []*SubLine)

func (*CropViewportModel) SetContentGivenData

func (c *CropViewportModel) SetContentGivenData(tableList *process.ANSITableList, lines []*SubLine)

func (*CropViewportModel) Update

func (c *CropViewportModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*CropViewportModel) View

func (c *CropViewportModel) View() string

type RuneData

type RuneData struct {
	Byte  []byte
	Bound [2]int // refers to the visible width
}

func (*RuneData) GetBounds

func (r *RuneData) GetBounds() [2]int

type RuneDataList

type RuneDataList struct {
	L          []process.BoundsStruct
	TotalWidth int
}

func (*RuneDataList) Init

func (r *RuneDataList) Init(s []rune) *RuneDataList

init RuneData list given runes

RuneDataList can only be set with this function, no more process allowed afterwards

type SubLine

type SubLine struct {
	Data  *RuneDataList
	Bound [2]int
}

func ProcessContent

func ProcessContent(s string) (*process.ANSITableList, []*SubLine)

separate ansi and normal string, separate lines into RuneData list

func SplitLines

func SplitLines(raw string) []*SubLine