Development in the lib

1- Initialize the project by installing the packages with resource to:

npm run init

2- Run the src-code compiler:

npm start

3- In a seperate cli window run the following to see a live preview of the lib in a project:

cd example
npm start

Important notice

If you want to add Peer Dependencies to the library make sure to add as Dev Dependencies to your package.json so that they are installed locally, thus your compiler does not complain about missing libs: just check how it is being done on other external libs (e.g. React). Last but not least, be sure that when you add this library, to install all the Peer Dependencies. For the example project just check how its being done for the other libraries and follow.

@creditshelf/muuri-grid-engine

CS Muuri Grid

Introduction

Basic library that wraps the Muuri core for a more React dev friendly interface.

Installing the lib

npm install @creditshelf/muuri-grid-engine

Usage

import React from 'react';

import { ComponentInputs, MuuriGrid } from "@creditshelf/muuri-grid-engine";

...

const Example: React.FC<PropsInterface> = ({props}) => {

  // create a reference for the grid object
  const ref = React.useRef<any>(null);

  // example of how to make use of the grid object:
  // consult more on https://github.com/haltu/muuri
  // for a better understanding of the API
  const handleDelete = () => {
    const grid = ref.current?.grid;

    console.log(grid);
    grid.remove(grid.getItems(0), { removeElements: true });
  };

  // render the grid
  return (
    <>
      <button onClick={handleDelete}>Delete</button>
      <MuuriGrid ref={ref} componentsConfig={components} />
    </>
  );
}

License

MIT ©