Skip to main content

Below, learn about the default modules that HubSpot provides for building templates for website pages, blog posts, and blog listing pages. You'll also find default modules that can be used to build quote templates.

When developing locally, you can fetch a specific default module using the module path (e.g. hs fetch @hubspot/linked_image.module).

To view a default module's code, you can view and clone the module within the @hubspot folder of the design manager. In the code, some default modules use the default account ID 7052064, rather than the one belonging to the current account.

design-manager-default-modules

Supported in blog posts and blog listings.

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
select_blogBlogThe blog to use for the module.
titleStringTitle for the module (wrapped in a h3 tag)"Subscribe Here!"
response_messageRich TextThe message that is shown upon submitting the form.Thanks for subscribing!

Add this module to blog listing pages to display blog post previews containing each post's title, featured image, author, publish date, and more with a clickable button that navigates to the post.

This default module has built using React, and you can view its source code on GitHub.

ParameterTypeDescriptionDefault
layoutRequiredChoiceThe content layout for each blog post preview.
  • grid (default): aligns posts in a basic grid.
  • singleColumn: aligns posts in a single column. with featured images on their own row above the rest of the post content.
  • sideBySide: aligns posts in a column with featured images aligned horizontally with the post content.
grid
columnsNumberWhen using the grid layout, the number of posts per row. Can be 2, 3, or 4.3
alternateImageBooleanWhen using the sideBySide layout, set to true to align the featured image on the right and left side of the post preview, alternating.false
fullImageBooleanWhen using the grid or singleColumn layouts, set this field to true to make the featured image the background of the post preview.false
displayForEachListItemArrayThe content to include in each blog post preview. Choices include:
  • image: the post's featured image.
  • title: the post's title.
  • authorImage: the post author's image.
  • authorName: the post author's name.
  • tags: the post's blog tags.
  • publishDate: the post's publish date.
  • description: the post's meta description.
  • button: the read more button that links to the blog post.
[ 'image', 'title', 'authorImage', 'authorName', 'tags', 'publishDate', 'description', 'button' ]
buttonTextStringThe text that displays on the read more button, if included.Read more

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
select_blogBlogSelect a blog to display. Default will use the current blog when used in a blog template or the primary blog when used elsewhere.
filter_typeChoiceType of filtering links to show. Choices include:
  • tag
  • month
  • author
tag
order_byChoiceOrdering for the values of filter links. Choices include:
  • post_count
  • name
post_count
list_titleTextAn H3 heading."Posts by Tag"
max_linksNumberNumber of filter links to show. Leave blank to show all.5
expand_link_textTextText to display if more than the max_links value to display are available."See all"

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
select_blogBlogSelect a blog to display. Default will use the current blog when used in a blog template or the primary blog when used elsewhere.
listing_typeChoiceThe type of listing for your posts. Choices include:
  • recent: most recent.
  • popular_all_time: most popular of all time.
  • popular_past_year: most popular the past year.
  • popular_past_six_months: most popular the past six months.
  • popular_past_month: most popular the past month.
recent
list_titleTextAn H3 heading."Recent Posts"
max_linksNumberMaximum number of posts to display.5

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
linkLinkThe URL that the button redirects to.{ "url": { "type": "EXTERNAL", "href": "www.hubspot.com", "content_id": null }, "open_in_new_tab": false, "no_follow": false }
button_textTextText that will be displayed on the button."Add a button link here"
styleObject
  • override_default_style (Boolean)
  • button_font (Font)
  • button_color (Color)
  • text_hover_color (Color)
  • button_hover_color (Color)
{ "override_default_style": false, "button_font": { "color": "#FFFFFF", "size_unit": "px" }, "button_color": { "color": "#000000", "opacity": 100 }, "text_hover_color": { "color": "#000000", "opacity": 100 }, "button_hover_color": { "color": "#CCCCCC", "opacity": 100 } }

Supported in pages, blog listings, and blog posts.

ParameterTypeDescription
guidStringGlobally Unique Identifier of the CTA.

You can add this module to your subscription preferences page to allow contacts to request that their data be deleted. This function is required under certain data privacy laws. Once a contact requests that their data be deleted, they have 30 minutes to confirm in an email that will automatically be sent.

Users with super admin permissions will receive a notification email about these requests. Learn how to allow contacts to request a download of their data.

