zulip/static/js/confirm_dialog.js

112 lines
3.3 KiB
JavaScript

import $ from "jquery";
import render_confirm_dialog from "../templates/confirm_dialog.hbs";
import render_confirm_dialog_heading from "../templates/confirm_dialog_heading.hbs";
import * as blueslip from "./blueslip";
import * as loading from "./loading";
import * as overlays from "./overlays";
/*
Look for confirm_dialog in settings_user_groups
to see an example of how to use this widget. It's
pretty simple to use!
Some things to note:
1) We create DOM on the fly, and we remove
the DOM once it's closed.
2) We attach the DOM for the modal to conf.parent,
and this temporary DOM location will influence
how styles work.
3) The cancel button is driven by bootstrap.js.
4) For settings, we have a click handler in settings.js
that will close the dialog via overlays.close_active_modal.
5) We assume that since this is a modal, you will
only ever have one confirm dialog active at any
time.
6) If a modal wants a loading spinner, it should pass loading_spinner: true
and manage the spinner via calling the functions hide_confirm_dialog_spinner
and show_confirm_dialog_spinner via its callback hooks.
*/
export function hide_confirm_dialog_spinner() {
const spinner = $("#confirm_dialog_spinner");
loading.destroy_indicator(spinner);
$("#confirm_dialog_modal > div.modal-footer > button").show();
}
export function show_confirm_dialog_spinner() {
const spinner = $("#confirm_dialog_spinner");
$("#confirm_dialog_modal > div.modal-footer > button").hide();
loading.make_indicator(spinner);
}
export function launch(conf) {
const html = render_confirm_dialog({fade: conf.fade});
const confirm_dialog = $(html);
const conf_fields = [
// The next three fields should be safe HTML. If callers
// interpolate user data into strings, they should use
// templates.
"html_heading",
"html_body",
"html_yes_button",
"on_click",
"parent",
];
for (const f of conf_fields) {
if (conf[f] === undefined) {
blueslip.error("programmer omitted " + f);
}
}
conf.parent.append(confirm_dialog);
// Close any existing modals--on settings screens you can
// have multiple buttons that need confirmation.
if (overlays.is_modal_open()) {
overlays.close_modal("#confirm_dialog_modal");
}
confirm_dialog.find(".confirm_dialog_heading").html(
render_confirm_dialog_heading({
heading_text: conf.html_heading,
link: conf.help_link,
}),
);
confirm_dialog.find(".confirm_dialog_body").prepend(conf.html_body);
const yes_button = confirm_dialog.find(".confirm_dialog_yes_button");
yes_button.html(conf.html_yes_button);
// Set up handlers.
yes_button.on("click", () => {
if (conf.loading_spinner) {
show_confirm_dialog_spinner();
} else {
overlays.close_modal("#confirm_dialog_modal");
}
conf.on_click();
});
confirm_dialog.on("hidden.bs.modal", () => {
confirm_dialog.remove();
});
// Open the modal
overlays.open_modal("#confirm_dialog_modal");
conf.parent.on("shown.bs.modal", () => {
yes_button.trigger("focus");
});
}