vercengen/features/Confirm.js

/**
 * Refer to <span color = "yellow">{@link ve.Feature}</span> for methods or fields inherited from the parent, such as automatic destructuring.
 * 
 * Confirmation prompt used for executing a `.options.special_function` call.
 * - Functional binding: <span color=00ffff>veConfirm</span>().
 * - Inherits Feature: {@link ve.Modal}
 * 
 * ##### Constructor:
 * - `arg0_components_obj`: {@link function}|{@link Object}<{@link ve.Component}>|{@link string}|{@link ve.Component}
 * - `arg1_options`: {@link Object} - Superset of `.options` for {@link ve.Modal}.
 *   - `.do_not_close`: {@link boolean} - Whether to keep the confirmation prompt if `.special_function` is properly fired.
 *   - `.special_function`: {@link function}(v:{@link function}, e:{@link ve.Button})
 * 
 * ##### Methods::
 * - <span color=00ffff>{@link ve.Confirm.close|close}</span>()
 *
 * @augments ve.Feature
 * @memberof ve.Feature
 * @type {ve.Confirm}
 */
ve.Confirm = class extends ve.Feature {
	constructor (arg0_components_obj, arg1_options) {
		//Convert from parameters
		let components_obj = arg0_components_obj;
		let options = (arg1_options) ? arg1_options : {};
			super(components_obj, options);
			
		//Internal guard clause if options is the wrong type
		if (typeof options === "function") console.warn(`ve.Confirm: .options is of the wrong type function. Did you mean to use { special_function: function } for arg1_options instead?`);
		
		//Declare local instance variables: this.modal
		this.components_obj = components_obj;
		this.options = options;
		
		if (typeof this.components_obj === "function" || typeof this.components_obj === "string")
			this.components_obj = {
				html: new ve.HTML(this.components_obj, { style: { overflowWrap: "anywhere" } })
			};
		this.components_obj = { 
			...this.components_obj,
			confirm_bar: new ve.RawInterface({
				yes_button: new ve.Button((v, e) => {
					if (this.options.special_function) {
						this.options.special_function(v, e);
						if (!this.options.do_not_close)
							this.close();
					}
				}, { name: loc("ve.registry.localisation.Confirm_yes") }),
				no_button: new ve.Button(() => this.close(), { name: loc("ve.registry.localisation.Confirm_no") })
			}, { name: " ", style: { display: "flex" } })
		};
		
		this.modal = new ve.Modal(this.components_obj, {
			name: loc("ve.registry.localisation.Confirm_confirm"),
			draggable: true,
			resizable: true,
			width: "24rem",
			...this.options
		});
	}
	
	/**
	 * Closes the present {@link ve.Confirm} feature.
	 * - Method of: {@link ve.Confirm}
	 *
	 * @alias close
	 * @memberof ve.Feature.ve.Confirm
	 */
	close () {
		if (this.modal)
			this.modal.close();
	}
};

//Functional binding

/**
 * @returns {ve.Confirm}
 */
veConfirm = function () {
	//Return statement
	return new ve.Confirm(...arguments);
};