API Docs for: 3.17.2
Show:

Paginator.Url Class

Defined in: paginator/js/paginator-url.js:1
Module: paginator-url
Parent Module: paginator

Adds in URL options for paginator links.

Item Index

Methods

Attributes

Methods

formatPageUrl

(
  • [page]
)
String | null

Defined in paginator/js/paginator-url.js:43

Returns a formated URL for the provided page number.

Parameters:

  • [page] Number optional

    Page value to be used in the formatted URL. If empty, page will be the value of the page ATTRS.

Returns:

String | null:

Formatted URL for the page or null if there is not a pageUrl set.

nextPageUrl

() String | null

Defined in paginator/js/paginator-url.js:34

Returns a formated URL for the next page.

Returns:

String | null:

Formatted URL for the next page or null if there is no next page.

prevPageUrl

() String | null

Defined in paginator/js/paginator-url.js:25

Returns a formated URL for the previous page.

Returns:

String | null:

Formatted URL for the previous page, or null if there is no previous page.

Attributes

pageUrl

String

Defined in paginator/js/paginator-url.js:13

URL to return formatted with the page number. URL uses Y.Lang.sub for page number stubstitutions.

For example, if the page number is 3, setting the pageUrl to "?pg={page}", will result in ?pg=3

Fires event pageUrlChange

Fires when the value for the configuration attribute pageUrl is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.