Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/askides/react-plock
The 1kB Masonry Grid for React.
https://github.com/askides/react-plock
masonry masonry-layout nextjs react
Last synced: about 2 months ago
JSON representation
The 1kB Masonry Grid for React.
- Host: GitHub
- URL: https://github.com/askides/react-plock
- Owner: askides
- License: mit
- Created: 2022-01-10T17:11:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T12:28:49.000Z (8 months ago)
- Last Synced: 2024-04-28T03:47:58.089Z (8 months ago)
- Topics: masonry, masonry-layout, nextjs, react
- Language: TypeScript
- Homepage: https://react-plock-with-nextjs.vercel.app
- Size: 1.23 MB
- Stars: 444
- Watchers: 5
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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.
> Using Tailwind? Check out Aski, an [open source suite of Tailwind elements](https://github.com/askides/aski) For React. No Lock-In. Just Copy, Paste, Build.
### 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.
### Examples
- Using Next.js 14 (Server Components) [See Working Demo](https://react-plock-with-nextjs.vercel.app/)
- Using ViteJS [See Working Demo](https://react-plock-with-vite.vercel.app/)
### Installation
```bash
npm install react-plock
```
### 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](https://unsplash.com/) masonry grid. You can even see a demo of this example by clicking [here](https://react-plock.netlify.app/).
```tsx
import { Masonry } from "react-plock";
const ImagesMasonry = () => {
const items = [...imageUrls];
return (
(
)}
/>
);
};
```
### API Reference
Here's the TypeScript definition for the Masonry Component, below you can find a more detailed explanation.
```ts
export type MasonryProps = React.ComponentPropsWithoutRef<"div"> & {
items: T[];
render: (item: T, idx: number) => React.ReactNode;
config: {
columns: number | number[];
gap: number | number[];
media?: number[];
};
};
```
#### 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!
```tsx
// Correct: This will be responsive with 3 breakpoints.
// Correct: This will be responsive with 2 breakpoints.
// Correct: This will be fixed with 4 columns in every screen size.
// NOT Correct: This will cause trouble in rendering.
```