API Docs for: 0.0.1
Show:

Component Class

Defined in: lib/component.jsx:3
Module: component.jsx

Description here

Copyright (c) 2016 ItsAsbreuk - http://itsasbreuk.nl
New BSD License - http://choosealicense.com/licenses/bsd-3-clause/

Methods

changePageSize

(
  • newIndex
)

Defined in lib/component.jsx:50

Available since 15.0.0

Will set the itemsPerPage, by calling the callback props.onChangePageSize.

Parameters:

  • newIndex Number

    the index of the array this.props.pageSizes that was selected

gotoPage

(
  • page
  • blur
  • e
)

Defined in lib/component.jsx:34

Available since 15.0.0

Will reset the current page, by calling the callback props.onChange.

Parameters:

  • page Number

    the page that should be shown

  • blur Boolean

    whether to blur the button

  • e Object

    the eventobject

render

()

Defined in lib/component.jsx:89

Available since 15.0.0

React render-method --> renderes the Component.

Returns:

ReactComponent

renderSelectSizes

()

Defined in lib/component.jsx:61

Available since 15.0.0

Renders the select-sizes Select-Component.

Returns:

ReactComponent

Properties

className

String

Defined in lib/component.jsx:250

Available since 15.0.1

A className for the component

itemsPerPage

Number

Defined in lib/component.jsx:259

Available since 15.0.0

How many items are shown on a page. This value is needed to generate the pagebuttons. When not set, all items are supposed to be shown on a single page.

msgItemsPerPage

String

Defined in lib/component.jsx:338

Available since 15.1.0

The message before the itemsPerPage selector

msgOneItem

String

Defined in lib/component.jsx:347

Available since 15.1.3

The one-item-message of: showing 1 item. Only available when showCountOutOf===true.

msgOutOf

String

Defined in lib/component.jsx:357

Available since 15.1.0

The showing-message of: showing count out of total. Only available when showCountOutOf===true.

msgShowing

String

Defined in lib/component.jsx:367

Available since 15.1.0

The out of-message of: showing count out of total. Only available when showCountOutOf===true.

msgShowingNoItems

String

Defined in lib/component.jsx:377

Available since 15.1.3

The showing no items-message: the message when there are no items. Only available when showCountOutOf===true.

onChange

Function

Defined in lib/component.jsx:269

Available since 15.0.0

The callback whenever a page is changed. The callback gets 1 argument --> newPage, which is the pagenumber (starting at 1).

onChangePageSize

Function

Defined in lib/component.jsx:280

Available since 15.0.0

The callback whenever a page is changed. The callback get1 1 argument --> newIndex, which is the selected index within the property pageSizes.

page

Number

Defined in lib/component.jsx:290

Available since 15.0.0

The current pagenumber (starting at 1).

pageSizes

Array

Defined in lib/component.jsx:309

Available since 15.0.0

The pageSizes. In order to wotk well with onChangePageSize, it is recomended to fill this array with numbers. In this case, the callback can pick up the number straight ahead and pass it into itemsPerPage at once.

showCountOutOf

Boolean

Defined in lib/component.jsx:300

Available since 15.1.0

Whether showing count out of total is shown.

tabIndex

Number

Defined in lib/component.jsx:319

Available since 15.0.0

The tabIndex. All sub-items will get this same tabindex.

totalItems

Number

Defined in lib/component.jsx:328

Available since 15.0.0

The Total itemcount of the array where the paginator relates to. This number is used to calculate and generate the buttons.