Options
All
  • Public
  • Public/Protected
  • All
Menu

Class to define the Pagination component used in Onboarding

class

Pagination

extends

{React.Component<IPaginationProps, IPaginationState>}

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns Pagination

  • Parameters

    Returns Pagination

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<IPaginationProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<IPaginationState>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

CenterContent

  • CenterContent(): TypeComponent
  • Method that renders the center container component

    Returns TypeComponent

Done

  • Done(): TypeComponent
  • Method that renders the Done button

    Returns TypeComponent

Dots

  • Dots(): TypeComponent
  • Method that renders the pagination Dots

    Returns TypeComponent

LeftContent

  • LeftContent(): TypeComponent
  • Method that renders the left container component

    Returns TypeComponent

Next

  • Next(): TypeComponent
  • Method that renders the Next button

    Returns TypeComponent

Prev

  • Prev(): TypeComponent
  • Method that renders the Previous button

    Returns TypeComponent

RightContent

  • RightContent(): TypeComponent
  • Method that renders the right container component

    Returns TypeComponent

Skip

  • Skip(): TypeComponent
  • Methods that renders the Skip button

    Returns TypeComponent

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

Private _getContent

  • Method that renders the content of each container (left, center and right)

    Parameters

    Returns TypeComponent[]

Private _processProps

  • Method that process the props of the component

    Returns IPaginationProps

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

  • 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

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IPaginationProps>, 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

forceUpdate

  • forceUpdate(callback?: undefined | function): void
  • Parameters

    • Optional callback: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

  • 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

isFirstPage

  • isFirstPage(): boolean
  • Method to check if the current page is the first page

    Returns boolean

isLastPage

  • isLastPage(): boolean
  • Method to check if the current page is the last page

    Returns boolean

render

  • render(): TypeComponent
  • Method that renders the component

    Returns TypeComponent

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof IPaginationState

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • 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

    Returns boolean

Generated using TypeDoc