mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 22:13:26 +00:00
settings_playgrounds: Convert module to TypeScript.
This commit is contained in:
189
web/src/settings_playgrounds.ts
Normal file
189
web/src/settings_playgrounds.ts
Normal file
@@ -0,0 +1,189 @@
|
||||
import $ from "jquery";
|
||||
|
||||
import render_confirm_delete_playground from "../templates/confirm_dialog/confirm_delete_playground.hbs";
|
||||
import render_admin_playground_list from "../templates/settings/admin_playground_list.hbs";
|
||||
|
||||
import * as bootstrap_typeahead from "./bootstrap_typeahead";
|
||||
import type {TypeaheadInputElement} from "./bootstrap_typeahead";
|
||||
import * as channel from "./channel";
|
||||
import * as confirm_dialog from "./confirm_dialog";
|
||||
import * as dialog_widget from "./dialog_widget";
|
||||
import {$t_html} from "./i18n";
|
||||
import * as ListWidget from "./list_widget";
|
||||
import * as realm_playground from "./realm_playground";
|
||||
import type {RealmPlayground} from "./realm_playground";
|
||||
import * as scroll_util from "./scroll_util";
|
||||
import {current_user, realm} from "./state_data";
|
||||
import {render_typeahead_item} from "./typeahead_helper";
|
||||
import * as ui_report from "./ui_report";
|
||||
|
||||
const meta = {
|
||||
loaded: false,
|
||||
};
|
||||
|
||||
export function reset(): void {
|
||||
meta.loaded = false;
|
||||
}
|
||||
|
||||
export function maybe_disable_widgets(): void {
|
||||
if (current_user.is_admin) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
export function populate_playgrounds(playgrounds_data: RealmPlayground[]): void {
|
||||
if (!meta.loaded) {
|
||||
return;
|
||||
}
|
||||
const $playgrounds_table = $("#admin_playgrounds_table").expectOne();
|
||||
ListWidget.create<RealmPlayground>($playgrounds_table, playgrounds_data, {
|
||||
name: "playgrounds_list",
|
||||
get_item: ListWidget.default_get_item,
|
||||
modifier_html(playground) {
|
||||
return render_admin_playground_list({
|
||||
playground: {
|
||||
playground_name: playground.name,
|
||||
pygments_language: playground.pygments_language,
|
||||
url_template: playground.url_template,
|
||||
id: playground.id,
|
||||
},
|
||||
can_modify: current_user.is_admin,
|
||||
});
|
||||
},
|
||||
filter: {
|
||||
$element: $playgrounds_table
|
||||
.closest(".settings-section")
|
||||
.find<HTMLInputElement>("input.search"),
|
||||
predicate(item, value) {
|
||||
return (
|
||||
item.name.toLowerCase().includes(value) ||
|
||||
item.pygments_language.toLowerCase().includes(value)
|
||||
);
|
||||
},
|
||||
onupdate() {
|
||||
scroll_util.reset_scrollbar($playgrounds_table);
|
||||
},
|
||||
},
|
||||
$parent_container: $("#playground-settings").expectOne(),
|
||||
init_sort: "pygments_language_alphabetic",
|
||||
sort_fields: {
|
||||
...ListWidget.generic_sort_functions("alphabetic", [
|
||||
"pygments_language",
|
||||
"name",
|
||||
"url_template",
|
||||
]),
|
||||
},
|
||||
$simplebar_container: $("#playground-settings .progressive-table-wrapper"),
|
||||
});
|
||||
}
|
||||
|
||||
export function set_up(): void {
|
||||
build_page();
|
||||
maybe_disable_widgets();
|
||||
}
|
||||
|
||||
function build_page(): void {
|
||||
meta.loaded = true;
|
||||
populate_playgrounds(realm.realm_playgrounds);
|
||||
$(".admin_playgrounds_table").on("click", ".delete", function (e) {
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
const $btn = $(this);
|
||||
const url =
|
||||
"/json/realm/playgrounds/" + encodeURIComponent($btn.attr("data-playground-id")!);
|
||||
const html_body = render_confirm_delete_playground();
|
||||
|
||||
confirm_dialog.launch({
|
||||
html_heading: $t_html({defaultMessage: "Delete code playground?"}),
|
||||
html_body,
|
||||
id: "confirm_delete_code_playgrounds_modal",
|
||||
on_click() {
|
||||
dialog_widget.submit_api_request(channel.del, url);
|
||||
},
|
||||
loading_spinner: true,
|
||||
});
|
||||
});
|
||||
|
||||
$(".organization form.admin-playground-form")
|
||||
.off("submit")
|
||||
.on("submit", (e) => {
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
const $playground_status = $("#admin-playground-status");
|
||||
const $add_playground_button = $(".new-playground-form button");
|
||||
$add_playground_button.prop("disabled", true);
|
||||
$playground_status.hide();
|
||||
const data = {
|
||||
name: $("#playground_name").val(),
|
||||
pygments_language: $("#playground_pygments_language").val(),
|
||||
url_template: $("#playground_url_template").val(),
|
||||
};
|
||||
void channel.post({
|
||||
url: "/json/realm/playgrounds",
|
||||
data,
|
||||
success() {
|
||||
$("#playground_pygments_language").val("");
|
||||
$("#playground_name").val("");
|
||||
$("#playground_url_template").val("");
|
||||
$add_playground_button.prop("disabled", false);
|
||||
ui_report.success(
|
||||
$t_html({defaultMessage: "Custom playground added!"}),
|
||||
$playground_status,
|
||||
3000,
|
||||
);
|
||||
// FIXME: One thing to note here is that the "view code in playground"
|
||||
// option for an already rendered code block (tagged with this newly added
|
||||
// language) would not be visible without a re-render. To fix this, we should
|
||||
// probably do some extraction in `rendered_markdown.ts` which does a
|
||||
// live-update of the `data-code-language` parameter in code blocks. Or change
|
||||
// how we do the HTML in the frontend so that the icon labels/behavior are
|
||||
// computed dynamically when you hover over the message based on configured
|
||||
// playgrounds. Since this isn't high priority right now, we can probably
|
||||
// take this up later.
|
||||
},
|
||||
error(xhr) {
|
||||
$add_playground_button.prop("disabled", false);
|
||||
ui_report.error(
|
||||
$t_html({defaultMessage: "Failed"}),
|
||||
xhr,
|
||||
$playground_status,
|
||||
3000,
|
||||
);
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
const $search_pygments_box = $<HTMLInputElement>("input#playground_pygments_language");
|
||||
let language_labels = new Map<string, string>();
|
||||
|
||||
const bootstrap_typeahead_input: TypeaheadInputElement = {
|
||||
$element: $search_pygments_box,
|
||||
type: "input",
|
||||
};
|
||||
|
||||
bootstrap_typeahead.create(bootstrap_typeahead_input, {
|
||||
source(query: string): string[] {
|
||||
language_labels = realm_playground.get_pygments_typeahead_list_for_settings(query);
|
||||
return [...language_labels.keys()];
|
||||
},
|
||||
items: 5,
|
||||
fixed: true,
|
||||
helpOnEmptyStrings: true,
|
||||
highlighter_html: (item: string): string =>
|
||||
render_typeahead_item({primary: language_labels.get(item)}),
|
||||
matcher(item: string, query: string): boolean {
|
||||
const q = query.trim().toLowerCase();
|
||||
return item.toLowerCase().startsWith(q);
|
||||
},
|
||||
sorter(items: string[], query: string): string[] {
|
||||
return bootstrap_typeahead.defaultSorter(items, query);
|
||||
},
|
||||
});
|
||||
|
||||
$search_pygments_box.on("click", (e) => {
|
||||
bootstrap_typeahead.lookup($search_pygments_box);
|
||||
$search_pygments_box.trigger("select");
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user