Helper Index (A–Z)

This page exists for one job. You have a helper name — from a template you inherited, a build log line, or a half-memory — and you want the page that documents it. Find the name, follow the link.

Everything here assumes the mechanics set out in How Helpers Work: the trailing options object, when {{ }} is not enough, and what the context has to carry. Before you use any of these in anger, the cross-cutting failure modes — which ones throw and stop the build, which return nothing silently, and which need triple braces — are collected once on Helper Gotchas and Failures.

All helpers, A to Z

Form is the call shape the helper’s body expects — see Inline, block and subexpression. A row marked (internal) is system plumbing that Leed’s own shipped templates call; it is documented so that reading those templates makes sense, not because you are expected to reach for it. A † marks a deprecated helper.

HelperFormDoesDocumented on
absoluteImageUrlinlineSwaps in a size variant and makes the URL absoluteImage and Media
AnnouncementSeriesblockIterates the announcement-series pages carrying a labelCollection, Lookup and Series
AuthorsblockIterates the page’s authorsCollection, Lookup and Series
breadcrumbsNavinlineRenders the breadcrumb trail from the left docs menuDocumentation Navigation
buildUrlinlineAppends a query string, choosing ? or &URL and Link
collectionsubexpressionFetches a named Eleventy collectionCollection, Lookup and Series
concatinlineJoins its string argumentsUtility
CTAinline† Emits a hidden call-to-action target markerForm and CTA
dateblockFormats the date its block body producesDate and Content
docsColorThemeinlineReturns the documentation color theme nameDocumentation Navigation
docsLayoutNameinlineReturns the documentation layout nameDocumentation Navigation
docsLayoutTemplateinlineReturns the layout’s base partial path (internal)Documentation Navigation
docsMenuNameinlineReturns a documentation menu’s name keyDocumentation Navigation
FeatureImageblockRenders the page’s feature image as an <img>Image and Media
FeatureVideoblock or inlineEmbeds the page’s feature videoImage and Media
fieldIdinlineBuilds a form field’s id for a <label for>Form and CTA
filterObjectsubexpressionFilters a keyed map by a field pathCollection, Lookup and Series
firstTruthyblockRenders its block with the first truthy argumentUtility
formatSecurityNameinlineTitle-cases OpenAPI security scheme names (internal)Utility
fullNameinlineJoins an author’s first and last nameCollection, Lookup and Series
hasFeaturesubexpressionIs a named feature included in this plan?Tier Gating
hasTiersubexpressionDoes this plan meet a minimum tier?Tier Gating
hrefIsRenderablesubexpressionWill this href resolve to a page that rendered?Menu-Safety
IfAnnouncementSeriesblockRenders its block when the label is an announcement seriesCollection, Lookup and Series
IfMultipartSeriesblockRenders its block when the label is a multipart seriesCollection, Lookup and Series
ImageblockRenders an <img> from a URL at a chosen variantImage and Media
ImageTagblock or inlineRenders an <img> from an image-reference objectImage and Media
imageUrlinlineSwaps a size variant into an image URLImage and Media
JSON-LDinlineEmits the page’s structured-data scriptDate and Content
JSONsafeinlineEmits a value as a quoted JSON string literalUtility
labelblock or inlineLooks up a label by idCollection, Lookup and Series
LabelsblockIterates the page’s labelsCollection, Lookup and Series
latestDateinlineFinds the latest date value in a collectionDate and Content
leedConfiguredCSSinlineBuilds the documentation theme class string (internal)Documentation Navigation
loggerinlinePrints values to the build console; emits nothingUtility
menuItemShouldRendersubexpressionShould this menu item appear at all?Menu-Safety
MultipartSeriesblockIterates the multipart-series pages carrying a labelCollection, Lookup and Series
nextPageNavinlineRenders the link to the next documentation pageDocumentation Navigation
pageIdExistssubexpressionDid a page with this id render in this build?Menu-Safety
pagesUrlinlineReturns the workers preview host (internal)URL and Link
pageTypeblock or inlineLooks up a page type by idCollection, Lookup and Series
pageTypeSluginlineReturns a page type’s slugified name (internal)Collection, Lookup and Series
PaginationLinksblockIterates every page in a paginated setPagination
PaginationRangeblockExposes range start, end and total for a listPagination
previousPageNavinlineRenders the link to the previous documentation pageDocumentation Navigation
processinlineRenders CMS content: autolinks and expands partialsDate and Content
readingTimeinlineReturns whole minutes to read the pageCollection, Lookup and Series
Recommendationsinline† Emits a hidden recommendations target markerForm and CTA
resolveRedirectIndexinlineBuilds a page type’s index redirect rules (internal)URL and Link
searchDocumentHashinlineReturns the build’s search document hash (internal)Utility
searchIndexHashinlineReturns the build’s search index hash (internal)Utility
SeriesblockIterates every page in a series, whatever its typeCollection, Lookup and Series
siteUrlinlineReturns the site’s origin, with no trailing slashURL and Link
SmartPaginationLinksinlineRenders windowed numbered links with ellipsesPagination
sortedsubexpressionReturns a sorted copy of a listCollection, Lookup and Series
staticImageblockRenders an <img> for a file shipped in your repositoryImage and Media
stripTagsinlineRemoves tags and neutralises & and =Utility
svgDiagraminlineInlines an SVG partial inside a themed wrapperImage and Media
templateExistssubexpressionDoes this file exist in _includes?Utility
tocinlineBuilds an on-this-page list from id-bearing headingsDocumentation Navigation
turnstileKeyinlineReturns the Turnstile public key for this environmentForm and CTA
urlinlineReturns this page’s URL, absolute unless you ask otherwiseURL and Link
useCustomTemplatesubexpressionDid the build detect an override file for this slot?Utility
userblock or inlineLooks up a user by idCollection, Lookup and Series
wrapSubstringinlineWraps every occurrence of a substring in a spanUtility

