render

README

color

Turns github.com/fatih/color into HTML. Just kidding!

Just a tag based approach to write some nice text.

Usage

package main

import (
	"fmt"

	render "github.com/hygge-io/color"
)

func main() {

	s := `This is a #red[part of text with #bold[some] in bold] word.
Possible to #(green,italic)[combine]`

	renderer := render.New()
	fmt.Println(renderer.Render(s))
}

Depending on the text you want to format, it can be necessary to change how the parsing is done:

s := `In Markdown, @(bold)<a new paragraph> uses the # tag
while links are written as @green<[link](url)>`

renderer := render.New().WithTagMarker('@').WithTextLimiter('<', '>')
fmt.Println(renderer.Render(s))

Documentation

Index

• Constants
• func SameStyle(a, b *Style) bool
• type Color
• type Renderer
  • func New() *Renderer
  • func (renderer *Renderer) Render(text string) string
  • func (renderer *Renderer) RenderWithTemplate(text string, obj any) string
  • func (renderer *Renderer) Scanner() *Scanner
  • func (renderer *Renderer) WithTagMarker(m int32) *Renderer
  • func (renderer *Renderer) WithTextLimiter(start, end int32) *Renderer
• type Scanner
  • func NewScanner() *Scanner
  • func (s *Scanner) Scan(text string) []Token
  • func (s *Scanner) ScanWithTemplate(text string, obj any) []Token
• type Style
  • func NewStyle() *Style
  • func (style *Style) Add(ts ...string)
  • func (style *Style) AddOne(t string)
  • func (style *Style) Clone() *Style
  • func (style *Style) Color(color int) *Style
  • func (style *Style) String() string
  • func (style *Style) Typography(t int) *Style
• type Theme
  • func (theme *Theme) Color(c Color) (color.Attribute, bool)
  • func (theme *Theme) Convert(token Token) string
  • func (theme *Theme) Produce(tokens []Token) string
  • func (theme *Theme) Typographies(typographies []Typography) []color.Attribute
• type Token
• type Type
• type Typography

Constants

const (
	Black = iota
	Red
	Green
	Yellow
	Blue
	Magenta
	Cyan
	White
)

const (
	None = iota
	Bold
	Italic
)

Functions

func SameStyle

func SameStyle(a, b *Style) bool

Types

type Color

type Color struct {
	// contains filtered or unexported fields
}

type Renderer

type Renderer struct {
	// contains filtered or unexported fields
}

func New

func New() *Renderer

func (*Renderer) Render

func (renderer *Renderer) Render(text string) string

func (*Renderer) RenderWithTemplate

func (renderer *Renderer) RenderWithTemplate(text string, obj any) string

func (*Renderer) Scanner

func (renderer *Renderer) Scanner() *Scanner

func (*Renderer) WithTagMarker

func (renderer *Renderer) WithTagMarker(m int32) *Renderer

func (*Renderer) WithTextLimiter

func (renderer *Renderer) WithTextLimiter(start, end int32) *Renderer

type Scanner

type Scanner struct {
	TagMarker int32
	Start     int32
	End       int32
}

func NewScanner

func NewScanner() *Scanner

func (*Scanner) Scan

func (s *Scanner) Scan(text string) []Token

func (*Scanner) ScanWithTemplate

func (s *Scanner) ScanWithTemplate(text string, obj any) []Token

type Style

type Style struct {
	// contains filtered or unexported fields
}

func NewStyle

func NewStyle() *Style

func (*Style) Add

func (style *Style) Add(ts ...string)

func (*Style) AddOne

func (style *Style) AddOne(t string)

func (*Style) Clone

func (style *Style) Clone() *Style

func (*Style) Color

func (style *Style) Color(color int) *Style

func (*Style) String

func (style *Style) String() string

func (*Style) Typography

func (style *Style) Typography(t int) *Style

type Theme

type Theme struct {
}

func (*Theme) Color

func (theme *Theme) Color(c Color) (color.Attribute, bool)

func (*Theme) Convert

func (theme *Theme) Convert(token Token) string

func (*Theme) Produce

func (theme *Theme) Produce(tokens []Token) string

func (*Theme) Typographies

func (theme *Theme) Typographies(typographies []Typography) []color.Attribute

type Token

type Token struct {
	Text  string
	Style *Style
}

type Type

type Type interface {
}

type Typography

type Typography struct {
	// contains filtered or unexported fields
}