Skip to content

Commit

Permalink
chore: add implicit keyboard binding example
Browse files Browse the repository at this point in the history
  • Loading branch information
jarekdanielak authored and barmac committed Dec 20, 2024
1 parent 1db99b9 commit 3f27af2
Show file tree
Hide file tree
Showing 14 changed files with 4,813 additions and 0 deletions.
2 changes: 2 additions & 0 deletions embedding/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
public/
29 changes: 29 additions & 0 deletions embedding/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# bpmn-js embedding example

This example shows how different versions of the toolkit can be embedded easily into a HTML page.

Keyboard binding and focus handling is done natively, as you expect from other elements on the canvas. For more information see [pull request](https://github.com/bpmn-io/diagram-js/pull/662) and [changelog](https://github.com/bpmn-io/diagram-js/blob/develop/CHANGELOG.md#1500) for `diagram-js` v15.0.0.

## About

This example embedds different variants of the BPMN toolkit into a larger website. You can see how each instance of modeler only captures keyboard shortcuts when it's focused and doesn't interfer with other (native or custom) elements.

![demo application screenshot](https://raw.githubusercontent.com/bpmn-io/bpmn-js-examples/main/embedding/docs/screenshot.png "Screenshot of the example application")

## Building

You need a [NodeJS](http://nodejs.org) development stack with [npm](https://npmjs.org) installed to build the project.

To install all project dependencies execute

```
npm install
```

Spawn the demo by executing

```
npm start
```

Both tasks generate the distribution ready client-side modeler application into the `public` folder.
Binary file added embedding/docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3f27af2

Please sign in to comment.