ParameterTypeDescriptionDefault
contentRich TextMessage displayed above the button. ### Delete Data Permanently delete your personal data stored by {{ site_settings.company_name}}. Personal data is information that can be used to identify you and doesn't include anonymized data. You'll get a follow-up email where you'll need to verify your request.
button_textTextButton text.Request data deletion
group_alertsField groupThe success and fail alert field group. Including the following field groups:
  • group_success_alert:
    • content: rich text content of success alert.
  • group_fail_alert:
    • content: rich text content of fail alert.
  • group_close_icon:
    • icon: the icon to close the alert.

Supported in pages. There's a new version of this module available in accounts created after August 25th, 2022. Learn more about this change.

ParameterTypeDescriptionDefault
heightNumberPixel (px) height of the divider line.1
widthNumberPercentage (%) width of the divider line.50
colorColorColor (hex) and opacity (number) of the divider line.{ "color": "#000000", "opacity": 100 }
line_typeChoiceLine type. Choices include:
  • solid
  • dotted
  • dashed
solid
alignmentChoiceHorizontal alignment of divider line. Choices include:
  • left
  • center
  • right
center
show_paddingBooleanShow/hide top and bottom margining on the divider.false
paddingNumberPixel (px) value for the margining on top and bottom of divider line. Option available when show_padding equals true.5

You can add this module to your subscription preferences page to allow contacts to request a copy of their data. This function is required under certain data privacy laws. Users with super admin permissions will receive a notification email about these requests. Learn how to allow contacts to request that their data be deleted.

ParameterTypeDescriptionDefault
contentRich TextMessage displayed above the button. ### Download Data Download your personal data stored by {{ site_settings.company_name}}. Personal data is information that can be used to identify you and doesn't include anonymized data.
button_textTextButton text.Request data download
group_alertsField groupThe success and fail alert field group. Including the following field groups:
  • group_success_alert:
    • content: rich text content of success alert.
  • group_fail_alert:
    • content: rich text content of fail alert.
  • group_close_icon:
    • icon: the icon to close the alert.

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
titleTextH3 heading
formObjectForm object including:
  • form_id: ID for form to use
  • response_type: what the visitor will see after submitting the form:
    • inline
    • redirect
  • message: inline message if response_type is set to inline
  • redirect_id: ID of page to be redirected to if response_type is set to redirect.
  • redirect_url: URL to be redirected to if response_type is set to redirect
{ "form_id": "", "response_type": "redirect", "message": "Thanks for submitting the form.", "redirect_id": null, "redirect_url": "http://www.google.com" }
notifications_are_overriddenBooleanEmail to send form notification to instead of form defaults.false
notifications_override_email_addressesEmailComma-separated list of emails to send to when notifications_are_overridden equals true.
follow_up_type_simpleBooleanEnabled sending a follow up email.false
simple_email_for_live_idFollowupemailID of the follow-up email. Available when follow_up_type_simple equals true.
sfdc_campaignSalesforcecampaignWhen Salesforce integration is active, the campaign ID.

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
valueTextText for the heading."A clear and bold header"
header_tagChoiceChoose a heading level. Choice include h1 through h6.h1

Supported in pages, blog listings, blog posts, and emails.

Supported in pages, blog listings, and blog posts. Icons can be pulled from the Font Awesome 5.0.10 and 5.14.0 icon sets.

ParameterTypeDescriptionDefault
nameStringThe name of the icon."hubspot"
purposeChoiceAn accessibility option that categorizes the purpose of the icon for screen readers. Available values are:
  • decorative: ignored by the screen reader.
  • semantic: read by the screen reader.
"decorative"
titleStringAn accessibility option that assigns the icon a title.
styleStringThe type of icon. Can be one of solid, regular, light, thin, or duotone."solid"
unicodeStringThe icon's unicode value.f3b2

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
imgImageImage object containing:
  • src: image url
  • alt: alt text for image
  • loading: lazy loading options include:
    • disabled
    • lazy
  • width: px value
  • height: px value
{ "src": "https://static.hubspot.com/final/img/content/email-template-images/placeholder_200x200.png", "alt": "placeholder_200x200", "loading": "disabled", "width": 200, "height": 200 }
linkTextOptional link for the image.
targetBooleanOpens link in a new tab.false

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
slidesObjectObject containing information for each slide. Object contains:
  • img: image URL.
  • link_url: URL where the slide should link.
  • hover_messages: text that overlays on the image on hover.
