Components/Data display

EPagination Pagination

import EUI 1.0

Examples

Page size and page jump

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 Column { spacing: 12 width: parent.width EPagination { id: pagination total: 258 width: parent.width pageSizes: [10, 20, 50, 100] layout: width < 760 ? "total, sizes, ->, jumper" : "total, sizes, prev, pager, next, jumper" onPageSizeChanged: { if (pager) pager.pageSize = pageSize } onCurrentPageChanged: { if (pager) pager.currentPage = currentPage } } EPagination { id: pager width: parent.width visible: width < 760 total: pagination.total layout: "prev, pager, next" pageSize: pagination.pageSize currentPage: pagination.currentPage onCurrentChange: function(number) { pagination.setPage(number) } } EText { text: qsTr("Page %1; items per page: %2").arg(pagination.currentPage).arg(pagination.pageSize) } }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Pagination

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 EPagination { total: 256 pageSize: 10 onCurrentChange: function(page) { console.log(page) } }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Properties

PropertyDescriptionValues and default

buttonBackgroundbool

Show pager button backgrounds.

Defaulttrue

contentalias

Content slot; declare QML child objects directly inside the component.

DefaultAlias: customContent.data

currentPageint

Current page number, starting at 1.

Default1

enabledbool

Allow interaction; false disables the control.

Defaulttrue

explicitPageCountint

Explicit page count; otherwise derived from total and pageSize.

Default0

heightreal

Component size in pixels; may be bound to its parent layout.

DefaultimplicitHeight

hideOnSinglePagebool

Hide pagination when there is only one page.

Defaultfalse

layoutstring

Visible pagination controls and their order.

Comma-separated:
prev, pager, next
sizes, total, jumper
->: align following items to the right

Default"total, prev, pager, next"

nextTextstring

Custom text for next-page or previous-page buttons.

Default""

pageSizeint

Data items per page.

Default10

pageSizesvar

Available page-size choices.

Default[10, 20, 50, 100]

pagerCountint

Number of pager buttons.

Default7

prevTextstring

Custom text for next-page or previous-page buttons.

Default""

showTotalbool

Show pagination total count.

Defaulttrue

sizeint

Control size; inherits the nearest EConfigProvider by default.

EStyle.Small
EStyle.Medium
EStyle.Large

DefaultInherited; EStyle.Medium by default

totalint

Total number of data items.

Default0

visiblebool

Whether the component is visible.

Default!hideOnSinglePage || pageCount > 1

widthreal

Component size in pixels; may be bound to its parent layout.

DefaultimplicitWidth

effectivePageSizeintRead only

Effective page size, at least 1.

DefaultComputed at runtime

layoutItemsvarRead only

Pagination layout items and groups on either side of ->.

DefaultComputed at runtime

leftItemsvarRead only

Pagination layout items and groups on either side of ->.

DefaultComputed at runtime

pageCountintRead only

Resolved total page count.

DefaultComputed at runtime

pagesvarRead only

Current pager numbers and ellipsis entries.

DefaultComputed at runtime

rightItemsvarRead only

Pagination layout items and groups on either side of ->.

DefaultComputed at runtime

splitIndexintRead only

Index of -> in pagination layout.

DefaultComputed at runtime

localizedTextsvarRead only

Localized texts for the current language; updated when the language changes.

DefaultELocale.texts

Signals

SignaturePurpose

nextClicked(int page)

Emitted when the next-page button is clicked; page is the target page number.

currentChange(int page)

Emitted when the current page changes; page is the new one-based page number.

sizeChange(int pageSize)

Emitted when the page size changes; pageSize is the new size.

previousClicked(int page)

Emitted when the previous-page button is clicked; page is the target page number.

changed(int page, int pageSize)

Emitted when the page or page size changes; page is the current page and pageSize is the page size.

Methods

SignaturePurpose

normalizePage()

Clamp the current page to the valid range, for example after the page count decreases.

next()

Move to the next item or step.

previous()

Move to the previous item or step.

setPage(page)

Switch to the one-based page number specified by page.

setPageSize(value)

Set the page size and update the valid page range.