html

Documentation

Index

• Variables
• func Anchor(text, href string) string
• func Get(attrs []html.Attribute, key string) string
• type AnchorFormat
• type Output
• type PlainTagConverter
  • func (c PlainTagConverter) Get(name string, _ []html.Attribute) (Tag, bool)
• type Tag
• type TagConverter
• type Writer
  • func (w *Writer) Bold(text string, args ...interface{}) *Writer
  • func (w *Writer) Code(text string, args ...interface{}) *Writer
  • func (w *Writer) EndTag() *Writer
  • func (w *Writer) Flush() error
  • func (w *Writer) Italic(text string, args ...interface{}) *Writer
  • func (w *Writer) Link(text, href string) *Writer
  • func (w *Writer) Markup(reader io.Reader) *Writer
  • func (w *Writer) MarkupString(markup string) *Writer
  • func (w *Writer) Media(url string, ref media.Ref, collapsible bool, anchored bool) *Writer
  • func (w *Writer) Pre(text string, args ...interface{}) *Writer
  • func (w *Writer) StartTag(name string, attrs []html.Attribute) *Writer
  • func (w *Writer) Text(text string, args ...interface{}) *Writer

Variables

var (
	DefaultLinkAllocSize  = 200
	DefaultMaxMessageSize = telegram.MaxMessageSize - DefaultLinkAllocSize
	DefaultMaxCaptionSize = telegram.MaxCaptionSize - DefaultLinkAllocSize
)

var (
	Bold   = Tag{Open: "<b>", Close: "</b>"}
	Italic = Tag{Open: "<i>", Close: "</i>"}
	Code   = Tag{Open: "<code>", Close: "</code>"}
	Pre    = Tag{Open: "<pre>", Close: "</pre>"}
)

var DefaultTagConverter = PlainTagConverter{
	"strong": Bold,
	"b":      Bold,
	"italic": Italic,
	"em":     Italic,
	"i":      Italic,
	"code":   Code,
	"pre":    Pre,
}

Functions

func Anchor

func Anchor(text, href string) string

func Get

func Get(attrs []html.Attribute, key string) string

Types

type AnchorFormat

type AnchorFormat interface {
	Format(text string, attrs []html.Attribute) string
}

var DefaultAnchorFormat AnchorFormat = defaultAnchorFormat{}

type Output

type Output interface {
	IsOverflown() bool
	UpdatePrefix(update func(prefix string) string)
	UpdateSuffix(update func(suffix string) string)
	Write(text string)
	WriteBreakable(ctx context.Context, text string) error
	WriteUnbreakable(ctx context.Context, text string) error
	AddMedia(ctx context.Context, ref media.Ref, anchor string, collapsible bool) error
	BreakPage(ctx context.Context) error
	Flush(ctx context.Context) error
	PageCapacity() int
}

type PlainTagConverter

type PlainTagConverter map[string]Tag

func (PlainTagConverter) Get

func (c PlainTagConverter) Get(name string, _ []html.Attribute) (Tag, bool)

type Tag

type Tag struct {
	Open, Close string
	// contains filtered or unexported fields
}

type TagConverter

type TagConverter interface {
	Get(tag string, attrs []html.Attribute) (Tag, bool)
}

type Writer

type Writer struct {
	Context context.Context
	Out     Output
	Tags    TagConverter
	Anchors AnchorFormat
	// contains filtered or unexported fields
}

func (*Writer) Bold

func (w *Writer) Bold(text string, args ...interface{}) *Writer

func (*Writer) Code

func (w *Writer) Code(text string, args ...interface{}) *Writer

func (*Writer) EndTag

func (w *Writer) EndTag() *Writer

func (*Writer) Flush

func (w *Writer) Flush() error

func (*Writer) Italic

func (w *Writer) Italic(text string, args ...interface{}) *Writer

func (*Writer) Link

func (w *Writer) Link(text, href string) *Writer

func (*Writer) Markup

func (w *Writer) Markup(reader io.Reader) *Writer

func (*Writer) MarkupString

func (w *Writer) MarkupString(markup string) *Writer

func (*Writer) Media

func (w *Writer) Media(url string, ref media.Ref, collapsible bool, anchored bool) *Writer

func (*Writer) Pre

func (w *Writer) Pre(text string, args ...interface{}) *Writer

func (*Writer) StartTag

func (w *Writer) StartTag(name string, attrs []html.Attribute) *Writer

func (*Writer) Text

func (w *Writer) Text(text string, args ...interface{}) *Writer