@monstermann/signals-modal 0.4.2 → 0.4.5

package/dist/status/isAnyModalClosing.d.mts

@@ -1,4 +1,39 @@
 //#region src/status/isAnyModalClosing.d.ts
+/**
+ * # isAnyModalClosing
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isAnyModalClosing(): boolean;
+ * ```
+ *
+ * Returns `true` if any modal has status `"closing"`.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     closeModal,
+ *     isAnyModalClosing,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("modal1", () => {
+ *     withModalStatus("opened");
+ * });
+ *
+ * createModal("modal2", () => {
+ *     withModalStatus();
+ * });
+ *
+ * closeModal("modal1");
+ *
+ * isAnyModalClosing(); // true
+ * ```
+ *
+ */
 declare function isAnyModalClosing(): boolean;
 //#endregion
 export { isAnyModalClosing };

package/dist/status/isAnyModalClosing.mjs

@@ -1,6 +1,41 @@
 import { getClosingModals } from "./getClosingModals.mjs";
 
 //#region src/status/isAnyModalClosing.ts
+/**
+* # isAnyModalClosing
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isAnyModalClosing(): boolean;
+* ```
+*
+* Returns `true` if any modal has status `"closing"`.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     closeModal,
+*     isAnyModalClosing,
+* } from "@monstermann/signals-modal";
+*
+* createModal("modal1", () => {
+*     withModalStatus("opened");
+* });
+*
+* createModal("modal2", () => {
+*     withModalStatus();
+* });
+*
+* closeModal("modal1");
+*
+* isAnyModalClosing(); // true
+* ```
+*
+*/
 function isAnyModalClosing() {
 	return getClosingModals().length > 0;
 }

package/dist/status/isAnyModalOpen.d.mts

@@ -1,4 +1,36 @@
 //#region src/status/isAnyModalOpen.d.ts
+/**
+ * # isAnyModalOpen
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isAnyModalOpen(): boolean;
+ * ```
+ *
+ * Returns `true` if any modal has status `"opening"` or `"opened"`.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     isAnyModalOpen,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("modal1", () => {
+ *     withModalStatus();
+ * });
+ *
+ * createModal("modal2", () => {
+ *     withModalStatus("opened");
+ * });
+ *
+ * isAnyModalOpen(); // true
+ * ```
+ *
+ */
 declare function isAnyModalOpen(): boolean;
 //#endregion
 export { isAnyModalOpen };

package/dist/status/isAnyModalOpen.mjs

@@ -1,6 +1,38 @@
 import { getOpenModals } from "./getOpenModals.mjs";
 
 //#region src/status/isAnyModalOpen.ts
+/**
+* # isAnyModalOpen
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isAnyModalOpen(): boolean;
+* ```
+*
+* Returns `true` if any modal has status `"opening"` or `"opened"`.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     isAnyModalOpen,
+* } from "@monstermann/signals-modal";
+*
+* createModal("modal1", () => {
+*     withModalStatus();
+* });
+*
+* createModal("modal2", () => {
+*     withModalStatus("opened");
+* });
+*
+* isAnyModalOpen(); // true
+* ```
+*
+*/
 function isAnyModalOpen() {
 	return getOpenModals().length > 0;
 }

package/dist/status/isAnyModalOpened.d.mts

@@ -1,4 +1,36 @@
 //#region src/status/isAnyModalOpened.d.ts
+/**
+ * # isAnyModalOpened
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isAnyModalOpened(): boolean;
+ * ```
+ *
+ * Returns `true` if any modal has status `"opened"`.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     isAnyModalOpened,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("modal1", () => {
+ *     withModalStatus();
+ * });
+ *
+ * createModal("modal2", () => {
+ *     withModalStatus("opened");
+ * });
+ *
+ * isAnyModalOpened(); // true
+ * ```
+ *
+ */
 declare function isAnyModalOpened(): boolean;
 //#endregion
 export { isAnyModalOpened };

package/dist/status/isAnyModalOpened.mjs

@@ -1,6 +1,38 @@
 import { getOpenedModals } from "./getOpenedModals.mjs";
 
 //#region src/status/isAnyModalOpened.ts
+/**
+* # isAnyModalOpened
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isAnyModalOpened(): boolean;
+* ```
+*
+* Returns `true` if any modal has status `"opened"`.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     isAnyModalOpened,
+* } from "@monstermann/signals-modal";
+*
+* createModal("modal1", () => {
+*     withModalStatus();
+* });
+*
+* createModal("modal2", () => {
+*     withModalStatus("opened");
+* });
+*
+* isAnyModalOpened(); // true
+* ```
+*
+*/
 function isAnyModalOpened() {
 	return getOpenedModals().length > 0;
 }

