Liquid Objects

Liquid Objects, a coding term that is also known as liquid variables, contain attributes to output dynamic content on a page. In REACH, these are used to insert an object’s custom fields in Email Templates, Mail Merge Templates and Themes.

Attributes can be a single value ex: {{ account.name }} or a collection of multiple objects such as {{ link.links }}.

To output an object’s attribute on the page, wrap them in {{ and }} as shown below:

{{ account.name }} <!– Output: “My Organization” –>

To test whether a Supporter is logged in, use:

{% if supporter != nil %}<!– Do Something –>{% endif %}

Here is a list of Objects that are available in every REACH Template:

  • account
  • menus
  • cart
  • template
  • supporter

These Liquid Objects can be used with your Custom Fields.

To do so, you can use the liquid code available in our Email Templates, Mail Merge Templates and Theme layouts, templates and partials.

You will first need to indicate the Object you wish to use that’s available with our Custom Fields (supporter, sponsorship, project, place or campaign) followed by the permalink of the custom field.

Example: {{ supporter | custom_field: ‘gender’ }}

Here is a list of the available Objects and design elements, defining what each returns.

Note: REACH makes regular, continual updates and while we work to maintain and update this list, it may not be exhaustive.


account – example call: {{ account.name }}

name – Returns the name of the organization

phone – Returns the phone number of the organization

address – Returns the street address of the organization

city – Returns the city of the organization’s mailing address

state – Returns the state 

postal – Returns the postal/zip code 

email – Returns the organization’s main contact email

google_analytics – Returns the Google Analytics code used for web analytics

available_campaign_themes – Returns the collection of campaign themes available for the organization. This includes the built-in REACH campaign themes and any custom themes the organization has set up. Access the attributes using campaign_theme

overview – Returns the site overview text from Settings > Portal Setup

campaign_overview – Returns the overview text from Settings > Portal Setup > Campaigns tab

sponsorship_overview – Returns the overview text from Settings > Portal Setup > Sponsorships tab

project_overview – Returns the overview text from Settings > Portal Setup > Projects tab

place_overview – Returns the overview text from Settings > Portal Setup > Places tab

place_name – Returns the label set for places from Settings > Portal Setup > Places tab

project_name – Returns the label set for projects from Settings > Portal Setup > Projects tab

campaign_name – Returns the label set for campaigns from Settings > Portal Setup > Campaigns tab

supporter_campaign_name – Returns the label set for supporter campaigns from Settings > Portal Setup > Campaigns tab

sponsorship_name – Returns the label set for sponsorships from Settings > Portal Setup > Sponsorships tab

sponsorship_share_name – Returns the label set for sponsorship shares from Settings > Portal Setup > Sponsorships tab

sponsorship_types – Returns the collection of all sponsorship types used in the sponsorship search partial

sponsorship_categories_for_select – Returns the collection of custom field options used in the sponsorship search partial

available_sponsorships – Returns the collection of sponsorships that are not disabled or hidden, use sponsorship to access attributes

places – Returns the collection of all places, use place to access attributes

projects – Returns the collection of all projects, use project to access attributes

campaigns – Returns the collection of all campaigns, use campaign to access attributes

approved_campaigns – Returns the collection of approved campaigns, use campaign to access attributes

sponsorships – Returns the collection of all sponsorships, use sponsorship to access attributes

primary_domain – Returns the URL for the web address used for public pages

admin_domain – Returns the URL for the secure web address used for donations and user accounts

Design elements for account used in themes – example call: {{ account.logo_file }}

logo_file – Returns the URL of the logo file uploaded to Settings > Portal Branding

body_bg_image_file – Returns the URL of the background file uploaded to Settings > Portal Branding

body_font_family – Returns the font family selected in Settings > Portal Branding

body_bg_color – Returns the body background color selected in Settings > Portal Branding

body_bg_style – Returns the body background image style selected in Settings > Portal Branding

body_text_color – Returns the default text color selected in Settings > Portal Branding

h_color – Returns the text color for H tag elements selected in Settings > Portal Branding

a_color – Returns the text color for links selected in Settings > Portal Branding

