0.5.0 • Published 4 months ago

facebook-image-layout v0.5.0

Weekly downloads
-
License
-
Repository
-
Last release
4 months ago

Getting Started with Facebook Images Layout

Facebook-images-layout library which displays them in beautiful grids , inspired from facebook

Table of contents

  1. Installation
  2. Demo
  3. Basic Usage

Installation

  • Using NPM npm i facebook-image-layout

Demo

can layout different number of images

Base CaseOne ImageTwo Images
Three ImagesFour imagesFive Images

Story interactions

npm.io

Demo Carousel

npm.io

Basic Usage of Image Grid

  • For image grid of 1 image with modal

    import {ImageGridComponent} from "facebook-image-layout";
    
    function App() {
      return (
          <ImageGridComponent
            images={[
              {
                alt: 'a person standing in a canyon surrounded by rocks',
                url: 'https://images.unsplash.com/photo-1682695794816-7b9da18ed470?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3w1MDk3MzJ8MXwxfGFsbHwxfHx8fHx8Mnx8MTcwMjc5OTQwMnw&ixlib=rb-4.0.3&q=80&w=1080'
              },
            ]}
            imagesGridHeight="20rem"
            imagesGridMaxWidth="30rem"
          />
      );
    }
    
    export default App;
  • For image grid of more than 5 images with modal

    import {ImageGridComponent} from "facebook-image-layout";
    
    function App() {
      return (
          <ImageGridComponent
            images={[
              {
                alt: 'a person standing in a canyon surrounded by rocks',
                url: 'https://images.unsplash.com/photo-1682695794816-7b9da18ed470?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3w1MDk3MzJ8MXwxfGFsbHwxfHx8fHx8Mnx8MTcwMjc5OTQwMnw&ixlib=rb-4.0.3&q=80&w=1080'
              },
              {
                alt: 'a woman holding an umbrella in a forest',
                url: 'https://images.unsplash.com/photo-1702700485044-652cbbd41fde?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3w1MDk3MzJ8MHwxfGFsbHwyfHx8fHx8Mnx8MTcwMjc5OTQwMnw&ixlib=rb-4.0.3&q=80&w=1080'
              },
              {
                alt: 'a forest covered in lots of trees under a cloudy sky',
                url: 'https://images.unsplash.com/photo-1702659610398-58d3fb3f65f2?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3w1MDk3MzJ8MHwxfGFsbHwzfHx8fHx8Mnx8MTcwMjc5OTQwMnw&ixlib=rb-4.0.3&q=80&w=1080'
              },
              {
                alt: 'a black and brown dog standing in the snow',
                url: 'https://images.unsplash.com/photo-1702611120121-e03dafc14150?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3w1MDk3MzJ8MHwxfGFsbHw0fHx8fHx8Mnx8MTcwMjc5OTQwMnw&ixlib=rb-4.0.3&q=80&w=1080'
              },
              {
                alt: 'two white plates topped with chocolate cake on top of a table',
                url: 'https://images.unsplash.com/photo-1702323213406-db43f134bd80?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3w1MDk3MzJ8MHwxfGFsbHw1fHx8fHx8Mnx8MTcwMjc5OTQwMnw&ixlib=rb-4.0.3&q=80&w=1080'
              },
              {
                alt: 'a couple of animals standing on top of a rocky hillside',
                url: 'https://images.unsplash.com/photo-1682687221213-56e250b36fdd?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=M3w1MDk3MzJ8MXwxfGFsbHw2fHx8fHx8Mnx8MTcwMjc5OTQwMnw&ixlib=rb-4.0.3&q=80&w=1080'
              },
            ]}
            imagesGridHeight="20rem"
            imagesGridMaxWidth="30rem"
          />
      );
    }
    
    export default App;

props

Accepted propstypeDescription
imagesGridMaxWidthstringset maximum Width for Image Grid Component
imagesGridHeightstringset height for Image Grid Component
imagesImageFormat{alt: string, url: string}List of Image Object with property: alt & url