Documentation
¶
Overview ¶
Package details provides a Goldmark extension for stateful collapsible details elements. It adds unique IDs to <details> elements and includes JavaScript to save/restore their state using browser session storage.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewHTMLRenderer ¶
func NewHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
NewHTMLRenderer creates a new HTMLRenderer
Types ¶
type Extender ¶
type Extender struct {
// IDPrefix is the prefix used for generated IDs. Defaults to "details-"
IDPrefix string
}
Extender implements goldmark.Extender to add stateful details support
func NewWithPrefix ¶
NewWithPrefix creates a new details Extender with a custom ID prefix
type HTMLRenderer ¶
HTMLRenderer renders the state management script for details elements
func (*HTMLRenderer) RegisterFuncs ¶
func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs registers rendering functions
type Transformer ¶
type Transformer struct {
// contains filtered or unexported fields
}
Transformer is a transformer that adds IDs to HTML <details> elements
func NewTransformer ¶
func NewTransformer(idPrefix string) *Transformer
NewTransformer creates a new Transformer
Source Files
Click to show internal directories.
Click to hide internal directories.