module (Banner Group)

This module component fetches data relating to Banner Groups.

{% component type: "module", source: "Banner Group", layout: "List" %}

Parameters and Options

Parameter Values Required Description
type module This is the name of the entity that needs to be used for the component retrieving function.
source Banner Group (default) The entity/alias name or ID that the data is to be sourced from.
layout List (default)
<Your Layout name>
The layout name you want to use for rendering the component. The layout name is referenced from the available Layouts of the source specified. If the parameter is blank or has an incorrect referenced Layout then the component will not render any code.
filterBy id
parentid
name
weighting
url
urlslug
releasedate
expirydate
lastupdateddate
author
itemcategories
itemtags
<custompropertyname>
enableamp
ampcontent
canonicallink
codeeditor
createdbymemberid
description
disableforsitesearch
enabled
externalid
metadescription
opengraphproperties
seopriority
seotitle
showpageforsearchengine
socialmetatags

The name of the property to filter by. If empty or not present, no filtering will be used.

Remove spaces from custom property names here.

Values in italics may not be available in the Component Manager but can still be filtered by when added manually.

While these values may be present as properties in the Liquid collection, not all properties are configurable in all site plans.

filterValue <your value>
Your specific value to filter by, eg: name, id, number, date, etc.
Liquid variables can be used here also. If present but no value set, no items will be returned.
sortBy id
parentid
name
weighting
url
urlslug
releasedate
expirydate
lastupdateddate
author
itemcategories
itemtags
<custompropertyname>
enableamp
ampcontent
canonicallink
codeeditor
createdbymemberid
description
disableforsitesearch
enabled
externalid
metadescription
opengraphproperties
seopriority
seotitle
showpageforsearchengine
socialmetatags

The name of the property to sort by. If empty or not present, alpha/numeric sorting will be used.

Remove spaces from custom property names here.

Values in italics may not be available in the Component Manager but can still be sorted by when added manually.

While these values may be present as properties in the Liquid collection, not all properties are configurable in all site plans.

sortOrder ASC (default)
DESC

ASC sorts the items in ascending order while DESC sorts in descending order (based on alpha/numeric or date sorting).
If empty or not present, alpha/numeric sorting will be used.
random false (default)
true

Displays the available items in a random order.

If used in conjunction with sortBy, that sorting criteria will be applied to the randomly retrieved results. So, if retrieving all, or most, of the items they will not appear to be random since they will then be sorted back into a logical order. To overcome this, set the sortBy parameter to 'enabled' (or another unused property) as this will not provide any viable sorting criteria* and the items will not be sorted from their initial random order.
* Unless there are weighted items, which will always override the random option.

limit 10 (default)
<number>

The maximum number of items returned. If displayPagination is enabled this determines the maximum number of items per page.
displayPagination false (default)
true

Displays pagination if there are more items available than the limit set.
emptyMessage <Your custom message>
Custom content that is rendered if no items are returned by the Component. The default is no content.
Liquid variables are supported here, although Liquid logic tags and HTML are not.

If using Liquid variables with filters added, be sure to change any double quotes to single quotes. For eg:
emptyMessage: “{{ myVariable | prepend: 'Error: ' }}”

To use HTML in your empty message, first capture it using a Liquid capture, then insert the capture variable into the emptyMessage parameter.

object item (default)
collection

Determines the method for Liquid rendering.
item returns each item iteratively, one after another, for output (generally, output to a container element with no need for looping through the data).
collection returns all items as one collection for output (your container element and looping logic would be handled in the Components Layout).
collectionVariable <yourLiquidVariableName>
Assigns the data to a Liquid collection enabling further access to the data on the Page or Template using Liquid.
<customParameter> <your custom value>
You can add your own additional parameters (name/value pairs) to the Component tag. These will be passed to the Components Layout (and the collectionVariable if used) for use via Liquid.

You can use HTML as the value here, just be sure to change any double quotes in your HTML to single quotes.

Liquid Output

The below example has 2 sample items (Banner Groups), but is otherwise the default structure you will get from this Component.

