search

clauderic / dnd-kit

The modern, lightweight, performant, accessible and extensible drag & drop toolkit for React.
http://dndkit.com
MIT License
13.09k stars 648 forks source link

Make examples easier to use and understand #778

Open rodolphoasb opened 2 years ago

rodolphoasb commented 2 years ago

Hey, @clauderic! How are you doing? Thank you so much for your work on this!

First, I'd like to say that the library performance seems great and it's super awesome the fact that I can customize a lot of things (e.g Collision detection algorithms).

IMO a huge piece of the library's success is the easier of use and the "onboarding" experience.

And as a new user, I feel like we could improve this... Storybook is good but, for example, if I want to create something similar to this, I need to enter here and here, and kinda guess what I need.

Recently, I started to use React Table, and the onboarding experience has been super good, most of it I attribute to fact that the examples are isolated and I'm able to use them live and see the entire code using codesandbox. This makes things a lot easier to understand.

Here's the example:

https://github.com/TanStack/table/tree/alpha/examples

I think it would improve a lot our docs and de DX if the examples were inside there and if it was easier to see the code behind it...

What do you think?! There's any way I could help you with this?

mariusrak commented 2 years ago

Hi. When I started using this library I've asked same as You are asking now. I received a response that @clauderic realizes this and it's part of a plan but there's too much to do. So everybody is welcomed to work on more explanatory and understandable examples that could be used and published. So consider whether you'd go for it and help out community with this.

Forfold commented 2 years ago

I'm having the same struggle as you @rodolphoasb in developing a vertical, sortable list. I'm using this example from their docs as a reference