ansi

package module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 3, 2025 License: MIT Imports: 2 Imported by: 8

README

Description

The ansi package provides a set of constants and functions for generating ANSI escape codes, which are used to control text formatting, color, and other output options on text terminals. These escape codes can be used to manipulate the appearance of text in terminal emulators, such as changing text color, moving the cursor, clearing parts of the screen, and more.

Key Features:

  • Text Formatting: Apply styles like bold, italic, underline, blink, reverse, hidden, and strike-through to text.
  • Color Control: Set foreground and background colors using standard and intense colors.
  • Cursor Movement: Move the cursor to specific positions, save and restore cursor positions, and hide or show the cursor.
  • Screen Clearing: Clear parts of the screen or entire lines.
  • Scrolling: Scroll the screen up or down by a specified number of lines.
  • 8-bit Color Support: Set foreground and background colors using 8-bit color codes.
  • 24-bit Color Support: Set foreground and background colors using 24-bit color codes.

Installation

ansi is available using the standard go get command.

Install by running:

go get github.com/engmtcdrm/go-ansi

Run tests by running:

go test github.com/engmtcdrm/go-ansi

Usage

import "github.com/engmtcdrm/go-ansi"

Index

Constants

const (
    ANSIBlack = iota
    ANSIRed
    ANSIGreen
    ANSIYellow
    ANSIBlue
    ANSIMagenta
    ANSICyan
    ANSIWhite
    ANSIBrightBlack
    ANSIBrightRed
    ANSIBrightGreen
    ANSIBrightYellow
    ANSIBrightBlue
    ANSIBrightMagenta
    ANSIBrightCyan
    ANSIBrightWhite
)

const (

    // Clears from the cursor to the end of the screen.
    ClearFromCursorToEndScreen = csi + "0J"
    // Clears from the cursor to the beginning of the screen.
    ClearFromCursorToBeginScreen = csi + "1J"
    // Clear the entire screen.
    ClearScreen = csi + "2J"
    // Clear from the cursor to the end of the row (line).
    ClearToEnd = csi + "K"
    // Clear from the cursor to the beginning of the row (line).
    ClearToBegin = csi + "1K"
    // Clear the entire row (line).
    ClearLine = csi + "2K"
    // Clear the entire row (line) and move the cursor to the start of the row (line).
    ClearLineReset = csi + "2k\r"

    // Save the cursor position
    SaveCursorPos = csi + "s"
    // Restore the cursor position
    RestoreCursorPos = csi + "u"

    // Hide the cursor
    HideCursor = csi + "?25l"

    // Show the cursor
    ShowCursor = csi + "?25h"

    // Text Formatting
    Reset           = csi + "0m"
    Bold            = csi + "1m"
    Dim             = csi + "2m"
    Italic          = csi + "3m"
    Underline       = csi + "4m"
    SlowBlink       = csi + "5m"
    RapidBlink      = csi + "6m"
    Reverse         = csi + "7m"
    Hidden          = csi + "8m"
    Strike          = csi + "9m"
    DoubleUnderline = csi + "21m"

    // Reset Formatting
    ResetIntensity = csi + "22m"
    ResetItalic    = csi + "23m"
    ResetUnderline = csi + "24m"
    ResetBlink     = csi + "25m"
    ResetReverse   = csi + "27m"
    ResetHidden    = csi + "28m"
    ResetStrike    = csi + "29m"

    // Foreground Color
    Black   = csi + "30m"
    Red     = csi + "31m"
    Green   = csi + "32m"
    Yellow  = csi + "33m"
    Blue    = csi + "34m"
    Magenta = csi + "35m"
    Cyan    = csi + "36m"
    White   = csi + "37m"

    // Background Color
    BlackBg   = csi + "40m"
    RedBg     = csi + "41m"
    GreenBg   = csi + "42m"
    YellowBg  = csi + "43m"
    BlueBg    = csi + "44m"
    MagentaBg = csi + "45m"
    CyanBg    = csi + "46m"
    WhiteBg   = csi + "47m"
    DefaultBg = csi + "49m"

    // Intense Foreground Color
    IntenseBlack   = csi + "90m"
    IntenseRed     = csi + "91m"
    IntenseGreen   = csi + "92m"
    IntenseYellow  = csi + "93m"
    IntenseBlue    = csi + "94m"
    IntenseMagenta = csi + "95m"
    IntenseCyan    = csi + "96m"
    IntenseWhite   = csi + "97m"

    // Intense Background Color
    IntenseBlackBg   = csi + "100m"
    IntenseRedBg     = csi + "101m"
    IntenseGreenBg   = csi + "102m"
    IntenseYellowBg  = csi + "103m"
    IntenseBlueBg    = csi + "104m"
    IntenseMagentaBg = csi + "105m"
    IntenseCyanBg    = csi + "106m"
    IntenseWhiteBg   = csi + "107m"
)

