0.0.3 • Published 2 years ago

react-native-masonry-grid v0.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Would you like to support me?

react-native-masonry-grid

Customizable masonry Flatlist. it just behave like Flatlist but using ScrollView behind the scene

Installation

npm install react-native-masonry-grid

Preview

npm.ionpm.ionpm.io
2-columns3-columns4-columns

Usage

import MasonryFlatlist from 'react-native-masonry-grid';

// ...
const DATA = [
  {
    name: 'Coffee Now!',
    url: 'https://mp-staging-ix.onshobbak.net/media/ninja-catalog-42/eac92236-0e4f-466a-9bc2-e68a04bb96ad_NowCoffeeNew.png',
    height: 136, // Mendatory and can be dynamic for each item
  }
]

<MasonryFlatlist
    data={DATA}
    numColumns={3} // for number of columns
    columnWrapperStyle={styles.columnWrapperStyle}
    showsVerticalScrollIndicator={false}
    style={styles.masonryFlatlist}
    renderItem={({ item, index }) => {
      return <Card data={item} height={item.height} onPress={() => {}} />;
    }}
  />

Props

interface Props extends ScrollViewProps {
  numColumns?: number;
  loading?: boolean;
  LoadingView?: React.ReactNode | React.ReactElement | null;

  columnWrapperStyle: StyleProp<ViewStyle>;
  ListHeaderComponent?: React.ReactNode | React.ReactElement | null;
  ListEmptyComponent?: typeof React.Fragment | React.ReactElement | null;
  ListFooterComponent?: React.ReactNode | React.ReactElement | null;
  ListHeaderComponentStyle?: StyleProp<ViewStyle>;
  contentContainerStyle?: StyleProp<ViewStyle>;
  containerStyle?: StyleProp<ViewStyle>;
  onRefresh?: RefreshControlProps['onRefresh'];
  onEndReached?: () => void;
  keyExtractor?: ((item: any, index: number) => string) | undefined;
  onEndReachedThreshold?: number;
  style?: StyleProp<ViewStyle>;
  data: any[];
  renderItem: ({ item, index }: { item: any; index: number }) => ReactElement;

}
namerequireddefaultdescription
numColumnsno2Number of columns you want to render.
columnWrapperStylenonullOptional custom style for multi-item rows generated when numColumns > 1.
loadingnofalsefor enabling loadingView.
LoadingViewnonullLoader component will be show when loading prop will true.
refnonullit will be forwardRef to ScrollView then you can use all props of scrollview by ref.

Note: Other props are the same as Flatlist. you can read flatlist docs for other props which are in props but not in the props table.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT