From c5cc4fb114edfa7cf495ab820238ccb368fbd2a1 Mon Sep 17 00:00:00 2001
From: Sahil Batra <sahil@zulip.com>
Date: Wed, 18 Aug 2021 15:40:12 +0530
Subject: [PATCH] settings: Refactor default-language modal code.

We add a prefix to id of default_language_modal.hbs
such that we can use the same code for user settings
and realm-level settings.
We also add a class "default_language_modal" to the
modal div to avoid duplicate css.
---
 frontend_tests/puppeteer_tests/settings.ts    |  2 +-
 static/js/settings_display.js                 | 54 ++++++++++---------
 static/styles/settings.css                    |  2 +-
 static/templates/default_language_modal.hbs   |  6 +--
 .../templates/settings/display_settings.hbs   |  2 +-
 5 files changed, 35 insertions(+), 31 deletions(-)

diff --git a/frontend_tests/puppeteer_tests/settings.ts b/frontend_tests/puppeteer_tests/settings.ts
index cde2d63195..28ec5ef93b 100644
--- a/frontend_tests/puppeteer_tests/settings.ts
+++ b/frontend_tests/puppeteer_tests/settings.ts
@@ -301,7 +301,7 @@ async function test_alert_words_section(page: Page): Promise<void> {
 async function change_language(page: Page, language_data_code: string): Promise<void> {
     await page.waitForSelector("#user-display-settings .default_language", {visible: true});
     await page.click("#user-display-settings .default_language");
-    await page.waitForSelector("#default_language_modal", {visible: true});
+    await page.waitForSelector("#user_default_language_modal", {visible: true});
     const language_selector = `a[data-code="${CSS.escape(language_data_code)}"]`;
     await page.click(language_selector);
 }
diff --git a/static/js/settings_display.js b/static/js/settings_display.js
index dd8e341c88..3635aaef85 100644
--- a/static/js/settings_display.js
+++ b/static/js/settings_display.js
@@ -41,6 +41,8 @@ function change_display_setting(data, status_element, success_msg_html, sticky)
 export function set_up() {
     meta.loaded = true;
     const container = $("#user-display-settings");
+    const language_modal_elem = "#user_default_language_modal";
+
     container.find(".display-settings-status").hide();
 
     container.find(".demote_inactive_streams").val(user_settings.demote_inactive_streams);
@@ -57,8 +59,8 @@ export function set_up() {
         .find(`.emojiset_choice[value="${CSS.escape(user_settings.emojiset)}"]`)
         .prop("checked", true);
 
-    $("#default_language_modal [data-dismiss]").on("click", () => {
-        overlays.close_modal("#default_language_modal");
+    $(`${CSS.escape(language_modal_elem)} [data-dismiss]`).on("click", () => {
+        overlays.close_modal(language_modal_elem);
     });
 
     const all_display_settings = settings_config.get_all_display_settings();
@@ -86,36 +88,38 @@ export function set_up() {
         });
     }
 
-    $("#default_language_modal .language").on("click", (e) => {
-        e.preventDefault();
-        e.stopPropagation();
-        overlays.close_modal("#default_language_modal");
+    $(language_modal_elem)
+        .find(".language")
+        .on("click", (e) => {
+            e.preventDefault();
+            e.stopPropagation();
+            overlays.close_modal(language_modal_elem);
 
-        const $link = $(e.target).closest("a[data-code]");
-        const setting_value = $link.attr("data-code");
-        const data = {default_language: setting_value};
+            const $link = $(e.target).closest("a[data-code]");
+            const setting_value = $link.attr("data-code");
+            const data = {default_language: setting_value};
 
-        const new_language = $link.attr("data-name");
-        container.find(".default_language_name").text(new_language);
+            const new_language = $link.attr("data-name");
+            container.find(".default_language_name").text(new_language);
 
-        change_display_setting(
-            data,
-            "#user-display-settings .language-settings-status",
-            $t_html(
-                {
-                    defaultMessage:
-                        "Saved. Please <z-link>reload</z-link> for the change to take effect.",
-                },
-                {"z-link": (content_html) => `<a class='reload_link'>${content_html}</a>`},
-            ),
-            true,
-        );
-    });
+            change_display_setting(
+                data,
+                "#user-display-settings .language-settings-status",
+                $t_html(
+                    {
+                        defaultMessage:
+                            "Saved. Please <z-link>reload</z-link> for the change to take effect.",
+                    },
+                    {"z-link": (content_html) => `<a class='reload_link'>${content_html}</a>`},
+                ),
+                true,
+            );
+        });
 
     container.find(".default_language").on("click", (e) => {
         e.preventDefault();
         e.stopPropagation();
-        overlays.open_modal("#default_language_modal");
+        overlays.open_modal(language_modal_elem);
     });
 
     container.find(".demote_inactive_streams").on("change", function () {
diff --git a/static/styles/settings.css b/static/styles/settings.css
index c6140543a6..babcad771a 100644
--- a/static/styles/settings.css
+++ b/static/styles/settings.css
@@ -342,7 +342,7 @@ td .button {
         text-decoration: none;
     }
 
-    #default_language_modal {
+    .default_language_modal {
         table {
             width: 90%;
             margin-top: 20px;
diff --git a/static/templates/default_language_modal.hbs b/static/templates/default_language_modal.hbs
index 58d79beaf2..a6c48988ee 100644
--- a/static/templates/default_language_modal.hbs
+++ b/static/templates/default_language_modal.hbs
@@ -1,8 +1,8 @@
-<div id="default_language_modal" class="modal hide modal-bg fade" tabindex="-1" role="dialog"
-  aria-labelledby="default_language_modal_label" aria-hidden="true">
+<div id="{{prefix}}default_language_modal" class="modal hide modal-bg fade default_language_modal" tabindex="-1" role="dialog"
+  aria-labelledby="{{prefix}}default_language_modal_label" aria-hidden="true">
     <div class="modal-header">
         <button type="button" class="close" data-dismiss="modal" aria-label="{{t 'Close' }}"><span aria-hidden="true">&times;</span></button>
-        <h3 id="default_language_modal_label">{{t "Select default language" }}</h3>
+        <h3 id="{{prefix}}default_language_modal_label">{{t "Select default language" }}</h3>
     </div>
     <div class="modal-body">
         <p>
diff --git a/static/templates/settings/display_settings.hbs b/static/templates/settings/display_settings.hbs
index 746efce33f..b333598e6d 100644
--- a/static/templates/settings/display_settings.hbs
+++ b/static/templates/settings/display_settings.hbs
@@ -13,7 +13,7 @@
             </button>
         </div>
 
-        {{> ../default_language_modal language_list=language_list_dbl_col}}
+        {{> ../default_language_modal language_list=language_list_dbl_col prefix=prefix}}
     </div>
 
     <div class="display-settings">