[ { "show_caption": false, "open_in_new_tab": false } ]
display_modeChoiceDisplay mode of the Image Gallery. Choices include:
  • standard: standard slider.
  • thumbnail: thumbnail navigator.
  • lightbox: lightbox gallery.
standard
lightboxRowsNumberNumber of rows in the Lightbox gallery when display_mode equals lightbox.3
loop_slidesBooleanEnables looping through the slides with next/prev when display_mode equals standard or thumbnail.true
auto_advanceBooleanAutomatically advances to the next slide when display_mode equals standard or thumbnail.true
num_secondsNumberAmount of time (seconds) between advancing to the next slide when display_mode equals standard or thumbnail.5
show_paginationBooleanShow navigation buttons when display_mode equals standard or thumbnail.true
sizingChoiceSets the height of the slides when display_mode equals standard or thumbnail. Choices include:
  • static: fixed height.
  • resize: variable height.
static
transitionChoiceSlide transition styles when display_mode equals standard or thumbnail. Choices include:
  • slide: slide transition.
  • fade: fade transition.
slide
caption_positionChoicePosition of the slide captions when display_mode equals standard or thumbnail. Choices include:
  • below: always keep captions below the image.
  • superimpose: superimpose captions on top of images.
below

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
slidesObjectObject containing information for each slide. Object contains:
  • img: image URL.
  • show_caption: boolean to show slide caption.
  • caption: rich text for caption.
  • link_url: URL where the slide should link.
  • open_in_new_tab: boolean to direct if the link should open in a new tab.
[ { "show_caption": false, "open_in_new_tab": false } ]
display_modeChoiceDisplay mode of the Image Gallery. Choices include:
  • standard: standard slider.
  • thumbnail: thumbnail navigator.
  • lightbox: lightbox gallery.
standard
lightboxRowsNumberNumber of rows in the Lightbox gallery when display_mode equals lightbox.3
loop_slidesBooleanEnables looping through the slides with next/prev when display_mode equals standard or thumbnail.true
auto_advanceBooleanAutomatically advances to the next slide when display_mode equals standard or thumbnail.true
num_secondsNumberAmount of time (seconds) between advancing to the next slide when display_mode equals standard or thumbnail.5
show_paginationBooleanShow navigation buttons when display_mode equals standard or thumbnail.true
sizingChoiceSets the height of the slides when display_mode equals standard or thumbnail. Choices include:
  • static: fixed height.
  • resize: variable height.
static
transitionChoiceSlide transition styles when display_mode equals standard or thumbnail. Choices include:
  • slide: slide transition.
  • fade: fade transition.
slide
caption_positionChoicePosition of the slide captions when display_mode equals standard or thumbnail. Choices include:
  • below: always keep captions below the image.
  • superimpose: superimpose captions on top of images.
below

Supported in pages, blog posts, and blog listings.

ParameterTypeDescription
slidesField groupA field group containing the following fields:
  • img: image URL.
  • caption: rich text for image caption.
  • link_url: URL that the slide links to.
slideshow_settingsField groupThe image slider settings field group. Includes the following field groups:
  • slides: slide settings, including:
    • per_page: number of slides per page.
    • sizing: image sizing.
    • aspect_ratio: image aspect ratio.
    • show_captions: a boolean
  • movement: image sliding behavior settings.
  • navigation: image navigation settings.
default_textField groupThe module's default text elements, including:
  • default_caption: image caption.
  • default_image_alt_text: image text.
  • slider_aria_label: the module's default aria label.
  • arial_label_thumbnails: the module's default aria thumbnail.
  • slider_nav_aria_label: the module navigation's default aria label.
  • prev: previous slide text.
  • next: next slide text.
  • first: go to first slide text.
  • slideX: go to X slide text.
  • pageX: go to X page text.
  • play: start autoplay text.
  • pause: pause autoplay text.
  • carousel: carousel text.
  • select: text for selecting a slide to show.
  • slide: slide text.
  • slidelabel: slide label.

Supported in pages.

