masonryfy v1.0.7

Masonryfy

Convert an array of items into an array of columns of items.

Each item is placed in the shortest column, creating a Masonry like structure.

No external dependencies.

📦 Install

pnpm add masonryfy

# OR:
yarn add masonryfy
npm i masonryfy

⚡Usage

Masonryfy takes an array of objects with width and height properties, and a number of colums, and returns an array of arrays of items, with a length of number of colums.

It calculates the aspect ratio of each item, and places it into the shortest column.

The items will be distributed in a Masonry type of structure.

  const items = [ 
    { id: 'one', width: 100, height: 300 },
    { id: 'two', width: 100, height: 100 },
    { id: 'three', width: 100, height: 200 },
    { id: 'four', width: 100, height: 100 }
  ]

  const itemMatrix = masonryfy(items, 3)
        // ^? 
        // [
        //   [{ id: 'one', width: 100, height: 300 }],
        //   [{ id: 'two', width: 100, height: 100 }, { id: 'four', width: 100, height: 100 }],
        //   [{ id: 'three', width: 100, height: 200 }],
        // ]

  // +------+-------+-------+
  // | one  | two   | three |
  // |      | four  |       |
  // +------+-------+-------+

The result can be used by any frontend to create a masonry-like layout like so:

// Example using React. But can be adapted to any frontend framework.

export const MasonryGrid = ({ items }: Props) => {
  const itemMatrix = masonryfy(items, 3)

  return (
    <section className="w-full flex flex-col">
      {itemMatrix[0]?.length > 0 && (

        <ul className="flex max-w-7xl gap-8">

          {itemMatrix.map((col, index) => (
            <li key={'grid-column' + index} className="w-1/3">
              {col.length > 0 && (
                <ul className="flex flex-col gap-8">
                  {col.map(item => {
                    return (
                      <Item
                        key={item.id}
                        item={item}
                      />
                    )
                  })}
                </ul>
              )}
            </li>
          ))}

        </ul>

      )}
    </section>
  )
}

Good to know

• Masonryfy uses generics, so types will be preserved.
• If an item has width 0 it will be counted as a square.