Add types for jquery.confirmable

jquery/confirmable.d.ts

@@ -0,0 +1,100 @@
+declare global {
+    interface JQuery {
+        confirmable: Confirmable;
+    }
+}
+
+interface Confirmable {
+    /**
+     * Enable inline confirmation for given clickable element (like `<a />` or `<button />`).
+     *
+     * An additional inline confirmation step being shown before the default action is carried out on
+     * click.
+     *
+     * Calling `.confirmable( { handler: function () { … } } )` will fire the handler only after the
+     * confirmation step.
+     *
+     * The element will have the `jquery-confirmable-element` class added to it when it's clicked for
+     * the first time, which has `white-space: nowrap;` and `display: inline-block;` defined in CSS.
+     * If the computed values for the element are different when you make it confirmable, you might
+     * encounter unexpected behavior.
+     *
+     * @param {Options} [options]
+     */
+    (options?: Partial<Options>): this;
+
+    /**
+     * Default options. Overridable primarily for internationalisation handling.
+     */
+    defaultOptions: Options;
+
+    handler(event: JQuery.Event, options: Options): void;
+}
+
+interface Options {
+    /**
+     * Optional selector used for jQuery event delegation.
+     */
+    delegate: string | null;
+
+    /**
+     * Events to hook to.
+     */
+    events: string;
+
+    /**
+     * Text to use for interface elements.
+     */
+    i18n: I18N;
+
+    /**
+     * Callback to fire when preparing confirmable buttons. It is fired separately for the 'Yes' and 'No' button.
+     * Receives the button jQuery object as the first parameter and 'yes' or 'no' as the second.
+     */
+    buttonCallback($button: JQuery): JQuery;
+
+    /**
+     * Callback to fire when the action is confirmed (user clicks the 'Yes' button).
+     */
+    handler: ((event: JQuery.Event) => void) | null;
+
+    /**
+     * Callback to fire when preparing confirmable interface.
+     * Receives the interface jQuery object as the only parameter.
+     */
+    wrapperCallback($interface: JQuery): JQuery;
+}
+
+interface I18N {
+    /**
+     * Text to use for the confirmation question.
+     */
+    confirm: string;
+
+    /**
+     * Text to use for the 'No' button.
+     */
+    no: string;
+
+    /**
+     * Title text to use for the 'No' button.
+     */
+    noTitle: string | undefined;
+
+    /**
+     * Word separator to place between the three text messages.
+     */
+    space: string;
+
+    /**
+     * Text to use for the 'Yes' button.
+     */
+    yes: string;
+
+    /**
+     * Title text to use for the 'Yes' button.
+     */
+    yesTitle: string | undefined;
+}
+
+export {};