Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate dmn-js@17 / diagram-js@15 (implicit keyboard binding) #132

Merged
merged 7 commits into from
Nov 15, 2024

Conversation

nikku
Copy link
Member

@nikku nikku commented Nov 8, 2024

Proposed Changes

Update to latest diagram-js and dmn-js versions.

Incorporates implicit keyboard / focusable canvas.

Child of https://github.com/bpmn-io/internal-docs/issues/1081.

Checklist

To ensure you provided everything we need to look at your PR:

  • Brief textual description of the changes present
  • Visual demo attached
  • Steps to try out present, i.e. using the @bpmn-io/sr tool
  • Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

@nikku nikku requested review from jarekdanielak, a team and abdul99ahad and removed request for a team November 8, 2024 09:39
@bpmn-io-tasks bpmn-io-tasks bot added the needs review Review pending label Nov 8, 2024
@nikku nikku added the dependencies Updates a dependency label Nov 8, 2024
@barmac
Copy link
Collaborator

barmac commented Nov 14, 2024

I tested this locally, and apparently undo/redo shortcut does not work in dmn-js@17 but it works in dmn-js@16.

@barmac
Copy link
Collaborator

barmac commented Nov 14, 2024

Oh ok, this is due to bpmn-io/dmn-js#920

@jarekdanielak jarekdanielak requested a review from barmac November 15, 2024 10:17
@jarekdanielak
Copy link
Contributor

@barmac ready for review.

CHANGELOG.md Outdated

### Breaking Changes

* Keyboard is now implicit, and canvas is focusable, cf. [bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Keyboard is now implicit, and canvas is focusable, cf. [bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662))
* Keyboard is now bound implicitly, and canvas is focusable, cf. [bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662)). Calls to `keyboard.bind` and `keyboard.bindTo` now result with a descriptive console error and have no effect.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually not all new calls to bind will result in an error. Proposed a better message in a4faee3

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update camunda-bpmn-js changelog in that case: https://github.com/camunda/camunda-bpmn-js/blob/main/CHANGELOG.md#breaking-changes

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be clear: I'd like us to anchor at "do not use these APIs anymore", rather than "you can continue to use them.

I think the old changelog entries + descriptive error on mis-use were OK already. To simplify this message it could read:

* Keyboard is now bound implicitly, and canvas is focusable, cf. [bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662)). Attempts to bind the keyboard to an explicit HTML element have no effect.

Copy link
Collaborator

@barmac barmac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Giving we have an issue for the limitation from bpmn-io/dmn-js#921 (review), this is ready to merge.

@jarekdanielak jarekdanielak merged commit 365b5ca into main Nov 15, 2024
11 checks passed
@jarekdanielak jarekdanielak deleted the housekeeping branch November 15, 2024 12:32
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Updates a dependency
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants