Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

compose: Allow arrow navigation from restored drafts.

vighneshbhat9945c417cea5eb7a
diff --git a/web/src/compose_state.ts b/web/src/compose_state.ts
index 47e4af3034b..6e2ab11ac77 100644
--- a/web/src/compose_state.ts
+++ b/web/src/compose_state.ts
@@ -173,11 +173,20 @@ export const message_content = get_or_set("textarea#compose-textarea", true);
const untrimmed_message_content = get_or_set("textarea#compose-textarea", true, true);
+function cursor_at_start_of_content_in_compose(): boolean {
+ return $("textarea#compose-textarea").caret() === 0;
+}
+
function cursor_at_start_of_whitespace_in_compose(): boolean {
const cursor_position = $("textarea#compose-textarea").caret();
return message_content() === "" && cursor_position === 0;
}
+function cursor_at_end_of_content_in_compose(): boolean {
+ const cursor_position = $("textarea#compose-textarea").caret();
+ return cursor_position === untrimmed_message_content().length;
+}
+
export function focus_in_formatting_buttons(): boolean {
const is_focused_formatting_button =
document.activeElement?.classList.contains("compose_control_button");
@@ -232,6 +241,27 @@ export function focus_in_empty_compose(
return false;
}
+function focus_in_unedited_restored_draft(): boolean {
+ // A user pressing the Up Arrow at the start, or the Down Arrow at
+ // the end, of an unedited restored draft is most likely trying to
+ // navigate messages. The callers check the cursor position.
+ if (!composing()) {
+ return false;
+ }
+
+ // Only apply this check when focus is in the message textarea. The
+ // arrow keys have different semantics in other compose inputs.
+ return document.activeElement?.id === "compose-textarea" && is_content_unedited_restored_draft;
+}
+
+export function focus_at_start_of_unedited_restored_draft(): boolean {
+ return focus_in_unedited_restored_draft() && cursor_at_start_of_content_in_compose();
+}
+
+export function focus_at_end_of_unedited_restored_draft(): boolean {
+ return focus_in_unedited_restored_draft() && cursor_at_end_of_content_in_compose();
+}
+
export function private_message_recipient_emails(): string {
return compose_pm_pill.get_emails();
}
diff --git a/web/src/hotkey.ts b/web/src/hotkey.ts
index b458d9b701e..0e62e2d6d63 100644
--- a/web/src/hotkey.ts
+++ b/web/src/hotkey.ts
@@ -1082,7 +1082,10 @@ function process_hotkey(e: JQuery.KeyDownEvent, hotkey: Hotkey): boolean {
((event_name === "down_arrow" || event_name === "page_down" || event_name === "end") &&
compose_state.focus_in_empty_compose()) ||
((event_name === "up_arrow" || event_name === "page_up" || event_name === "home") &&
- compose_state.focus_in_empty_compose(true))
+ compose_state.focus_in_empty_compose(true)) ||
+ (event_name === "down_arrow" &&
+ compose_state.focus_at_end_of_unedited_restored_draft()) ||
+ (event_name === "up_arrow" && compose_state.focus_at_start_of_unedited_restored_draft())
) {
compose_actions.cancel();
// don't return, as we still want it to be picked up by the code below
diff --git a/web/tests/compose_actions.test.cjs b/web/tests/compose_actions.test.cjs
index c4ccfcb0369..a3f35d56d15 100644
--- a/web/tests/compose_actions.test.cjs
+++ b/web/tests/compose_actions.test.cjs
@@ -995,6 +995,64 @@ test("focus_in_empty_compose", () => {
assert.ok(!compose_state.focus_in_empty_compose());
});
+test("focus_at_start_of_unedited_restored_draft", () => {
+ document.activeElement = {id: "compose-textarea"};
+ compose_state.set_message_type("stream");
+ compose_state.set_is_content_unedited_restored_draft(true);
+ const $textarea = $("textarea#compose-textarea");
+ $textarea.val("hello");
+ $textarea.caret(0);
+ assert.ok(compose_state.focus_at_start_of_unedited_restored_draft());
+
+ compose_state.set_message_type(undefined);
+ assert.ok(!compose_state.focus_at_start_of_unedited_restored_draft());
+
+ compose_state.set_message_type("stream");
+ compose_state.set_is_content_unedited_restored_draft(false);
+ assert.ok(!compose_state.focus_at_start_of_unedited_restored_draft());
+
+ compose_state.set_is_content_unedited_restored_draft(true);
+ document.activeElement = {id: "stream_message_recipient_topic"};
+ assert.ok(!compose_state.focus_at_start_of_unedited_restored_draft());
+
+ document.activeElement = {id: "compose-textarea"};
+ $textarea.caret(3);
+ assert.ok(!compose_state.focus_at_start_of_unedited_restored_draft());
+
+ document.activeElement = undefined;
+ compose_state.set_is_content_unedited_restored_draft(false);
+ compose_state.set_message_type(undefined);
+});
+
+test("focus_at_end_of_unedited_restored_draft", () => {
+ document.activeElement = {id: "compose-textarea"};
+ compose_state.set_message_type("stream");
+ compose_state.set_is_content_unedited_restored_draft(true);
+ const $textarea = $("textarea#compose-textarea");
+ $textarea.val("hello");
+ $textarea.caret(5);
+ assert.ok(compose_state.focus_at_end_of_unedited_restored_draft());
+
+ compose_state.set_message_type(undefined);
+ assert.ok(!compose_state.focus_at_end_of_unedited_restored_draft());
+
+ compose_state.set_message_type("stream");
+ compose_state.set_is_content_unedited_restored_draft(false);
+ assert.ok(!compose_state.focus_at_end_of_unedited_restored_draft());
+
+ compose_state.set_is_content_unedited_restored_draft(true);
+ document.activeElement = {id: "stream_message_recipient_topic"};
+ assert.ok(!compose_state.focus_at_end_of_unedited_restored_draft());
+
+ document.activeElement = {id: "compose-textarea"};
+ $textarea.caret(3);
+ assert.ok(!compose_state.focus_at_end_of_unedited_restored_draft());
+
+ document.activeElement = undefined;
+ compose_state.set_is_content_unedited_restored_draft(false);
+ compose_state.set_message_type(undefined);
+});
+
test("on_narrow", ({override, override_rewire}) => {
let narrowed_by_topic_reply;
override(narrow_state, "narrowed_by_topic_reply", () => narrowed_by_topic_reply);