Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Onboarding<SS>

Class to define the component Onboarding

class

Onboarding

extends

{React.Component<IOnboardingProps, IOnboardingProps>}

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns Onboarding

  • Parameters

    Returns Onboarding

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

Optional flatList

flatList: any

The reference to the FlatList component

type

{FlatList}

Optional itemVisibleHotfix

itemVisibleHotfix: undefined | object

Hotfix to swipe the pages

type

{{ itemVisiblePercentThreshold: number }}

props

props: Readonly<IOnboardingProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<IOnboardingProps>

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

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

Private _flatlistProps

  • _flatlistProps(): FlatListProps<__type>
  • Method that process the props for the FlatList

    Returns FlatListProps<__type>

    }

Private _onChangePage

  • _onChangePage(index: number): void
  • Method that fire when a pages change, this returns the current index page

    Parameters

    • index: number

    Returns void

Private _onDone

  • _onDone(): void
  • Method that fire when the button Done is pressed

    Returns void

Private _onLayout

  • _onLayout(): void
  • Method that fire when the layout is changed

    Returns void

Private _onSkip

  • _onSkip(): void
  • Method that fire when the button Skip is pressed

    Returns void

Private _onSwipePageChange

  • _onSwipePageChange(data: any): void
  • Method thar fire when a page is swiped

    Parameters

    • data: any

      Event of the flatlist change

    Returns void

Private _paginationProps

  • Method that process the props for the pagination

    Returns IPaginationProps

Private _processProps

  • Method that process the props of the component

    Returns IOnboardingProps

Private _skipToLastPage

  • _skipToLastPage(): void
  • Method that changes to the last page

    Returns 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

componentDidUpdate

  • componentDidUpdate(): void
  • Method that fire when the component is updated

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

defaultPages

  • Method that define 3 pages by default

    Returns IOnboardingPage[]

forceUpdate

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

    • Optional callback: undefined | function

    Returns void

getCurrentPage

  • Method to get the current page

    Returns IOnboardingPage | undefined

getPreviousPage

  • Method to get the previous page

    Returns IOnboardingPage | undefined

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

goNext

  • goNext(): void
  • Method to advance to the next page

    Returns void

goPrev

  • goPrev(): void
  • Method to back to the previous page

    Returns void

render

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

    Returns TypeComponent

renderPage

  • renderPage(data?: any): TypeComponent
  • Method that renders the page in the component

    Parameters

    • Optional data: any

    Returns TypeComponent

setState

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

    • K: keyof IOnboardingProps

    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