Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IProps>, prevState: Readonly<IState>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IProps>
    • prevState: Readonly<IState>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IProps>, prevState: Readonly<IState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

Private onChange

  • onChange(page: number): (Anonymous function)

Private page

  • page(visiblePagePlace: number): Element

Private pages

  • pages(): ReactElement<any, string | ((props: P) => ReactElement | null) | {}>[]

render

  • render(): Element

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<IProps>
    • nextState: Readonly<IState>
    • nextContext: any

    Returns boolean

Private triggerNewPage

  • triggerNewPage(nextPage: number, event: MouseEvent): void

Static getDerivedStateFromProps

  • getDerivedStateFromProps(__namedParameters: { page: number }, __namedParameters: { prevPage: number }): IState

Object literals

Static defaultProps

defaultProps: object

defaultPage

defaultPage: number = -1

disabled

disabled: boolean = false

tabIndex

tabIndex: number = 0

type

type: string = "button"

mapPagesLabel

  • mapPagesLabel(_: any): any

Static propTypes

propTypes: object

defaultPage

defaultPage: Requireable<number> = PropTypes.number

disabled

disabled: Requireable<boolean> = PropTypes.bool

mapPagesLabel

mapPagesLabel: Requireable<(...args: any[]) => any> = PropTypes.func

name

name: Requireable<string> = PropTypes.string

onChange

onChange: Requireable<(...args: any[]) => any> = PropTypes.func

page

page: Requireable<number> = PropTypes.number

tabIndex

tabIndex: Requireable<number> = PropTypes.number

total

total: Validator<number> = PropTypes.number.isRequired

type

type: Requireable<string> = PropTypes.oneOf(['button','submit'])

Generated using TypeDoc