package templates

import "github.com/gohugoio/hugo/tpl/templates"

Package templates provides template functions for working with templates.

Index ¶

• type DeferOpts
• type Namespace
• func New(deps *deps.Deps) *Namespace
• func (ns *Namespace) Current(ctx context.Context) *tpl.CurrentTemplateInfo
• func (ns *Namespace) Defer(args ...any) (bool, error)
• func (ns *Namespace) DoDefer(ctx context.Context, id string, optsv any) string
• func (ns *Namespace) Exists(name string) bool

Types ¶

type DeferOpts ¶

type DeferOpts struct {
	// Optional cache key. If set, the deferred block will be executed
	// once per unique key.
	Key string

	// Optional data context to use when executing the deferred block.
	Data any
}

type Namespace ¶

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

Namespace provides template functions for the "templates" namespace.

func New ¶

func New(deps *deps.Deps) *Namespace

New returns a new instance of the templates-namespaced template functions.

func (*Namespace) Current ¶

func (ns *Namespace) Current(ctx context.Context) *tpl.CurrentTemplateInfo

Get information about the currently executing template.

func (*Namespace) Defer ¶

func (ns *Namespace) Defer(args ...any) (bool, error)

Defer defers the execution of a template block.

func (*Namespace) DoDefer ¶

func (ns *Namespace) DoDefer(ctx context.Context, id string, optsv any) string

DoDefer defers the execution of a template block. For internal use only.

func (*Namespace) Exists ¶

func (ns *Namespace) Exists(name string) bool

Exists returns whether the template with the given name exists. Note that this is the Unix-styled relative path including filename suffix, e.g. partials/header.html

Source Files ¶

init.go templates.go