styledtext

README

styledtext

Provides a widget that renders text in different styles.

Documentation

Overview

Package styledtext provides rendering of text containing multiple fonts and styles.

Index

• type SpanStyle
  • func (ss SpanStyle) Layout(gtx layout.Context, shape spanShape) layout.Dimensions
• type TextStyle
  • func Text(shaper *text.Shaper, styles ...SpanStyle) TextStyle
  • func (t TextStyle) Layout(gtx layout.Context, ...) layout.Dimensions
• type WrapPolicy

Types

type SpanStyle

type SpanStyle struct {
	Font    font.Font
	Size    unit.Sp
	Color   color.NRGBA
	Content string
	// contains filtered or unexported fields
}

SpanStyle describes the appearance of a span of styled text.

func (SpanStyle) Layout

func (ss SpanStyle) Layout(gtx layout.Context, shape spanShape) layout.Dimensions

Layout renders the span using the provided text shaping.

type TextStyle

type TextStyle struct {
	Styles     []SpanStyle
	Alignment  text.Alignment
	WrapPolicy WrapPolicy
	*text.Shaper
}

TextStyle presents rich text.

func Text

func Text(shaper *text.Shaper, styles ...SpanStyle) TextStyle

Text constructs a TextStyle.

func (TextStyle) Layout

func (t TextStyle) Layout(gtx layout.Context, spanFn func(gtx layout.Context, idx int, dims layout.Dimensions)) layout.Dimensions

Layout renders the TextStyle.

The spanFn function, if not nil, gets called for each span after it has been drawn, with the offset set to the span's top left corner. This can be used to set up input handling, for example.

The context's maximum constraint is set to the span's dimensions, while the dims argument additionally provides the text's baseline. The idx argument is the span's index in TextStyle.Styles. The function may get called multiple times with the same index if a span has to be broken across multiple lines.

type WrapPolicy

type WrapPolicy uint8

WrapPolicy defines line wrapping policies for styledtext. Due to complexities of the styledtext implementation, there are fewer options available than in gioui.org/text.WrapPolicy.

const (
	// WrapWords implements behavior like [gioui.org/text/.WrapWords]. This is the default,
	// as it prevents words from being split across lines.
	WrapWords WrapPolicy = iota
	// WrapWords implements behavior like [gioui.org/text/.WrapGraphemes]. This often gives
	// unpleasant results, as it will choose to split words across lines whenever it can. Some
	// use-cases may still want this, however.
	WrapGraphemes
)