List Picker Component
Class Name
The List Picker Component is implemented in the following class:
org.onehippo.cms7.essentials.components.EssentialsListPickerComponent
Overview
The List Picker Component exposes up to 10 related documents as Java beans to the rendering template. Editors select these documents manually, typically using the Experience manager's channel editor.
Use this component when you need to display a curated list of items, where each item corresponds to a separate document. The picker does not enforce document type restrictions, but it is common to select documents of the same type for consistency.
The component provides the selected documents to the rendering template as a pageable list. Pagination is supported, but since the maximum number of documents is 10, pagination is rarely necessary in practice.
Component Parameters
| Name | Description |
|---|---|
| documentX | X is an integer from 1 to 10. Each value is the repository path to a document (handle), relative to the site's content root. If the path does not resolve to a document, it is ignored. |
| pageSize | The number of items to display per page. Defaults to 10 (all items). |
| page | The page number to display (1-based). Defaults to 1 if not specified. This value is overridden by the request parameter if present. |
Request Parameters
| Name | Description |
|---|---|
| page | The page number to display (1-based). Defaults to 1 if not specified. This parameter overrides the component parameter. |
Rendering Attributes
| Name | Type | Description |
|---|---|---|
| pageable | org.onehippo.cms7.essentials.components.paging.Pageable | A pageable collection containing all selected and successfully retrieved HippoDocument objects. The collection exposes the current page size and page number. |