fix(types): showLoading() (#2595)

sweetalert2 · Jan 24, 2023 · 6b4aa39 · 6b4aa39
1 parent 49ecc95
commit 6b4aa39
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 13 deletions.
diff --git a/src/keydown-handler.js b/src/keydown-handler.js
@@ -172,10 +172,9 @@ const handleArrows = (key) => {
   const confirmButton = dom.getConfirmButton()
   const denyButton = dom.getDenyButton()
   const cancelButton = dom.getCancelButton()
-  if (
-    document.activeElement instanceof HTMLElement &&
-    ![confirmButton, denyButton, cancelButton].includes(document.activeElement)
-  ) {
+  /** @type HTMLElement[] */
+  const buttons = [confirmButton, denyButton, cancelButton]
+  if (document.activeElement instanceof HTMLElement && !buttons.includes(document.activeElement)) {
     return
   }
   const sibling = arrowKeysNextButton.includes(key) ? 'nextElementSibling' : 'previousElementSibling'

diff --git a/src/staticMethods/showLoading.js b/src/staticMethods/showLoading.js
@@ -5,6 +5,8 @@ import * as dom from '../utils/dom/index.js'
 /**
  * Shows loader (spinner), this is useful with AJAX requests.
  * By default the loader be shown instead of the "Confirm" button.
+ *
+ * @param {HTMLButtonElement} [buttonToReplace]
  */
 const showLoading = (buttonToReplace) => {
   let popup = dom.getPopup()
@@ -26,6 +28,10 @@ const showLoading = (buttonToReplace) => {
   popup.focus()
 }
 
+/**
+ * @param {HTMLElement} popup
+ * @param {HTMLButtonElement} [buttonToReplace]
+ */
 const replaceButton = (popup, buttonToReplace) => {
   const actions = dom.getActions()
   const loader = dom.getLoader()

diff --git a/src/utils/dom/getters.js b/src/utils/dom/getters.js
@@ -67,29 +67,32 @@ export const getProgressSteps = () => elementByClass(swalClasses['progress-steps
 export const getValidationMessage = () => elementByClass(swalClasses['validation-message'])
 
 /**
- * @returns {HTMLElement | null}
+ * @returns {HTMLButtonElement | null}
  */
-export const getConfirmButton = () => elementBySelector(`.${swalClasses.actions} .${swalClasses.confirm}`)
+export const getConfirmButton = () =>
+  /** @type {HTMLButtonElement} */ (elementBySelector(`.${swalClasses.actions} .${swalClasses.confirm}`))
 
 /**
- * @returns {HTMLElement | null}
+ * @returns {HTMLButtonElement | null}
  */
-export const getDenyButton = () => elementBySelector(`.${swalClasses.actions} .${swalClasses.deny}`)
+export const getCancelButton = () =>
+  /** @type {HTMLButtonElement} */ (elementBySelector(`.${swalClasses.actions} .${swalClasses.cancel}`))
 
 /**
- * @returns {HTMLElement | null}
+ * @returns {HTMLButtonElement | null}
  */
-export const getInputLabel = () => elementByClass(swalClasses['input-label'])
+export const getDenyButton = () =>
+  /** @type {HTMLButtonElement} */ (elementBySelector(`.${swalClasses.actions} .${swalClasses.deny}`))
 
 /**
  * @returns {HTMLElement | null}
  */
-export const getLoader = () => elementBySelector(`.${swalClasses.loader}`)
+export const getInputLabel = () => elementByClass(swalClasses['input-label'])
 
 /**
  * @returns {HTMLElement | null}
  */
-export const getCancelButton = () => elementBySelector(`.${swalClasses.actions} .${swalClasses.cancel}`)
+export const getLoader = () => elementBySelector(`.${swalClasses.loader}`)
 
 /**
  * @returns {HTMLElement | null}

diff --git a/sweetalert2.d.ts b/sweetalert2.d.ts
@@ -180,7 +180,7 @@ declare module 'sweetalert2' {
      * Swal.showLoading(Swal.getDenyButton())
      * ```
      */
-    function showLoading(buttonToReplace: HTMLButtonElement | null): void
+    function showLoading(buttonToReplace?: HTMLButtonElement): void
 
     /**
      * Hides loader and shows back the button which was hidden by .showLoading()