Page¶
-
/libs/granite/ui/components/shell/page The generic page to render Shell.
It also supports resource filtering using FilteringResourceWrapper and acts as its container.
It has the following content structure:
- granite:ShellPage
- consoleIdstring
A general purpose ID to uniquely identify the console.
The recommended value is hierarchical separated by “-“. e.g. “cq-commerce-report”
- jcr:titlestring
To render the title of the page (
<title>), resource athead/titleis first inspected. If it doesn’t exist, this property is used accordingly; otherwise do nothing. i.e. the title athead/titleis included naturally.
- redirector
To redirect the page, this resource can be specified. It will be included, where the redirect can be performed.
- head
A folder to specify the content of
<head>of the page. Its child resources are iterated and included as is.
- title
The component to render the title.
This is optional, and if not specified, the title header is not displayed. If the title is just a simple string, Title can be used.
The only requirement of the component is to generate a simple text without any wrapping markup. E.g. To have a title of “My Page”, just make the component do something like
out.print("My Page").Note if the title and breadcrumbs are provided, only the breadcrumbs will be generated.
- breadcrumbs
The data source for the list of breadcrumbs.
This is optional, and if not specified, the breadcrumbs are not displayed.
Note that only the breadcrumbs can be rendered or the title, not both. The breadcrumbs will take prescience over the title if both are provided.
-
actions
- granite:ShellPageActions
The folder for the actions applicable in the context of the whole page.
- omnisearchLocationPathstringel
The path to the omnisearch configuration associated with the console.
e.g.
/libs/granite/omnisearch/content/metadata/site
-
rails
- granite:ShellCollectionPageRails
A folder to specify the panels of the rail.
- content
The actual content of the page.
- granite:ShellPageActions
- primary
The folder for primary actions.
The action can be any action component such as Button, AnchorButton, Pulldown, Collection.
The
actionBarvariant of the components above SHOULD be used, unlessprimaryvariant is used.
- secondary
The folder for secondary actions.
The action can be any action component such as Button, AnchorButton, Pulldown, Collection.
The
actionBarvariant of the components above SHOULD be used, unlessprimaryvariant is used.
- granite:ShellCollectionPageRails
- activebooleanel
trueto activate the rail initially.Note that you need to also set
activeproperty of the rail panel totrueaccordingly.
-
*
- granite:PanelRailPanel
The child resources are considered as the panels, where each MUST be a RailPanel (or its derivative).
Example:
+ mypage - sling:resourceType = "granite/ui/components/shell/page" - jcr:title = "My Page" + content - sling:resourceType = "granite/ui/components/coral/foundation/container"