|
- declare module 'sweetalert2' {
- /**
- * A namespace inside the default function, containing utility function for controlling the currently-displayed popup.
- *
- * Example:
- * ```
- * Swal.fire('Hey user!', 'You are the rockstar!', 'info');
- *
- * Swal.update({
- * icon: 'success'
- * })
- * ```
- */
- namespace Swal {
- /**
- * Function to display a SweetAlert2 popup, with an object of options, all being optional.
- * See the `SweetAlertOptions` interface for the list of accepted fields and values.
- *
- * Example:
- * ```
- * Swal.fire({
- * title: 'Auto close alert!',
- * text: 'I will close in 2 seconds.',
- * timer: 2000
- * })
- * ```
- */
- function fire<T = any>(options: SweetAlertOptions): Promise<SweetAlertResult<Awaited<T>>>
-
- /**
- * Function to display a simple SweetAlert2 popup.
- *
- * Example:
- * ```
- * Swal.fire('The Internet?', 'That thing is still around?', 'question');
- * ```
- */
- function fire<T = any>(title?: string, html?: string, icon?: SweetAlertIcon): Promise<SweetAlertResult<Awaited<T>>>
-
- /**
- * Reuse configuration by creating a `Swal` instance.
- *
- * Example:
- * ```
- * const Toast = Swal.mixin({
- * toast: true,
- * position: 'top-end',
- * timer: 3000,
- * timerProgressBar: true
- * })
- * Toast.fire('Something interesting happened', '', 'info')
- * ```
- *
- * @param options the default options to set for this instance.
- */
- function mixin(options: SweetAlertOptions): typeof Swal
-
- /**
- * Determines if a popup is shown.
- */
- function isVisible(): boolean
-
- /**
- * Updates popup options.
- * See the `SweetAlertOptions` interface for the list of accepted fields and values.
- *
- * Example:
- * ```
- * Swal.update({
- * icon: 'error'
- * })
- * ```
- */
- function update(options: Pick<SweetAlertOptions, SweetAlertUpdatableParameters>): void
-
- /**
- * Closes the currently open SweetAlert2 popup programmatically.
- *
- * @param result The promise originally returned by `Swal.fire()` will be resolved with this value.
- * If no object is given, the promise is resolved with an empty `SweetAlertResult` object.
- */
- function close(result?: Partial<SweetAlertResult>): void
-
- /**
- * Gets the popup container which contains the backdrop and the popup itself.
- */
- function getContainer(): HTMLElement | null
-
- /**
- * Gets the popup.
- */
- function getPopup(): HTMLElement | null
-
- /**
- * Gets the popup title.
- */
- function getTitle(): HTMLElement | null
-
- /**
- * Gets progress steps.
- */
- function getProgressSteps(): HTMLElement | null
-
- /**
- * Gets the DOM element where the `html`/`text` parameter is rendered to.
- */
- function getHtmlContainer(): HTMLElement | null
-
- /**
- * Gets the image.
- */
- function getImage(): HTMLElement | null
-
- /**
- * Gets the close button.
- */
- function getCloseButton(): HTMLButtonElement | null
-
- /**
- * Gets the icon.
- */
- function getIcon(): HTMLElement | null
-
- /**
- * Gets the icon content (without border).
- */
- function getIconContent(): HTMLElement | null
-
- /**
- * Gets the "Confirm" button.
- */
- function getConfirmButton(): HTMLButtonElement | null
-
- /**
- * Gets the "Deny" button.
- */
- function getDenyButton(): HTMLButtonElement | null
-
- /**
- * Gets the "Cancel" button.
- */
- function getCancelButton(): HTMLButtonElement | null
-
- /**
- * Gets actions (buttons) wrapper.
- */
- function getActions(): HTMLElement | null
-
- /**
- * Gets the popup footer.
- */
- function getFooter(): HTMLElement | null
-
- /**
- * Gets the timer progress bar (see the `timerProgressBar` param).
- */
- function getTimerProgressBar(): HTMLElement | null
-
- /**
- * Gets all focusable elements in the popup.
- */
- function getFocusableElements(): readonly HTMLElement[]
-
- /**
- * Enables "Confirm" and "Cancel" buttons.
- */
- function enableButtons(): void
-
- /**
- * Disables "Confirm" and "Cancel" buttons.
- */
- function disableButtons(): void
-
- /**
- * Shows loader (spinner), this is useful with AJAX requests.
- *
- * By default the loader be shown instead of the "Confirm" button, but if you want
- * another button to be replaced with a loader, just pass it like this:
- * ```
- * Swal.showLoading(Swal.getDenyButton())
- * ```
- */
- function showLoading(buttonToReplace?: HTMLButtonElement | null): void
-
- /**
- * Hides loader and shows back the button which was hidden by .showLoading()
- */
- function hideLoading(): void
-
- /**
- * Determines if popup is in the loading state.
- */
- function isLoading(): boolean
-
- /**
- * Clicks the "Confirm" button programmatically.
- */
- function clickConfirm(): void
-
- /**
- * Clicks the "Deny" button programmatically.
- */
- function clickDeny(): void
-
- /**
- * Clicks the "Cancel" button programmatically.
- */
- function clickCancel(): void
-
- /**
- * Shows a validation message.
- *
- * @param validationMessage The validation message.
- */
- function showValidationMessage(validationMessage: string): void
-
- /**
- * Hides validation message.
- */
- function resetValidationMessage(): void
-
- /**
- * Gets the input DOM node, this method works with input parameter.
- */
- function getInput(): HTMLInputElement | null
-
- /**
- * Disables the popup input. A disabled input element is unusable and un-clickable.
- */
- function disableInput(): void
-
- /**
- * Enables the popup input.
- */
- function enableInput(): void
-
- /**
- * Gets the validation message container.
- */
- function getValidationMessage(): HTMLElement | null
-
- /**
- * If `timer` parameter is set, returns number of milliseconds of timer remained.
- * Otherwise, returns undefined.
- */
- function getTimerLeft(): number | undefined
-
- /**
- * Stop timer. Returns number of milliseconds of timer remained.
- * If `timer` parameter isn't set, returns `undefined`.
- */
- function stopTimer(): number | undefined
-
- /**
- * Resume timer. Returns number of milliseconds of timer remained.
- * If `timer` parameter isn't set, returns `undefined`.
- */
- function resumeTimer(): number | undefined
-
- /**
- * Toggle timer. Returns number of milliseconds of timer remained.
- * If `timer` parameter isn't set, returns `undefined`.
- */
- function toggleTimer(): number | undefined
-
- /**
- * Check if timer is running. Returns true if timer is running,
- * and false is timer is paused / stopped.
- * If `timer` parameter isn't set, returns `undefined`.
- */
- function isTimerRunning(): boolean | undefined
-
- /**
- * Increase timer. Returns number of milliseconds of an updated timer.
- * If `timer` parameter isn't set, returns `undefined`.
- *
- * @param ms The number of milliseconds to add to the current timer
- */
- function increaseTimer(ms: number): number | undefined
-
- /**
- * Allows to trigger popups declaratively:
- *
- * ```
- * <button data-swal-template="#hello-world-alert">Click me!</button>
- *
- * <template id="hello-world-alert">
- * <swal-title>Hello world!</swal-title>
- * <swal-html>Here I come...</swal-html>
- * </template>
- * ```
- *
- * @param attribute The attribute name to search for, defaults to `data-swal-template`
- */
- function bindClickHandler(attribute?: string): void
-
- /**
- * Determines if a given parameter name is valid.
- *
- * @param paramName The parameter to check
- */
- function isValidParameter(paramName: string): paramName is keyof SweetAlertOptions
-
- /**
- * Determines if a given parameter name is valid for `Swal.update()` method.
- *
- * @param paramName The parameter to check
- */
- function isUpdatableParameter(paramName: string): paramName is SweetAlertUpdatableParameters
-
- /**
- * Normalizes the arguments you can give to Swal.fire() in an object of type SweetAlertOptions.
- *
- * Example:
- * ```
- * Swal.argsToParams(['title', 'text']); //=> { title: 'title', text: 'text' }
- * Swal.argsToParams([{ title: 'title', text: 'text' }]); //=> { title: 'title', text: 'text' }
- * ```
- *
- * @param params The array of arguments to normalize.
- */
- function argsToParams(params: SweetAlertArrayOptions | readonly [SweetAlertOptions]): SweetAlertOptions
-
- /**
- * An enum of possible reasons that can explain an alert dismissal.
- */
- enum DismissReason {
- cancel,
- backdrop,
- close,
- esc,
- timer,
- }
-
- /**
- * SweetAlert2's version
- */
- const version: string
- }
-
- interface SweetAlertHideShowClass {
- backdrop?: string | readonly string[]
- icon?: string | readonly string[]
- popup?: string | readonly string[]
- }
-
- type Awaited<T> = T extends Promise<infer U> ? U : T
-
- type SyncOrAsync<T> = T | Promise<T> | { toPromise: () => T }
-
- type ValueOrThunk<T> = T | (() => T)
-
- export type SweetAlertArrayOptions = readonly [string?, string?, SweetAlertIcon?]
-
- export type SweetAlertGrow = 'row' | 'column' | 'fullscreen' | false
-
- export type SweetAlertHideClass = SweetAlertHideShowClass
-
- export type SweetAlertShowClass = Readonly<SweetAlertHideShowClass>
-
- export type SweetAlertIcon = 'success' | 'error' | 'warning' | 'info' | 'question'
-
- export type SweetAlertEventName = 'didRender' | 'willOpen' | 'didOpen' | 'willClose' | 'didClose' | 'didDestroy'
-
- export type SweetAlertInput =
- | 'text'
- | 'email'
- | 'password'
- | 'number'
- | 'tel'
- | 'search'
- | 'range'
- | 'textarea'
- | 'select'
- | 'radio'
- | 'checkbox'
- | 'file'
- | 'url'
- | 'date'
- | 'datetime-local'
- | 'time'
- | 'week'
- | 'month'
-
- type SweetAlertStringInput = Exclude<SweetAlertInput, 'file'>
-
- type SweetAlertInputValidator =
- | {
- input?: SweetAlertStringInput
- /**
- * Validator for input field, may be async (Promise-returning) or sync.
- *
- * Example:
- * ```
- * Swal.fire({
- * input: 'radio',
- * inputValidator: result => !result && 'You need to select something!'
- * })
- * ```
- *
- * @default undefined
- */
- inputValidator?: (value: string) => SyncOrAsync<string | null | false | void>
- }
- | {
- input: 'file'
- /**
- * Validator for input field, may be async (Promise-returning) or sync.
- *
- * Example:
- * ```
- * Swal.fire({
- * input: 'file',
- * inputValidator: result => !result && 'You need to select something!'
- * })
- * ```
- *
- * @default undefined
- */
- inputValidator?: (file: File | FileList | null) => SyncOrAsync<string | null | false | void>
- }
-
- export type SweetAlertPosition =
- | 'top'
- | 'top-start'
- | 'top-end'
- | 'top-left'
- | 'top-right'
- | 'center'
- | 'center-start'
- | 'center-end'
- | 'center-left'
- | 'center-right'
- | 'bottom'
- | 'bottom-start'
- | 'bottom-end'
- | 'bottom-left'
- | 'bottom-right'
-
- export type SweetAlertUpdatableParameters =
- | 'allowEscapeKey'
- | 'allowOutsideClick'
- | 'background'
- | 'buttonsStyling'
- | 'cancelButtonAriaLabel'
- | 'cancelButtonColor'
- | 'cancelButtonText'
- | 'closeButtonAriaLabel'
- | 'closeButtonHtml'
- | 'confirmButtonAriaLabel'
- | 'confirmButtonColor'
- | 'confirmButtonText'
- | 'currentProgressStep'
- | 'customClass'
- | 'denyButtonAriaLabel'
- | 'denyButtonColor'
- | 'denyButtonText'
- | 'didClose'
- | 'didDestroy'
- | 'footer'
- | 'hideClass'
- | 'html'
- | 'icon'
- | 'iconColor'
- | 'imageAlt'
- | 'imageHeight'
- | 'imageUrl'
- | 'imageWidth'
- | 'preConfirm'
- | 'preDeny'
- | 'progressSteps'
- | 'reverseButtons'
- | 'showCancelButton'
- | 'showCloseButton'
- | 'showConfirmButton'
- | 'showDenyButton'
- | 'text'
- | 'title'
- | 'titleText'
- | 'willClose'
-
- export interface SweetAlertCustomClass {
- container?: string | readonly string[]
- popup?: string | readonly string[]
- title?: string | readonly string[]
- closeButton?: string | readonly string[]
- icon?: string | readonly string[]
- image?: string | readonly string[]
- htmlContainer?: string | readonly string[]
- input?: string | readonly string[]
- inputLabel?: string | readonly string[]
- validationMessage?: string | readonly string[]
- actions?: string | readonly string[]
- confirmButton?: string | readonly string[]
- denyButton?: string | readonly string[]
- cancelButton?: string | readonly string[]
- loader?: string | readonly string[]
- footer?: string | readonly string[]
- timerProgressBar?: string | readonly string[]
- }
-
- export interface SweetAlertResult<T = any> {
- readonly isConfirmed: boolean
- readonly isDenied: boolean
- readonly isDismissed: boolean
- readonly value?: T
- readonly dismiss?: Swal.DismissReason
- }
-
- export type SweetAlertOptions = SweetAlertInputValidator & {
- /**
- * The title of the popup, as HTML.
- * It can either be added to the object under the key `title` or passed as the first parameter of `Swal.fire()`.
- *
- * @default ''
- */
- title?: string | HTMLElement | JQuery | undefined
-
- /**
- * The title of the popup, as text. Useful to avoid HTML injection.
- *
- * @default ''
- */
- titleText?: string | undefined
-
- /**
- * A description for the popup.
- * If `text` and `html` parameters are provided in the same time, `html` will be used.
- *
- * @default ''
- */
- text?: string | undefined
-
- /**
- * A HTML description for the popup.
- * If `text` and `html` parameters are provided in the same time, `html` will be used.
- *
- * [Security] SweetAlert2 does NOT sanitize this parameter. It is the developer's responsibility
- * to escape any user input when using the `html` option, so XSS attacks would be prevented.
- *
- * @default ''
- */
- html?: string | HTMLElement | JQuery | undefined
-
- /**
- * The icon of the popup.
- * SweetAlert2 comes with 5 built-in icons which will show a corresponding icon animation:
- * `'warning'`, `'error'`, `'success'`, `'info'` and `'question'`.
- * It can either be put to the object under the key `icon` or passed as the third parameter of `Swal.fire()`.
- *
- * @default undefined
- */
- icon?: SweetAlertIcon | undefined
-
- /**
- * Use this to change the color of the icon.
- *
- * @default undefined
- */
- iconColor?: string | undefined
-
- /**
- * The custom HTML content for an icon.
- *
- * Example:
- * ```
- * Swal.fire({
- * icon: 'error',
- * iconHtml: '<i class="fas fa-bug"></i>'
- * })
- * ```
- *
- * @default undefined
- */
- iconHtml?: string | undefined
-
- /**
- * The footer of the popup, as HTML.
- *
- * @default ''
- */
- footer?: string | HTMLElement | JQuery | undefined
-
- /**
- * The declarative <template> of the popup. All API prams can be set via
- * `<swal-param name="..." value="..."></swal-param>`, e.g.
- * `<swal-param name="toast" value="true"></swal-param>`
- *
- * Additionally, there are specialized elements for specific params:
- * - `<swal-title>`
- * - `<swal-html>`
- * - `<swal-icon>`
- * - `<swal-image>`
- * - `<swal-input>`
- * - `<swal-input-option>`
- * - `<swal-button>`
- * - `<swal-footer>`
- *
- * Example:
- * ```html
- * <template id="my-template">
- * <swal-title>Are you sure?</swal-title>
- * <swal-html>You won't be able to revert this!</swal-html>
- *
- * <swal-icon type="success"></swal-icon>
- * <swal-image src="..." width="..." height="..." alt="..."></swal-image>
- *
- * <swal-input type="select" placeholder="..." label="..." value="...">
- * <swal-input-option value="...">...</swal-input-option>
- * </swal-input>
- * <swal-param name="inputAttributes" value='{ "multiple": true }'></swal-param>
- *
- * <swal-button type="confirm" color="..." aria-label="...">Yes</swal-button>
- * <swal-button type="cancel" color="..." aria-label="...">No</swal-button>
- *
- * <swal-footer>read more here</swal-footer>
- * </template>
- * ```
- *
- * ```
- * Swal.fire({
- * template: '#my-template'
- * })
- * ```
- *
- * @default undefined
- */
- template?: string | HTMLTemplateElement | undefined
-
- /**
- * Whether or not SweetAlert2 should show a full screen click-to-dismiss backdrop.
- * Either a boolean value or a css background value (hex, rgb, rgba, url, etc.)
- *
- * @default true
- */
- backdrop?: boolean | string | undefined
-
- /**
- * Whether or not an alert should be treated as a toast notification.
- * This option is normally coupled with the `position` and `timer` parameters.
- * Toasts are NEVER autofocused.
- *
- * @default false
- */
- toast?: boolean | undefined
-
- /**
- * The container element for adding popup into (query selector only).
- *
- * @default 'body'
- */
- target?: string | HTMLElement | null | undefined
-
- /**
- * Popup width, including paddings (`box-sizing: border-box`).
- *
- * @default undefined
- */
- width?: number | string | undefined
-
- /**
- * Popup padding.
- *
- * @default undefined
- */
- padding?: number | string | undefined
-
- /**
- * Color for title, content and footer (CSS `color` property). The default color is `#545454`.
- *
- * @default undefined
- */
- color?: string | undefined
-
- /**
- * Popup background (CSS `background` property). The default background is `#fff`.
- *
- * @default undefined
- */
- background?: string | undefined
-
- /**
- * Popup position
- *
- * @default 'center'
- */
- position?: SweetAlertPosition | undefined
-
- /**
- * Popup grow direction
- *
- * @default false
- */
- grow?: SweetAlertGrow | undefined
-
- /**
- * If set to `false`, the popup animation will be disabled.
- *
- * @default true
- */
- animation?: boolean | undefined
-
- /**
- * CSS classes for animations when showing a popup (fade in)
- *
- * @default { popup: 'swal2-show', backdrop: 'swal2-backdrop-show', icon: 'swal2-icon-show' }
- */
- showClass?: SweetAlertShowClass | undefined
-
- /**
- * CSS classes for animations when hiding a popup (fade out)
- *
- * @default { popup: 'swal2-hide', backdrop: 'swal2-backdrop-hide', icon: 'swal2-icon-hide' }
- */
- hideClass?: SweetAlertHideClass | undefined
-
- /**
- * A custom CSS class for the popup.
- * If a string value is provided, the classname will be applied to the popup.
- * If an object is provided, the classnames will be applied to the corresponding fields:
- *
- * Example:
- * ```
- * Swal.fire({
- * customClass: {
- * container: '...',
- * popup: '...',
- * title: '...',
- * closeButton: '...',
- * icon: '...',
- * image: '...',
- * htmlContainer: '...',
- * input: '...',
- * inputLabel: '...',
- * validationMessage: '...',
- * actions: '...',
- * confirmButton: '...',
- * denyButton: '...',
- * cancelButton: '...',
- * loader: '...',
- * footer: '...',
- * timerProgressBar: '...',
- * }
- * })
- * ```
- *
- * @default {}
- */
- customClass?: SweetAlertCustomClass | undefined
-
- /**
- * Auto close timer of the popup. Set in ms (milliseconds).
- *
- * @default undefined
- */
- timer?: number | undefined
-
- /**
- * If set to `true`, the timer will have a progress bar at the bottom of a popup.
- * Mostly, this feature is useful with toasts.
- *
- * @default false
- */
- timerProgressBar?: boolean | undefined
-
- /**
- * By default, SweetAlert2 sets html's and body's CSS `height` to `auto !important`.
- * If this behavior isn't compatible with your project's layout, set `heightAuto` to `false`.
- *
- * @default true
- */
- heightAuto?: boolean | undefined
-
- /**
- * If set to `false`, the user can't dismiss the popup by clicking outside it.
- * You can also pass a custom function returning a boolean value, e.g. if you want
- * to disable outside clicks for the loading state of a popup.
- *
- * @default true
- */
- allowOutsideClick?: ValueOrThunk<boolean> | undefined
-
- /**
- * If set to `false`, the user can't dismiss the popup by pressing the Escape key.
- * You can also pass a custom function returning a boolean value, e.g. if you want
- * to disable the escape key for the loading state of a popup.
- *
- * @default true
- */
- allowEscapeKey?: ValueOrThunk<boolean> | undefined
-
- /**
- * If set to `false`, the user can't confirm the popup by pressing the Enter or Space keys,
- * unless they manually focus the confirm button.
- * You can also pass a custom function returning a boolean value.
- *
- * @default true
- * @deprecated
- */
- allowEnterKey?: ValueOrThunk<boolean> | undefined
-
- /**
- * If set to `false`, SweetAlert2 will allow keydown events propagation to the document.
- *
- * @default true
- */
- stopKeydownPropagation?: boolean | undefined
-
- /**
- * Useful for those who are using SweetAlert2 along with Bootstrap modals.
- * By default keydownListenerCapture is `false` which means when a user hits `Esc`,
- * both SweetAlert2 and Bootstrap modals will be closed.
- * Set `keydownListenerCapture` to `true` to fix that behavior.
- *
- * @default false
- */
- keydownListenerCapture?: boolean | undefined
-
- /**
- * If set to `false`, the "Confirm" button will not be shown.
- * It can be useful when you're using custom HTML description.
- *
- * @default true
- */
- showConfirmButton?: boolean | undefined
-
- /**
- * If set to `true`, the "Deny" button will be shown, which the user can click on to deny the popup.
- *
- * @default false
- */
- showDenyButton?: boolean | undefined
-
- /**
- * If set to `true`, the "Cancel" button will be shown, which the user can click on to dismiss the popup.
- *
- * @default false
- */
- showCancelButton?: boolean | undefined
-
- /**
- * Use this to change the text on the "Confirm" button.
- *
- * @default 'OK'
- */
- confirmButtonText?: string | undefined
-
- /**
- * Use this to change the text on the "Confirm" button.
- *
- * @default 'No'
- */
- denyButtonText?: string | undefined
-
- /**
- * Use this to change the text on the "Cancel" button.
- *
- * @default 'Cancel'
- */
- cancelButtonText?: string | undefined
-
- /**
- * Use this to change the background color of the "Confirm" button.
- *
- * @default undefined
- */
- confirmButtonColor?: string | undefined
-
- /**
- * Use this to change the background color of the "Deny" button.
- *
- * @default undefined
- */
- denyButtonColor?: string | undefined
-
- /**
- * Use this to change the background color of the "Cancel" button.
- *
- * @default undefined
- */
- cancelButtonColor?: string | undefined
-
- /**
- * Use this to change the `aria-label` for the "Confirm" button.
- *
- * @default ''
- */
- confirmButtonAriaLabel?: string | undefined
-
- /**
- * Use this to change the `aria-label` for the "Deny" button.
- *
- * @default ''
- */
- denyButtonAriaLabel?: string | undefined
-
- /**
- * Use this to change the `aria-label` for the "Cancel" button.
- *
- * @default ''
- */
- cancelButtonAriaLabel?: string | undefined
-
- /**
- * Whether to apply the default SweetAlert2 styling to buttons.
- * If you want to use your own classes (e.g. Bootstrap classes) set this parameter to `false`.
- *
- * @default true
- */
- buttonsStyling?: boolean | undefined
-
- /**
- * Set to `true` if you want to invert default buttons positions.
- *
- * @default false
- */
- reverseButtons?: boolean | undefined
-
- /**
- * Set to `false` if you want to focus the first element in tab order instead of the "Confirm" button by default.
- *
- * @default true
- */
- focusConfirm?: boolean | undefined
-
- /**
- * Set to `true` if you want to focus the "Deny" button by default.
- *
- * @default false
- */
- focusDeny?: boolean | undefined
-
- /**
- * Set to `true` if you want to focus the "Cancel" button by default.
- *
- * @default false
- */
- focusCancel?: boolean | undefined
-
- /**
- * Set to `false` if you don't want to return the focus to the element that invoked the modal
- * after the modal is closed.
- *
- * @default true
- */
- returnFocus?: boolean | undefined
-
- /**
- * Set to `true` to show close button.
- *
- * @default false
- */
- showCloseButton?: boolean | undefined
-
- /**
- * Use this to change the HTML content of the close button.
- *
- * @default '×'
- */
- closeButtonHtml?: string | undefined
-
- /**
- * Use this to change the `aria-label` for the close button.
- *
- * @default 'Close this dialog'
- */
- closeButtonAriaLabel?: string | undefined
-
- /**
- * Use this to change the HTML content of the loader.
- *
- * @default ''
- */
- loaderHtml?: string | undefined
-
- /**
- * Set to `true` to disable buttons and show the loader instead of the Confirm button.
- * Use it in combination with the `preConfirm` parameter.
- *
- * @default false
- */
- showLoaderOnConfirm?: boolean | undefined
-
- /**
- * Set to `true` to disable buttons and show the loader instead of the Deny button.
- * Use it in combination with the `preDeny` parameter.
- *
- * @default false
- */
- showLoaderOnDeny?: boolean | undefined
-
- /**
- * Function to execute before confirming, may be async (Promise-returning) or sync.
- * Returned (or resolved) value can be:
- * - `false` to prevent a popup from closing
- * - anything else to pass that value as the `result.value` of `Swal.fire()`
- * - `undefined` to keep the default `result.value`
- *
- * Example:
- * ```
- * Swal.fire({
- * title: 'Multiple inputs',
- * html:
- * '<input id="swal-input1" class="swal2-input">' +
- * '<input id="swal-input2" class="swal2-input">',
- * focusConfirm: false,
- * preConfirm: () => [
- * document.querySelector('#swal-input1').value,
- * document.querySelector('#swal-input2').value
- * ]
- * }).then(result => Swal.fire(JSON.stringify(result));
- * ```
- *
- * @default undefined
- */
- preConfirm?(inputValue: any): SyncOrAsync<any>
-
- /**
- * Function to execute before denying, may be async (Promise-returning) or sync.
- * Returned (or resolved) value can be:
- * - `false` to prevent a popup from closing
- * - anything else to pass that value as the `result.value` of `Swal.fire()`
- * - `undefined` to keep the default `result.value`
- *
- * @default undefined
- */
- preDeny?(value: any): SyncOrAsync<any | void>
-
- /**
- * Add an image to the popup. Should contain a string with the path or URL to the image.
- *
- * @default undefined
- */
- imageUrl?: string | null | undefined
-
- /**
- * If imageUrl is set, you can specify imageWidth to describes image width.
- *
- * @default undefined
- */
- imageWidth?: number | string | undefined
-
- /**
- * If imageUrl is set, you can specify imageHeight to describes image height.
- *
- * @default undefined
- */
- imageHeight?: number | string | undefined
-
- /**
- * An alternative text for the custom image icon.
- *
- * @default ''
- */
- imageAlt?: string | undefined
-
- /**
- * Input field label.
- *
- * @default ''
- */
- inputLabel?: string | undefined
-
- /**
- * Input field placeholder.
- *
- * @default ''
- */
- inputPlaceholder?: string | undefined
-
- /**
- * Input field initial value.
- *
- * @default ''
- */
- inputValue?: SyncOrAsync<string | number | File | FileList> | null | undefined
-
- /**
- * If the `input` parameter is set to `'select'` or `'radio'`, you can provide options.
- * Object keys will represent options values, object values will represent options text values.
- *
- * @default {}
- */
- inputOptions?: SyncOrAsync<ReadonlyMap<string, string> | Record<string, any>> | undefined
-
- /**
- * Automatically focus the input when popup is shown.
- * Set this parameter to `false` to disable auto-focusing.
- *
- * @default true
- */
- inputAutoFocus?: boolean | undefined
-
- /**
- * Automatically remove whitespaces from both ends of a result string.
- * Set this parameter to `false` to disable auto-trimming.
- *
- * @default true
- */
- inputAutoTrim?: boolean | undefined
-
- /**
- * HTML input attributes (e.g. `min`, `max`, `step`, `accept`), that are added to the input field.
- *
- * Example:
- * ```
- * Swal.fire({
- * title: 'Select a file',
- * input: 'file',
- * inputAttributes: {
- * accept: 'image/*'
- * }
- * })
- * ```
- *
- * @default {}
- */
- inputAttributes?: Record<string, string> | undefined
-
- /**
- * If you want to return the input value as `result.value` when denying the popup, set to `true`.
- * Otherwise, the denying will set `result.value` to `false`.
- *
- * @default false
- */
- returnInputValueOnDeny?: boolean | undefined
-
- /**
- * A custom validation message for default validators (email, url).
- *
- * Example:
- * ```
- * Swal.fire({
- * input: 'email',
- * validationMessage: 'Invalid email address'
- * })
- * ```
- *
- * @default undefined
- */
- validationMessage?: string | undefined
-
- /**
- * Progress steps, useful for popup queues.
- *
- * @default []
- */
- progressSteps?: readonly string[] | undefined
-
- /**
- * Current active progress step.
- *
- * @default undefined
- */
- currentProgressStep?: number | undefined
-
- /**
- * Distance between progress steps.
- *
- * @default undefined
- */
- progressStepsDistance?: number | string | undefined
-
- /**
- * Popup lifecycle hook. Synchronously runs before the popup is shown on screen.
- *
- * @default undefined
- * @param popup The popup DOM element.
- */
- willOpen?(popup: HTMLElement): void
-
- /**
- * Popup lifecycle hook. Asynchronously runs after the popup has been shown on screen.
- *
- * @default undefined
- * @param popup The popup DOM element.
- */
- didOpen?(popup: HTMLElement): void
-
- /**
- * Popup lifecycle hook. Synchronously runs after the popup DOM has been updated (ie. just before the popup is
- * repainted on the screen).
- * Typically, this will happen after `Swal.fire()` or `Swal.update()`.
- * If you want to perform changes in the popup's DOM, that survive `Swal.update()`, prefer `didRender` over
- * `willOpen`.
- *
- * @default undefined
- * @param popup The popup DOM element.
- */
- didRender?(popup: HTMLElement): void
-
- /**
- * Popup lifecycle hook. Synchronously runs when the popup closes by user interaction (and not due to another popup
- * being fired).
- *
- * @default undefined
- * @param popup The popup DOM element.
- */
- willClose?(popup: HTMLElement): void
-
- /**
- * Popup lifecycle hook. Asynchronously runs after the popup has been disposed by user interaction (and not due to
- * another popup being fired).
- *
- * @default undefined
- */
- didClose?(): void
-
- /**
- * Popup lifecycle hook. Synchronously runs after popup has been destroyed either by user interaction or by another
- * popup.
- * If you have cleanup operations that you need to reliably execute each time a popup is closed, prefer
- * `didDestroy` over `didClose`.
- *
- * @default undefined
- */
- didDestroy?(): void
-
- /**
- * Attach a handler function for a lifecycle event.
- */
- on?(event: SweetAlertEventName, handler: () => void): void
-
- /**
- * Attach a handler function for a lifecycle event. The handler is executed at most once.
- */
- once?(event: SweetAlertEventName, handler: () => void): void
-
- /**
- * Remove event handlers.
- * If neither `event` nor `handler` is provided, all handlers for all events will be removed.
- * If `event` is provided, but `handler` is not, all handlers for the given event will be removed.
- * If both `event` and `handler` are provided, only the given handler for the given event will be removed.
- */
- off?(event?: SweetAlertEventName, handler?: () => void): void
-
- /**
- * Set to `false` to disable body padding adjustment when scrollbar is present.
- *
- * @default true
- */
- scrollbarPadding?: boolean | undefined
- }
-
- export default Swal
- }
-
- declare module 'sweetalert2/*/sweetalert2.js' {
- export * from 'sweetalert2'
- // "export *" does not matches the default export, so do it explicitly.
- export { default } from 'sweetalert2'
- }
-
- declare module 'sweetalert2/*/sweetalert2.all.js' {
- export * from 'sweetalert2'
- // "export *" does not matches the default export, so do it explicitly.
- export { default } from 'sweetalert2'
- }
-
- /**
- * These interfaces aren't provided by SweetAlert2, but its definitions use them.
- * They will be merged with 'true' definitions.
- */
-
- interface JQuery {} // eslint-disable-line @typescript-eslint/no-empty-object-type
|