{
  "items": [
    {
      "id": 2293,
      "url": "/_banner_group/demo-custom-banner",
      "parentid": 1563,
      "lastupdateddate": "2018-12-15T22:28:42",
      "AMPContent": "",
      "Author_name": null,
      "Author_url": null,
      "Author": 0,
      "CanonicalLink": "",
      "CodeEditor": false,
      "CreatedByMemberId": 0,
      "Description": "<p>Custom Banner Description...</p>",
      "DisableForSiteSearch": false,
      "EnableAMP": false,
      "Enabled": true,
      "ExpiryDate": "2099-12-10T18:00:00",
      "ExternalId": 0,
      "ItemCategories": null,
      "ItemTags": null,
      "MetaDescription": "",
      "Name": "DEMO Custom Banner",
      "OpenGraphProperties": "",
      "ReleaseDate": "2018-12-14T18:00:00",
      "SeoPriority": "",
      "SEOTitle": "",
      "MetaTitle": "",
      "ShowPageForSearchEngine": false,
      "SocialMetaTags": "",
      "UrlSlug": "demo-custom-banner",
      "Weighting": 0
    },
    {
      "id": 2277,
      "url": "/_banner_group/demo-standard-banner",
      "parentid": 1563,
      "lastupdateddate": "2018-12-15T22:30:11",
      "AMPContent": "",
      "Author_name": null,
      "Author_url": null,
      "Author": 0,
      "CanonicalLink": "",
      "CodeEditor": false,
      "CreatedByMemberId": 0,
      "Description": "<p>Description text...</p>",
      "DisableForSiteSearch": false,
      "EnableAMP": false,
      "Enabled": true,
      "ExpiryDate": "2099-12-10T18:00:00",
      "ExternalId": 0,
      "ItemCategories": null,
      "ItemTags": null,
      "MetaDescription": "",
      "Name": "DEMO Standard Banner",
      "OpenGraphProperties": "",
      "ReleaseDate": "2018-11-25T18:00:00",
      "SeoPriority": "",
      "SEOTitle": "",
      "MetaTitle": "",
      "ShowPageForSearchEngine": false,
      "SocialMetaTags": "",
      "UrlSlug": "demo-standard-banner",
      "Weighting": 0
    }
  ],
  "pagination": {
    "currentpage": 1,
    "itemsperpage": 10,
    "numberofpages": 1,
    "totalitemscount": 2
  },
  "params": {},
  "parent": {
    "id": 2146,
    "url": "/documentation_group/component-types/module-banner-group",
    "parentid": 2127,
    "lastupdateddate": "2019-06-06T20:41:36",
    "Active": true,
    "AdditionalRelatedArticle_name": null,
    "AdditionalRelatedArticle_url": null,
    "AdditionalRelatedArticle": null,
    "AMPContent": "",
    "Author_name": null,
    "Author_url": null,
    "Author": null,
    "Authors": "2418",
    "CanonicalLink": "",
    "CodeEditor": false,
    "CreatedByMemberId": 0,
    "Description": "<p>This module component fetches data relating to Banner Groups.</p>\n{% capture data %}\n{% raw %}\n{% component type: \"module\", source: \"Banner Group\", layout: \"List\" %}\n{% endraw %}\n{% endcapture %}\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n\n{% component type: \"snippet\", alias: \"section_parameters\" %}\n\n{% component type: \"snippet\", alias: \"param_table_head\" %}\n    {% component type: \"snippet\", alias: \"param_type\", required: \"true\" %}\n    {% component type: \"snippet\", alias: \"param_source\", required: \"true\", values: \"Banner Group <em>(default)</em>\" %}\n    {% component type: \"snippet\", alias: \"param_layout\", required: \"true\", values: \"List <em>(default)</em><br>&lt;Your Layout name&gt;\" %}\n    {% component type: \"snippet\", alias: \"param_filterby\" %}\n    {% component type: \"snippet\", alias: \"param_filtervalue\" %}\n    {% component type: \"snippet\", alias: \"param_sortby\" %}\n    {% component type: \"snippet\", alias: \"param_sortorder\" %}\n    {% component type: \"snippet\", alias: \"param_random\" %}\n    {% component type: \"snippet\", alias: \"param_limit\" %}\n    {% component type: \"snippet\", alias: \"param_displaypagination\" %}\n    {% component type: \"snippet\", alias: \"param_emptymessage\" %}\n    {% component type: \"snippet\", alias: \"param_object\" %}\n    {% component type: \"snippet\", alias: \"param_collectionvariable\" %}\n    {% component type: \"snippet\", alias: \"param_customparameter\" %}\n{% component type: \"snippet\", alias: \"param_table_foot\" %}\n\n\n{% component type: \"snippet\", alias: \"section_output\" %}\n\n{% component source: \"Banner Group\", layout: \"\", type: \"module\", collectionVariable: \"allBanners\" %}\n<p>The below example has {{allBanners.pagination.totalitemscount}} sample <code>items</code> (Banner Groups), but is otherwise the default structure you will get from this Component.</p>\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{allBanners}}\", lang: \"json\" %}\n\n{% component type: \"snippet\", alias: \"section_accessing_data\" %}\n\n<p>This data is accessible in two main ways:</p>\n\n<p>1. Using Liquid in the specified Layout via the <code>this</code> object.</p>\n{% capture data %}\n{% raw %}\n{{this['name']}}\n{% endraw %}\n{% endcapture %}\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p>2. Directly on the Page or Template via a Liquid Collection if <code>collectionVariable</code> was added to the Component tag.</p>\n\n<p>An example using <code>collectionVariable</code> with value \"allBanners\" to list all \"Banner Groups\" across the site:</p>\n<p class=\"notice-note\">Here we suppress any Layout from rendering by setting <code>layout: \"\"</code> as an empty attribute.</p>\n{% capture data %}\n{% raw %}\n{% component type: \"module\", source: \"Banner Group\", layout: \"\", collectionVariable: \"allBanners\" %}\n{% endraw %}\n{% endcapture %}\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p><em>Looping through the collection to render all the item names in a list, giving us:</em></p>\n\n<ul>\n    {% for i in allBanners.items %}\n        <li>{{i['name']}}</li>\n    {% endfor %}\n</ul>\n<br>\n<p><em>The code:</em></p>\n{% capture data %}\n{% raw %}\n<ul>\n    {% for i in allBanners.items %}\n        <li>{{i['name']}}</li>\n    {% endfor %}\n</ul>\n{% endraw %}\n{% endcapture %}\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p><em>Accessing a specific item within the collection. In this case the second item (zero based index), which in our example would render the value <code>{{allBanners.items[1]['name']}}</code></em></p>\n{% capture data %}\n{% raw %}\n{{allBanners.items[1]['name']}}\n{% endraw %}\n{% endcapture %}\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n{% component type: \"snippet\", alias: \"section_counter\" %}\n",
    "DisableForSiteSearch": false,
    "EnableAMP": false,
    "Enabled": true,
    "ExpiryDate": "2099-12-09T00:00:00",
    "ExternalId": 0,
    "ExternalResources": "",
    "IgnoreUpdates": true,
    "ItemCategories": null,
    "ItemTags": [
      "Banners"
    ],
    "MetaDescription": "",
    "Name": "module (Banner Group)",
    "OpenGraphProperties": "",
    "ReleaseDate": "2018-09-05T00:00:00",
    "SeoPriority": "",
    "SEOTitle": "",
    "MetaTitle": "",
    "ShowPageForSearchEngine": true,
    "SocialMetaTags": "",
    "UpdateNotes": "All new article",
    "UrlSlug": "module-banner-group-",
    "Weighting": 960,
    "parentname": "Component Types",
    "parenturl": "/documentation_group/component-types",
    "templatename": "Docs Template-1",
    "ishome": false
  }
}