Variables

var (
    // Move the cursor to the top left corner of screen
    CursorTopLeft = CursorPosition(1, 1)
    // Move the cursor to beginning of the row (line).
    CursorLineBegin = CursorHorizontalAbsolute(1)
    // Move cursor down one row (line).
    CursorNextLine = CursorNextLineN(1)
    // Move cursor up one row (line).
    CursorPreviousLine = CursorPreviousLineN(1)

    // Scroll the screen up one row (line).
    ScrollUp1 = ScrollUpN(1)
    // Scroll the screen down one row (line).
    ScrollDown1 = ScrollDownN(1)
)

func Background24Bit

func Background24Bit(r, g, b int) string

24-bit background color r, g, b must be between 0 and 255 otherwise it will return an empty string

func Background8Bit

func Background8Bit(color int) string

8-bit background color color must be between 0 and 255 othrewise it will return an empty string

func CursorBackward

func CursorBackward(n int) string

CursorBackward moves the cursor backward n columns.

func CursorDown

func CursorDown(n int) string

CursorDown moves the cursor down n rows (lines).

func CursorForward

func CursorForward(n int) string

CursorForward moves the cursor forward n columns.

func CursorHorizontalAbsolute

func CursorHorizontalAbsolute(n int) string

CursorHorizontalAbsolute moves the cursor to the nth column.

func CursorNextLineN

func CursorNextLineN(n int) string

CursorNextLine moves the cursor down n rows (lines).

func CursorPosition

func CursorPosition(row, column int) string

CursorPosition moves the cursor to the specified position of row (line) and column.

func CursorPreviousLineN

func CursorPreviousLineN(n int) string

CursorPreviousLine moves the cursor up n rows (lines).

func CursorUp

func CursorUp(n int) string

CursorUp moves the cursor up n rows (lines).

func Foreground24Bit

func Foreground24Bit(r, g, b int) string

24-bit foreground color r, g, b must be between 0 and 255 otherwise it will return an empty string

func Foreground8Bit

func Foreground8Bit(color int) string

8-bit foreground color color must be between 0 and 255 otherwise it will return an empty string

func ScrollDownN

func ScrollDownN(n int) string

ScrollDownN scrolls the screen down n rows (lines).

func ScrollUpN

func ScrollUpN(n int) string

ScrollUp scrolls the screen up n rows (lines).

func StripCodes

func StripCodes(input string) string

StripCodes removes all ANSI escape codes from the input string.

Documentation

Index

Constants

View Source 
const (
	ANSIBlack = iota
	ANSIRed
	ANSIGreen
	ANSIYellow
	ANSIBlue
	ANSIMagenta
	ANSICyan
	ANSIWhite
	ANSIBrightBlack
	ANSIBrightRed
	ANSIBrightGreen
	ANSIBrightYellow
	ANSIBrightBlue
	ANSIBrightMagenta
	ANSIBrightCyan
	ANSIBrightWhite
)

ANSI color codes.