package/dist/status/isAnyModalOpening.d.mts

@@ -1,4 +1,39 @@
 //#region src/status/isAnyModalOpening.d.ts
+/**
+ * # isAnyModalOpening
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isAnyModalOpening(): boolean;
+ * ```
+ *
+ * Returns `true` if any modal has status `"opening"`.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     openModal,
+ *     isAnyModalOpening,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("modal1", () => {
+ *     withModalStatus();
+ * });
+ *
+ * createModal("modal2", () => {
+ *     withModalStatus();
+ * });
+ *
+ * openModal("modal1");
+ *
+ * isAnyModalOpening(); // true
+ * ```
+ *
+ */
 declare function isAnyModalOpening(): boolean;
 //#endregion
 export { isAnyModalOpening };

package/dist/status/isAnyModalOpening.mjs

@@ -1,6 +1,41 @@
 import { getOpeningModals } from "./getOpeningModals.mjs";
 
 //#region src/status/isAnyModalOpening.ts
+/**
+* # isAnyModalOpening
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isAnyModalOpening(): boolean;
+* ```
+*
+* Returns `true` if any modal has status `"opening"`.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     openModal,
+*     isAnyModalOpening,
+* } from "@monstermann/signals-modal";
+*
+* createModal("modal1", () => {
+*     withModalStatus();
+* });
+*
+* createModal("modal2", () => {
+*     withModalStatus();
+* });
+*
+* openModal("modal1");
+*
+* isAnyModalOpening(); // true
+* ```
+*
+*/
 function isAnyModalOpening() {
 	return getOpeningModals().length > 0;
 }

package/dist/status/isAnyModalVisible.d.mts

@@ -1,4 +1,36 @@
 //#region src/status/isAnyModalVisible.d.ts
+/**
+ * # isAnyModalVisible
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isAnyModalVisible(): boolean;
+ * ```
+ *
+ * Returns `true` if any modal is visible (not `"closed"`). This includes `"opening"`, `"opened"`, and `"closing"` statuses.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     isAnyModalVisible,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("modal1", () => {
+ *     withModalStatus();
+ * });
+ *
+ * createModal("modal2", () => {
+ *     withModalStatus("opened");
+ * });
+ *
+ * isAnyModalVisible(); // true
+ * ```
+ *
+ */
 declare function isAnyModalVisible(): boolean;
 //#endregion
 export { isAnyModalVisible };

package/dist/status/isAnyModalVisible.mjs

@@ -1,6 +1,38 @@
 import { getVisibleModals } from "./getVisibleModals.mjs";
 
 //#region src/status/isAnyModalVisible.ts
+/**
+* # isAnyModalVisible
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isAnyModalVisible(): boolean;
+* ```
+*
+* Returns `true` if any modal is visible (not `"closed"`). This includes `"opening"`, `"opened"`, and `"closing"` statuses.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     isAnyModalVisible,
+* } from "@monstermann/signals-modal";
+*
+* createModal("modal1", () => {
+*     withModalStatus();
+* });
+*
+* createModal("modal2", () => {
+*     withModalStatus("opened");
+* });
+*
+* isAnyModalVisible(); // true
+* ```
+*
+*/
 function isAnyModalVisible() {
 	return getVisibleModals().length > 0;
 }

package/dist/status/isModalClosed.d.mts

@@ -1,4 +1,32 @@
 //#region src/status/isModalClosed.d.ts
+/**
+ * # isModalClosed
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isModalClosed(key: string): boolean;
+ * ```
+ *
+ * Returns `true` if the modal's status is `"closed"` or if the modal doesn't exist.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     isModalClosed,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("key", () => {
+ *     withModalStatus();
+ * });
+ *
+ * isModalClosed("key"); // true
+ * ```
+ *
+ */
 declare function isModalClosed(key: string): boolean;
 //#endregion
 export { isModalClosed };

package/dist/status/isModalClosed.mjs

@@ -1,6 +1,34 @@
 import { $keysToStatus } from "./internals.mjs";
 
 //#region src/status/isModalClosed.ts
