Component-Specific Parameters
Name |
Options |
Description |
limit
|
Any Number
|
Sets a limit to the number of people to be displayed in a paginated page. |
showHidden
|
true
|
If set to true , shows a person even if their profile page is set
to “Hide from navigation.” |
customLabel
|
whatever-label-you-want
|
If you enter a label, it will replace the default label used to pull in dynamic content. |
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-directory" %}
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 directory
partial
to one of the slots.
Component-Specific Configuration
Name |
Options |
Description |
Limit
|
Any Number
|
Sets a limit to the number of people to be displayed in a paginated page. |
Show if hidden?
|
checked unchecked
|
If
checked, shows a person even if their profile page is set to “Hide
from navigation.” |
Custom Label
|
whatever-label-you-want
|
If you enter a label, it will replace the default label used to pull in dynamic content. |
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”. |