Help us shape the future of Go! Take the 2026 Go Developer Survey

runtime

package
v0.3.1100 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 26, 2026 License: MIT Imports: 24 Imported by: 2,941

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultBufferSize = 4 * 1024 // 4KB

DefaultBufferSize is the default size of buffers. It is set to 4KB by default, which is the same as the default buffer size of bufio.Writer.

View Source 
var ErrInvalidStyleAttributeFunctionSignature = errors.New("invalid function signature, should be in the form func() (string, error)")
View Source 
var TemplUnsupportedStyleAttributeValue = "zTemplUnsupportedStyleAttributeValue:Invalid;"

TemplUnsupportedStyleAttributeValue is the default value returned for unsupported types.

Functions

func GeneratedTemplate 

func GeneratedTemplate(f func(GeneratedComponentInput) error) templ.Component

GeneratedTemplate is used to avoid generated code needing to import the `context` and `io` packages.

func GetBuilder 

func GetBuilder() (sb strings.Builder)

GetBuilder returns a strings.Builder.

func GetDevModeTextFileName 

func GetDevModeTextFileName(templFileName string) string

func ReleaseBuffer 

func ReleaseBuffer(w io.Writer) (err error)

ReleaseBuffer flushes the buffer and returns it to the pool.

func RenderAttributes added in v0.3.1100 

func RenderAttributes(ctx context.Context, w io.Writer, scriptWriter io.Writer, elementName string, attributes templ.Attributer) (err error)

RenderAttributes renders spread attributes on the named element. Attribute names that would change the structure of the element are replaced with templ.FailedSanitizationAttributeName. Attribute values are escaped and sanitized in the same way as attributes with constant names, except that event handler values that are not a templ.ComponentScript are replaced with templ.FailedSanitizationJS. The functions of templ.ComponentScript values are rendered to scriptWriter, which generated code writes before the opening tag of the element, so that the functions are defined before the element calls them.

func SanitizeAttributeName added in v0.3.1100 

func SanitizeAttributeName(name string) string

SanitizeAttributeName returns name if it can be written as an HTML attribute name, or templ.FailedSanitizationAttributeName if it can not.

func SanitizeStyleAttributeValues 

func SanitizeStyleAttributeValues(values ...any) (string, error)

SanitizeStyleAttributeValues renders a style attribute value. The supported types are: - string - templ.SafeCSS - map[string]string - map[string]templ.SafeCSSProperty - templ.KeyValue[string, string] - A map of key/values where the key is the CSS property name and the value is the CSS property value. - templ.KeyValue[string, templ.SafeCSSProperty] - A map of key/values where the key is the CSS property name and the value is the CSS property value. - templ.KeyValue[string, bool] - The bool determines whether the value should be included. - templ.KeyValue[templ.SafeCSS, bool] - The bool determines whether the value should be included. - func() (anyOfTheAboveTypes) - func() (anyOfTheAboveTypes, error) - []anyOfTheAboveTypes

In the above, templ.SafeCSS and templ.SafeCSSProperty are types that are used to indicate that the value is safe to render as CSS without sanitization. All other types are sanitized before rendering.

If an error is returned by any function, or a non-nil error is included in the input, the error is returned.

func ScriptContentInsideRegexp added in v0.3.1100 

func ScriptContentInsideRegexp[T any](v T, errs ...error) (string, error)

ScriptContentInsideRegexp escapes v for the pattern of a JavaScript regular expression literal, so that it matches itself, and can not end the regular expression.

func ScriptContentInsideStringLiteral 

func ScriptContentInsideStringLiteral[T any](v T, errs ...error) (string, error)

func ScriptContentInsideTemplateLiteral added in v0.3.1100 

func ScriptContentInsideTemplateLiteral[T any](v T, errs ...error) (string, error)

func ScriptContentOutsideStringLiteral 

func ScriptContentOutsideStringLiteral[T any](v T, errs ...error) (string, error)

func WriteString 

func WriteString(w io.Writer, index int, s string) (err error)

WriteString writes the string to the writer. If development mode is enabled s is replaced with the string at the index in the _templ.txt file.

Types

type AttributeExpression added in v0.3.1100 

type AttributeExpression[T attributeValue] struct {
	Value T
	Err   error
}

AttributeExpression is the result of an attribute expression. Generated code creates one with NewAttributeExpression, so that an expression that returns a value and an error, e.g. { getURL() }, can be resolved by a method that also takes a context.

func NewAttributeExpression added in v0.3.1100 

func NewAttributeExpression[T attributeValue](v T, errs ...error) AttributeExpression[T]

NewAttributeExpression returns the result of an attribute expression.

