ng2-dnd icon indicating copy to clipboard operation
ng2-dnd copied to clipboard

Better documentation

Open moniuch opened this issue 6 years ago • 4 comments

  • I'm submitting a ... [ ] bug report [x] feature request [ ] question about the decisions made in the repository

  • Do you want to request a feature or report a bug? It is basically a request for better documentation.

When starting to implementing the module in my app I looked at many examples you provide (plnkr, snippets in readme) and couldn't see clear info on:

  • list of callbacks (grouped by directives) and when they are triggered
  • list of classes that are dynamically appended to elements (container, dragged items) as the drag is being carried out
  • information how to enable/disable drag/drop temporarily, such as maybe [dnd-sortable]="isLoading$ | async"

While the module works really great for me, I find it a real hurdle in my way to have to dig the source code hunting for know-how hints.

moniuch avatar Mar 08 '18 11:03 moniuch

@moniuch where you able to use the directive with the async pipe?

I'm having trouble getting it to work :|

jjreisfl avatar Apr 09 '18 22:04 jjreisfl

For starters, components like SortableContainer should be documented.

Chealer avatar Aug 10 '21 19:08 Chealer

@Chealer I think the date of last commit (Aug 2018) says a lot about what we could expect from this project.

moniuch avatar Aug 11 '21 21:08 moniuch

@moniuch where you able to use the directive with the async pipe?

I'm having trouble getting it to work :|

@jjreisfl Sorry for a really late reply, but no - I didn't.

moniuch avatar Aug 11 '21 21:08 moniuch