Table of Contents
Note

This documentation describes the PaginationBar Vue component for native UI views for Xml templates see pagination-bar.

PaginationBar

Binds pagination controls to the ViewModel. Automatically shows/hides based on whether there are enough records to warrant pagination.

Import

import { PaginationBar } from '@neos/app'

Props

Prop Type Default Description
alwaysDisplay boolean false When true, the bar is always visible even when all records fit on one page

Notes

  • Reads pageNumber, recordsByPage, and totalRecordCount from the injected ViewModel.
  • Automatically hidden when totalRecordCount <= recordsByPage unless alwaysDisplay is true.
  • Page navigation and records-per-page changes are delegated back to the ViewModel.

Usage Examples

<VerticalLayout space="none">
  <Toolbar />
  <FilterBar />
  <Datagrid />
  <PaginationBar />
</VerticalLayout>

Always visible

<PaginationBar :always-display="true" />