func (AttributeExpression[T]) Resolve added in v0.3.1100 

func (e AttributeExpression[T]) Resolve(ctx context.Context) (string, error)

Resolve converts the value to an HTML-escaped string. A templ.ComponentScript is converted to its function call.

func (AttributeExpression[T]) ResolveAnimationValue added in v0.3.1100 

func (e AttributeExpression[T]) ResolveAnimationValue(ctx context.Context) (string, error)

ResolveAnimationValue converts the value of an SVG animation attribute, such as the to attribute of a set element, to an HTML-escaped string. SVG animations can set the href of their parent element, so each item in the semicolon separated list is sanitized with templ.URL. A templ.SafeURL is not sanitized.

func (AttributeExpression[T]) ResolveDynamic added in v0.3.1100 

func (e AttributeExpression[T]) ResolveDynamic(ctx context.Context, scriptWriter io.Writer, elementName, name string) (string, error)

ResolveDynamic converts the value of an attribute with a name that is only known at render time to an HTML-escaped string. The value is sanitized based on the name, in the same way as the value of a spread attribute. If the value is a templ.ComponentScript, its function is rendered to scriptWriter, which generated code writes before the opening tag of the element, so that the function is defined before the element calls it.

func (AttributeExpression[T]) ResolveSrcset added in v0.3.1100 

func (e AttributeExpression[T]) ResolveSrcset(ctx context.Context) (string, error)

ResolveSrcset converts the value of a srcset attribute, which holds a comma separated list of image candidates, to an HTML-escaped string. The URL of each candidate is sanitized with templ.URL. A templ.SafeURL is not sanitized.

func (AttributeExpression[T]) ResolveURL added in v0.3.1100 

func (e AttributeExpression[T]) ResolveURL(ctx context.Context) (string, error)

ResolveURL converts the value of an attribute that contains a URL to an HTML-escaped string. A templ.SafeURL is not sanitized. All other values are sanitized with templ.URL.

type Buffer 

type Buffer struct {
	Underlying io.Writer
	// contains filtered or unexported fields
}

Buffer is a wrapper around bufio.Writer that enables flushing and closing of the underlying writer.

func GetBuffer 

func GetBuffer(w io.Writer) (b *Buffer, existing bool)

GetBuffer creates and returns a new buffer if the writer is not already a buffer, or returns the existing buffer if it is.

func (*Buffer) Close 

func (b *Buffer) Close() error

Close closes the buffer and the underlying io.Writer if it implements io.Closer.

func (*Buffer) Flush 

func (b *Buffer) Flush() error

Flush writes any buffered data to the underlying io.Writer and calls the Flush method of the underlying http.Flusher if it implements it.

func (*Buffer) Reset 

func (b *Buffer) Reset(w io.Writer)

Reset sets the underlying io.Writer to w and resets the buffer.

func (*Buffer) Size 

func (b *Buffer) Size() int

Size returns the size of the underlying buffer in bytes.

func (*Buffer) Write 

func (b *Buffer) Write(p []byte) (n int, err error)

Write the contents of p into the buffer.

func (*Buffer) WriteString 

func (b *Buffer) WriteString(s string) (n int, err error)

WriteString writes the contents of s into the buffer.

type GeneratedComponentInput 

type GeneratedComponentInput struct {
	Context context.Context
	Writer  io.Writer
}

GeneratedComponentInput is used to avoid generated code needing to import the `context` and `io` packages.

type SrcdocExpression added in v0.3.1100 

type SrcdocExpression[T any] struct {
	Value T
	Err   error
}

SrcdocExpression is the result of the expression of an iframe srcdoc attribute. Unlike AttributeExpression, the value can be a templ.Component.

func NewSrcdocExpression added in v0.3.1100 

func NewSrcdocExpression[T any](v T, errs ...error) SrcdocExpression[T]

NewSrcdocExpression returns the result of the expression of an iframe srcdoc attribute.

func (SrcdocExpression[T]) Resolve added in v0.3.1100 

func (e SrcdocExpression[T]) Resolve(ctx context.Context) (string, error)

Resolve converts the value to an HTML-escaped string. The browser parses the value as an HTML document, so a templ.Component is rendered as HTML, while strings, booleans, and numbers are escaped as text. Other types return an error.

type StringLoader 

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

func NewStringLoader 

func NewStringLoader(devModeWatchRootPath string) (sl *StringLoader)

func (*StringLoader) GetWatchedString 

func (sl *StringLoader) GetWatchedString(templFilePath string, index int, defaultValue string) (string, error)

Source Files

View all Source files

Directories

Path Synopsis
fuzzing module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.