Last activity on 12 December 2019
  • 13
  • 5
  • 26137
composer require flowpack/listable

Tiny extension for listing things


Tiny extension for listing things

Release Date
04.12.2019 11:48:25
  • neos/neos: ^3.3 || ^4.0 || ^5.0 || dev-master
Requires (dev)
MIT cdc37c6d66ea8a733e9e37ad409b2e2d4f99725b


This Neos package solves one problem: help you list any nodes in TypoScript. The idea is very simple: you often need to display list of things (e.g. news, articles etc), and the concern of listing items should better be separated from the concern of rendering items. This packages provides a solid foundation for listing, while allowing you to take care of rendering stuff on your own.


  1. Install the package with composer. Here it is on packagist.
  2. Add Flowpack.Listable:ListableMixin to nodetypes that you want to list.
  3. Build your list based on Flowpack.Listable:Listable for simple list or on Flowpack.Listable:List for list with a header and an archive link.
  4. For each of your nodetypes create a new TS object of type NodeTypeName + 'Short', or manually definy a rendering object.
  5. Rely on public API keys when overriding settings.

See here for a trivial integration example.

If you don't need the package, but love TypoScript, look here, you may find some inspiration :)

Nodetype mixins

On data level we provide only one mixin: Flowpack.Listable:ListableMixin. The only thing you have to do, is to add this mixin to nodetypes that you would want to list with this package. That's right, planing all other fields is completely up to you.

TypoScript objects

Keys documented here are considered public API and would be treated with semantic versioning in mind. Extend all other properties at your own risk.


At the heart of this package is a Flowpack.Listable:Listable object. It provides some good defaults for rendering lists of things, and is pretty extensible too. Here are TypoScript context variables that you can configure for this object:

Setting Description Defaults
listClass Classname of UL tag ''
itemClass Classname of LI tag of wrapping each item ''
sortProperty Sort by property 'date'
sortOrder Sort order 'DESC'
limit Limit number of results. Set to high number when using with pagination 10000
offset Offset results by some value (i.e. skip a number of first records) 0
paginationEnabled Enable pagination true
itemsPerPage Number of items per page when using pagination 24
maximumNumberOfLinks Number of page links in pagination 15
queryType Predefined query types, choose between getFromCurrentPage and getAll 'getAll'
itemRenderer Object used for rendering child items 'Flowpack.Listable:ContentCaseShort'

You may also override collection key with custom query. Sorting and pagination would still apply (via @process). Here's an example that lists first 10 objects of type Something.Custom:Here.

prototype(My.Custom:Object) < prototype(Flowpack.Listable:Listable) {
  @context.limit = 10
  collection = ${q(site).find('[instanceof Something.Custom:Here]').get()}


There's often a need to render a list with a header an a archive link. This object takes Flowpack.Listable:Listable and wraps it with just that.

This is just a helper object, and in many cases you would not want to use it, but use Flowpack.Listable:Listable directly.

Setting Description Defaults
wrapClass Class of a div that wraps the whole object ''
listTitle Test of a title ''
listTitleClass Class of a list title ''
archiveLink Nodepath for archive link ''
archiveLinkTitle Title of an archive link ''
archiveLinkClass Classname of an archive link ''

Configuring pagination

Besides enabling pagination in TS object, you must not forget about adding pagination entryIdentifier to all parent cache objects, e.g. like this:

prototype(TYPO3.Neos:Page).@cache.entryIdentifier.pagination = ${request.pluginArguments.listable-paginate.currentPage}
root.@cache.entryIdentifier.pagination = ${request.pluginArguments.listable-paginate.currentPage}

To make urls pretty, see Routes.yaml.

Helper FlowQueries you can use


Filter nodes by properties of type date


Filter nodes by properties of type reference or references


Sort nodes by any property


${q(site).find('[instanceof TYPO3.Neos:Document]').sort('title', ['ASC'|'DESC']).get()}


Sort nodes recursively by their sorting property.


${q(site).find('[instanceof TYPO3.Neos:Document]').sortRecursiveByIndex(['ASC'|'DESC']).get()}
The content of the readme is provided by Github
The same vendor provides 45 package(s).