Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FlatList<T, SS>

A FlatList that has a subset of the React Native API and totally focussed on providing virtualization that preserves the height of the content. The height of the content can then be used to effciently translate new items into view. The virtualization uses two Views that replace the items off the top/bottom of the viewport. It can do this because

Type parameters

  • T: any

  • SS

Hierarchy

Index

Constructors

constructor

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IProps<T>>, 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

componentDidUpdate

  • componentDidUpdate(prev: IProps<T>): void

componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

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

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IProps<T>>, 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

    • prevProps: Readonly<IProps<T>>
    • prevState: Readonly<IState>

    Returns SS | null

render

  • render(): React.ReactNode

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IProps<T>>, 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<T>>
    • nextState: Readonly<IState>
    • nextContext: any

    Returns boolean

Object literals

Static defaultProps

defaultProps: object

onEndReachedThreshold

onEndReachedThreshold: number = 1

scrollEventThrottle

scrollEventThrottle: number = 50

windowSize

windowSize: number = 5

translateAnimationParams

translateAnimationParams: object

bounciness

bounciness: number = 2