projectstorm / react-diagrams

a super simple, no-nonsense diagramming library written in react that just works
https://projectstorm.cloud/react-diagrams
MIT License
8.74k stars 1.18k forks source link

code of more complex examples #157

Closed smeijer closed 6 years ago

smeijer commented 6 years ago

There are two awesome images shown in the README, of two more complex examples regarding custom controls. But I cannot find them in the demos folder or storybook.

Is this code somewhere available? Or if not, can it be made available?

I'm referring to the image below:

image

smeijer commented 6 years ago

Self-closing due to #56, still request for example similar to above screenshots stands.

tuckwat commented 6 years ago

Shouldn't the screenshots be removed considering it contains "nodes and widgets" (and functionality) which are missing from this open source project?

dylanvorster commented 6 years ago

can u explain what functionality is missing?

dylanvorster commented 6 years ago

The whole point of this library is that you can create your own nodes, which is what the screenshot shows.

smeijer commented 6 years ago

I do understand your point of view. But from the end users perspective, it just doesn't feel right.

We've been shown some awesome screenshots on the introduction page. But after the initial clone and fiddling around, there is nothing like that. There is a high learning curve, and a lot of work to be done before something like the screenshots is being achieved.

If you wish to show these screenshots, they should have been placed on a separate showcases page. Or at least moved to the bottom of the readme under a "showcases" chapter. Make it obvious that this is not what is present in the package, but that something like this can be build.

Currently, it feels like buying a big mac. It does satisfy most of the hunger, but it never looks like the picture.

Even after I've contributed a few PR's to this project, I've decided that the learning curve was to high, and it was to much work to get something that works for me. So I've switched to implementing jsPlumb instead (for now).

The posted screenshots gave me wrong expectations. I think that at the end, the wrong expectations do more harm than good.

Like I said, no hard feelings. This project still has some awesome goods. My advise; update the readme to correct the expectations.

ajthinking commented 6 years ago

I mostly agree with Dylan, and of course there should be epic pics in the readme. Though I see your point about expecting that out of the box.

@dylanvorster I am sending a PR that you might consider adding notes to the images: "Example implementation using custom models" "Get started with the default models right out of the box"

On a side note I think it would be nice with a list of "examples-in-the-wild".md where we can submit the results of using this awesome library. It would be really cool to see what other people have done with it and also might help clarify that this is mostly a base to extend upon.