Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
import {$} from "jquery";
import * as loading from "./loading.ts";
import {COMPONENT_INTENT_VALUES} from "./types.ts";
import type {ComponentIntent} from "./types.ts";
export const ACTION_BUTTON_VARIANT_VALUES = ["solid", "subtle", "text"] as const;
export type ActionButtonVariant = (typeof ACTION_BUTTON_VARIANT_VALUES)[number];
export type ActionButton = {
variant: ActionButtonVariant;
intent?: ComponentIntent;
label?: string;
icon?: string;
id?: string;
custom_classes?: string;
"aria-describedby"?: string;
};
let loading_indicator_count = 0;
export function show_button_loading_indicator($button: JQuery): void {
// If the button already has a loading indicator, do nothing.
if ($button.find(".button-loading-indicator").length > 0) {
return;
}
// First, we hide the current content of the button.
$button.find(".zulip-icon").css("visibility", "hidden");
$button.find(".action-button-label").css("visibility", "hidden");
// Next, we create a loading indicator with a unique id.
// The unique id is required for the `filter` element in the loader SVG,
// to prevent the loading indicator from being hidden due to duplicate ids.
// Reference commit: 995d073dbfd8f22a2ef50c1320e3b1492fd28649
const loading_indicator_unique_id = `button-loading-indicator-${loading_indicator_count}`;
loading_indicator_count += 1;
const $button_loading_indicator = $("<span>")
.attr("id", loading_indicator_unique_id)
.addClass("button-loading-indicator");
requestAnimationFrame(() => {
// We want this to happen in the same animation frame to
// avoid showing a non spinning loading indicator.
$button.append($button_loading_indicator);
loading.make_indicator($button_loading_indicator, {
width: $button.width(),
height: $button.height(),
});
});
}
export function hide_button_loading_indicator($button: JQuery): void {
$button.find(".button-loading-indicator").remove();
$button.prop("disabled", false);
$button.find(".zulip-icon").css("visibility", "visible");
$button.find(".action-button-label").css("visibility", "visible");
}
export function modify_action_button_style(
$button: JQuery,
opts: {
variant?: ActionButtonVariant;
intent?: ComponentIntent;
},
): void {
if (opts.variant === undefined && opts.intent === undefined) {
// If neither variant nor intent is provided, do nothing.
return;
}
const action_button_variant_pattern = ACTION_BUTTON_VARIANT_VALUES.join("|");
const component_intent_pattern = COMPONENT_INTENT_VALUES.join("|");
const action_button_style_regex = new RegExp(
`action-button-(${action_button_variant_pattern})-(${component_intent_pattern})`,
);
const action_button_style_regex_match = $button.attr("class")?.match(action_button_style_regex);
if (!action_button_style_regex_match) {
// If the button doesn't have the expected class, do nothing.
return;
}
const [action_button_style_class, old_variant, old_intent] = action_button_style_regex_match;
// Replace the old variant and intent values with the new ones, if provided.
$button.removeClass(action_button_style_class);
$button.addClass(`action-button-${opts.variant ?? old_variant}-${opts.intent ?? old_intent}`);
}
export function modify_button_icon($button: JQuery, new_icon: string): void {
$button
.find(".zulip-icon")
.attr("class", (_index, className) =>
className.replaceAll(/zulip-icon-[^\s]+/g, () => `zulip-icon-${new_icon}`),
);
}