19
react-infinitegrid: A Infinite Virtual Grid, 5 layout component for React
source link: https://github.com/naver/egjs-infinitegrid/tree/master/packages/react-infinitegrid
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
react-infinitegrid
A react component that can easily use egjs-infinitegrid
Install
$ npm install @egjs/react-infinitegrid --save
How to use
// GridLayout, JustifiedLayout, FrameLayout, SquareLayout, PackingLayout import {GridLayout} from "@egjs/react-infinitegrid"; <GridLayout tag = "div" useFirstRender={false} loading={<div>Loading...</div>} options={{ threshold: 100, isOverflowScroll: false, isEqualSize: false, isContantSize: false, useFit: false, useRecycle: false, horizontal: false, }} layoutOptions={{ align: "justify", }} onAppend = {e => append} onPrepend = {e => append} onLayoutComplete = {e => layoutComplete} onImageError = {e => imageError} onChange = {e => chnage}> <Item groupKey={0} key={0}/> <Item groupKey={0} key={1}/> <Item groupKey={1} key={2}/> <Item groupKey={1} key={3}/> <Item groupKey={2} key={4}/> <Item groupKey={2} key={5}/> <Item groupKey={2} key={6}/> </GridLayout>
Props
name type default description tag string "div" The tag name of the wrapper element containerTag string "div" The tag name of the container element groupBy Function get groupKey or data-groupkey Get a unique key to distinguish between groups. useFirstRender boolean false The useFirstRender option determines whether the markup will be shown on the first rendering or after loading is complete. loading React.ReactElement Specifies the Loading Bar to use for append or prepend items. status IInfiniteGridStatus null State object of the react-infinitegrid module layoutType Class GridLayout Specifies the Layout class to use. options IInfiniteGridOptions {} The option object of the eg.InfiniteGrid module layoutOptions IInfiniteGridOptions {} Options to apply to the Layout. ...others DOM Attributes You can set the attribute of the wrapper element.export interface InfiniteGridProps<T extends ILayout = any> { tag?: string; containerTag?: string; useFirstRender?: boolean; status?: IInfiniteGridStatus | null; options?: Partial<IInfiniteGridOptions>; layoutOptions?: Partial<T["options"]>; loading?: React.ReactElement | null; layoutType?: new (...args: any[]) => ILayout; groupBy?: (item: any, index: number) => any; onAppend?: (param: OnAppend) => any; onPrepend?: (param: OnPrepend) => any; onLayoutComplete?: (param: OnLayoutComplete) => any; onImageError?: (param: OnImageError) => any; onChange?: (param: OnChange) => any; [others: string]: any; }
Options
- InfiniteGrid's options
- InfiniteGrid's events
- GridLayout's layoutOptions
- JustifiedLayout's layoutOptions
- SquareLayout's layoutOptions
- FrameLayout's layoutOptions
- PackingLayout's layoutOptions
More examples
this.state = { list: loadItems(0, 0), }; loadItems = (groupKey, start) => { const items = []; for (let i = 0; i < 20; ++i) { items.push(<Item groupKey={groupKey} key={start + i} />); } return items; } onAppend = ({groupKey, startLoading}) => { const list = this.state.list; const start = list.length; const items = this.loadItems(groupKey + 1, start); startLoading(); this.setState({list: list.concat(items)}); } onLayoutComplete = ({isLayout, endLoading}) => { !isLayout && endLoading(); } render() { return (<GridLayout onAppend={this.onAppend} onLayoutComplete={this.onLayoutComplete} loading={<div className="loading">Loading... append</div>}> {this.state.list} </GridLayout>); }
migration 1.x=> 3.x
InfiniteGris's props are bundled into options
, layoutOptions
.
- InfiniteGrid's options
- GridLayout's layoutOptions
- JustifiedLayout's layoutOptions
- SquareLayout's layoutOptions
- FrameLayout's layoutOptions
- PackingLayout's layoutOptions
// 1.x <GridLayout isOverflowScroll = {false} isEqualSize = {false} isConstantSize = {false} useFit = {true} useRecycle = {true} useFirstRender = {true} horizontal = {false} align = "justify" /> // 3.x <GridLayout useFirstRender={true} options={{ isOverflowScroll: false, isEqualSize: false, isContantSize: false, useFit: false, useRecycle: false, horizontal: true, }} layoutOptions={{ align: "justify", }} />
InfiniteGrid's event types are changed.
// 1.x interface InfiniteGridProps { tag?: string, type?: (...args: any[]) => any, options?: object, margin?: number, threshold?: number, isOverflowScroll?: boolean, isEqualSize?: boolean, useRecycle?: boolean, isConstantSize?: boolean, horizontal?: boolean, loading?: React.ReactNode, transitionDuration?: number, onAppend?: (param: OnAppendParameter) => void, onPrepend?: (param: OnPrependParameter) => void, onLayoutComplete?: (param: OnLayoutCompleteParameter) => void, onImageError?: (param: any) => void, onChange?: (param: OnChangeParameter) => void, status?: object, useFit?: boolean, [others: string]: any, } // 3.x export interface InfiniteGridProps<T extends ILayout = any> { tag?: string; containerTag?: string; useFirstRender?: boolean; status?: IInfiniteGridStatus | null; options?: Partial<IInfiniteGridOptions>; layoutOptions?: Partial<T["options"]>; loading?: React.ReactElement | null; layoutType?: new (...args: any[]) => ILayout; groupBy?: (item: any, index: number) => any; onAppend?: (param: OnAppend) => any; onPrepend?: (param: OnPrepend) => any; onLayoutComplete?: (param: OnLayoutComplete) => any; onImageError?: (param: OnImageError) => any; onChange?: (param: OnChange) => any; [others: string]: any; }
itemIndex changed totalIndex in onImageError event.
// 1.x <InfiniteGrid onImageError={e => { this.items.splice(e.itemIndex, 1); this.setState({ items: [...this.items] }); }} /> // 3.x <InfiniteGrid onImageError={e => { this.items.splice(e.totalIndex, 1); this.setState({ items: [...this.items] }); }}>
Development
# Run webpack-dev-server server and see examples for development $ npm run start
Bug Report
If you find a bug, please report it to us using the Issues page on GitHub.
License
react-infinitegrid is released under the MIT license .
Copyright (c) 2017 NAVER Corp. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK