Agenda Agenda Snippets AgendaCategories

This snippet displays a list of categories.


It uses the following snippet properties:

Property Description Default
ajax Since 1.4.0 If set, the snippet output will be directly returned to the browser as a JSON result when the page is requested with the same value in the ajax request parameter. 0 (No)
allowedRequestKeys Comma-separated list of request keys, that can be used to filter the displayed categories. Defaults to all allowed. -
categories Comma-separated list of aliases of categories to filter the displayed categories. -
emptyTpl Name of a chunk that contains the template for not found categories. tplAgendaCategoriesEmpty
filterByEvents Since 1.5.0 If set, the categories with no future events are filtered from the result. 0 (No)
limit Limit the number of categories in the result. Use “0” for unlimited categories. 20
listId ID of a resource containing an AgendaList snippet call. -
offset The offset of categories to skip. -
outputSeparator An optional string to separate each tpl instance. -
selected Comma separated list of category aliases, that have the placeholder selected filled. -
sortby Since 1.5.0 Sort field for sorting the output. It could also contain a JSON object to sort the ouput by multiple fields like
sortdir Since 1.5.0 Sort direction for sorting the output. Unused when the sortby property contains a valid JSON object. ASC
toPlaceholder If set, the snippet result will be assigned to this placeholder instead of outputting it directly. -
totalVar The key of a placeholder that indicates the total number of categories.
tpl Name of a chunk that contains the template for one category. tplAgendaCategory
where Since 1.5.0 Since 1.5.0 JSON encoded xPDO where clause to filter the categories. -
wrapperTpl Name of a chunk that contains the wrapper template for all categories. tplAgendaCategoriesWrapper


The following placeholders are available in the different (default) chunks. Each snippet property will be set as placeholder in each template chunk, i.e. a snippet call [[!AgendaDetail? &subtitle=`whatever`]] will fill the placeholder subtitle in each used chunk with the value whatever.

CAUTION: The default template chunks for both snippets are overwritten during each package update, so please rename the chunks before editing them.


Placeholder Description
alias The alias of the category.
background The background color of the category of the event.
foreground The foreground color of the category of the event.
name The name of the category.
resource_id The id of a linked resource of the category.
selected Contains selected="selected", when the category request value is equal to the alias of the category.
url The url that shows the event list filtered by the displayed category. Will be generated with the system/context setting agenda.list_id. This resource should contain an AgendaList snippet call.


Only the current script properties are available as placeholders.


Placeholder Description
count Count of the categories filtered by the snippet properties (without limit/offset)
output All categories collected by the snippet separated by the string in the outputSeparator property