Accessing the Data

This data is accessible in two main ways:

1. Using Liquid in the specified Layout via the this object.

{{this['name']}}

2. Directly on the Page or Template via a Liquid Collection if collectionVariable was added to the Component tag.

An example using collectionVariable with value "allBanners" to list all "Banner Groups" across the site:

Here we suppress any Layout from rendering by setting layout: "" as an empty attribute.

{% component type: "module", source: "Banner Group", layout: "", collectionVariable: "allBanners" %}

Looping through the collection to render all the item names in a list, giving us:

  • DEMO Custom Banner
  • DEMO Standard Banner

The code:

<ul>
    {% for i in allBanners.items %}
        <li>{{i['name']}}</li>
    {% endfor %}
</ul>

Accessing a specific item within the collection. In this case the second item (zero based index), which in our example would render the value DEMO Standard Banner

{{allBanners.items[1]['name']}}

Counter

Along with the data output above, there is also a special liquid tag available {{counter}} which increments for each item. This tag is only available within Layouts when object: "item" is used in the Component tag.



Related Articles

  • module (Banner)
    This module component fetches data relating to Banner items. {% component type: "module", source: "Banner",...
  • Banners
    Banners give you an easy way to display random banner ads, perhaps a random quote...

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.


Questions?

We are always happy to help with any questions you may have.
Send us a message at support@treepl.co and we will consult you as soon as possible.