ParameterTypeDescriptionDefault
display_modeChoiceThe language of the text in the language switcher. Options include:
  • pagelang: the names of languages will display in the language of the page the switcher is on.
  • localized: the name of each language will display in that language.
  • hybrid: a combination of the two.
localized

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
imgImageImage object containing:
  • override_inherited_src: override the default logo from settings
  • src: image url
  • alt: alt-text for logo
{ "override_inherited_src": false, "src": null, "alt": null }
linkTextOptional link for the logo. If no URL is specified, your logo will link to the Logo URL set in your brand settings.
open_in_new_tabBooleanOpens link in a new tab.false
suppress_company_nameBooleanHide the company name when an image is not selected.true
heading_levelChoiceChoose a heading level when no image is selected and suppress_company_name equals false. Choices include h1 through h6.h1

A customizable grid of containers to display logos uniformly. Supported in pages, blog listings, and blog posts.

ParameterTypeDescription
group_logosArrayAn array containing an object for each logo in the grid.
logoObjectIn group_logos, an object for each logo in the grid. Each logo can include the following parameters:
  • src: the file path of the logo.
  • loading: the lazy load behavior of the logo.
  • alt: the logo's alt-text.
  • height: the logo's height.
  • width: the logo's width.
  • max_height: the logo's maximum height.
  • max_width: the logo's maximum width.
stylesArrayAn array containing the style fields that affect the grid layout, logo containers, and logo images. This array contains the following style groups:
  • group_logo: styles that affect the logo containers and logo images. Contains the following:
    • group_background: styles that set the aspect ratio and background color of the grid containers. Aspect ratios include: 1/1, 4/3, 16/9.
    • group_spacing: styles that set the inner padding of the logo container. For wider logos, higher padding value may decrease logo width.
    • max_logo_height: the maximum height of each logo.
  • group_logo_grid: styles that set the grid layout, including:
    • column_count: the number of columns in the grid.
    • grid_gap: the spacing between grid items.

Supported in pages, blog posts, and blog listings.

ParameterTypeDescription
meetingMeetingSelect a meeting link.

This module provides Google and Facebook login capability to memberships sites. The user must sign-in with an account linked to the email for the contact in the CRM. You can choose which social logins to enable.

Supported in membership login pages.

ParameterTypeDescriptionDefault
facebook_appidStringYour facebook app ID.
facebook_enabledbooleanEnable the button for Facebook login. facebook_appid is required**.**False
google_clientidStringYour Google client ID.
google_enabledBooleanEnable the button for Google login. google_clientid is required**.**False

Supported in pages, blog posts, and blog listings.

Looking to build your own custom menu? Try our menu() function.

ParameterTypeDescriptionDefault
idMenuID of the menu.
root_typeChoiceAdvanced menu type. Choices include:
  • site_root: always show top-level pages in menu.
  • top_parent: show pages in menu that are related to section being viewed.
  • parent: show pages in menu that are related to page being viewed.
  • breadcrumb: breadcrumb style path menu (uses horizontal flow).
site_root
max_levelsChoiceDetermines the number of menu tree children that can be expanded in the menu. Choices include 1 through 102
flowChoiceOrientation of the menu. Choices include:
  • horizontal
  • vertical
horizontal
flyoutsBooleanEnabled hover over functionality for child menu items.true

Supported in pages, blog listings, and blog posts.

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
submit_button_textTextText that appears on the submit button."Submit"
password_placeholderTextPlaceholder text for the password field."Password"
bad_password_messageRich TextMessage to show when a password is entered incorrectly."Sorry, please try again. "

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
paymentStringTo set the module to use a specific payment link, include the ID of the payment link. You can find the ID in the URL while editing the payment link.
checkout_locationStringSet whether the payment form opens in a new tab or in an overlay. Available values are:
  • new_tab: opens the payment form in a new tab.
  • overlay: opens the payment form in a sliding overlay.
"new_tab"
button_textStringSets the text of the checkout button."Checkout"
button_targetChoiceWhether the button uses a HubSpot payment link or an external link. Choices include:
  • payment_link
  • custom_link
"payment_link"
button_linkLinkWhen button_target is set to custom_link, sets the destination of the external link. Supported link types include:
  • EXTERNAL
  • CONTENT
EXTERNAL

Displays a product from the account's product library. Supported in pages, blog posts, and blog listings.

