https://github.com/drcmda/mauerwerk

⚒ A react-spring driven masonry-like grid with enter/exit and shared element transitions
https://github.com/drcmda/mauerwerk

Last synced: 27 days ago
JSON representation

⚒ A react-spring driven masonry-like grid with enter/exit and shared element transitions

• Host: GitHub
• URL: https://github.com/drcmda/mauerwerk
• Owner: drcmda
• License: mit
• Created: 2018-08-06T20:27:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-08-02T06:52:26.000Z (over 3 years ago)
• Last Synced: 2024-10-09T13:14:44.682Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 4.46 MB
• Stars: 836
• Watchers: 17
• Forks: 55
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/drcmda/mauerwerk.svg?branch=master)](https://travis-ci.org/drcmda/mauerwerk) [![npm version](https://badge.fury.io/js/mauerwerk.svg)](https://badge.fury.io/js/mauerwerk)

    npm install mauerwerk



  



 

 

 

Demo: https://codesandbox.io/embed/0582jolnl

Simplified Demo: https://codesandbox.io/embed/z6ly40071p

## How to use

```jsx

import { Grid } from 'mauerwerk'

 d.key}

  // Can be a fixed value or an individual data accessor (for variable heights)

  // If you leave it undefined it will assume 100% container height

  heights={d => d.height}

  // Optional: number of columns (make it responsive yourself using react-measure/react-media)

  columns={3}

  // Optional: space between elements

  margin={0}

  // Optional: removes the possibility to scroll away from a maximized element

  lockScroll={false}

  // Optional: delay before minimizing an opened element

  closeDelay={500}

  // Optional: animates the grid in if true (default)

  transitionMount={true}>

  {(data, open, toggle) => (

    


      {data.title}

      {open && 
Opened/maximized content here
}

      {open ? 'Close' : 'Open'}

    

  )}


```

You feed mauerwerk any data-set (an array of objects most likely), give it accessors so it can access keys (which can be names, hashes, etc., the same keys you'd normally hand over to React), and either a fixed cell height or individual heights. You render out each individual cell via render-prop. You'll receive three arguments:

1. `data`, the item from your data-set

2. `open`, the cells state, depending on whether it is `true` or `false` you can display varying content or use further animation prototypes to transition from cell-state to maximized-state

3. `toggle`, use this to maximize/minimize your cell

## Effects

You probably don't want flip between open/closed content using static conditions. mauerwerk comes with two simple to use effects:

- `Fade` will fade contents in according to the `show` property. It's a simgple wrapper around react-spring's `Transition`, you can feed it the same properties (config, from, enter, leave, update). By default it will just move opacity from 0 -> 1.

- `Slug` lets elements "crawl" in. It's a wrapper around react-spring's `Trail`. By default it will move opacity from 0 -> 1 and translate y from 40px -> 0px.

These two would work outside the Grids context if you wanted to use them elsewhere.

```jsx

import { Grid, Slug, Fade } from 'mauerwerk'

  {(data, open, toggle) => (

    


      

        

          
Opened content

          Some text

          Close

        

      

      

        

          
Cell content

          Some text

          Open

        

      

      
Content that would apply to both open and closed state

    

  )}


```

---

mauerwerk depends on [react-spring](https://github.com/drcmda/react-spring) and [react-measure](https://github.com/souporserious/react-measure).