egroupware/api/js/etemplate/Et2Button/Et2Button.ts

/**
 * EGroupware eTemplate2 - Button widget
 *
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 * @package etemplate
 * @subpackage api
 * @link https://www.egroupware.org
 * @author Nathan Gray
 */


import {css, html} from "@lion/core";
import {LionButton} from "@lion/button";
import {SlotMixin} from "@lion/core";
import {Et2InputWidget} from "../Et2InputWidget/Et2InputWidget";

export class Et2Button extends Et2InputWidget(SlotMixin(LionButton))
{
	protected _created_icon_node : HTMLImageElement;
	protected clicked : boolean = false;
	private _image : string;

	static get styles()
	{
		return [
			...super.styles,
			css`
            :host {
                padding: 1px 8px;
                /* These should probably come from somewhere else */
                border-radius: 3px;
                background-color: #e6e6e6;
            }
            :host([readonly]) {
            	display: none;
            }
            /* Set size for icon */
            ::slotted([slot="icon"]) {
                width: 20px;
                padding-right: 3px;
            }`,
		];
	}

	static get properties()
	{
		return {
			...super.properties,
			image: {type: String}
		}
	}

	get slots()
	{
		return {
			...super.slots,
			icon: () =>
			{
				return document.createElement("img");
			}
		}
	}

	constructor()
	{
		super();

		// Property default values
		this._image = '';

		// Do not add icon here, no children can be added in constructor

		// Define a default click handler
		// If a different one gets set via attribute, it will be used instead
		this.onclick = (typeof this.onclick === "function") ? this.onclick : () =>
		{
			return this.getInstanceManager().submit();
		};
	}

	connectedCallback()
	{
		super.connectedCallback();

		//this.classList.add("et2_button")
	}

	set image(new_image : string)
	{
		let oldValue = this._image;
		if(new_image.indexOf("http") >= 0)
		{
			this._image = new_image
		}
		else
		{
			this._image = this.egw().image(new_image, 'etemplate');
		}
		this.requestUpdate("image", oldValue);
	}

	_handleClick(event : MouseEvent) : boolean
	{
		// ignore click on readonly button
		if(this.disabled || this.readonly)
		{
			return false;
		}

		this.clicked = true;

		// Cancel buttons don't trigger the close confirmation prompt
		if(this.classList.contains("et2_button_cancel"))
		{
			this.getInstanceManager()?.skip_close_prompt();
		}

		if(!super._handleClick(event))
		{
			this.clicked = false;
			return false;
		}

		this.clicked = false;
		this.getInstanceManager()?.skip_close_prompt(false);
		return true;
	}

	render()
	{
		if(this.readonly)
		{
			return '';
		}

		this._iconNode.src = this._image;

		return html`
            <div class="button-content et2_button" id="${this._buttonId}">
                <slot name="icon"></slot>
                <slot></slot>
            </div> `;
	}

	get _iconNode() : HTMLImageElement
	{
		return <HTMLImageElement>(Array.from(this.children)).find(
			el => (<HTMLElement>el).slot === "icon",
		);
	}

	/**
	 * Implementation of the et2_IInput interface
	 */

	/**
	 * Always return false as a button is never dirty
	 */
	isDirty()
	{
		return false;
	}

	resetDirty()
	{
	}

	getValue()
	{
		if(this.clicked)
		{
			return true;
		}

		// If "null" is returned, the result is not added to the submitted
		// array.
		return null;
	}
}

// @ts-ignore TypeScript is not recognizing that Et2Button is a LitElement
customElements.define("et2-button", Et2Button);