Allow toggling CTRL+Enter vs Enter to send ChatAreaInput #6592

ea42gh · 2024-03-27T01:46:14Z

current state with console.log statements....

ahuang11 · 2024-03-27T03:38:56Z

Thanks!

That looks right to me; I'd recommend creating a new env for Panel dev. Also, clearing browser console.

https://panel.holoviz.org/developer_guide/index.html#installing-the-project

Lastly, I'm hesitant on a three word keyword, maybe enter_sends?

ahuang11 · 2024-03-27T14:08:15Z

panel/models/chatarea_input.ts

@@ -45,7 +52,8 @@ export class ChatAreaInputView extends PnTextAreaInputView {
 export namespace ChatAreaInput {
  export type Attrs = p.AttrsOf<Props>
  export type Props = PnTextAreaInput.Props & {
-    disabled_enter: p.Property<boolean>
+    disabled_enter: p.Property<boolean>,
+    shift_enter_sends: p.Property<boolean>,


This needs to be updated to enter_sends too

ahuang11 · 2024-03-27T14:08:21Z

panel/models/chatarea_input.ts

@@ -65,6 +73,7 @@ export class ChatAreaInput extends PnTextAreaInput {
    this.define<ChatAreaInput.Props>(({Bool}) => {
      return {
        disabled_enter: [ Bool, false ],
+        shift_enter_sends: [ Bool, false ],


ea42gh · 2024-03-27T15:19:21Z

changed the parameter name to enter_sends, and added the notebook - will need some changes eventually
got some problems...

how do I update a PR with whatever my current code is? I clicked the update branch button, hope that is it?!
if you run the notebook, there are a number of issues when using the final output cell:
- default version of the code: does not appear to allow multiline inputs?
- when shift enter is enabled:
  - the callback to set the output is disabled somehow
  - executing shift-enter redraws the whole output cell
  How do I track down why this happens?

ahuang11 · 2024-03-27T15:29:28Z

examples/reference/chat/ChatAreaInput.ipynb

@@ -60,7 +61,7 @@
   "source": [
    "#### Basics\n",
    "\n",
-    "To submit a message, press the Enter key."
+    "To submit a message, press the Enter key if **``shift_enter_sends``** is False, else press Shift-Enter."


Suggested change

"To submit a message, press the Enter key if **``shift_enter_sends``** is False, else press Shift-Enter."

"To submit a message, press the Enter key if **``enter_sends``** is True, else press Shift-Enter."

ahuang11 · 2024-03-27T15:30:34Z

panel/chat/input.py

+
+    enter_sends = param.Boolean(
+        default=True,
+        doc="If False, the shift_enter key will send the message rather than the enter key.",


Suggested change

doc="If False, the shift_enter key will send the message rather than the enter key.",

doc="If True, pressing the Enter key will send the message; if False, Shift+Enter will send the message.",

ahuang11 · 2024-03-27T15:30:52Z

panel/chat/input.py

@@ -44,7 +44,12 @@ class ChatAreaInput(_PnTextAreaInput):

    disabled_enter = param.Boolean(
        default=False,
-        doc="If True, the enter key will not submit the message (clear the value).",
+        doc="If True, disables sending the message by pressing the enter or the shift_enter key (clear the value).",


Suggested change

doc="If True, disables sending the message by pressing the enter or the shift_enter key (clear the value).",

doc="If True, disables sending the message by pressing the Enter or Shift+Enter key (clear the value).",

ahuang11 · 2024-03-27T15:35:42Z

If something is not working properly, I'd also check: event.preventDefault() which disables any inputs, but this is looking good so far!

ahuang11 · 2024-03-27T15:43:14Z

panel/models/chatarea_input.ts

+      console.log( "DBG: keydown event", event.key )
+      if (event.key === "Enter" && (  (!event.shiftKey &&  this.model.enter_sends)
+                                   || ( event.shiftKey && !this.model.enter_sends))
+      ) {
+        console.log( ".  enter_sends:     ", event.shiftKey && !this.model.enter_sends )


Maybe if you swap it?

Suggested change

console.log( "DBG: keydown event", event.key )

if (event.key === "Enter" && ( (!event.shiftKey && this.model.enter_sends)

|| ( event.shiftKey && !this.model.enter_sends))

) {

console.log( ". enter_sends: ", event.shiftKey && !this.model.enter_sends )

if (event.key === "Enter" && (

(event.shiftKey && !this.model.enter_sends) ||

(!event.shiftKey && this.model.enter_sends)

)) {

if (!this.model.disabled_enter) {

console.log(". . FIRE: ", this.model.value_input)

this.model.trigger_event(new ChatMessageEvent(this.model.value_input))

this.model.value_input = ""

}

event.preventDefault()

}

})

mattpap · 2024-03-27T15:46:35Z

panel/models/chatarea_input.ts

+      if (event.key === "Enter" && (  (!event.shiftKey &&  this.model.enter_sends)
+                                   || ( event.shiftKey && !this.model.enter_sends))


As a suggestion, this xor can be written more concisely as:

Suggested change

if (event.key === "Enter" && ( (!event.shiftKey && this.model.enter_sends)

|| ( event.shiftKey && !this.model.enter_sends))

if (event.key === "Enter" && event.shiftKey != this.model.enter_sends)

Hmm, nice! It will need a comment though: I had to really stare at it
to figure out what it does :-)

…panel into chat_shift_enter_to_send

ea42gh · 2024-03-27T16:58:42Z

Shift-Enter appears bound to rerun the current cell in the notebook.

I was able to make this work with Ctrl-Enter instead.

ahuang11 · 2024-03-27T17:37:21Z

Shift-Enter appears bound to rerun the current cell in the notebook.
I was able to make this work with Ctrl-Enter instead.

Hmm let's keep shift enter with the hope that this is fixed: #6394

ea42gh · 2024-03-27T18:03:30Z

Shift vs Ctrl Enter:
the change to the code would be trivial.
Replace all occurrences of "Ctrl" with "Shift" in the four files involved.

Right now, Ctrl does work, and would be consistent with the
Jupyter binding "Execute Cell and Stay in Cell"
Personally, I would not care whether Send is bound to Ctrl-Enter or Shift-Enter,
as it would not make me inadvertently send an incomplete message.

I would like to make one more edit to the Jupyter notebook though:
When send is bound to Enter, how do I create a multiline input
in the ChatAreaInput? I have not been able to make it work!

ahuang11 · 2024-03-27T18:05:23Z

Are you able to press shift+enter to start new lines? Also try working outside of the notebook (call .show() on the obj in the notebook)

Try the suggestion from #6592 (comment)

ea42gh · 2024-03-27T18:43:50Z

Are you able to press shift+enter to start new lines? Also try working outside of the notebook (call .show() on the obj in the notebook)

Try the suggestion from #6592 (comment)

I did implement it and left the previous logic as a comment
You can serve the notebook; it does work as expected.
Typing Shift-Enter when enter_sends is True does not work: it reruns the cell instead, i.e.,
there is no way of entering a multiline prompt with the current code

ea42gh · 2024-04-09T18:06:53Z

@ahuang11 anything I need to do here?
I don't see how the current code affects the failing tests?

ahuang11 · 2024-04-09T18:09:02Z

Sorry, I'll get to this today! No need to keep updating the branch.

ahuang11

Looks really nice! Just wording clean up and I believe we can merge after if all tests passes!

I recommend using Add suggestion to batch functionality to commit if you agree with the changes.

examples/reference/chat/ChatAreaInput.ipynb

panel/chat/input.py

panel/models/chatarea_input.py

panel/chat/input.py

examples/reference/chat/ChatAreaInput.ipynb

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

ahuang11 · 2024-04-09T18:48:35Z

(Encourage you to use the Add suggestion to batch or else it triggers many many commits)

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

ea42gh · 2024-04-09T18:49:23Z

unfortunately add suggestions to batch was greyed out?!

ahuang11 · 2024-04-09T18:50:25Z

Usually have to do it in Files changed tab. I suppose I could've mentioned that.

examples/reference/chat/ChatAreaInput.ipynb

ahuang11 · 2024-04-09T19:56:40Z

Great thank you for adding this!

ea42gh added 2 commits March 26, 2024 21:44

incomplete

870a8fa

fixed spelling, better log message, weird update behavior

96a3157

philippjfr marked this pull request as draft March 27, 2024 09:53

ea42gh added 4 commits March 27, 2024 08:55

update log messages

d8ead2f

update log messages

1aac3c5

update log messages

f388857

Merge branch 'main' into chat_shift_enter_to_send

db51616

ahuang11 reviewed Mar 27, 2024

View reviewed changes

update shift_enter_sends variable name

841453b

ahuang11 reviewed Mar 27, 2024

View reviewed changes

mattpap reviewed Mar 27, 2024

View reviewed changes

ea42gh added 3 commits March 27, 2024 12:49

working code

2856bea

Merge branch 'main' into chat_shift_enter_to_send

fd68671

Merge branch 'chat_shift_enter_to_send' of https://github.com/ea42gh/…

f135b22

…panel into chat_shift_enter_to_send

ea42gh marked this pull request as ready for review March 27, 2024 16:58

fixed lint complaints

ded25f4

ahuang11 changed the title ~~incomplete~~ Allow toggling Shift+Enter vs Enter to send ChatAreaInput Mar 27, 2024

fixed lint complaints

4d23950

ea42gh added 2 commits April 8, 2024 12:14

Merge branch 'main' into chat_shift_enter_to_send

dd0d50c

Merge branch 'main' into chat_shift_enter_to_send

ca218e2

Merge branch 'main' into chat_shift_enter_to_send

3559d6b

ahuang11 requested changes Apr 9, 2024

View reviewed changes

ea42gh and others added 7 commits April 9, 2024 14:47

Update examples/reference/chat/ChatAreaInput.ipynb

8a91014

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

Update examples/reference/chat/ChatAreaInput.ipynb

40732d6

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

Update panel/chat/input.py

20841e2

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

Update examples/reference/chat/ChatAreaInput.ipynb

e8a82ae

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

Update examples/reference/chat/ChatAreaInput.ipynb

82db2ef

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

Update panel/chat/input.py

06a37e8

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

Update panel/models/chatarea_input.py

c31bd75

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

Update panel/models/chatarea_input.py

ec31e88

Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>

ahuang11 reviewed Apr 9, 2024

View reviewed changes

examples/reference/chat/ChatAreaInput.ipynb Outdated Show resolved Hide resolved

Update examples/reference/chat/ChatAreaInput.ipynb

9ebbd2d

ahuang11 reviewed Apr 9, 2024

View reviewed changes

examples/reference/chat/ChatAreaInput.ipynb Outdated Show resolved Hide resolved

Update examples/reference/chat/ChatAreaInput.ipynb

003c44f

ahuang11 reviewed Apr 9, 2024

View reviewed changes

examples/reference/chat/ChatAreaInput.ipynb Outdated Show resolved Hide resolved

Update examples/reference/chat/ChatAreaInput.ipynb

34c13fa

ahuang11 reviewed Apr 9, 2024

View reviewed changes

examples/reference/chat/ChatAreaInput.ipynb Outdated Show resolved Hide resolved

Update examples/reference/chat/ChatAreaInput.ipynb

149c4bd

ahuang11 approved these changes Apr 9, 2024

View reviewed changes

ahuang11 merged commit defe76a into holoviz:main Apr 9, 2024
14 checks passed

philippjfr mentioned this pull request Apr 19, 2024

Add release notes for 1.4.2 #6765

Merged

ahuang11 mentioned this pull request Jun 13, 2024

pn.chat.ChatAreaInput <Enter> key binding Feature Request #6575

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow toggling CTRL+Enter vs Enter to send ChatAreaInput #6592

Allow toggling CTRL+Enter vs Enter to send ChatAreaInput #6592

ea42gh commented Mar 27, 2024

ahuang11 commented Mar 27, 2024 •

edited

Loading

ahuang11 Mar 27, 2024

ahuang11 Mar 27, 2024

ea42gh commented Mar 27, 2024 •

edited

Loading

ahuang11 Mar 27, 2024

ahuang11 Mar 27, 2024 •

edited

Loading

ahuang11 Mar 27, 2024

ahuang11 commented Mar 27, 2024 •

edited

Loading

ahuang11 Mar 27, 2024

mattpap Mar 27, 2024

ea42gh Mar 27, 2024

ea42gh commented Mar 27, 2024

ahuang11 commented Mar 27, 2024 •

edited

Loading

ea42gh commented Mar 27, 2024

ahuang11 commented Mar 27, 2024 •

edited

Loading

ea42gh commented Mar 27, 2024

ea42gh commented Apr 9, 2024

ahuang11 commented Apr 9, 2024

ahuang11 left a comment •

edited

Loading

ahuang11 commented Apr 9, 2024

ea42gh commented Apr 9, 2024

ahuang11 commented Apr 9, 2024

ahuang11 commented Apr 9, 2024

	"To submit a message, press the Enter key if ``shift_enter_sends`` is False, else press Shift-Enter."
	"To submit a message, press the Enter key if ``enter_sends`` is True, else press Shift-Enter."

	doc="If False, the shift_enter key will send the message rather than the enter key.",
	doc="If True, pressing the Enter key will send the message; if False, Shift+Enter will send the message.",

	doc="If True, disables sending the message by pressing the enter or the shift_enter key (clear the value).",
	doc="If True, disables sending the message by pressing the Enter or Shift+Enter key (clear the value).",

		if (event.key === "Enter" && ( (!event.shiftKey && this.model.enter_sends)
		\|\| ( event.shiftKey && !this.model.enter_sends))

	if (event.key === "Enter" && ( (!event.shiftKey && this.model.enter_sends)
	\|\| ( event.shiftKey && !this.model.enter_sends))
	if (event.key === "Enter" && event.shiftKey != this.model.enter_sends)

Allow toggling CTRL+Enter vs Enter to send ChatAreaInput #6592

Allow toggling CTRL+Enter vs Enter to send ChatAreaInput #6592

Conversation

ea42gh commented Mar 27, 2024

ahuang11 commented Mar 27, 2024 • edited Loading

ahuang11 Mar 27, 2024

Choose a reason for hiding this comment

ahuang11 Mar 27, 2024

Choose a reason for hiding this comment

ea42gh commented Mar 27, 2024 • edited Loading

ahuang11 Mar 27, 2024

Choose a reason for hiding this comment

ahuang11 Mar 27, 2024 • edited Loading

Choose a reason for hiding this comment

ahuang11 Mar 27, 2024

Choose a reason for hiding this comment

ahuang11 commented Mar 27, 2024 • edited Loading

ahuang11 Mar 27, 2024

Choose a reason for hiding this comment

mattpap Mar 27, 2024

Choose a reason for hiding this comment

ea42gh Mar 27, 2024

Choose a reason for hiding this comment

ea42gh commented Mar 27, 2024

ahuang11 commented Mar 27, 2024 • edited Loading

ea42gh commented Mar 27, 2024

ahuang11 commented Mar 27, 2024 • edited Loading

ea42gh commented Mar 27, 2024

ea42gh commented Apr 9, 2024

ahuang11 commented Apr 9, 2024

ahuang11 left a comment • edited Loading

Choose a reason for hiding this comment

ahuang11 commented Apr 9, 2024

ea42gh commented Apr 9, 2024

ahuang11 commented Apr 9, 2024

ahuang11 commented Apr 9, 2024

ahuang11 commented Mar 27, 2024 •

edited

Loading

ea42gh commented Mar 27, 2024 •

edited

Loading

ahuang11 Mar 27, 2024 •

edited

Loading

ahuang11 commented Mar 27, 2024 •

edited

Loading

ahuang11 commented Mar 27, 2024 •

edited

Loading

ahuang11 commented Mar 27, 2024 •

edited

Loading

ahuang11 left a comment •

edited

Loading