JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q47680F
  • License MIT

A messy grid layout library for React. Like a masonry layout; except that it crops images as little as possible, and displays them as close to their original aspect ratio as possible.

Package Exports

  • messonry
  • messonry/dist/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (messonry) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

messonry

A messy grid layout library for React.

Screenshot of webpage using messonry layout
Like a masonry layout;
except that it displays media at its intended aspect ratio.


Warning

I'd like to release v1.0.0 with full support of Next v13.

Consider the API experimental after messonry@0.2.0.

Using the 'next' branch until stable release. Appreciate your understanding.


Table of Contents

Install with package manager of your choice

pnpm add messonry
yarn add messonry
npm i messonry

Usage


import MessonryGrid from "messonry";


const MyMessyLandingPage = () => {
    const myMediaArray = [
        { src: 'https://url-of-image.com/', mimeType: "image", alt: "description of image" },
        { src: 'https://url-of-video.com/', mimeType: "video", alt: "description of video" },
        { content: <MyCustomComponent /> }
    ]

    const gridOptions = {
      useNextImage={true},
       nextImageConfig: {
        quality: 90,
        priority: true,
        loading: "eager",
        unoptimized: false,
      },
    }

    return (
        <>
            <MessonryGrid items={media} options={gridOptions} />
        </>
    )

}

Maintainers

@nickadamson

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2022 Nick Adamson