Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

  • object
    • IProps

Index

Properties

Optional animate

animate: undefined | false | true

Determines if the list should animate items into view

Optional maxHeight

maxHeight: undefined | number

Limit the max height of contents to show. Items that is outside will not be rendered.

Optional theme

theme: ITheme

The theme to use for the animations

Optional translateAnimationParams

translateAnimationParams: IAnimationParameters

Parameters of the translate spring animation

Optional translateDelay

translateDelay: undefined | number

How long to delay the translate animations

Methods

Optional onMaxHeightReached

  • onMaxHeightReached(): void

Optional onTranslateBegin

  • onTranslateBegin(value: number): void
  • Invoked when the translation starts. Will be invoked with the size of the incoming items

    Parameters

    • value: number

      the starting translation value

    Returns void

Optional onTranslateEnd

  • onTranslateEnd(value: number | undefined): void
  • Invoked when the translation ends

    Parameters

    • value: number | undefined

      the ending translation value. Will be undefined if the animation was cancelled

    Returns void

renderItem

  • Renders an item in the list. Is a subset of the React Native FlatList render item as we don't support the separators that it does.

    Parameters

    Returns Element | null

    an element