ParameterTypeDescription
productProductThe product to display, specified by product ID.
group_buttonField groupBy default, the module includes a button that directs users to the product's set URL. To customize the button destination, include this optional field group along with the following fields:
  • button_text: a string that sets the button's text.
  • override_product_button: set to true to override the default button link settings. Then, include a button_override object. Learn more about button_override below.
button_overrideObjectIn the group_button field group, this sets the button's URL behavior when override_product_button is set to true.Includes the following fields:
  • no_follow: boolean field for the link's no_follow behavior.
  • open_link_in_new_tab: boolean field for the link's open behavior.
  • url: an object that specifies the button's destination.
In the url field, you can set the type of destination through the type field, which supports the following content types:
  • EXTERNAL: a standard URL. Include the URL in an href field.
  • CONTENT: a HubSpot page. Include the page ID in a content_id field.
  • PAYMENT: a payment link. Include the payment link in an href field.
  • EMAIL_ADDRESS: an email address. Include the address in an href field.
group_nameField groupBy default, the module will display the product name at the top of the module as an h3. To customize the name, include this optional field group along with the following fields:
  • heading_level: the heading size. Can be h1 - h6.
  • override_product_name: set to true to specify text rather than the product name.
  • name_override: the string that you want to display at the top of the module.
group_descriptionField groupBy default, the module will display the product's set description. To customize the description, include this optional field group along with the following fields:
  • override_product_description: set to true to customize the product description.
  • description_override: a string containing your new description.
group_imageField groupBy default, the module will display the product's set image. To customize this image, include this optional field group with the following fields:
  • override_product_image: set to true to specify a new image.
  • image_override: an object that specifies the new image, including the following properties:
    • alt
    • height
    • loading
    • src
    • width

Supported in quote templates.

ParameterTypeDescriptionDefault
button_textStringThe text displayed on the download button.Download
download_errorStringError message displayed if the download fails.There was a problem downloading the quote. Please try again.

Supported in quote templates.

ParameterTypeDescriptionDefault
heading_textStringThe heading displayed above the payment section of a quote template.Payment
heading_tagChoiceThe type of heading used to display heading_text. Values include h1, h2, h3, h4, h5, h6.h3
checkoutStringThe payment button text.Pay now
needs_signatureStringButton text when a signature is required.Payment can't be made because the quote isn't fully signed.
checkout_errorRich textMessage that displays when there's an error during checkout.There was a problem setting up checkout. Please contact the person who sent you this quote.
payment_status_errorRich textMessage that displays when there's an error when trying to make a payment.There was a problem loading the payment status for this quote. Please try refreshing the page.
paidStringA successful payment status indicator.Paid
payment_processingStringA payment processing status indicator.Payment processing

Supported in quote templates.

When a quote requires an e-signature, the following fields are available within an esignature object:

ParameterTypeDescriptionDefault
pretextRich textE-signature explanation text.Before you sign this quote, an email must be sent to you to verify your identity. Find your profile below to request a verification email.
verify_buttonStringText that displays on the verification button.Verify to sign
failureStringAlert text that displays when the signature information can't be retrieved.There was a problem retrieving the signature information. Please reload the page.
verification_sentStringA status indicator that appears when the verification request has been successfully sent to the quote signer.Verification sent
signedStringText that displays when the quote has been successfully signed.Signed

When a quote requires a printed signature, the following fields are available within a print_signature object:

ParameterTypeDescriptionDefault
headerRich textText displayed at the top of the signature section.Signature
signatureStringText that displays next to the signature field.Signature
dateStringText that displays next to the date field.Date
printed_nameStringText that displays next to the printed name field.Printed name
countersignatureObjectAn object containing content for the countersignature section. This object can contain the following fields:
  • header: text that displays at the top of the countersignature section.
  • countersignature: Text that displays next to the countersignature field.
  • date: text that displays next to the date field.
  • printed_name: text that displays next to the printed name field.
Signed

Supported in quote templates. This module also includes the default text used on custom quotes.

ParameterTypeDescriptionDefault
titleTextThe title of the line item column.Column description
use_additional_product_propertyBooleanDisplay checkbox to allow users to select additional line item columns from product properties.False
additional_product_propertiesChoiceA product property. Choices include:
  • price: price of line item.
  • item_description: description of line item.
  • quantity: number of line items.
  • amount: total cost of line items.
  • hs_recurring_billing_start_date: billing start date for recurring line items.
  • discount: discount amount applies to the line item.
