Categorygithub.com/sysread/textsel
modulepackage
0.1.8
Repository: https://github.com/sysread/textsel.git
Documentation: pkg.go.dev

# README

TextSel

Go Reference

textsel is a Go package that extends the tview.TextView widget to include cursor movement and text selection capabilities. It allows users to navigate and select text within the TextView, making it easier to copy and highlight text.

Features

  • Cursor movement (up, down, left, right).
  • Text selection with visual highlighting.
  • Customizable colors for cursor and selection.

Installation

To install textsel, you need to have Go installed and set up on your machine. Use the following command to install the package:

go get github.com/sysread/textsel

Usage

Here's an example of how to use textsel in your project:

package main

import (
    "github.com/sysread/textsel"
    "github.com/rivo/tview"
)

func main() {
    app := tview.NewApplication()

    textSel := textsel.NewTextSel().SetText("Hello, World!")

    if err := app.SetRoot(textSel, true).Run(); err != nil {
        panic(err)
    }
}

Customization

You can customize the colors used for cursor and selection highlighting by modifying the defaultColor, cursorColor, selectionColor, and cursorInSelectionColor fields in the TextSel struct.

Example:

textSel := textsel.NewTextSel()
textSel.defaultColor = "[#FFFFFF:#000000:-]"
textSel.cursorColor = "[#000000:#FFFFFF:-]"
textSel.selectionColor = "[#000000:#FF0000:-]"
textSel.cursorInSelectionColor = "[#000000:#FF0000:bu]"

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request with your improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.

# Packages

No description provided by the author

# Functions

NewTextSel creates and returns a new TextSel instance.

# Structs

TextSel is a `tview.TextView` widget that supports selecting text with the keyboard.