Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

ts: Migrate `settings_ui.js` to TypeScript.

This commit is contained in:
Junyao Chen 2023-08-04 03:58:55 -04:00 committed by Tim Abbott
parent 5151dd7ff8
commit 446aea41b3
2 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
tools/test-js-with-node
View File

@ -176,7 +176,7 @@ EXEMPT_FILES = make_set(
"web/src/settings_sections.js", "web/src/settings_sections.js",
"web/src/settings_streams.js", "web/src/settings_streams.js",
"web/src/settings_toggle.js", "web/src/settings_toggle.js",
"web/src/settings_ui.js", "web/src/settings_ui.ts",
"web/src/settings_user_groups_legacy.js", "web/src/settings_user_groups_legacy.js",
"web/src/settings_user_topics.js", "web/src/settings_user_topics.js",
"web/src/settings_users.js", "web/src/settings_users.js",

35
web/src/settings_ui.js → web/src/settings_ui.ts
View File

@ -4,9 +4,19 @@ import checkbox_image from "../images/checkbox-green.svg";
import {$t, $t_html} from "./i18n"; import {$t, $t_html} from "./i18n";
import * as loading from "./loading"; import * as loading from "./loading";
import type {AjaxRequestHandler} from "./types";
import * as ui_report from "./ui_report"; import * as ui_report from "./ui_report";
export function display_checkmark($elem) { type RequestOpts = {
success_msg_html?: string;
failure_msg_html?: string;
success_continuation?: (response_data: unknown) => void;
error_continuation?: (xhr: JQuery.jqXHR) => void;
sticky?: boolean;
$error_msg_element?: JQuery;
};
export function display_checkmark($elem: JQuery): void {
const check_mark = document.createElement("img"); const check_mark = document.createElement("img");
check_mark.src = checkbox_image; check_mark.src = checkbox_image;
$elem.prepend(check_mark); $elem.prepend(check_mark);
@ -18,15 +28,14 @@ export const strings = {
failure_html: $t_html({defaultMessage: "Save failed"}), failure_html: $t_html({defaultMessage: "Save failed"}),
saving: $t({defaultMessage: "Saving"}), saving: $t({defaultMessage: "Saving"}),
}; };
// Generic function for informing users about changes to the settings // Generic function for informing users about changes to the settings
// UI. Intended to replace the old system that was built around // UI. Intended to replace the old system that was built around
// direct calls to `ui_report`. // direct calls to `ui_report`.
export function do_settings_change( export function do_settings_change(
request_method, request_method: AjaxRequestHandler,
url, url: string,
data, data: Parameters<AjaxRequestHandler>[0]["data"],
status_element, status_element: string,
{ {
success_msg_html = strings.success_html, success_msg_html = strings.success_html,
failure_msg_html = strings.failure_html, failure_msg_html = strings.failure_html,
@ -34,8 +43,8 @@ export function do_settings_change(
error_continuation, error_continuation,
sticky = false, sticky = false,
$error_msg_element, $error_msg_element,
} = {}, }: RequestOpts = {},
) { ): void {
const $spinner = $(status_element).expectOne(); const $spinner = $(status_element).expectOne();
$spinner.fadeTo(0, 1); $spinner.fadeTo(0, 1);
loading.make_indicator($spinner, {text: strings.saving}); loading.make_indicator($spinner, {text: strings.saving});
@ -76,11 +85,11 @@ export function do_settings_change(
// * disable_on_uncheck is boolean, true if sub setting should be disabled // * disable_on_uncheck is boolean, true if sub setting should be disabled
// when main setting unchecked. // when main setting unchecked.
export function disable_sub_setting_onchange( export function disable_sub_setting_onchange(
is_checked, is_checked: boolean,
sub_setting_id, sub_setting_id: string,
disable_on_uncheck, disable_on_uncheck: boolean,
include_label, include_label: boolean,
) { ): void {
if ((is_checked && disable_on_uncheck) || (!is_checked && !disable_on_uncheck)) { if ((is_checked && disable_on_uncheck) || (!is_checked && !disable_on_uncheck)) {
$(`#${CSS.escape(sub_setting_id)}`).prop("disabled", false); $(`#${CSS.escape(sub_setting_id)}`).prop("disabled", false);
if (include_label) { if (include_label) {