Component-Specific Parameters
| Name |
Options |
Description |
limit
|
Any Number |
Sets a limit to the number of articles that will display per paginated
page.
|
featurettesID
|
The ID of the article index you want to target (optional)
|
If an ID of an article index is entered, the article index will pull the most
recent articles under that article index. If the article index is being used on an article index page itself i.e. a page created with type Article Index, there is no need to supply an ID; it will just display the child articles automatically. |
General Component Parameters
The following parameters can be used when including any shared partial.
| Name |
Options |
Description |
editModeOnly
|
true
|
If set to
true, the component will only appear in Edit Mode. This is useful
for testing your component before you want to make it live. |
main
|
true
|
If set to
true, a <main></main> element will apply
to the component. |
scope
|
page
site
|
If set to site, content in the editable regions of the component will apply sitewide to any component with the same name and instance number that is also set to scope: "site". |
Code Example
{% render "components/wvu-article-index" main: true, limit: 5 %}
PRO TIP: Options that contain integers (1, 2, 3) or boolean values (true, false) don’t need to be wrapped in quotes e.g. limit: 1 or main: true. Strings should be wrapped in quotes e.g. scope: "site".
Setup
From the CleanSlate Pages dashboard, assign the Super Template to a page. In
the page properties, navigate to the Slots tab. Assign a article-index partial
to one of the slots.
Component-Specific Configuration
| Name |
Options |
Description |
|
Limit
|
Any Number |
Sets a limit to the number of articles that will display per paginated
page.
|
|
Root Page ID
|
The ID of the article index you want to target (optional)
|
If an ID of an article index is entered, the article index will pull the most
recent articles under that article index. If the article index is being used on an article index page itself i.e. a page created with the type Article Index, there is no need to supply an ID; it will just display the child articles automatically. |
General Component Configuration
The following options can applied to any component in a slot.
| Name |
Options |
Description |
|
Edit Mode Only
|
checked
unchecked
|
If
checked, the component will only appear in Edit Mode. This is useful
for testing your component before you want to make it live. |
|
Is Main
|
checked
unchecked
|
If
checked, a <main></main> element will apply
to the component. |
|
Sitewide
|
checked
unchecked
|
If checked, content in the editable regions of the component will apply sitewide to any other component with the same name and instance number that is also set to “Sitewide”. |
Configuration
| Name |
Options |
Description |
|
Disable Author for Articles
|
checked
unchecked
|
If
checked, the author will no longer display for articles in the Articles
Index or individual article pages. |