+/**
+* # isModalClosed
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isModalClosed(key: string): boolean;
+* ```
+*
+* Returns `true` if the modal's status is `"closed"` or if the modal doesn't exist.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     isModalClosed,
+* } from "@monstermann/signals-modal";
+*
+* createModal("key", () => {
+*     withModalStatus();
+* });
+*
+* isModalClosed("key"); // true
+* ```
+*
+*/
 function isModalClosed(key) {
 	const $status = $keysToStatus().get(key);
 	return $status === void 0 || $status() === "closed";

package/dist/status/isModalClosing.d.mts

@@ -1,4 +1,36 @@
 //#region src/status/isModalClosing.d.ts
+/**
+ * # isModalClosing
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isModalClosing(key: string): boolean;
+ * ```
+ *
+ * Returns `true` if the modal's status is `"closing"`.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     openModal,
+ *     closeModal,
+ *     isModalClosing,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("key", () => {
+ *     const { $status } = withModalStatus();
+ *     $status("opened");
+ * });
+ *
+ * closeModal("key");
+ * isModalClosing("key"); // true
+ * ```
+ *
+ */
 declare function isModalClosing(key: string): boolean;
 //#endregion
 export { isModalClosing };

package/dist/status/isModalClosing.mjs

@@ -1,6 +1,38 @@
 import { $keysToStatus } from "./internals.mjs";
 
 //#region src/status/isModalClosing.ts
+/**
+* # isModalClosing
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isModalClosing(key: string): boolean;
+* ```
+*
+* Returns `true` if the modal's status is `"closing"`.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     openModal,
+*     closeModal,
+*     isModalClosing,
+* } from "@monstermann/signals-modal";
+*
+* createModal("key", () => {
+*     const { $status } = withModalStatus();
+*     $status("opened");
+* });
+*
+* closeModal("key");
+* isModalClosing("key"); // true
+* ```
+*
+*/
 function isModalClosing(key) {
 	return $keysToStatus().get(key)?.() === "closing";
 }

package/dist/status/isModalOpen.d.mts

@@ -1,4 +1,32 @@
 //#region src/status/isModalOpen.d.ts
+/**
+ * # isModalOpen
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isModalOpen(key: string): boolean;
+ * ```
+ *
+ * Returns `true` if the modal's status is `"opening"` or `"opened"`.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     isModalOpen,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("key", () => {
+ *     const { $status } = withModalStatus("opening");
+ * });
+ *
+ * isModalOpen("key"); // true
+ * ```
+ *
+ */
 declare function isModalOpen(key: string): boolean;
 //#endregion
 export { isModalOpen };

package/dist/status/isModalOpen.mjs

@@ -2,6 +2,34 @@ import { isModalOpened } from "./isModalOpened.mjs";
 import { isModalOpening } from "./isModalOpening.mjs";
 
 //#region src/status/isModalOpen.ts
+/**
+* # isModalOpen
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isModalOpen(key: string): boolean;
+* ```
+*
+* Returns `true` if the modal's status is `"opening"` or `"opened"`.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     isModalOpen,
+* } from "@monstermann/signals-modal";
+*
+* createModal("key", () => {
+*     const { $status } = withModalStatus("opening");
+* });
+*
+* isModalOpen("key"); // true
+* ```
+*
+*/
 function isModalOpen(key) {
 	return isModalOpening(key) || isModalOpened(key);
 }

package/dist/status/isModalOpened.d.mts

@@ -1,4 +1,34 @@
 //#region src/status/isModalOpened.d.ts
+/**
+ * # isModalOpened
+ *
+ * <Badge type="tip">Reactive</Badge>
+ *
+ * ```ts
+ * function isModalOpened(key: string): boolean;
+ * ```
+ *
+ * Returns `true` if the modal's status is `"opened"`.
+ *
+ * ## Example
+ *
+ * ```ts
+ * import {
+ *     createModal,
+ *     withModalStatus,
+ *     openModal,
+ *     isModalOpened,
+ * } from "@monstermann/signals-modal";
+ *
+ * createModal("key", () => {
+ *     const { $status } = withModalStatus();
+ *     $status("opened");
+ * });
+ *
+ * isModalOpened("key"); // true
+ * ```
+ *
+ */
 declare function isModalOpened(key: string): boolean;
 //#endregion
 export { isModalOpened };

package/dist/status/isModalOpened.mjs

@@ -1,6 +1,36 @@
 import { $keysToStatus } from "./internals.mjs";
 
 //#region src/status/isModalOpened.ts
+/**
+* # isModalOpened
+*
+* <Badge type="tip">Reactive</Badge>
+*
+* ```ts
+* function isModalOpened(key: string): boolean;
+* ```
+*
+* Returns `true` if the modal's status is `"opened"`.
+*
+* ## Example
+*
+* ```ts
+* import {
+*     createModal,
+*     withModalStatus,
+*     openModal,
+*     isModalOpened,
+* } from "@monstermann/signals-modal";
+*
+* createModal("key", () => {
+*     const { $status } = withModalStatus();
+*     $status("opened");
+* });
+*
+* isModalOpened("key"); // true
+* ```
+*
+*/
 function isModalOpened(key) {
 	return $keysToStatus().get(key)?.() === "opened";
 }