datapages-templates

Templates

Read datapages first for the build loop, hard rules and naming conventions.

A Templ component implements datapages.Component, so handlers can return it. Run templ generate to compile .templ files to _templ.go. Datapages does not run this command. Templ docs: https://templ.guide/llms.md

Return application HTML as a Templ datapages.Component. Do not render it into a datapages.File: its bytes bypass Templ's contextual escaping and the Datapages template linter.

href: links

The generated href package has 1 function for each page, named after its page type. Query structs are named href.Query<PageType>. Zero-value fields are omitted from the URL.

<a href={ href.PageIndex() }>Home</a>
<a href={ href.PagePost(post.Slug) }>{ post.Title }</a>
<a href={ href.PageMessages(href.QueryPageMessages{Chat: chatID}) }>Messages</a>
<a href={ href.Asset("logo.svg") }>Logo</a>

The linter rejects a hardcoded root-relative, relative, query-only or empty href. It also rejects javascript:. Literal https://, mailto:, tel:, #frag and //cdn.example.com values are valid. Use href.External(url) for an external URL computed by the app.

Inside href={ ... }, use an href package call, string literal or constant. The linter rejects variables and other calls, including fmt.Sprintf and templ.SafeURL, because it cannot resolve them.

A GETXXX action, which answers with a datapages.File, has a URL builder that is a method of its owner: (*App).GETImage becomes href.App.Image(name), PageDoc.GETExport becomes href.PageDoc.Export(id). href.PageDoc(id) still builds the URL of the page. Pass a query value from the constructor next to the builder, as href.App.Image(name, href.App.ImageQuery(width)). Use these builders in src and href, such as href.App.Image(img.Name) for an image or href.PageDoc.Export(doc.ID) for a download link. The action package has no helper for a GET action: a browser loads it by URL.