Objects

Objects are the data your Liquid templates read: the firm, the signed-in client (customer), the page being viewed, the section being rendered. Read a property with a dot and its snake_case name:

<a href="{{ firm.url }}">{{ firm.name | escape }}</a>

Some objects are available everywhere, some only in certain templates, and some only come from other objects (a menu's links are link objects). Each section below says where its object is available.

Reading this reference#

Types

Missing values. A property that doesn't exist, or an object that isn't available in the current template, is nil. It renders as nothing and doesn't raise an error.

Relative URLs. Properties named url or …_url that point at the firm's own pages are paths, such as /contact. Image URLs and firm.url are absolute.

Overview#

firm#

The firm whose site is being rendered. It only exposes public details.

Available: everywhere, as firm.

{% if firm.logo_url %}
  <img src="{{ firm.logo_url }}" alt="{{ firm.name | escape }}">
{% else %}
  <span>{{ firm.name | escape }}</span>
{% endif %}

The office details are set in Firm settings → General, so they stay the same whichever theme is live. Leave out any that are empty:

{% if firm.phone %}<a href="{{ firm.phone_url }}">{{ firm.phone | escape }}</a>{% endif %}
{% if firm.address %}<address>{{ firm.address_line_1 | escape }}<br>{{ firm.address_line_2 | escape }}</address>{% endif %}
<p>© {{ 'now' | date: '%Y' }} {{ firm.legal_name | escape }}</p>

Social link#

{% for link in firm.social_links %}
  <a href="{{ link.url }}" target="_blank" rel="noopener noreferrer">
    {{ link.label | default: link.type | escape }}
  </a>
{% endfor %}

Powered-by badge#

{% if firm.powered_by.visible %}
  <a href="{{ firm.powered_by.url }}">{{ firm.powered_by.text | escape }}</a>
{% endif %}

settings#

The theme-wide settings declared in config/settings_schema.json, by setting id, with the values the firm saved in the theme editor (or each setting's default). Section and block settings work the same way, as section.settings and block.settings.

Available: everywhere, as settings.

The value's type depends on the setting's type:

See Settings for how to declare each type.

<h1 style="font-family: {{ settings.heading_font.family }}">{{ section.settings.heading | escape }}</h1>

routes#

URLs of the platform pages a theme links to. Use these instead of hard-coded paths, so your theme keeps working if a path changes. Every property is a string path.

Available: everywhere, as routes.

<a href="{{ routes.contact_url }}">Contact us</a>

customer#

The signed-in client, or nil for visitors who aren't signed in.

Available: everywhere, as customer.

{% if customer %}
  <a href="{{ routes.account_url }}">My account</a>
  {% form 'customer_logout' %}<button type="submit">Sign out</button>{% endform %}
{% else %}
  <a href="{{ routes.signin_url }}">Sign in</a>
{% endif %}

request#

The current request.

Available: everywhere, as request.

flash#

The success or error message from the visitor's last action, such as signing out or resetting a password, or nil.

Available: everywhere, as flash.

{% if flash %}
  <p role="status" class="alert alert-{{ flash.type }}">{{ flash.message | escape }}</p>
{% endif %}

Page metadata#

Available: everywhere.

content_for_header already outputs the meta description, canonical and social sharing tags, so you only need these to show them somewhere else.

<body class="template-{{ template | replace: '/', '-' | replace: '.', '-' }}">

content_for_header and content_for_layout#

Available: in layouts.

content_for_header also prints the page's structured data for search engines (JSON-LD): the firm as a LegalService and the WebSite on the homepage, a BlogPosting on articles, a Service on practice group pages and a BreadcrumbList on the rest. Don't add your own JSON-LD for these types, or search engines see them twice. Client portal pages (customers/* templates) are marked noindex.

<head>
  {{ content_for_header }}
</head>
<body>
  {% sections 'header-group' %}
  <main id="main-content">{{ content_for_layout }}</main>
</body>

form_authenticity_token#

Available: everywhere, as a string.

The security token a form needs when it posts to the platform. {% form %} adds it for you; use it only in a form you write by hand.

<form method="post" action="{{ routes.signout_url }}">
  <input type="hidden" name="_token" value="{{ form_authenticity_token }}">
  <button type="submit">Sign out</button>
</form>

linklists#

The firm's menus, built under Navigation, by handle. Hyphenated handles can also be read with underscores. Every firm has main-menu and footer.

Available: everywhere. Each value is a linklist.

{% for link in linklists['main-menu'].links %}
  <a href="{{ link.url }}">{{ link.title | escape }}</a>
{% endfor %}

Prefer a link_list setting, so the firm chooses which menu a section shows.

The firm can mark a link "Hide from signed-in clients" in Navigation. While a client is signed in, that link (with its child links) isn't in the menu at all, so your markup needs nothing for it.

practice_areas#

The firm's published practice areas, in the firm's order. Firms write them under Firm settings → Practice areas: each is a practice group with its own page at /practice-areas/{handle}, and its areas (sub-practices) are sections of that page.

Available: everywhere, as an array of practice_area. It's empty when the firm hasn't published any.

{% for group in practice_areas %}
  <a href="{{ group.url }}">{{ group.name | escape }}</a>
  {% for area in group.areas %}<a href="{{ area.url }}">{{ area.name | escape }}</a>{% endfor %}
{% endfor %}

practice_area#

A published practice group.

Available: as items of practice_areas, and as practice_area on the practice_area template (the group's own page).

area#

One area (sub-practice) of a practice group, shown as a section of the group's page.

Available: as items of practice_area.areas.

{% for area in practice_area.areas %}
  <section id="{{ area.handle }}">
    <h2>{{ area.name | escape }}</h2>
    {{ area.content }}
  </section>
{% endfor %}

intake_form#

The firm's intake form, which prospective clients fill in to tell the firm about their matter. The firm sets it up in its admin (Intake → Intake form); each submission becomes a lead there. Draw it with {% form 'intake' %} in your intake template (Counsel's main-intake section is the reference).

{% form 'intake' %}
  <input type="text" name="company_website" class="hidden" tabindex="-1" autocomplete="off">
  <input type="text" name="name" required>
  <input type="email" name="email" required>
  {% for question in intake_form.questions %}
    <label for="q-{{ question.key }}">{{ question.label | escape }}</label>
    <input id="q-{{ question.key }}" type="text" name="answers[{{ question.key }}]" value="{{ form.values.answers[question.key] | escape }}"{% if question.required %} required{% endif %}>
    {% assign field = 'answers.' | append: question.key %}
    {% if form.errors[field] %}<p>{{ form.errors[field] | escape }}</p>{% endif %}
  {% endfor %}
  <button type="submit">Send</button>
{% endform %}

Keep the hidden company_website field: it's a spam trap, and submissions that fill it are dropped.

blog#

The firm's blog. Firms write articles under Website → Blog, each optionally in one category and with any number of tags. Only live articles appear: published, with a publish date that has passed. On plans without the blog every list is empty.

Available: everywhere, as blog. On the blog template it is the page being shown: /blog (?page=2 for older articles), a category's archive at /blog/category/{handle}, or a tag's at /blog/tag/{handle}. Elsewhere it holds the blog's first page.

{% for article in blog.articles %}
  <a href="{{ article.url }}">{{ article.title | escape }}</a>
{% endfor %}
{% if blog.pagination.next_url %}<a href="{{ blog.pagination.next_url }}">Older</a>{% endif %}

article#

A live blog article.

Available: as items of the blog lists, and as article on the article template (the article's page at /blog/{handle}).

article_category#

A blog category, with its archive at /blog/category/{handle}.

Available: as article.category, items of blog.categories, and blog.category.

article_tag#

A blog tag, with its archive at /blog/tag/{handle}.

Available: as items of article.tags and blog.tags, and blog.tag.

metafields#

A practice group's or area's custom fields. Firms add their own under Firm settings → Custom fields, each with a key, so your theme can show more than the standard properties without the platform knowing about it. Read one as metafields.<key>. A key the firm hasn't added, or a field left empty, gives nil ([] for a list), so check before printing and document the keys your theme reads.

Available: as practice_area.metafields, area.metafields, article.metafields and article_category.metafields.

Every firm starts with three practice group fields, which the bundled themes read:

{% if practice_area.metafields.intro != blank %}
  <p>{{ practice_area.metafields.intro | escape }}</p>
{% endif %}
{% for item in practice_area.metafields.highlights %}
  <dt>{{ item.label | escape }}</dt><dd>{{ item.value | escape }}</dd>
{% endfor %}

team#

The firm members shown on the firm's team page (switched on with On website on the Team page; each member fills in their own website profile under My account), in the firm's order. Featured people have a full profile; the others are the supporting team. People have no page of their own: link to them on your team page with #{{ person.handle }}.

Available: everywhere, as team.

team_member#

One person on the team page.

Available: as items of team.members, team.featured and team.supporting, as practice_area.lead and as article.author.

{% for person in team.featured %}
  <article id="{{ person.handle }}">
    {% if person.photo_url %}<img src="{{ person.photo_url }}" alt="{{ person.name | escape }}">{% endif %}
    <h3>{{ person.name | escape }}</h3>
    {{ person.bio }}
  </article>
{% endfor %}

page#

A page of the firm's site, written under Pages.

Available: as page on every site page (the index, page and page.* templates).

Pages don't nest: each one is at its own address, and the firm groups them into dropdowns in Navigation (see linklists).

<h1>{{ page.title | escape }}</h1>
<div class="rte">{{ page.content }}</div>

reset_password#

Available: as reset_password in the customers/reset_password template.

See the reset_customer_password form in the Liquid reference.

invitation#

Available: as invitation in the customers/activate_account template, the page a client's invitation email opens. It's nil once the link has expired or been used: tell them to ask the firm for a new one, or to sign in.

{% if invitation %}
  {% form 'activate_customer_password' %}
    <input type="hidden" name="token" value="{{ invitation.token | escape }}">
    …
  {% endform %}
{% else %}
  <a href="{{ routes.signin_url }}">Sign in</a>
{% endif %}

See the activate_customer_password form in the Liquid reference.

section#

The section being rendered.

Available: as section inside a section file (sections/*.liquid).

<img src="{{ section.settings.image }}" alt=""
     loading="{% if section.index == 1 %}eager{% else %}lazy{% endif %}">

block#

One block of a section.

Available: as each item of section.blocks.

{% for block in section.blocks %}
  {% case block.type %}
    {% when 'heading' %}
      <h2 {{ block.theme_attributes }}>{{ block.settings.text | escape }}</h2>
    {% when 'button' %}
      <a href="{{ block.settings.link }}" {{ block.theme_attributes }}>{{ block.settings.label | escape }}</a>
  {% endcase %}
{% endfor %}

form#

The state of the form being rendered.

Available: as form inside {% form %}…{% endform %}. See Forms for each form type and its fields.

{% form 'contact' %}
  <input type="email" name="email" value="{{ form.values.email | escape }}">
  {% if form.errors.email %}<p class="error">{{ form.errors.email | escape }}</p>{% endif %}
{% endform %}

linklist#

A menu.

Available: as values of linklists, and as the value of a link_list setting. Output on its own, a linklist prints its handle.

link#

One link of a menu. Links to draft or deleted pages, and to practice groups or areas that aren't public, are left out.

Available: as items of linklist.links and link.links.

{% for link in section.settings.menu.links %}
  <a href="{{ link.url }}" {% if link.current %}aria-current="page"{% endif %}>{{ link.title | escape }}</a>
  {% if link.links.size > 0 %}
    <ul>
      {% for child in link.links %}
        <li><a href="{{ child.url }}">{{ child.title | escape }}</a></li>
      {% endfor %}
    </ul>
  {% endif %}
{% endfor %}

font#

A font chosen with a font_picker setting. Output on its own, a font prints its CSS font-family stack.

Available: as the value of a font_picker setting.

{{ settings.body_font | font_face }}
<style>
  body { font-family: {{ settings.body_font.family }}; }
</style>

color_scheme#

One colour scheme: a named set of colours. Output on its own, a colour scheme prints its ID.

Available: as items of a color_scheme_group setting, and as the value of a color_scheme setting.

<section class="color-{{ section.settings.color_scheme }}">
  …
</section>

The platform already outputs a .color-<id> class for each scheme, setting the scheme's colours as --theme-* CSS variables. See Settings.