dirtree

Documentation

Index

• type Model
  • func NewModel(showIcons bool, selectedItemColor, unselectedItemColor lipgloss.AdaptiveColor) Model
  • func (m Model) GetCursor() int
  • func (m Model) GetFilePaths() []string
  • func (m Model) GetSelectedFile() (os.FileInfo, error)
  • func (m Model) GetTotalFiles() int
  • func (m *Model) GoDown()
  • func (m *Model) GoUp()
  • func (m *Model) GotoBottom()
  • func (m *Model) GotoTop()
  • func (m *Model) SetContent(files []fs.DirEntry)
  • func (m *Model) SetFilePaths(filePaths []string)
  • func (m *Model) SetSize(width int)
  • func (m *Model) ToggleHidden()
  • func (m Model) View() string

Types

type Model

type Model struct {
	Files               []fs.DirEntry
	FilePaths           []string
	Width               int
	Cursor              int
	ShowIcons           bool
	ShowHidden          bool
	SelectedItemColor   lipgloss.AdaptiveColor
	UnselectedItemColor lipgloss.AdaptiveColor
}

Model is a struct to represent the properties of a dirtree.

func NewModel

func NewModel(showIcons bool, selectedItemColor, unselectedItemColor lipgloss.AdaptiveColor) Model

NewModel creates a new instance of a dirtree.

func (Model) GetCursor

func (m Model) GetCursor() int

GetCursor gets the position of the cursor in the tree.

func (Model) GetFilePaths

func (m Model) GetFilePaths() []string

GetFilePaths returns an array of file paths.

func (Model) GetSelectedFile

func (m Model) GetSelectedFile() (os.FileInfo, error)

GetSelectedFile returns the currently selected file in the tree.

func (Model) GetTotalFiles

func (m Model) GetTotalFiles() int

GetTotalFiles returns the total number of files in the tree.

func (*Model) GoDown

func (m *Model) GoDown()

GoDown goes down the tree by one.

func (*Model) GoUp

func (m *Model) GoUp()

GoUp goes up the tree by one.

func (*Model) GotoBottom

func (m *Model) GotoBottom()

GotoBottom goes to the bottom of the tree.

func (*Model) GotoTop

func (m *Model) GotoTop()

GotoTop goes to the top of the tree.

func (*Model) SetContent

func (m *Model) SetContent(files []fs.DirEntry)

SetContent sets the files currently displayed in the tree.

func (*Model) SetFilePaths

func (m *Model) SetFilePaths(filePaths []string)

SetFilePaths sets an array of file paths.

func (*Model) SetSize

func (m *Model) SetSize(width int)

SetSize updates the size of the dirtree, useful when resizing the terminal.

func (*Model) ToggleHidden

func (m *Model) ToggleHidden()

ToggleHidden toggles the visibility of hidden files.

func (Model) View

func (m Model) View() string

View returns a string representation of the current tree.