• Stars
    star
    831
  • Rank 52,749 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

Build Status npm version

npm install mauerwerk

     

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

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

How to use

import { Grid } from 'mauerwerk'

<Grid
  // Arbitrary data, should contain keys, possibly heights, etc.
  data={this.state.data}
  // Key accessor, instructs grid on how to fetch individual keys from the data set
  keys={d => 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) => (
    <div>
      {data.title}
      {open && <div>Opened/maximized content here</div>}
      <button onClick={toggle}>{open ? 'Close' : 'Open'}</button>
    </div>
  )}
</Grid>

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.

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

<Grid {...props}>
  {(data, open, toggle) => (
    <div>
      <Fade show={open}>
        <Slug>
          <h1>Opened content</h1>
          <span>Some text</span>
          <button onClick={toggle}>Close</button>
        </Slug>
      </Fade>
      <Fade show={!open}>
        <Slug>
          <h1>Cell content</h1>
          <span>Some text</span>
          <button onClick={toggle}>Open</button>
        </Slug>
      </Fade>
      <div>Content that would apply to both open and closed state</div>
    </div>
  )}
</Grid>

mauerwerk depends on react-spring and react-measure.

More Repositories

1

react-springy-parallax

🌊 A springy, composable parallax-scroller for React - deprecated
JavaScript
1,328
star
2

react-animated-tree

🌲Simple to use, configurable tree view with full support for drop-in animations
JavaScript
815
star
3

react-contextual

🚀 react-contextual is a small (less than 1KB) helper around React 16s new context api
JavaScript
643
star
4

the-substance

Scroll, Refraction and Shader Effects in Three.js and React
JavaScript
371
star
5

poimandres-theme

⚫️ poimandres vsc theme
JavaScript
218
star
6

floating-shoe

JavaScript
169
star
7

immer-wieder

✨ React 16 context wrap with redux semantics powered by immer
JavaScript
167
star
8

learnwithjason

Learn how to use theejs in react using react-three-fiber 🎉
JavaScript
121
star
9

reactanoid

JavaScript
98
star
10

testlighting

JavaScript
93
star
11

scheduler-test

JavaScript
56
star
12

r3fv4

Created with CodeSandbox
JavaScript
34
star
13

r3f-aesop

JavaScript
21
star
14

nft-gallery

Created with CodeSandbox
JavaScript
17
star
15

react-higher-order

☔️ Maps render props to a higher order component
JavaScript
16
star
16

untitled-game

Created with CodeSandbox
JavaScript
14
star
17

splats

TypeScript
13
star
18

arc-x-pmndrs

JavaScript
12
star
19

projects

projects
JavaScript
7
star
20

react-spring-numerical

🙌 React-springs leaner doppelgånger
JavaScript
7
star
21

awv3node-homepage

JavaScript
5
star
22

scroll-template

JavaScript
4
star
23

dom-resize

JavaScript
3
star
24

threeparcel

JavaScript
3
star
25

reacteurope

JavaScript
3
star
26

testsvg

2
star
27

plugs-draft

JavaScript
1
star
28

meshtransmissionmaterial

JavaScript
1
star
29

vite-three-js

JavaScript
1
star
30

zustand-website

CSS
1
star