paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-14 19:06:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

dialog_widget: Assign each dialog widget a unique id.

Browse Source 
This makes it easy to check if the correct dialog widget is open
and to perform actions based on the state of dialog widget in
async callbacks.
This commit is contained in:
Aman Agrawal
2024-05-15 06:38:06 +00:00
committed by Tim Abbott
parent ab0fc402e0
commit e51962d6ac
10 changed files with 66 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
web/src/dialog_widget.ts
View File

@@ -9,6 +9,21 @@ import * as loading from "./loading";
import * as modals from "./modals";
import * as ui_report from "./ui_report";
// Since only one dialog widget can be active at a time
// and we don't support reopening already closed dialog widgets,
// this is also the id of the current / last open dialog widget.
// We will use this as id for current dialog widget assuming
// the caller has already checked that the dialog widget is open.
let widget_id_counter = 0;
function current_dialog_widget_id(): string {
return `dialog_widget_modal_${widget_id_counter}`;
}
function current_dialog_widget_selector(): string {
return `#${current_dialog_widget_id()}`;
}
/*
* Look for confirm_dialog in settings_user_groups
* to see an example of how to use this widget. It's
@@ -60,7 +75,7 @@ export type DialogWidgetConfig = {
on_shown?: () => void;
on_hide?: () => void;
on_hidden?: () => void;
post_render?: () => void;
post_render?: (modal_unique_id: string) => void;
loading_spinner?: boolean;
update_submit_disabled_state_on_change?: boolean;
always_visible_scrollbar?: boolean;
@@ -74,17 +89,19 @@ type RequestOpts = {
export function hide_dialog_spinner(): void {
$(".dialog_submit_button span").show();
$("#dialog_widget_modal .modal__btn").prop("disabled", false);
const dialog_widget_selector = current_dialog_widget_selector();
$(`${dialog_widget_selector} .modal__btn`).prop("disabled", false);
const $spinner = $("#dialog_widget_modal .modal__spinner");
const $spinner = $(`${dialog_widget_selector} .modal__spinner`);
loading.destroy_indicator($spinner);
}
export function show_dialog_spinner(): void {
const dialog_widget_selector = current_dialog_widget_selector();
// Disable both the buttons.
$("#dialog_widget_modal .modal__btn").prop("disabled", true);
$(`${dialog_widget_selector} .modal__btn`).prop("disabled", true);
const $spinner = $("#dialog_widget_modal .modal__spinner");
const $spinner = $(`${dialog_widget_selector} .modal__spinner`);
const dialog_submit_button_span_width = $(".dialog_submit_button span").width();
const dialog_submit_button_span_height = $(".dialog_submit_button span").height();
@@ -100,10 +117,10 @@ export function show_dialog_spinner(): void {
// Supports a callback to be called once the modal finishes closing.
export function close(on_hidden_callback?: () => void): void {
modals.close("dialog_widget_modal", {on_hidden: on_hidden_callback});
modals.close(current_dialog_widget_id(), {on_hidden: on_hidden_callback});
}
export function launch(conf: DialogWidgetConfig): void {
export function launch(conf: DialogWidgetConfig): string {
// Mandatory fields:
// * html_heading
// * html_body
@@ -135,9 +152,12 @@ export function launch(conf: DialogWidgetConfig): void {
// has scrollable content. Default behaviour is to hide the scrollbar when it is
// not in use.
widget_id_counter += 1;
const modal_unique_id = current_dialog_widget_id();
const html_submit_button = conf.html_submit_button ?? $t_html({defaultMessage: "Save changes"});
const html_exit_button = conf.html_exit_button ?? $t_html({defaultMessage: "Cancel"});
const html = render_dialog_widget({
modal_unique_id,
heading_text: conf.html_heading,
link: conf.help_link,
html_submit_button,
@@ -151,7 +171,7 @@ export function launch(conf: DialogWidgetConfig): void {
$("body").append($dialog);
if (conf.post_render !== undefined) {
conf.post_render();
conf.post_render(modal_unique_id);
}
const $submit_button = $dialog.find(".dialog_submit_button");
@@ -219,7 +239,7 @@ export function launch(conf: DialogWidgetConfig): void {
conf.on_click(e);
});
modals.open("dialog_widget_modal", {
modals.open(modal_unique_id, {
autoremove: true,
on_show() {
if (conf.focus_submit_on_open) {
@@ -233,6 +253,7 @@ export function launch(conf: DialogWidgetConfig): void {
on_shown: conf?.on_shown,
on_hidden: conf?.on_hidden,
});
return modal_unique_id;
}
export function submit_api_request(