Bpmn.js documentation

Where can i find the bpmn.js API documentation? Include eventlistener and canvas context operation…

1 Like

Hi, welcome!

Unfortunately, there is currently no dedicated API documentation. We hope to improve that in the future. In the meantime, the best approach would be to scan the several modules.

Hi, any updates on the API documentation? It’s really frustrating having to go through the examples and the repo trying to figure out what everything does…

2 Likes

I understand that the lack of documentation is a huge pain point. We will create documentation as soon as we find the time.

@philippfromme has there been progress on the API documentation?

There is some progress indeed. We now ship type declarations that allow you to get assistance in your favorite IDE.

We did not manage to progress on a documentation website.

2 Likes