Change log

module (Page Folder)

This module component fetches data relating to Page Folders.

Possible use cases for this are displaying the folder/directory name and description (if one is set) for the currently viewed page.

Page Folders are based on the same structure as many other modules in Treepl CMS (Page Folders and Pages are nested modules). So you can retrieve, list, sort and filter your site page folders just like you might Blogs or Custom Modules.

{% component type: "module", source: "1516", layout: "Folder Detail" %}

Parameters and Options

Parameter
Values
Required
Description
type
module (default)

This is the name of the entity that needs to be used for the component retrieving function.

source
1516 (default)
The module’s entity/alias name or ID that the data is to be sourced from.
layout
Folder Detail (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.

While this parameter is required to render your Layout markup, if the parameter is blank, has an incorrectly referenced Layout, or is removed altogether then the component will still output the modules item data to a Liquid collection which can be accessed via the collectionVariable parameter.

filterBy
id
parentid
name
weighting
url
urlslug
releasedate
expirydate
LastUpdatedDate
Author
ItemCategories
ItemTags
<CustomPropertyName>
...and any other top level properties available for the module

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.

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>
...and any other top level properties available for the module

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.

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.
ignoreWeighting
false (default)
true

Enables/disables sorting items first by their weighting values. When false items will sort by their weighting values first, followed by any sortBy properties (or the default alpha/numeric sorting if sortBy is empty or not present). If true item weightings will be ignored and sorting will only be applied via sortBy or default sorting.
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.

If this param's value is 'true' - pagination will not be shown.
limit
10 (default)
<integer>

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

Enables/disables pagination for the component.

This is useful for avoiding pagniation affects for a specific component when multiple components of the same module are output on the same page and do use pagination.

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.

Your collectionVariable value must only contain English letters, numbers or underscores. Spaces or special characters are not supported.

isSearchResult
false (default)
true

Allows search parameters in the URL to override the components output. Therefore, this parameter can be used to output module specific search results from a submitted search form.

Likewise, Tag, Category, and Archive components can be used in conjunction with this parameter for filtering the module's output.

URL search parameters will override any corresponding parameters in the component. If no search parameters are present in the URL, isSearchResult will be ignored.

Any value other than true, (including an empty value), will disable the search functionality and the component will output its regular data.

searchScope
eg:
{'prop_ParentId':'1234', 'prop_ReleaseDate_Min':'2018-07-01', 'prop_ReleaseDate_Max':'2018-07-31', 'prop_KeyWords':'Your Keywords', 'prop_ItemTags':['tag1','tag2'], 'page':'2'}

Allows a search on the module without search parameters needed in the URL. Instead, search parameters are added to the value of this parameter. Therefore, this parameter can be used to output module specific search results from hard-coded (or Liquid) values without the use of a search form.

Added search parameters will override any corresponding parameters otherwise configured on the component. If no search parameters are present, searchScope will be ignored.

This value supports Liquid and can therefore be constructed with Liquid data/variables.

<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.

Your <customParameter> name must only contain English letters, numbers or underscores. Spaces or special characters are not supported.

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

Also, see here for a tutorial on using Custom Paramters.

Liquid Output

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

{
  "Params": {
    "source": "1516",
    "layout": "",
    "type": "module",
    "collectionvariable": "allFolders"
  },
  "Pagination": {
    "CurrentPage": 1,
    "ItemsPerPage": 10,
    "NumberOfPages": 1,
    "TotalItemsCount": 2
  },
  "Parent": {
    "Id": 2328,
    "Name": "module (Page Folder)",
    "Url": "/component-types/module-page-folder",
    "Url_List": [
      "/component-types/module-page-folder"
    ],
    "UrlSlug": "module-page-folder",
    "ParentId": 2127,
    "ParentId_List": [
      2127
    ],
    "ParentName": "Liquid Components",
    "ParentUrl": "/component-types",
    "TemplateName": "Docs Template",
    "Module_Alias": "DocumentationPost",
    "Module_ID": 1870,
    "Enabled": true,
    "ReleaseDate": "2018-09-19T23:00:00",
    "ExpiryDate": "2099-12-10T00:00:00",
    "SiteSearchKeywords": [],
    "Description": "<p>This module component fetches data relating to Page Folders.</p>\r\n<p>Possible use cases for this are displaying the folder/directory name and description (if one is set) for the currently viewed page.</p>\r\n<p class=\"notice-tip\">Page Folders are based on the same structure as many other modules in Treepl CMS (Page Folders and Pages are nested modules). So you can retrieve, list, sort and filter your site page folders just like you might Blogs or Custom Modules.</p>\r\n\r\n\r\n\r\n\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\r\n\r\n\r\n{% component type: \"snippet\", alias: \"section_parameters\" %}\r\n\r\n{% component type: \"json\", source_type:\"string\", source:\"{{tabularData}}\", layout:\"/snippets/tabularJSON.layout\" %}\r\n</section>\r\n\r\n{% component type: \"snippet\", alias: \"section_output\" %}\r\n\r\n{% component source: \"1516\", layout: "", type: \"module\", collectionVariable: \"allFolders\" %}\r\n<p>The below example has 2 sample <code>items</code> but is otherwise the default structure you will get from this Component.</p>\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{allFolders}}\", lang: \"json\" %}\r\n</section>\r\n{% component type: \"snippet\", alias: \"section_accessing_data\" %}\r\n\r\n<p>This data is accessible in two main ways:</p>\r\n\r\n<p>1. Using Liquid in the specified Layout via the <code>this</code> object.</p>\r\n\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\r\n\r\n<p>2. Directly on the Page or Template via a Liquid Collection if <code>collectionVariable</code> was added to the Component tag.</p>\r\n\r\n<p>An example using <code>collectionVariable</code> with value \"allFolders\" to list all \"Page Folder items\" across the site:</p>\r\n<p class=\"notice-note\">Here we suppress any Layout from rendering by setting <code>layout: \"\"</code> as an empty attribute.</p>\r\n\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\r\n\r\n<p><em>Looping through the collection to render all the item names in a list, giving us:</em></p>\r\n\r\n<ul>\r\n    \r\n        <li>demo-cs</li>\r\n    \r\n        <li>HTML Folder</li>\r\n    \r\n</ul>\r\n<br>\r\n<p><em>The code:</em></p>\r\n\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\r\n\r\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>HTML Folder</code></em></p>\r\n\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\r\n</section>\r\n</section>\r\n\r\n<section id=\"secListFiltered\">\r\n    <h2>List a Specific Page Folder</h2>\r\n<p>If you want to only list a single specific Folder you could filter the items using the Folder's ID or perhaps even its name.</p>\r\n<p>To do this we add the <code>filterBy</code> and <code>filterValue</code> attributes to the Component tag using the specific Page Folder's ID (or their name) to get just that item. For example:</p>\r\n\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\r\n\r\n<p class=\"notice-note\">You <b>cannot</b> use the Component Manager to configure the Component tag for Page Folders as it's not generally part of the content management process that clients may need to utilise.</p>\r\n\r\n<section id=\"secCurrentPageFolderData\">\r\n<h3>Display the Current Page's Folder Data</h3>\r\n<p>Let's say you want to have the name and description of the current page's folder/directory displayed on the page. Perhaps as a page header or sidebar info.</p>\r\n<p>To do this, we can get the parent ID of the current page (which is the Folder ID) and filter the Page Folders by this ID.</p>\r\n\r\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\r\n\r\n<p class=\"notice-note\">If you are on a root level page nothing will be rendered by this code as there is no parent folder.</p>\r\n</section>\r\n</section>\r\n\r\n{% component type: \"snippet\", alias: \"section_counter\" %}\r\n</section>",
    "Weighting": 910,
    "DisableForSiteSearch": false,
    "CreatedByMemberId": "0",
    "ItemCategories": [],
    "ItemCategoryIdList": [],
    "ItemTags": [
      "Pages"
    ],
    "Author": 0,
    "Author_Name": "",
    "Author_Url": "",
    "Item_Rating": 0,
    "Active": true,
    "IgnoreUpdates": true,
    "UpdatesLog": "<ul><li>27-Oct-2020 | 5.6.0 | Added 'ignoreWeighting' parameter</li><li>'isSearchResult' and 'searchScope' parameter details added.</li></ul>",
    "ExternalResources": null,
    "AdditionalRelatedArticle": 0,
    "AdditionalRelatedArticle2": 0,
    "Authors": "2418",
    "ShowPageForSearchEngine": true,
    "MetaTitle": "",
    "SEOTitle": "",
    "MetaDescription": "",
    "CanonicalLink": "",
    "SocialMetaTags": "",
    "SeoPriority": 0.0,
    "EnableAMP": false,
    "AMPContent": "",
    "OpenGraphProperties": {
      "title": null,
      "type": null,
      "url": null,
      "locale": null,
      "image": null
    },
    "ExternalId": 0,
    "Params": {
      "type": "snippet",
      "alias": "section_output",
      "data": "\r\n{% component type: \"module\", source: \"1516\", layout: \"Folder Detail\" %}\r\n",
      "lang": "liquid",
      "name": "SECTION Output",
      "content": "<section id=\"secOutput\">\n    <h2>Liquid Output</h2>",
      "enabled": true,
      "required": "true",
      "values": "Folder Detail <em>(default)</em><br>&lt;Your Layout name&gt;"
    }
  },
  "Items": [
    {
      "Id": 2224,
      "Name": "demo-cs",
      "Url": "/demo-cs",
      "Url_List": [
        "/demo-cs"
      ],
      "UrlSlug": "demo-cs",
      "ParentId": 1516,
      "ParentId_List": [
        -1
      ],
      "ParentName": "",
      "ParentUrl": "",
      "TemplateName": "DEMO Companion Site",
      "Module_Alias": "PageFolder",
      "Module_ID": 1516,
      "Enabled": true,
      "ReleaseDate": "2018-11-24T18:00:00",
      "ExpiryDate": "2099-12-11T07:00:00",
      "SiteSearchKeywords": [],
      "Description": "",
      "Weighting": 0,
      "DisableForSiteSearch": false,
      "CreatedByMemberId": "0",
      "ItemCategories": [],
      "ItemCategoryIdList": [],
      "ItemTags": [],
      "Author": 0,
      "Author_Name": "",
      "Author_Url": "",
      "Item_Rating": 0,
      "ShowPageForSearchEngine": false,
      "MetaTitle": "",
      "SEOTitle": "",
      "MetaDescription": "",
      "CanonicalLink": "",
      "SocialMetaTags": "",
      "SeoPriority": 0.5,
      "EnableAMP": false,
      "AMPContent": "",
      "OpenGraphProperties": {
        "title": null,
        "type": null,
        "url": null,
        "locale": null,
        "image": null
      },
      "ExternalId": 0,
      "Params": {}
    },
    {
      "Id": 2226,
      "Name": "HTML Folder",
      "Url": "/demo-cs/html-folder",
      "Url_List": [
        "/demo-cs/html-folder"
      ],
      "UrlSlug": "html-folder",
      "ParentId": 2224,
      "ParentId_List": [
        2224
      ],
      "ParentName": "demo-cs",
      "ParentUrl": "/demo-cs",
      "TemplateName": "",
      "Module_Alias": "PageFolder",
      "Module_ID": 1516,
      "Enabled": true,
      "ReleaseDate": "2018-11-24T18:00:00",
      "ExpiryDate": "2099-12-11T07:00:00",
      "SiteSearchKeywords": [],
      "Description": "",
      "Weighting": 0,
      "DisableForSiteSearch": false,
      "CreatedByMemberId": "0",
      "ItemCategories": [],
      "ItemCategoryIdList": [],
      "ItemTags": [],
      "Author": 0,
      "Author_Name": "",
      "Author_Url": "",
      "Item_Rating": 0,
      "ShowPageForSearchEngine": false,
      "MetaTitle": "",
      "SEOTitle": "",
      "MetaDescription": "",
      "CanonicalLink": "",
      "SocialMetaTags": "",
      "SeoPriority": 0.0,
      "EnableAMP": false,
      "AMPContent": "",
      "OpenGraphProperties": {
        "title": null,
        "type": null,
        "url": null,
        "locale": null,
        "image": null
      },
      "ExternalId": 0,
      "Params": {}
    }
  ]
}

Accessing the Data

JSON Output

You can output the full JSON for your component data by referencing the root Liquid object {{this}} in your module’s layouts, or directly on your page, if using the collectionVariable parameter in your component tag.

For example:

{% component type: ... collectionVariable: "myData" %}

You can then render the JSON like so:

{{myData}}

For more details on using this approach, see Part 2 of the free ‘Learning Liquid Course’.

Rendering Property Values

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 "allFolders" to list all "Page Folder items" across the site:

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

{% component type: "module", source: "1516", layout: "", collectionVariable: "allFolders" %}

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

  • demo-cs
  • HTML Folder

The code:

<ul>
    {% for i in allFolders.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 HTML Folder

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

List a Specific Page Folder

If you want to only list a single specific Folder you could filter the items using the Folder's ID or perhaps even its name.

To do this we add the filterBy and filterValue attributes to the Component tag using the specific Page Folder's ID (or their name) to get just that item. For example:

{% component type: "module", source: "1516", layout: "Folder Detail", filterBy: "id", filterValue: "2226" %}
or
{% component type: "module", source: "1516", layout: "Folder Detail", filterBy: "name", filterValue: "HTML Folder" %}

You cannot use the Component Manager to configure the Component tag for Page Folders as it's not generally part of the content management process that clients may need to utilise.

Display the Current Page's Folder Data

Let's say you want to have the name and description of the current page's folder/directory displayed on the page. Perhaps as a page header or sidebar info.

To do this, we can get the parent ID of the current page (which is the Folder ID) and filter the Page Folders by this ID.

{% component type: "module", source: "1516", filterBy: "id", filterValue: "{{this.parentID}}", collectionVariable: "pageFolder" %}
{% for i in pageFolder.items %}
    <h1><a href="{{i.url}}">{{i.name}}</a></h1>
    <p>{{i.description}}</p>
{% endfor %}

If you are on a root level page nothing will be rendered by this code as there is no parent folder.

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

  • Site Settings & Management
    System Pages
    System Pages, under 'Settings', is where you’ll find all those pages required by certain system...
  • Content Modules
    Pages
    Pages allow the creation and management of standard page content and folders. Pages can be arranged within folders, secured from unauthorised access, hidden from either site search or search engines, assigned to templates and given full SEO properties among various other settings.
  • Liquid Components
    module (Page)
    This module component fetches data relating to Pages. Possible use cases for this are creating...

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.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.