Plock

The 1kB Masonry Grid for React.

LayoutReact
askides/react-plockreact-plock.netlify.appreact-plock

README

react-plock


React Plock is a tree-shakeable ultra small npm package (less than 1kB gzipped) that allows you to create amazing masonry layouts with an amazing developer experience. With React Plock, you can easily create responsive and customizable layouts that adapt to different screen sizes and devices.

Features


- Masonry Layout: Create beautiful masonry layouts with ease.
- Responsive: Automatically adapts to different screen sizes and devices.
- Customizable: Customize the layout to match your needs.
- TypeScript Ready: Get the strength of type-safe languages.
- Amazing DX: Easy to use and well-documented.

Installation


  1. ```bash
  2. npm install react-plock
  3. ```

Usage


Using Plock with the new v3 APIs it's a piece of cake. Here's an example of how can you create an Unsplash-Like masonry grid. You can even see a demo of this example by clicking here.

  1. ```tsx
  2. import { Masonry } from 'react-plock';

  4. const ImagesMasonry = () => {
  5.   const items = [...imageUrls];

  7.   return (
  8.     <Masonry
  9.       items={items}
  10.       config={{
  11.         columns: [1, 2, 3],
  12.         gap: [24, 12, 6],
  13.         media: [640, 768, 1024],
  14.       }}
  15.       render={(item, idx) => (
  16.         <img key={idx} src={item} style={{ width: "100%", height: "auto" }} />
  17.       )}
  18.     />
  19.   );
  20. };
  21. ```

API Reference


Here's the TypeScript definition for the Masonry Component, below you can find a more detailed explanation.

  1. ```ts
  2. export type MasonryProps<T> = React.ComponentPropsWithoutRef<"div"> & {
  3.   items: T[];
  4.   render: (item: T, idx: number) => React.ReactNode;
  5.   config: {
  6.     columns: number | number[];
  7.     gap: number | number[];
  8.     media?: number[];
  9.   };
  10. };
  11. ```

Items


This prop accepts a generic array of elements, each one will be passed to the render property.

Render


The masonry render prop. Here's where you define the styles of every tile of the grid, the function takes the current looping item and the relative index.

Config


A configuration object that is used to define the number of columns, media queries and gaps between items.

Other Props


As you can see, by using `React.ComponentPropsWithoutRef<"div">` you can simply pass every available property to the div, some examples are **id** and **className**. The only one property that will be overwritten will be the `style` because is used internally for the masonry generation.

Important Note


Please, note that in case you are passing an array to the columns attribute of the config property, the number of elements MUST be equal to the number of media AND gap breakpoints provided!

  1. ```tsx
  2. // Correct: This will be responsive with 3 breakpoints.
  3. <Masonry
  4.   {...otherProps}
  5.   config={{
  6.     columns: [1, 2, 3],
  7.     gap: [12, 16, 20],
  8.     media: [640, 768, 1024],
  9.   }}
  10. />

  12. // Correct: This will be responsive with 2 breakpoints.
  13. <Masonry
  14.   {...otherProps}
  15.   config={{
  16.     columns: [1, 2],
  17.     gap: [2, 4],
  18.     media: [640, 1024],
  19.   }}
  20. />

  22. // Correct: This will be fixed with 4 columns in every screen size.
  23. <Masonry
  24.   {...otherProps}
  25.   config={{
  26.     columns: 4,
  27.     gap: 8
  28.   }}
  29. />

  31. // NOT Correct: This will cause trouble in rendering.
  32. <Masonry
  33.   {...otherProps}
  34.   config={{
  35.     columns: [4],
  36.     media: [640, 768],
  37.   }}
  38. />
  39. ```