attributes

Documentation

Index

• Variables
• func RenderASTAttributes(w hugio.FlexiWriter, attributes ...ast.Attribute)
• func RenderAttributes(w hugio.FlexiWriter, skipClass bool, attributes ...Attribute)
• type Attribute
  • func (a Attribute) ValueString() string
• type Attributes
• type AttributesHolder
  • func New(astAttributes []ast.Attribute, ownerType AttributesOwnerType) *AttributesHolder
  • func (a *AttributesHolder) Attributes() map[string]any
  • func (a *AttributesHolder) AttributesSlice() []Attribute
  • func (a *AttributesHolder) Options() map[string]any
  • func (a *AttributesHolder) OptionsSlice() []Attribute
• type AttributesOwnerType

Variables

var Empty = &AttributesHolder{}

Empty holds no attributes.

Functions

func RenderASTAttributes

func RenderASTAttributes(w hugio.FlexiWriter, attributes ...ast.Attribute)

RenderASTAttributes writes the AST attributes to the given as attributes to an HTML element. This is used by the default HTML renderers, e.g. for headings etc. where no hook template could be found. This performs HTML esacaping of string attributes.

func RenderAttributes

func RenderAttributes(w hugio.FlexiWriter, skipClass bool, attributes ...Attribute)

Render writes the attributes to the given as attributes to an HTML element. This is used for the default codeblock renderering. This performs HTML esacaping of string attributes.

Types

type Attribute

type Attribute struct {
	Name  string
	Value any
}

func (Attribute) ValueString

func (a Attribute) ValueString() string

type Attributes

type Attributes map[string]any

type AttributesHolder

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

func New

func New(astAttributes []ast.Attribute, ownerType AttributesOwnerType) *AttributesHolder

func (*AttributesHolder) Attributes

func (a *AttributesHolder) Attributes() map[string]any

func (*AttributesHolder) AttributesSlice

func (a *AttributesHolder) AttributesSlice() []Attribute

func (*AttributesHolder) Options

func (a *AttributesHolder) Options() map[string]any

func (*AttributesHolder) OptionsSlice

func (a *AttributesHolder) OptionsSlice() []Attribute

type AttributesOwnerType

type AttributesOwnerType int

const (
	AttributesOwnerGeneral AttributesOwnerType = iota
	AttributesOwnerCodeBlockChroma
	AttributesOwnerCodeBlockCustom
)