NEURALNG

API

Public contract

Signal models remain controlled; semantic events are emitted only after direct user interaction.

Inputs and models

NameTypeDefaultPurpose
totalItemsnumber0 Full collection size; negative and fractional values normalize safely.
pageIndexmodel<number>0 Zero-based controlled page index.
pageSizemodel<number>10 Items per page; changing it preserves the first visible item.
pageSizeOptionsreadonly number[][] Sorted size choices; an empty array hides the selector.
pageLinkCountnumber5 Maximum numeric page window, normalized to at least five.
showFirstLastbooleantrue Shows first-page and last-page controls.
showReportbooleantrue Shows the polite current-range report.
reportTemplatestring | nullnull Local report override with supported placeholders.
labelsPartial<NeuralPaginatorLabels>{} Component-level accessible-label overrides.
disabledbooleanfalse Disables every navigation and NeuralSelect size control.
roundedbooleanfalse Makes navigation and numeric page controls circular.
outlinedbooleanfalse Removes resting borders and backgrounds; hover uses a primary-tinted theme surface.
firstPageIconstringnt-chevrons-left First-page Neural Icons class.
previousPageIconstringnt-chevron-left Previous-page icon class.
nextPageIconstringnt-chevron-right Next-page icon class.
lastPageIconstringnt-chevrons-right Last-page Neural Icons class.
ellipsisIconstringnt-dots Truncated page-window icon class.
unstyledbooleanfalse Removes NeuralNg visual classes while retaining structure.
paginatorClassstring'' Additive class applied to the internal nav.
classesNeuralPaginatorClasses{} Typed additive classes for internal slots.

Events

pageIndexChangenumber

Implicit model output when the selected page changes.

pageSizeChangenumber

Implicit model output when the user chooses another size.

pageChangeNeuralPageChange

Semantic user event containing the complete normalized page state.

Typed class slots

root

Internal nav landmark.

list

Native list containing page controls.

navigationButton

First, previous, next, and last buttons.

pageButton

Every numeric page button.

activePageButton

Current numeric page button.

icon

All navigation and ellipsis icons.

ellipsis

Non-interactive truncated-range marker.

report

Live current-range text.

pageSize

Page-size label wrapper.

pageSizeSelect

Trigger of the composed NeuralSelect size control.

NeuralPageChange

The payload contains pageIndex, pageSize, pageCount, totalItems, startIndex and endIndex. Start is inclusive and end is exclusive.