feat(markdown-editor) : SHIFT+ENTER inserts a linebreak

[dselman]

Signed-off-by: Dan Selman danscode@selman.org

Closes #153

Also: #182
Also: #49
Also: #41

Changes

• Adds a keyboard handler for SHIFT+ENTER which inserts a LINEBREAK into the Slate DOM

Flags

• HTML copy/paste requires a fix in markdown-html

Screenshots or Video

https://www.loom.com/share/a1458a6fece0468088e2fef776e99d8f

[jolanglinais]

[jolanglinais]

One issue is you are unable to exit a block quote with pressing ENTER twice.

[Michael-Grover]

lgtm

[DianaLease]

One issue is you are unable to exit a block quote with pressing ENTER twice.

I can reproduce this too. In the deployed version, we are able to exit block quotes by hitting enter twice. In this one, we aren't. Exiting lists by hitting enter twice still works.

[Michael-Grover]

Pressing shift+enter right before a Clause Template causes an error

https://www.loom.com/share/fea2e40ff37d4ddfb885e90cc00854df

[Michael-Grover]

actually I'm getting this error more than just when I press shift+enter before a Clause Template, is anyone else experiencing this?

[dselman]

actually I'm getting this error more than just when I press shift+enter before a Clause Template, is anyone else experiencing this?

Can you create a new issue for this please? It sounds like this is not a regression introduced by this PR.

[dselman]

The issue breaking out of block quotes seems to be related to:
https://github.com/accordproject/web-components/blob/master/packages/ui-markdown-editor/src/lib/plugins/withLists.js

(It's pretty confusing that the withLists plugin is dealing with block quotes imo and that this is mixed up with hotkeys).

@DianaLease @irmerk I don't remember writing this — do either of you understand how this code works? It appears to be sensitive to the presence of the LINEBREAK node (which also have empty text), because breaking out of block quotes works until you insert a LINEBREAK, then it no longer works.

[dselman]

Pushed a fix to the problem breaking out of block quotes. The issue appears to be that after we insert a linebreak we get text nodes that don't have "object" : "text" set, so I've added some defensive checks for this.

[DianaLease]

This fixes the escaping block quote issue! Looks like we need to also fix the issue Michael mentioned. I can reproduce getting this error in the Contract Editor component when hitting shift+enter:

Cannot read property 'src' of undefined

[DianaLease]

This fixes the escaping block quote issue! Looks like we need to also fix the issue Michael mentioned. I can reproduce getting this error in the Contract Editor component when hitting shift+enter:

Cannot read property 'src' of undefined

I think it is specific to this PR as I can only reproduce it in the netlify for this PR. @Michael-Grover, what did you mean by actually I'm getting this error more than just when I press shift+enter before a Clause Template? Can you only reproduce it by hitting shift + enter in other places or by doing things besides shift + enter? And can you reproduce it in the currently deployed version of web-components?

[Michael-Grover]

I can reproduce it by pressing shift+enter in other places, not just directly before the Smart Clause. The error appears to only happen in this PR. I tried it in https://ap-web-components.netlify.app/?path=/story/contract-editor--contract-editor and did not encounter the error.

[dselman]

Copy/paste support for line breaks requires merging this PR and releasing markdown-html
accordproject/markdown-transform#325

[DianaLease]

LGTM