npm

react-flatlist-ui
TypeScript icon, indicating that this package has built-in type declarations

1.4.2 • Public • Published

react-flatList-ui

Logo

The FlatList used by React-Native is also available in React.js🔥🔥

FlatList is a utility component UI that makes it easy to handle data rendering lists, and it makes grouping, sorting, UI expansion, styling, and more ...

It is also easy to process the number of data corresponding to media srceen on the screen

GitHub npm GitHub release (latest by date)

react-flatlist-ui

Install

npm install react-flatlist-ui

yarn add react-flatlist-ui

How to use

// This dummyData
dummyData = [
  { id: 1, name: "Correia", img: "https://images.unsplash.com/photo-1234568" },
  { id: 2, name: "Sam", img: "https://images.unsplash.com/photo-1234568" },
  { id: 3, name: "John", img: "https://images.unsplash.com/photo-1234568" },
  { id: 4, name: "James", img: "https://images.unsplash.com/photo-1234568" },
  { id: 5, name: "Steam", img: "https://images.unsplash.com/photo-1234568" },
  { id: 6, name: "Hwan", img: "https://images.unsplash.com/photo-1234568" },
  { id: 7, name: "John", img: "https://images.unsplash.com/photo-1234568" },
  { id: 8, name: "Key", img: "https://images.unsplash.com/photo-1234568" },
  { id: 9, name: "Min", img: "https://images.unsplash.com/photo-1234568" },
  { id: 10, name: "Ellan", img: "https://images.unsplash.com/photo-1234568" },
];

We get the values of dummyData through the data in FlatList, and we pass the unique key values to the keyExtractor, and we get the components through randerItem. This allows you to experience a higher level of performance by taking notes of data.

🔥👍This method is very similar to FlatList in React-Native. Try FlatList in React.js right now🔥👍

import FlatList from 'react-flatList-ui';

...
function App() {
  return (
    <FlatList
      direction="horizontal" // Vertical or horizontal
      data={dummyData} // Data
      dataCount={dummyData.length} // Data count or length
      loading={false} // This Loading State
      keyExtractor={(item) => item.id} // Item key
      renderItem={(item) => <Item name={item.name} img={item.img} />} // Rendering items
      listLoadingComponent={<p>loading...</p>} // loading: true components shown
      ListHeaderComponent={<h1>Title: FlatList</h1>} // Rendered at the top of all the items
      ListFooterComponent={<span>data finish ...</span>} // Rendered at the bottom of all the items
      ItemSeparatorComponent={{<div style={{width:'100%', height:1, backgroundColor:'#eeeeee'}}></div>}} // Components between data
      ListEmptyComponent={<p>Data does not exist ...</p>} // If noneData : view component
            itemHorizontalCount={{ desktop: 3, tablet: 2, mobile: 1 }} // Uf horizontal : media screen data count
      gap={15}
      crossGap={15}
      padding={{ all: 16 }}
      margin={{ bottom: 20 }}
      itemScrollActive={true} // Scroll Active
      listScrollbarView={false} // Scrollbar
    />
  );
}
...

Use Documentation

Props Type Features Description Default
data (*)(Memoization) any[] data Gets the data to sort in the list
dataCount number dataCount Enter the total number or length of data
loading boolean Current loading status or not Current loading status or not false
keyExtractor (*) (item?: any, index?: number) => string , number list key The unique id value of the passing data must be passed to the key
renderItem (*)(Memoization) (item?: any, index?: number) => ReactElement rendering of data items Effective rendering of dynamic lists and optimized processing for performance and memory use
ItemSeparatorComponent ReactElement Components between listItem You can handle another element between the elements imported into data
ListLoadingComponent ReactElement loading: components that are exposed on the screen when true loading: components that are exposed on the screen when true
ListEmptyComponent ReactElement Screen element when data does not exist You can expose custom elements when data does not exist ---
ListHeaderComponent ReactElement Rendered at the top of all the items Rendered at the top of all the items
ListFooterComponent ReactElement Rendered at the bottom of all the items Rendered at the bottom of all the items
direction horizontalvertical Determine the sort of items imported into the data horizontal : horizontal alignment of data--vertical: data vertical alignment vertical
itemHorizontalCount desktop: numbertablet: numbermobile: number Number of data exposed in one line during horizontal alignment Number of data exposed in one line during horizontal alignmentdesktop: By default, the number of data in a single line that is exposedtable : The number of tablets exposed to the resolution of the tablet with a width of 1080 or lessmobile : the number of data in a line exposed to mobile resolution less than 600 width desktop:1tablet:1mobile:1
itemGap number Distance between data items based on direction Distance between data items based on direction 10
itemCrossGap number Distance between data item counteraxes based on direction Distance between data item counteraxes based on direction 10
size width: "auto" , "100%" , "100vw"height: "auto" , "100%" , "100vh"minWidth: number , stringmaxWidth: number , stringminHeight: number , stringmaxHeight: number , string Adjust the entire area of the flatList Adjust the entire area of the flatList width:100%height:100%
display reverse: booleanalign: "start" , "end" , "center" , "stretch"crossAlign: "start" , "end" , "center" , "space-between" , "space-around" , "space-evenly"wrap: "nowrap" , "wrap" , "wrap-reverse" Determine the alignment of items in the Data element reverse : decide whether to reverse the item in the dataalignment : vertical horizontal alignment based on directioncrossAlign : vertical horizontal alignment of the opposite axis of direction referencewrap : Decides whether to move to the next line when the direction is horizontal direction === horizontal && wrap
itemScrollActive boolean If you need to enable scrolling in the FlatList area If you need to enable scrolling in the FlatList area occurs false
itemScrollbarView boolean If scrollbar exposure is required when itemScrollActive is enabled If scrollbar exposure is required when itemScrollActive is enabled false
padding all: number , stringhorizontal: number , stringvertical: number , stringtop: number , stringbottom: number , stringleft: number , stringright: number , string Determines the padding value of the FlatList all: full & all valuehorizontal: horizontal valuevertical: vertical valuetop: top valueBottom: bottom valueleft: left valueright: right value all:0
margin all: number , stringhorizontal: number , stringvertical: number , stringtop: number , stringbottom: number , stringleft: number , stringright: number , string Determines the margin value of the FlatList all: full & all valuehorizontal: horizontal valuevertical: vertical valuetop: top valueBottom: bottom valueleft: left valueright: right value all:0
ref HTMLUListElement
…props

License

MIT © Deepfactory, Inc. See LICENSE for details.

Toss

Dependents (1)

Package Sidebar

Install

npm i react-flatlist-ui

Weekly Downloads

61

Version

1.4.2

License

ISC

Unpacked Size

37.3 kB

Total Files

11

Last publish

Collaborators

  • deepdesign