toolbar_bg_color – Returns the background color for the toolbar (menu bar) selected in Settings > Portal Branding

toolbar_a_color – Returns the link color for the toolbar (menu bar) selected in Settings > Portal Branding

toolbar_h1_color – Returns the site name color for the toolbar (menu bar) selected in Settings > Portal Branding

wrapper_bg_color – Returns the background color for the wrapper selected in Settings > Portal Branding

message_bg_color – Returns the background color for the message elements selected in Settings > Portal Branding

css_styling – Returns the custom CSS added to Settings > CSS Editor


album – example call: {{ album.date | date: “%m/%d/%Y }}

title – Returns the title of the photo album

permalink – Returns the permalink of the photo album

url – Returns the relative URL of the photo album

full_url – Returns the full URL with domain name of the album

date – Returns the date of the photo album

description – Returns the description of the photo album

project – Returns the project object if the photo album is associated with a project.

place – Returns the place object if the photo album is associated with a place

campaign – Returns the campaign object if the photo album is associated with a campaign

sponsorship – Returns the sponsorship object if the photo album is associated with a sponsorship

photos – Returns collection of photos in the album, use the photo object to access attributes

type – Returns “album”, used when determining if a feed item is an album or message


campaign – example call: {{ campaign.title }}

title – Returns the title of the campaign

permalink – Returns the permalink of the campaign

url – Returns the relative URL of the campaign

full_url – Returns the full URL with domain name of the campaign

description – Returns the description of the campaign

sanitized_description – Returns the description of the campaign with all HTML attributes removed

embedded_video – Returns the attached video or YouTube/Vimeo video including embed code

video_link – Returns the YouTube or Vimeo video link of the campaign

images – Returns collection of image sizes: thumbnail, small, medium, large, original. Example “campaign.images[‘medium’]” returns the URL for the medium size image

cover_images – Returns collection of cover image sizes: cover, original. Example “campaign.cover_images[‘original’]” returns the URL for the original size image

goal_amount – Returns the amount the campaign is trying to raise

approved – Returns a true/false value for whether the campaign has been approved by the organization

days_remaining – Returns the number of days remaining before the goal end date.

funded? – Returns a true/false value for whether the campaign is fully funded

total – Returns the total amount raised for the campaign

complete_donations – Returns a collection of donations for the campaign

goal_end_date – Returns the end date of the campaign

approved_children – Returns a collection of supporter campaigns tied to this campaign

parent – Returns the parent campaign of a supporter campaign if there is one

sponsorship – Returns the sponsorship object associated with the campaign, use the sponsorship object to access attributes

albums – Returns collection of albums associated with the campaign, use the album and photo objects to access attributes

messages – Returns collection of messages associated with the campaign, use the message object to access attributes

products – Returns collection of products associated with the campaign, use the product object to access attributes

owner – Returns the supporter, project, or place associated to the campaign

custom_field_values – Returns collection of custom fields associated with the campaign, use the custom_field_values object to access attributes


campaign_pledges

campaign.funded_including_pledges – Returns a true/false value for whether the campaign is fully funded including pledges

campaign.total_with_pledges – Returns the total amount raised for the campaign including pledges

campaign.complete_donations_and_pledges – Returns a collection of donations and pledges for the campaign

campaign.donors_including_pledges – Returns a collection of donors to the campaign including those that have made pledges


campaign_theme

title – Returns the title of the theme

description – Returns the description of the theme

permalink – Returns the permalink of the theme

set_campaign_title – Returns true/false value for whether the theme will setup the campaign’s title

campaign_title_prompt – Returns the prompt question for the supporter to answer about the title

campaign_title_editable – Returns a true/false value for whether the supporter is allows to edit the title

campaign_title – Returns the generic title to be used for the campaign

set_description – Returns true/false value for whether the theme will setup the campaign’s long description

description_prompt – Returns the prompt question for the supporter to answer about the long description

campaign_description_editable – Returns a true/false value for whether the supporter is allows to edit the long description

campaign_description – Returns the generic long description to be used for the campaign

set_goal_end_date – Returns true/false value for whether the theme will setup the campaign’s end date