crm_product_propertyCRM object propertySelect any product property to appear as a line item column header.

Supported in all template types.

ParameterTypeDescriptionDefault
htmlRich TextHTML block. ## Something Powerful \n ### Tell The Reader More \n The headline and subheader tells us what you're [offering](\"#\"), and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for. \n Remember: \n<ul>\n<li>Bullets are great</li>\n<li>For spelling out [benefits](\"#\") and</li>\n<li>Turning visitors into leads.</li>\n</ul>

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
titleTextAn H3 heading."Test"
rss_feed_typeChoiceType of RSS feed. Choices include:
  • blog - HubSpot hosted blog.
  • external - An external RSS feed.
blog
rss_urlTextRSS URL to use when rss_feed_type equals external.
content_group_idBlogId of the blog to use when rss_feed_type equals blog.
topic_idTag(optional) Id of the tag to filter by when rss_feed_type equals blog.
number_of_itemsNumberMaximum number of posts to display.5
include_featured_imageBooleanInclude the featured image.false
show_authorBooleanShow the author name.true
attribution_textTextText that attributes an author to a post. Displayed when show_author equals true."by"
show_detailBooleanShow post summary text.true
limit_to_charsNumberLimits the length of the summary text when show_detail equals true.200
click_through_textTextThe text which will be displayed for the clickthrough link at the end of a post summary when show_detail equals true."Read more"
show_dateBooleanShow publish date.true
publish_date_formatChoiceFormat for the publish date when show_date equals true. Choices include:
  • short (ex: 06/11/06 12:00PM)
  • medium (ex: Jun 6, 2006 12:00:00 pm)
  • long (ex: June 6, 2017 12:00:00 pm EDT)
  • MMMM d, yyyy 'at' h:mm a (ex: June 6, 2006 at 12:00 pm)
  • h:mm a 'on' MMMM d, yyyy (ex: 12:00 pm on June 6, 2006)
short
publish_date_textTextThe text that indicates when a post was published when show_date equals true."posted at"

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
field_labelTextSearch input label text
placeholderTextPlaceholder text for the input field."Search"
include_search_buttonBooleanInclude a search button.false
content_typesObjectWhich content types to include in search results. Object contains the following keys with boolean values:
  • website_pages
  • landing_pages
  • blog_posts
  • knowledge_articles
{ "website_pages": true, "landing_pages": false, "blog_posts": true, "knowledge_articles": false }
resultsObjectAn object that enables controls for using a custom search results page. Includes the following properties:
  • use_custom_search_results_template (boolean): when set to true, users can select a custom search results page. Default is false.
  • path_id (string): the ID of the page that will be used for search results. The referenced page must contain the search results module.

Supported in pages, blog posts, and blog listings.

ParameterTypeDescriptionDefault
display_featured_imagesBooleanDisplay featured images for items.false

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
headerTextSection header content."A clear and bold header"
heading_levelChoiceHeading level for the header. Choices include h1 through h6.h1
subheaderTextSubheading paragraph text for the section."A more subdued subheader"

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
menu_treeSimple MenuSimple menu object.[]
orientationChoiceOrientation of the menu. Choices include:
  • horizontal
  • vertical
horizontal

Add links to your social media profiles, with drag and drop reordering in the content editor. Automatically inserts icons based on the social URL, but icons can be overridden.

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
linkTextThe destination link for the social page added in the editor.
open_in_new_windowBooleanWhen set to false, link will open in the same browser tab.true
is_podcastBooleanSet to true to display a podcast icon instead of a default or custom icon.false
customize_alt_textBooleanBy default, alt-text is automatically generated. When set to true, you can override the default alt-text with a custom value using the aria_label field.false
aria-labelStringWhen customize_alt_text is true, this field sets the icon alt-text (e.g., Follow us on Facebook). This is used by screen readers to describe the icon to users who are visually impaired.False
customize_iconBooleanBy default, icons are auto-populated based on the link URL. When set to true, you can use the custom_icon field to select one of the other provided icons (Font Awesome 6.4.2).false
custom_iconIconWhen customize_icon is true and is_podcast is false, use this field to specify a custom icon from the provided set. Available icons are from Font Awesome 6.4.2.

