html

type Config ¶

type Config interface {
	URL2Reader(url string) (io.ReadCloser, error)
}

Config configures HTML rendering.

type ConfigLogger ¶

type ConfigLogger interface {
	Log(format string, args ...any)
}

ConfigLogger may be optionally implemented by a Config instance. It provides a mechanism to report back errors etc.

type ConfigNavigator ¶

type ConfigNavigator interface {
	Navigate(url string) error
}

ConfigNavigator may be optionally implemented by a Config instance. It provides a mechanism to handle link clicks.

type ConfigQuirks ¶

type ConfigQuirks interface {
	QuirksMode(suggested bool) (enforced bool)
}

ConfigQuirks may be optionally implemented by a Config instance. It provides a mechanism to enforce quirks mode or non-quirks mode. Returning other than the suggested mode may have unpredictable results.

type ConfigUserAgentStyleSheet ¶

type ConfigUserAgentStyleSheet interface {
	UserAgentStyleSheet(quirksMode bool) string
}

ConfigUserAgentStyleSheet may be optionally implemented by a Config instance. It provides a mechanism to use other than the default user agent style sheet. Setting a non-standard user agent style sheet may have unpredictable results.

type DisplayList ¶

type DisplayList struct {
	ID int
	// contains filtered or unexported fields
}

DisplayList collects items to display in a HTML widget. The ID field reflects the value returned from [SetWindowLocation].

func (dl *DisplayList) Draw(budget time.Duration) (completed bool)

v := html.NewPreview(nil, cfg)
ch := make(chan *html.DisplayList, 20)
var dl *html.DisplayList

tk.NewTicker(100*time.Millisecond, func() {
	if dl == nil {
	out:
		for {
			select {
			case dl = <-ch:
				// Drain.
			default:
				break out
			}
		}
	}
	if dl != nil && dl.Draw(80*time.Millisecond) {
		dl = nil
	}
})

v.SetWindowLocation("index.html", ch)

type Preview ¶

type Preview struct {
	*TextWidget
	// contains filtered or unexported fields
}

Preview provides a TextWidget based, preview quality rendering of simple HTML documents.

Only a limited subset of HTML/CSS is recognized and only the flow layout is supported, approximately. Everything else is ignored.

The intended use is for presenting small and simple markdown-only documents rendered to HTML by the gomarkdown package. There are no plans at the moment to extend the capabilities of Preview beyond that — the text widget is not compatible with most modern HTML/CSS features.

func NewPreview(parent *Window, cfg Config, options ...Opt) (r *Preview)

func (p *Preview) SeeID(id string) bool

func (p *Preview) SetWindowLocation(href string, listChan chan *DisplayList, seeTop bool) (id int, err error)