goal_end_date_prompt – Returns the prompt question for the supporter to answer about the end date

campaign_goal_end_date_editable – Returns a true/false value for whether the supporter is allows to edit the end date

campaign_description – Returns the end date to be used for the campaign

set_goal_amount – Returns true/false value for whether the theme will setup the campaign’s goal amount

goal_amount_prompt – Returns the prompt question for the supporter to answer about the goal amount

campaign_goal_amount_editable – Returns a true/false value for whether the supporter is allows to edit the goal amount

campaign_goal_amount – Returns the generic goal amount to be used for the campaign

set_video_link – Returns true/false value for whether the theme will setup the campaign’s video link

campaign_video_link – Returns the generic video link to be used for the campaign


cart – example call: {{ cart.size }}

id – Returns the cart ID, used when updating cart details

total_price – Returns the total price for all items in the cart including shipping cost

size – Returns the count of items in the cart

cart_line_items – Returns the collection of items in the cart, use cart_line_item to access attributes

sub_total – Returns the total of items in the cart minus any shipping cost

total_shipping_cost – Returns the total of shipping cost for the items in the cart


cart_line_items

id – Returns the item ID, used when updating item details

price – Returns the price of the line item in the cart

quantity – Returns the quantity of the item in the line item

product – References the product object of the cart line item

total_price – Returns the value of price multiplied by quantity


category – example call: {{ category.permalink }}

title – Returns the category title, used when display the category as a blog

permalink – Returns the permalink of the category

url – Returns the relative URL of the category

full_url – Returns the full URL with domain name of the category

messages – Returns a collection of messages associated with the category


contribution statements – mail merge template

today – Returns current date – example: {{ today | date: “%m/%d/%Y” }}

statement _id – Returns unique contribution statement number- example: {{ statement_id }}

status – Returns copy if a statement has already been created- example use: {% if status == “copy” %}Copy of {% endif %}Statement #{{ statement_id }}


custom_field_values

title – Returns the title of the custom field.value – Returns the value of the custom field for the object


donation – example call: {{ donation.name }}

name – Returns the name of the supporter

date – Returns the date of the donation

purpose or referral_title – Returns the purpose of the donation

amount – Returns the amount of the donation

transaction_fees – Returns the amount donated to help cover the organization’s transaction fees

total_amount – Returns the amount of the donation plus any transaction fees that were donated

check_number – Returns the check number of the donation if present

confirmation – Returns the confirmation number of the donation if present

cart – Returns the cart of the donation, use “cart” to access attributes

anonymous_donor – Returns true if the donor requested to keep their name anonymous to the public

anonymous_amount – Returns true if the donor requested to keep their amount anonymous to the public

first_name – Returns the first name of the supporter saved on the donation

last_name – Returns the last name of the supporter saved on the donation

email – Returns the email of the supporter saved on the donation

address1 – Returns the first field of the donation’s street address

address2 – Returns the second field of the donation’s street address

city – Returns the city of the donation

state – Returns the state of the donation

country – Returns the country of the donation

phone – Returns the phone of the donation

note – Returns the note included in the donation

honoree_name – Returns the name of the Honoree of the donation

honoree_email – Returns the email of the Honoree of the donation

honoree_note – Returns the note to the Honoree of the donation

line_items – Returns the collection of items in the donation if the donor selected more than one purpose, use cart_line_item to access attributes

title – Returns the title of the link

url – Returns the relative URL of the link

links – Returns the collection of sub-links


mail merge and email templates

today – Returns current date – example: {{ today | date: “%m/%d/%Y” }}


media

file_name – Returns the file name of the media file

url – Returns the full URL of the media file

is_image? – Returns a true/false value of whether the file is an image

images – Returns collection of image sizes: thumbnail, small, medium, large, original. Example “media.images[‘medium’]” returns the URL for the medium size image

menus

title – Returns the title of the menu

permalink – Returns the permalink of the menu

top_level_links – Returns the collection of top-level links when building a dropdown, use “link” to access attributes

links – Returns the collection of all links, use “link” to access attributes


message – example call: {{ message.title }}