Supported in pages, blog listings, and blog posts.

Note: The variable social_link_url in the default column below is the same value as the link parameter.

ParameterTypeDescriptionDefault
linkTextThis is the destination link that will be shortened for easier sharing on social networks.
facebookObjectObject containing:
  • enabled: boolean to enable social item
  • custom_link_format: custom URL for socials sharer URL
{ "enabled": false, "custom_link_format": "http://www.facebook.com/share.php?u={{ social_link_url }}" }
twitterObjectObject containing:
  • enabled: boolean to enable social item
  • custom_link_format: custom URL for socials sharer URL
{ "enabled": false, "custom_link_format": "https://twitter.com/intent/tweet?original_referer=\{\{ social_link_url }}&url={{ social_link_url }}&source=tweetbutton&text={{ social_page_title|urlencode }}" }
linkedinObjectObject containing:
  • enabled: boolean to enable social item
  • custom_link_format: custom URL for socials sharer URL
{ "enabled": false, "custom_link_format": "http://www.linkedin.com/shareArticle?mini=true&url={{ social_link_url }}" }
pinterestObjectObject containing:
  • enabled: boolean to enable social item.
  • custom_link_format: custom URL for socials sharer URL.
  • pinterest_media: image object including:
    • src: image URL.
    • alt: alt-text for the image.
{ "enabled": false, "custom_link_format": "http://pinterest.com/pin/create/button/?url={{ social_link_url }}&media={{ pinterest_media }}", "pinterest_media": { "src": "", "alt": null } }
emailObjectObject containing:
  • enabled: boolean to enable social item
  • custom_link_format: custom URL for socials sharer URL
{ "enabled": false, "custom_link_format": "mailto:?subject=Check out {{ social_link_url }} &body=Check out {{ social_link_url }}" }

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
tabsField groupA field group that contains the tab label and text content of each tab. Contains the following fields:
  • tab_label: the label of the tab.
  • content: the tab's rich text content.
"Some additional information in one line"
fixed_heightBooleanBy default, the tabs will be set at a fixed height so that the container height stays the same when switching between tabs. You can set this to false if you want the tabbed card container height to be based on the active tab's content.False

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
valueTextAdd your text to this parameter."Some additional information in one line"

Supported in pages, blog listings, and blog posts.

ParameterTypeDescriptionDefault
video_typeChoiceType of video. Choices include:
  • embed: embed code from an external source.
  • hubspot_video: HubSpot hosted video.
embed
hubspot_videoVideo PlayerHubSpot hosted video. Used when video_type equals hubspot_video.
embed_fieldEmbedSupports embed types:
  • oembed
    • video: URL for video.
  • html: embed code for video.
oembed_thumbnailImageOverride oembed thumbnail image when video_type equals embed and embed_field equals oembed.
style_optionsObjectObject containing oembed_thumbnail_play_button_color - Color field.{"oembed_thumbnail_play_button_color":"#ffffff"}
placeholder_fieldsObjectObject containing:
  • placeholder_title: text field.
  • placeholder_description: text field.
{"placeholder_title":"No video selected", "placeholder_description":"Select a video type in the sidebar."}

Supported in pages.

ParameterTypeDescriptionDefault
urlTextURL for video. URLs from Vimeo and YouTube are supported."https://www.youtube.com/watch?v=X1Rr5BFO5rg"
is_full_widthBooleanSets the video to full width (true) or manually set width and height (false).true
max_widthNumberMax width (px)800
max_heightNumberMax height (px)450

Supported in pages, blog posts, and blog listing pages. Requires a connected WhatsApp channel.

ParameterTypeDescriptionDefault
whatsapp_numberURLSelect from the WhatsApp channels connected to the account.
optin_textChoiceThe opt-in and opt-out text.
whatsapp_displayChoiceSelect whether the button displays text, a WhatsApp icon, or both. Choices include:
  • text_and_icon
  • text
  • icon
text_and_icon
icon_positionChoiceThe position of the icon on the button. Choices include left and right.left
button_textStringThe button's text.Chat on WhatsApp
whatsapp_icon_titleStringThe icon text for screen readers.WhatsApp Icon