Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Description

Values

Default

selectors

Javascript object containing selectors for various fragments of the Pager component.

The object may contain any subset of the following keys:
  pagerBar
  pagerBarSecondary
  summary
  pageSize
  
Any values not provided will revert to the default.

                    

Code Block
javascript
javascript

        selectors: {
            pagerBar: ".pager-top",
            pagerBarSecondary: ".pager-bottom",
            summary: ".pager-summary",
            pageSize: ".pager-page-size"
        },

|

styles

Javascript object containing CSS style names that will be applied to the Pager component.

The object may contain any subset of the following keys:
  currentPage
  disabled
Any values not provided will revert to the default.

Code Block
javascript
javascript
styles: {
    currentPage: "current-page",
    disabled: "disabled"
}

pageWillChange

A function that will be called each time a new page has been selected. This function will most likely retrieve data for the selected page, or otherwise update the data.

a function

Code Block
javascript
javascript
pageWillChange: function (link) {
}

...

Field

Type

Primary/Computed

Description

pageIndex

integer

Primary

The current index of the page, expressed 0-based amongst the range of pages

pageSize

integer

Primary

The number of "items" which may be shown on a page

totalRange

integer

Primary

The total count of "items" in the underlying user's data model

pageCount

integer

Computed

The limit of the range in which pageIndex is expressed

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e0f36e963483a925-6227b865-4b51408c-ad3da54a-e1a51b0f7181d9714a8f70ea"><ac:plain-text-body><![CDATA[

[pageLimit]

integer

Computed

The limit of the range of items shown on the current page represented by the model

]]></ac:plain-text-body></ac:structured-macro>

...