title – Returns the title of the message

permalink – Returns the permalink of the message

url – Returns the relative URL of the message

full_url – Returns the full URL with domain name of the message

body – Returns the body of the message

publish_at – Returns the publish_at date and time for message

author – Returns the the name of the author of the message

embedded_video – Returns the attached video or YouTube/Vimeo video including embed code

video – Returns the video object attached to the message

video_link – Returns the YouTube or Vimeo video link of the message

media – Returns the collection of uploaded attachments, use media object to access attributes

type – Returns “message”, used when determining if a feed item is an album or message

categories – Returns a collection of categories associated to the message


page – example call: {{ page.body }}

title – Returns the title of the page

permalink – Returns the permalink of the page

url – Returns the relative URL of the page

full_url – Returns the full URL of the page

body – Returns the body of the page

status – Returns the publishing status of the page (draft/published/hidden)


photo

thumbnail – Returns the full URL of the thumbnail size photo

small – Returns the full URL of the small size photo

medium – Returns the full URL of the medium size photo

large – Returns the full URL of the large size photo

original – Returns the full URL of the original photo

description – Returns the description of the photo


place – example call: {{ place.leader }}

title – Returns the title of the place

permalink – Returns the permalink of the place

url – Returns the relative URL of the place

full_url – Returns the full URL with domain name of the place

leader – Returns the name of the place’s leader

leader_email – Returns the email address of the place’s leader

leader_phone – Returns the phone number of the place’s leader

location – Returns the text location of the place, for example: “Raleigh, North Carolina, United States”

latitude – Returns the latitude coordinates for the place

longitude – Returns the longitude coordinates for the place

description – Returns the description of the place

sanitized_description – Returns the description of the place with all HTML attributes removed

web_address – Returns the external web address with more information about the place

subtitle – Returns the sub-title of the place

images – Returns collection of image sizes: thumbnail, small, medium, large, original. Example “place.images[‘medium’]” returns the URL for the medium size image

cover_images – Returns collection of cover image sizes: cover, original. Example “place.cover_images[‘original’]” returns the URL for the original size image

sponsorships – Returns collection of sponsorships associated with the place, use the sponsorship object to access attributes

albums – Returns collection of albums associated with the place, use the album and photo objects to access attributes

campaigns – Returns collection of campaigns associated with the place, use the campaign object to access attributes

approved_campaigns – Returns collection of campaigns associated with the place, use the campaign object to access attributes

projects – Returns collection of projects associated with the place, use the project object to access attributes.
custom_field_values – Returns collection of custom fields associated with the place, use the custom_field_values object to access attributes.


product – example call: {{ product.description }}

title – Returns the title of the product

permalink – Returns the permalink of the product

description – Returns the description of the product

price – Returns the price of the product

images – Returns collection of image sizes: thumbnail, small, medium, large, original. Example “product.images[‘medium’]” returns the URL for the medium size image

inventory – Returns the number of items in inventory for this product

taxable – Returns the whether the product is a taxable item. This is used when determining if the checkout process is for a donation or a payment

number_sold – Returns the total number sold of this product

shipping_cost – Returns the cost to ship one of this product

shippable – Returns true if the product has been marked as shippable


project – example call: {{ project.sanitized_description }}

title – Returns the title of the project

permalink – Returns the permalink of the project

url – Returns the relative URL of the project

full_url – Returns the full URL with domain name of the project

leader – Returns the name of the project’s leader

leader_email – Returns the email address of the project’s leader

leader_phone – Returns the phone number of the project’s leader

description – Returns the description of the project

sanitized_description – Returns the description of the project with all HTML attributes removed

web_address – Returns the external web address with more information about the project

subtitle – Returns the sub-title of the project

images – Returns collection of image sizes: thumbnail, small, medium, large, original. Example “project.images[‘medium’]” returns the URL for the medium size image

cover_images – Returns collection of cover image sizes: cover, original. Example “project.cover_images[‘original’]” returns the URL for the original size image

sponsorships – Returns collection of sponsorships associated with the project, use the sponsorship object to access attributes

