mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-18 21:11:19 +02:00
Add render template hooks for headings
This commit also * Renames previous types to be non-specific. (e.g. hookedRenderer rather than linkRenderer) Resolves #6713
This commit is contained in:
committed by
Bjørn Erik Pedersen
parent
991934497e
commit
423b8f2fb8
@@ -27,13 +27,41 @@ type LinkContext interface {
|
||||
PlainText() string
|
||||
}
|
||||
|
||||
type Render struct {
|
||||
LinkRenderer LinkRenderer
|
||||
ImageRenderer LinkRenderer
|
||||
type LinkRenderer interface {
|
||||
RenderLink(w io.Writer, ctx LinkContext) error
|
||||
identity.Provider
|
||||
}
|
||||
|
||||
func (r *Render) Eq(other interface{}) bool {
|
||||
ro, ok := other.(*Render)
|
||||
// HeadingContext contains accessors to all attributes that a HeadingRenderer
|
||||
// can use to render a heading.
|
||||
type HeadingContext interface {
|
||||
// Page is the page containing the heading.
|
||||
Page() interface{}
|
||||
// Level is the level of the header (i.e. 1 for top-level, 2 for sub-level, etc.).
|
||||
Level() int
|
||||
// Anchor is the HTML id assigned to the heading.
|
||||
Anchor() string
|
||||
// Text is the rendered (HTML) heading text, excluding the heading marker.
|
||||
Text() string
|
||||
// PlainText is the unrendered version of Text.
|
||||
PlainText() string
|
||||
}
|
||||
|
||||
// HeadingRenderer describes a uniquely identifiable rendering hook.
|
||||
type HeadingRenderer interface {
|
||||
// Render writes the renderered content to w using the data in w.
|
||||
RenderHeading(w io.Writer, ctx HeadingContext) error
|
||||
identity.Provider
|
||||
}
|
||||
|
||||
type Renderers struct {
|
||||
LinkRenderer LinkRenderer
|
||||
ImageRenderer LinkRenderer
|
||||
HeadingRenderer HeadingRenderer
|
||||
}
|
||||
|
||||
func (r *Renderers) Eq(other interface{}) bool {
|
||||
ro, ok := other.(*Renderers)
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
@@ -49,10 +77,9 @@ func (r *Render) Eq(other interface{}) bool {
|
||||
return false
|
||||
}
|
||||
|
||||
if r.HeadingRenderer.GetIdentity() != ro.HeadingRenderer.GetIdentity() {
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
type LinkRenderer interface {
|
||||
Render(w io.Writer, ctx LinkContext) error
|
||||
identity.Provider
|
||||
}
|
||||
|
Reference in New Issue
Block a user