@egjs/react-layout

    1.4.1 • Public • Published

    react-layout npm version

    A react component that can easily use egjs-infinitegrid's layouts

    Install

    $ npm install @egjs/react-layout

    Usage

    import {GridLayout, JustifiedLayout, FrameLayout, SquareLayout, PackingLayout} from "@egjs/react-layout";
     
    <GridLayout tag="div" size="1000" horizontal={true} margin="10" isEqualSize={false} outline={[]}>
        <div></div>
        <div></div>
        <div></div>
        <div></div>
        <div></div>
        <div></div>
    </GridLayout>
     

    props

    name type description
    tag string The tag name of container
    size number The viewport size of container area where items are added to a layout. if size is zero, automatically resize the layout.
    horizontal boolean Direction of the scroll movement
    margin number Margin used to create space around items
    isEqualSize boolean Indicates whether sizes of all card elements are equal to one another. If true, the performance of layout arrangement can be improved.
    outline array Array of outline points to be reference points
    percentage boolean or ["position"?, "size"?] Specify property names (“position", "size") to which the percentage is applied, or set boolean value whether to apply percentage to all properties.
    onLayoutComplete function This event is fired when layout is successfully arranged.
    onImageError function This event is fired when an error occurs in the image.
    other props Check out! the options of Layouts

    The options of Layouts

    methods

    name description
    getItems() Returns the layouted items

    Development

    # Run webpack dev 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-layout 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.
    

    Install

    npm i @egjs/react-layout

    DownloadsWeekly Downloads

    10

    Version

    1.4.1

    License

    MIT

    Unpacked Size

    46.2 kB

    Total Files

    25

    Last publish

    Collaborators

    • ajaxpf
    • happyhj
    • jongmoon
    • mixed
    • netil
    • sculove
    • woodneck
    • younkue