albums – Returns collection of albums associated with the project, use the album and photo objects to access attributes

campaigns – Returns collection of campaigns associated with the project, use the campaign object to access attributes

places – Returns collection of places associated with the project, use the place object to access attributes

custom_field_values – Returns collection of custom fields associated with the project, use the custom_field_values object to access attributes


share_type

title – Returns the title of the share type

shares – Returns the share


sponsorship – example call: {{ sponsorship.place.title }}

title – Returns the title of the sponsorship

permalink – Returns the permalink of the sponsorship

url – Returns the relative URL of the sponsorship

full_url – Returns the full URL with domain name of the sponsorship

description – Returns the description of the sponsorship

sanitized_description – Returns the description of the sponsorship with all HTML attributes removed

sponsorship_type – Returns the sponsorship_type associated to the sponsorship, use the sponsorship_type object to access attributes

images – Returns collection of image sizes: thumbnail, small, medium, large, original. Example “media.images[‘medium’]” returns the URL for the medium size image

external_reference_id – Returns the external reference ID of the sponsorship

disable – Returns a true/false value for whether the sponsorship is disabled

position – Returns the position of the sponsorship

shares_sponsored – Returns the number of shares currently sponsored for the sponsorship

shares_available – Returns the number of shares available for sponsorship

total_shares – Returns the maximum number of shares designated by the sponsorship type

total – Returns the total amount raised for the sponsorship

goal_amount – Returns the goals amount trying to be raised for the sponsorship

sponsorship_categories – Returns collection of sponsorship categories associated with the sponsorship, use the sponsorship_category object to access attributes

album – Returns the album object associated with the sponsorship, use the album and photo objects to access attributes.

place – Returns place associated with the sponsorship, use the place object to access attributes

project – Returns project associated with the sponsorship, use the project object to access attributes

messages – Returns collection of messages associated with the sponsorship, use the message object to access attributes

shares_for_select – Returns a collection of sponsorship items to use in the sponsorship form ({% sponsorship_form sponsorship %}{% endsponsorship_form %})


sponsorship_category

title – Returns the title of category

value – Returns the value of the category for the sponsorship

url – Returns the relative URL to display all sponsorships under the sponsorship category

full_url – Returns the full URL with domain name of the sponsorship category


sponsorship_type

title – Returns the title of the sponsorship_type

permalink – Returns the permalink of the sponsorship_type

url – Returns the relative URL to display all sponsorships under the sponsorship type

full_url – Returns the full URL with domain name of the sponsorship type

description – Returns the description of the sponsorship type

shares – Returns the number of shares each sponsorship has for the sponsorship type

share_types – Returns collection of share_types under the sponsorship type, use the share_type object to access attributes

cost_per_share – Returns the cost of each share for the sponsorship type

recurring_period – Returns the default recurring period for sponsorships

allow_one_time_donations – Returns a true/false value for whether sponsorships are allowed to accept one-time donations

include_yearly_option – Returns a true/false value for whether sponsorships are allows to accept yearly sponsorships

include_quarterly_option – Returns a true/false value for whether sponsorships are allows to accept quarterly sponsorships

include_bi_annual_option – Returns a true/false value for whether sponsorships are allows to accept bi-annual sponsorships


supporter – example call: {{ supporter.address2 }}

name – Returns the name of the supporter

first_name – Returns the first name of the supporter

email – Returns the email address of the supporter

last_name – Returns the last name of the supporter

middle_name – Returns the middle name of the supporter

preferred_name – Returns the preferred name of the supporter

prefix – Returns the prefix of the supporter’s name

suffix – Returns the suffix of the supporter’s name

permalink – Returns the permalink of the supporter

url – Returns the relative URL of the supporter’s profile page

email_message – Used in the Default Supporter Email template

address1 – Returns the first field of the supporter’s street address

address2 – Returns the second field of the supporter’s street

address.city – Returns the city of the supporter

state – Returns the state of the supporter

country – Returns the country of the supporter

phone – Returns the phone of the supporter


video

thumbnail_url – Returns the full URL of the video file

url – Returns the full URL of the video file

Tags: , ,

Was this article helpful?