View Source 
const (

	// Clears from the cursor to the end of the screen.
	ClearFromCursorToEndScreen = csi + "0J"
	// Clears from the cursor to the beginning of the screen.
	ClearFromCursorToBeginScreen = csi + "1J"
	// Clear the entire screen.
	ClearScreen = csi + "2J"
	// Clear from the cursor to the end of the row (line).
	ClearToEnd = csi + "K"
	// Clear from the cursor to the beginning of the row (line).
	ClearToBegin = csi + "1K"
	// Clear the entire row (line).
	ClearLine = csi + "2K"
	// Clear the entire row (line) and move the cursor to the start of the row (line).
	ClearLineReset = csi + "2k\r"

	// Save the cursor position
	SaveCursorPos = csi + "s"
	// Restore the cursor position
	RestoreCursorPos = csi + "u"

	// Hide the cursor
	HideCursor = csi + "?25l"

	// Show the cursor
	ShowCursor = csi + "?25h"

	// Text Formatting
	Reset           = csi + "0m"
	Bold            = csi + "1m"
	Dim             = csi + "2m"
	Italic          = csi + "3m"
	Underline       = csi + "4m"
	SlowBlink       = csi + "5m"
	RapidBlink      = csi + "6m"
	Reverse         = csi + "7m"
	Hidden          = csi + "8m"
	Strike          = csi + "9m"
	DoubleUnderline = csi + "21m"

	// Reset Formatting
	ResetIntensity = csi + "22m"
	ResetItalic    = csi + "23m"
	ResetUnderline = csi + "24m"
	ResetBlink     = csi + "25m"
	ResetReverse   = csi + "27m"
	ResetHidden    = csi + "28m"
	ResetStrike    = csi + "29m"

	// Foreground Color
	Black   = csi + "30m"
	Red     = csi + "31m"
	Green   = csi + "32m"
	Yellow  = csi + "33m"
	Blue    = csi + "34m"
	Magenta = csi + "35m"
	Cyan    = csi + "36m"
	White   = csi + "37m"

	// Background Color
	BlackBg   = csi + "40m"
	RedBg     = csi + "41m"
	GreenBg   = csi + "42m"
	YellowBg  = csi + "43m"
	BlueBg    = csi + "44m"
	MagentaBg = csi + "45m"
	CyanBg    = csi + "46m"
	WhiteBg   = csi + "47m"
	DefaultBg = csi + "49m"

	// Intense Foreground Color
	IntenseBlack   = csi + "90m"
	IntenseRed     = csi + "91m"
	IntenseGreen   = csi + "92m"
	IntenseYellow  = csi + "93m"
	IntenseBlue    = csi + "94m"
	IntenseMagenta = csi + "95m"
	IntenseCyan    = csi + "96m"
	IntenseWhite   = csi + "97m"

	// Intense Background Color
	IntenseBlackBg   = csi + "100m"
	IntenseRedBg     = csi + "101m"
	IntenseGreenBg   = csi + "102m"
	IntenseYellowBg  = csi + "103m"
	IntenseBlueBg    = csi + "104m"
	IntenseMagentaBg = csi + "105m"
	IntenseCyanBg    = csi + "106m"
	IntenseWhiteBg   = csi + "107m"
)

Variables

View Source 
var (
	// Move the cursor to the top left corner of screen
	CursorTopLeft = CursorPosition(1, 1)
	// Move the cursor to beginning of the row (line).
	CursorLineBegin = CursorHorizontalAbsolute(1)
	// Move cursor down one row (line).
	CursorNextLine = CursorNextLineN(1)
	// Move cursor up one row (line).
	CursorPreviousLine = CursorPreviousLineN(1)

	// Scroll the screen up one row (line).
	ScrollUp1 = ScrollUpN(1)
	// Scroll the screen down one row (line).
	ScrollDown1 = ScrollDownN(1)
)

Functions

func Background8Bit 

func Background8Bit(color int) string

8-bit background color color must be between 0 and 255 othrewise it will return an empty string

func Background24Bit 

func Background24Bit(r, g, b int) string

24-bit background color r, g, b must be between 0 and 255 otherwise it will return an empty string

func CursorBackward 

func CursorBackward(n int) string

CursorBackward moves the cursor backward n columns.

func CursorDown 

func CursorDown(n int) string

CursorDown moves the cursor down n rows (lines).

func CursorForward 

func CursorForward(n int) string

CursorForward moves the cursor forward n columns.

func CursorHorizontalAbsolute 

func CursorHorizontalAbsolute(n int) string

CursorHorizontalAbsolute moves the cursor to the nth column.

func CursorNextLineN 

func CursorNextLineN(n int) string

CursorNextLine moves the cursor down n rows (lines).

func CursorPosition 

func CursorPosition(row, column int) string

CursorPosition moves the cursor to the specified position of row (line) and column.

func CursorPreviousLineN 

func CursorPreviousLineN(n int) string

CursorPreviousLine moves the cursor up n rows (lines).

func CursorUp 

func CursorUp(n int) string

CursorUp moves the cursor up n rows (lines).

func Foreground8Bit 

func Foreground8Bit(color int) string

8-bit foreground color color must be between 0 and 255 otherwise it will return an empty string

func Foreground24Bit 

func Foreground24Bit(r, g, b int) string

24-bit foreground color r, g, b must be between 0 and 255 otherwise it will return an empty string

func ScrollDownN 

func ScrollDownN(n int) string

ScrollDownN scrolls the screen down n rows (lines).

func ScrollUpN 

func ScrollUpN(n int) string

ScrollUp scrolls the screen up n rows (lines).

func StripCodes 

func StripCodes(input string) string

StripCodes removes all ANSI escape codes from the input string.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.