modals: Rename is_modal_open to is_open.

This commit is contained in:
Aman Agrawal
2023-10-10 12:29:09 +00:00
committed by Tim Abbott
parent 577a384845
commit d54a917104
7 changed files with 25 additions and 25 deletions

View File

@@ -280,7 +280,7 @@ export function process_escape_key(e) {
return true;
}
if (modals.is_modal_open()) {
if (modals.is_open()) {
modals.close_active_modal();
return true;
}
@@ -486,7 +486,7 @@ export function process_enter_key(e) {
// All custom logic for overlays/modals is above; if we're in a
// modal at this point, let the browser handle the event.
if (modals.is_modal_open()) {
if (modals.is_open()) {
return false;
}
@@ -695,7 +695,7 @@ export function process_hotkey(e, hotkey) {
}
// `list_util` will process the event in send later modal.
if (modals.is_modal_open() && modals.active_modal() !== "#send_later_modal") {
if (modals.is_open() && modals.active_modal() !== "#send_later_modal") {
return false;
}

View File

@@ -31,12 +31,12 @@ function call_hooks(func_list: Hook[]): void {
}
}
export function is_modal_open(): boolean {
export function is_open(): boolean {
return $(".micromodal").hasClass("modal--open");
}
export function active_modal(): string | undefined {
if (!is_modal_open()) {
if (!is_open()) {
blueslip.error("Programming error — Called active_modal when there is no modal open");
return undefined;
}
@@ -68,10 +68,10 @@ export function open_modal(
return;
}
if (is_modal_open()) {
if (is_open()) {
/*
Our modal system doesn't directly support opening a modal
when one is already open, because the `is_modal_open` CSS
when one is already open, because the `is_open` CSS
class doesn't update until Micromodal has finished its
animations, which can take 100ms or more.
@@ -178,8 +178,8 @@ export function close_modal(modal_id: string, conf: Pick<ModalConfig, "on_hidden
return;
}
if (!is_modal_open()) {
blueslip.warn("close_active_modal() called without checking is_modal_open()");
if (!is_open()) {
blueslip.warn("close_active_modal() called without checking is_open()");
return;
}
@@ -213,7 +213,7 @@ export function close_modal_if_open(modal_id: string): void {
return;
}
if (!is_modal_open()) {
if (!is_open()) {
return;
}
@@ -229,8 +229,8 @@ export function close_modal_if_open(modal_id: string): void {
}
export function close_active_modal(): void {
if (!is_modal_open()) {
blueslip.warn("close_active_modal() called without checking is_modal_open()");
if (!is_open()) {
blueslip.warn("close_active_modal() called without checking is_open()");
return;
}

View File

@@ -2,5 +2,5 @@ import * as modals from "./modals";
import * as overlays from "./overlays";
export function any_active(): boolean {
return overlays.is_active() || modals.is_modal_open();
return overlays.is_active() || modals.is_open();
}

View File

@@ -3,12 +3,12 @@ import Micromodal from "micromodal";
import * as blueslip from "../blueslip";
function is_modal_open(): boolean {
function is_open(): boolean {
return $(".micromodal").hasClass("modal--open");
}
function active_modal(): string | undefined {
if (!is_modal_open()) {
if (!is_open()) {
blueslip.error("Programming error — Called active_modal when there is no modal open");
return undefined;
}
@@ -18,8 +18,8 @@ function active_modal(): string | undefined {
}
function close_active_modal(): void {
if (!is_modal_open()) {
blueslip.warn("close_active_modal() called without checking is_modal_open()");
if (!is_open()) {
blueslip.warn("close_active_modal() called without checking is_open()");
return;
}
@@ -40,10 +40,10 @@ export function open_modal(modal_id: string, recursive_call_count: number = 0):
return;
}
if (is_modal_open()) {
if (is_open()) {
/*
Our modal system doesn't directly support opening a modal
when one is already open, because the `is_modal_open` CSS
when one is already open, because the `is_open` CSS
class doesn't update until Micromodal has finished its
animations, which can take 100ms or more.
@@ -118,8 +118,8 @@ export function close_modal(modal_id: string): void {
return;
}
if (!is_modal_open()) {
blueslip.warn("close_active_modal() called without checking is_modal_open()");
if (!is_open()) {
blueslip.warn("close_active_modal() called without checking is_open()");
return;
}

View File

@@ -26,7 +26,7 @@ export let settings_label;
$(() => {
$("#settings_overlay_container").on("click", (e) => {
if (!modals.is_modal_open()) {
if (!modals.is_open()) {
return;
}
if ($(e.target).closest(".micromodal").length > 0) {

View File

@@ -74,7 +74,7 @@ function compare_by_name(a, b) {
}
export function get_user_id_if_user_profile_modal_open() {
if (modals.is_modal_open() && modals.active_modal() === "#user-profile-modal") {
if (modals.is_open() && modals.active_modal() === "#user-profile-modal") {
const user_id = $("#user-profile-modal").data("user-id");
return user_id;
}

View File

@@ -56,7 +56,7 @@ const narrow_state = mock_esm("../src/narrow_state", {
});
const navigate = mock_esm("../src/navigate");
const modals = mock_esm("../src/modals", {
is_modal_open: () => false,
is_open: () => false,
active_modal: () => undefined,
});
const overlays = mock_esm("../src/overlays", {
@@ -350,7 +350,7 @@ run_test("drafts closed launch", ({override}) => {
});
run_test("modal open", ({override}) => {
override(modals, "is_modal_open", () => true);
override(modals, "is_open", () => true);
test_normal_typing();
});