List

Wrapper around FlatList component from react-native.

List component accepts every props from react native FlatList component.

Import

import { List } from 'react-native-ficus-ui';

Usage

<List
  bg="gray.200"
  p="xl"
  data={[
    {
      id: 'bd7acbea-c1b1-46c2-aed5-3ad53abb28ba',
      title: 'First Item',
    },
    {
      id: '3ac68afc-c605-48d3-a4f8-fbd91aa97f63',
      title: 'Second Item',
    },
    {
      id: '58694a0f-3da1-471f-bd96-145571e29d72',
      title: 'Third Item',
    },
  ]}
  renderItem={({ item }) => (
    <Box p="lg">
      <Text>{item.title}</Text>
    </Box>
  )}
/>

Props

renderItem

renderItem: ({ item, index, target, extraData }) => void;

Takes an item from data and renders it into the list.

https://shopify.github.io/flash-list/docs/usage#renderitem (opens in a new tab)

data

data: ItemT[];

For simplicity, data is a plain array of items of a given type.

https://shopify.github.io/flash-list/docs/usage#data (opens in a new tab)

estimatedItemSize

estimatedItemSize?: number;

https://shopify.github.io/flash-list/docs/usage#estimateditemsize (opens in a new tab)

bg

The background color property (backgroundColor style prop in StyleSheet)

m

The margin property (margin style prop in StyleSheet)

mt

The margin top property (marginTop style prop in StyleSheet)

mb

The margin bottom property (marginBottom style prop in StyleSheet)

mr

The margin right property (marginRight style prop in StyleSheet)

ml

The margin left property (marginLeft style prop in StyleSheet)

mx

The margin horizontal property (marginHorizontal style prop in StyleSheet)

my

The margin vertical property (marginVertical style prop in StyleSheet)

p

The padding property (padding style prop in StyleSheet)

pt

The padding top property (paddingTop style prop in StyleSheet)

pb

The padding bottom property (paddingBottom style prop in StyleSheet)

pr

The padding right property (paddingRight style prop in StyleSheet)

pl

The padding left property (paddingLeft style prop in StyleSheet)

px

The padding horizontal property (paddingHorizontal style prop in StyleSheet)

py

The padding vertical property (paddingVertical style prop in StyleSheet)

h

The height property (height style prop in StyleSheet)

w

The width property (width style prop in StyleSheet)

minH

The minimum height property (minHeight style prop in StyleSheet)

minW

The minimum width property (minWidth style prop in StyleSheet)

flex

The flex property for container (flex style prop in StyleSheet)

flexDirection

The flex direction property for container (flexDirection style prop in StyleSheet)

direction

The flex direction property for container (flexDirection style prop in StyleSheet)

flexWrap

The flex wrap property for container (flexWrap style prop in StyleSheet)

wrap

The flex wrap property for container (flexWrap style prop in StyleSheet)

flexGrow

The flex grow property for container (flexGrow style prop in StyleSheet)

grow

The flex grow property for container (flexGrow style prop in StyleSheet)

flexBasis

The flex basis property for container (flexBasis style prop in StyleSheet)

basis

The flex basis property for container (flexBasis style prop in StyleSheet)

flexShrink

The flex shrink property for container (flexShrink style prop in StyleSheet)

shrink

The flex shrink property for container (flexShrink style prop in StyleSheet)

justifyContent

The justify content property for container (justifyContent style prop in StyleSheet)

alignItems

The align items property for container (alignItems style prop in StyleSheet)

alignSelf

The align self property for container (alignSelf style prop in StyleSheet)

position

The position property for container (position style prop in StyleSheet)

top

The top position property for container (top style prop in StyleSheet)

bottom

The bottom position property for container (bottom style prop in StyleSheet)

right

The right position property for container (right style prop in StyleSheet)

left

The left position property for container (left style prop in StyleSheet)

overflow

The overflow property for container (overflow style prop in StyleSheet)

borderRadius

The border radius property (borderRadius style prop in StyleSheet)

borderTopRadius

The border radius top property (borderTopLeftRadius and borderTopRightRadius style props in StyleSheet)

borderBottomRadius

The border radius bottom property (borderBottomLeftRadius and borderBottomRightRadius style props in StyleSheet)

borderLeftRadius

The border radius left property (borderTopLeftRadius and borderBottomLeftRadius style props in StyleSheet)

borderRightRadius

The border radius right property (borderTopRightRadius and borderBottomRightRadius style props in StyleSheet)

borderTopLeftRadius

The border radius top left property (borderTopLeftRadius style prop in StyleSheet)

borderTopRightRadius

The border radius top right property (borderTopRightRadius style prop in StyleSheet)

borderBottomLeftRadius

The border radius bottom left property (borderBottomLeftRadius style prop in StyleSheet)

borderBottomRightRadius

The border radius bottom right property (borderBottomRightRadius style prop in StyleSheet)

borderColor

The border color property (borderColor style prop in StyleSheet)

borderTopColor

The border top color property (borderTopColor style prop in StyleSheet)

borderBottomColor

The border bottom color property (borderBottomColor style prop in StyleSheet)

borderRightColor

The border right color property (borderRightColor style prop in StyleSheet)

borderLeftColor

The border left color property (borderLeftColor style prop in StyleSheet)

borderWidth

The border width property (borderWidth style prop in StyleSheet)

borderTopWidth

The border top width property (borderTopWidth style prop in StyleSheet)

borderBottomWidth

The border bottom width property (borderBottomWidth style prop in StyleSheet)

borderRightWidth

The border right width property (borderRightWidth style prop in StyleSheet)

borderLeftWidth

The border left width property (borderLeftWidth style prop in StyleSheet)

shadow

The shadow property (shadowOffset and elevation style props in StyleSheet)

shadowColor

The shadow color property (shadowColor style props in StyleSheet)

opacity

The opacity property (opacity style prop in StyleSheet)