toc is the one row here that is not Leed’s code. It comes from eleventy-plugin-toc, and it is an Eleventy filter rather than a shortcode — but filters and shortcodes are both handed to Handlebars as helpers, so at the call site there is nothing to tell them apart.

† Deprecated. CTA and Recommendations still work and still emit their marker, but the supported approach is now a data-leed-cta or data-leed-recommendations attribute on the target element itself. Form and CTA Helpers has the replacement.

By job

When you know what you want to do but not what it is called, start here instead.

PageHelpers it coversCount
URL and Link Helpersurl, siteUrl, pagesUrl, buildUrl, resolveRedirectIndex5
Image and Media HelpersImage, FeatureImage, ImageTag, staticImage, svgDiagram, FeatureVideo, imageUrl, absoluteImageUrl8
Collection, Lookup and Series HelperspageType, user, label, Authors, Labels, Series, MultipartSeries, AnnouncementSeries, IfMultipartSeries, IfAnnouncementSeries, collection, filterObject, sorted, pageTypeSlug, readingTime, fullName16
Menu-Safety HelpershrefIsRenderable, menuItemShouldRender, pageIdExists3
Pagination HelpersPaginationLinks, SmartPaginationLinks, PaginationRange3
Documentation Navigation HelpersdocsLayoutName, docsColorTheme, docsLayoutTemplate, docsMenuName, previousPageNav, nextPageNav, breadcrumbsNav, leedConfiguredCSS8
Date and Content Helpersdate, latestDate, process, JSON-LD4
Form and CTA HelpersfieldId, turnstileKey, CTA, Recommendations4
Tier Gating in TemplateshasTier, hasFeature2
Utility HelpersuseCustomTemplate, templateExists, concat, JSONsafe, stripTags, firstTruthy, wrapSubstring, logger, searchDocumentHash, searchIndexHash, formatSecurityName11
64

The count column is the coverage claim for this whole reference: every helper Leed registers is documented on exactly one of those ten pages, and the ten add up to 64. toc is not in the total because it is not Leed’s, and it is documented alongside the other documentation-navigation helpers because that is the only place it is used.

Not helpers

Four things people look for on this page and will not find here.

Partials. leed/form, leed/head, leed/components/pagination and the rest are includes, written with {{> leed/… }} rather than a helper call. They take named arguments, not positional ones, and they render a whole component rather than returning a value. Their catalog is the Leed Partial Index.

The CMS Shortcodes feature. Branded /s/ short links with UTM parameters and click tracking. Unrelated to anything on this page, and documented at Short Links and Attribution. The name collision is unfortunate and real: Leed’s source calls template helpers “shortcodes” too.

The string category of handlebars-helpers. uppercase, lowercase, titleize, truncate, replace, split, trim and 29 others are not registered in a Leed build, because that category collides with the array helpers on reverse. A template calling one renders an empty string rather than failing. The full list of 36, and the four stand-ins Leed provides instead, are on How Helpers Work.

addAnchorReason. Removed from the product. Recommendation and CTA links now carry their attribution through a build-time data-reason convention instead. If you find it in an old template, delete the call.

ESC