fix(types): inputValue type

sweetalert2 · Aug 20, 2023 · 671fbc2 · 671fbc2
1 parent 676f6f9
commit 671fbc2
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 13 deletions.
diff --git a/sandbox/index.html b/sandbox/index.html
@@ -1,13 +1,12 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <style>
       @import url('https://fonts.googleapis.com/css?family=Montserrat');
 
       * {
-        font-family: 'Montserrat', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen-Sans, Ubuntu, Cantarell,
-          'Helvetica Neue', Helvetica, Arial, sans-serif;
+        font-family: Montserrat, sans-serif;
       }
     </style>
   </head>
@@ -27,9 +26,9 @@
         icon: 'success',
         showCloseButton: true,
         showCancelButton: true,
-        preConfirm: (value) => {
+        inputValidator: (value) => {
           if (!value) {
-            Swal.showValidationMessage('Should not be empty!')
+            return 'Should not be empty!'
           }
         },
         didOpen: (modal) => {

diff --git a/src/buttons-handlers.js b/src/buttons-handlers.js
@@ -68,7 +68,7 @@ const handleConfirmOrDenyWithInput = (instance, type) => {
 
 /**
  * @param {SweetAlert} instance
- * @param {string | number | File | FileList | null} inputValue
+ * @param {SweetAlertInputValue | null} inputValue
  * @param {'confirm' | 'deny'} type
  */
 const handleInputValidator = (instance, inputValue, type) => {

diff --git a/src/types.js b/src/types.js
@@ -4,6 +4,7 @@
  * @typedef { import('sweetalert2').SweetAlertIcon } SweetAlertIcon
  * @typedef { import('sweetalert2').SweetAlertInput } SweetAlertInput
  * @typedef { import('sweetalert2').SweetAlertResult } SweetAlertResult
+ * @typedef { import('sweetalert2').SweetAlertOptions['inputValue'] } SweetAlertInputValue
  */
 
 /**

diff --git a/src/utils/dom/inputUtils.js b/src/utils/dom/inputUtils.js
@@ -4,10 +4,6 @@ import { asPromise, error, hasToPromiseFn, isPromise } from '../utils.js'
 import { getDirectChildByClass } from './domUtils.js'
 import * as dom from './index.js'
 
-/**
- * @typedef { string | number | boolean | undefined } InputValue
- */
-
 /**
  * @param {SweetAlert} instance
  * @param {SweetAlertOptions} params
@@ -27,7 +23,7 @@ export const handleInputOptionsAndValue = (instance, params) => {
 /**
  * @param {SweetAlert} instance
  * @param {SweetAlertOptions} innerParams
- * @returns {string | number | File | FileList | null}
+ * @returns {SweetAlertInputValue}
  */
 export const getInputValue = (instance, innerParams) => {
   const input = instance.getInput()
@@ -235,7 +231,7 @@ const formatInputOptions = (inputOptions) => {
 
 /**
  * @param {string} optionValue
- * @param {InputValue | Promise<InputValue> | { toPromise: () => InputValue }} inputValue
+ * @param {SweetAlertInputValue} inputValue
  * @returns {boolean}
  */
 const isSelected = (optionValue, inputValue) => {

diff --git a/sweetalert2.d.ts b/sweetalert2.d.ts
@@ -1011,7 +1011,7 @@ declare module 'sweetalert2' {
      *
      * @default ''
      */
-    inputValue?: SyncOrAsync<string | number | boolean>
+    inputValue?: SyncOrAsync<string | number | File | FileList>
 
     /**
      * If the `input` parameter is set to `'select'` or `'radio'`, you can provide options.