gridstack-react-wrapper
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

gridstack-react-wrapper

gridstack-react-wrapper is a React wrapper for the popular Gridstack.js library. Gridstack.js is a JavaScript library designed to help developers create dynamic, resizable, and draggable grid layouts. This wrapper enables seamless integration of Gridstack.js with React applications, providing a declarative and easy-to-use API.

Table of Contents

Installation

To install gridstack-react-wrapper, you can use Yarn or npm:

yarn add gridstack-react-wrapper
# OR
npm install gridstack-react-wrapper
# OR
pnpm install gridstack-react-wrapper

Usage

Coming soon

Examples

Coming soon

Contributing

Contributions are welcome! Here are some ways you can contribute:

Reporting Bugs

If you encounter a bug, please create an issue with details about the bug and how to reproduce it. Include any relevant code snippets or screenshots.

Feature Requests

If you have an idea for a new feature or an enhancement, please create an issue with a detailed description of the feature and its potential use cases.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch from main (e.g., feature/new-component).
  3. Make your changes and commit them with clear and descriptive messages.

👉 We use gitmoji to help us write better commit messages. You can find a guide at https://gitmoji.dev/.

  1. Push your changes to your fork.
  2. Create a pull request from your forked repository to the main branch of this repository.

Development Setup

To set up the project for development, follow these steps:

  1. // TODO

Roadmap

  • [x] Add basic GridStack component
  • [ ] Add all GridStack API methods
  • [ ] Add vitest support
  • [ ] Add examples

Readme

Keywords

none

Package Sidebar

Install

npm i gridstack-react-wrapper

Weekly Downloads

4

Version

0.0.1

License

MIT

Unpacked Size

33.2 kB

Total Files

11

Last publish

Collaborators

  • damien-schneider