@ui5/webcomponents 0.0.0-97cba4b0b → 0.0.0-99b763015

package/src/CheckBox.ts

@@ -1,462 +0,0 @@
-import { isDesktop } from "@ui5/webcomponents-base/dist/Device.js";
-import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
-import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
-import property from "@ui5/webcomponents-base/dist/decorators/property.js";
-import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
-import event from "@ui5/webcomponents-base/dist/decorators/event.js";
-import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
-import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
-import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
-import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
-import { getFeature } from "@ui5/webcomponents-base/dist/FeaturesRegistry.js";
-import { getEffectiveAriaLabelText } from "@ui5/webcomponents-base/dist/util/AriaLabelHelper.js";
-import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
-import "@ui5/webcomponents-icons/dist/accept.js";
-import Icon from "./Icon.js";
-import Label from "./Label.js";
-import WrappingType from "./types/WrappingType.js";
-import {
-	VALUE_STATE_ERROR,
-	VALUE_STATE_WARNING,
-	VALUE_STATE_SUCCESS,
-} from "./generated/i18n/i18n-defaults.js";
-
-// Styles
-import checkboxCss from "./generated/themes/CheckBox.css.js";
-import type FormSupport from "./features/InputElementsFormSupport.js";
-import type { IFormElement } from "./features/InputElementsFormSupport.js";
-
-// Template
-import CheckBoxTemplate from "./generated/templates/CheckBoxTemplate.lit.js";
-
-let isGlobalHandlerAttached = false;
-let activeCb: CheckBox;
-
-/**
- * @class
- *
- * <h3 class="comment-api-title">Overview</h3>
- *
- * Allows the user to set a binary value, such as true/false or yes/no for an item.
- * <br><br>
- * The <code>ui5-checkbox</code> component consists of a box and a label that describes its purpose.
- * If it's checked, an indicator is displayed inside the box.
- * To check/uncheck the <code>ui5-checkbox</code>, the user has to click or tap the square
- * box or its label.
- * <br><br>
- * The <code>ui5-checkbox</code> component only has 2 states - checked and unchecked.
- * Clicking or tapping toggles the <code>ui5-checkbox</code> between checked and unchecked state.
- *
- * <h3>Usage</h3>
- *
- * You can define the checkbox text with via the <code>text</code> property. If the text exceeds the available width, it is truncated by default.
- * In case you prefer text to wrap, set the <code>wrappingType</code> property to "Normal".
- * The touchable area for toggling the <code>ui5-checkbox</code> ends where the text ends.
- * <br><br>
- * You can disable the <code>ui5-checkbox</code> by setting the <code>disabled</code> property to
- * <code>true</code>,
- * or use the <code>ui5-checkbox</code> in read-only mode by setting the <code>readonly</code>
- * property to <code>true</code>.
- *
- * <br><br>
- * <h3>Keyboard Handling</h3>
- *
- * The user can use the following keyboard shortcuts to toggle the checked state of the <code>ui5-checkbox</code>.
- * <ul>
- * <li>[SPACE, ENTER] - Toggles between different states: checked, not checked.</li>
- * </ul>
- * <br><br>
- *
- * <h3>ES6 Module Import</h3>
- *
- * <code>import "@ui5/webcomponents/dist/CheckBox";</code>
- *
- * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.main.CheckBox
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ui5-checkbox
- * @public
- */
-@customElement({
-	tag: "ui5-checkbox",
-	languageAware: true,
-	renderer: litRender,
-	template: CheckBoxTemplate,
-	styles: checkboxCss,
-	dependencies: [
-		Label,
-		Icon,
-	],
-})
-/**
- * Fired when the component checked state changes.
- *
- * @public
- * @event sap.ui.webc.main.CheckBox#change
- */
-@event("change")
-
-class CheckBox extends UI5Element implements IFormElement {
-	/**
-	 * Receives id(or many ids) of the elements that label the component
-	 * @type {string}
-	 * @defaultvalue ""
-	 * @name sap.ui.webc.main.CheckBox.prototype.accessibleNameRef
-	 * @public
-	 * @since 1.1.0
-	 */
-	@property()
-	accessibleNameRef!: string;
-
-	/**
-	 * Defines the accessible ARIA name of the component.
-	 *
-	 * @type {string}
-	 * @public
-	 * @name sap.ui.webc.main.CheckBox.prototype.accessibleName
-	 * @defaultvalue ""
-	 * @since 1.1.0
-	 */
-	@property()
-	accessibleName!: string;
-
-	/**
-	 * Defines whether the component is disabled.
-	 * <br><br>
-	 * <b>Note:</b> A disabled component is completely noninteractive.
-	 *
-	 * @type {boolean}
-	 * @name sap.ui.webc.main.CheckBox.prototype.disabled
-	 * @defaultvalue false
-	 * @public
-	 */
-	@property({ type: Boolean })
-	disabled!: boolean;
-
-	/**
-	 * Defines whether the component is read-only.
-	 * <br><br>
-	 * <b>Note:</b> A read-only component is not editable,
-	 * but still provides visual feedback upon user interaction.
-	 *
-	 * @type {boolean}
-	 * @name sap.ui.webc.main.CheckBox.prototype.readonly
-	 * @defaultvalue false
-	 * @public
-	 */
-	@property({ type: Boolean })
-	readonly!: boolean;
-
-	/**
-	 * Defines whether the component is required.
-	 *
-	 * @type {boolean}
-	 * @name sap.ui.webc.main.CheckBox.prototype.required
-	 * @defaultvalue false
-	 * @public
-	 * @since 1.3.0
-	 */
-	@property({ type: Boolean })
-	required!: boolean;
-
-	/**
-	* Defines whether the component is displayed as partially checked.
-	* <br><br>
-	* <b>Note:</b> The indeterminate state can be set only programmatically and can’t be achieved by user
-	* interaction and the resulting visual state depends on the values of the <code>indeterminate</code>
-	* and <code>checked</code> properties:
-	* <ul>
-	* <li> If the component is checked and indeterminate, it will be displayed as partially checked
-	* <li> If the component is checked and it is not indeterminate, it will be displayed as checked
-	* <li> If the component is not checked, it will be displayed as not checked regardless value of the indeterminate attribute
-	* </ul>
-	*
-	* @type {boolean}
-	* @name sap.ui.webc.main.CheckBox.prototype.indeterminate
-	* @defaultvalue false
-	* @public
-	* @since 1.0.0-rc.15
-	*/
-	@property({ type: Boolean })
-	indeterminate!: boolean;
-
-	/**
-	 * Defines if the component is checked.
-	 * <br><br>
-	 * <b>Note:</b> The property can be changed with user interaction,
-	 * either by cliking/tapping on the component, or by
-	 * pressing the Enter or Space key.
-	 *
-	 * @type {boolean}
-	 * @name sap.ui.webc.main.CheckBox.prototype.checked
-	 * @defaultvalue false
-	 * @formEvents change
-	 * @formProperty
-	 * @public
-	 */
-	@property({ type: Boolean })
-	checked!: boolean;
-
-	/**
-	 * Defines the text of the component.
-	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.CheckBox.prototype.text
-	 * @defaultvalue ""
-	 * @public
-	 */
-	@property()
-	text!: string;
-
-	/**
-	 * Defines the value state of the component.
-	 *
-	 * <br><br>
-	 * <b>Note:</b>
-	 *
-	 * <ul>
-	 * <li><code>Warning</code></li>
-	 * <li><code>Error</code></li>
-	 * <li><code>None</code>(default)</li>
-	 * <li><code>Success</code></li>
-	 * <li><code>Information</code></li>
-	 * </ul>
-	 *
-	 * @type {sap.ui.webc.base.types.ValueState}
-	 * @name sap.ui.webc.main.CheckBox.prototype.valueState
-	 * @defaultvalue "None"
-	 * @public
-	 */
-	@property({ type: ValueState, defaultValue: ValueState.None })
-	valueState!: ValueState;
-
-	/**
-	 * Defines whether the component text wraps when there is not enough space.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>None</code> - The text will be truncated with an ellipsis.</li>
-	 * <li><code>Normal</code> - The text will wrap. The words will not be broken based on hyphenation.</li>
-	 * </ul>
-	 *
-	 * @type {sap.ui.webc.main.types.WrappingType}
-	 * @name sap.ui.webc.main.CheckBox.prototype.wrappingType
-	 * @defaultvalue "None"
-	 * @public
-	 */
-	@property({ type: WrappingType, defaultValue: WrappingType.None })
-	wrappingType!: WrappingType;
-
-	/**
-	 * Determines the name with which the component will be submitted in an HTML form.
-	 *
-	 * <br><br>
-	 * <b>Important:</b> For the <code>name</code> property to have effect, you must add the following import to your project:
-	 * <code>import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";</code>
-	 *
-	 * <br><br>
-	 * <b>Note:</b> When set, a native <code>input</code> HTML element
-	 * will be created inside the component so that it can be submitted as
-	 * part of an HTML form. Do not use this property unless you need to submit a form.
-	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.CheckBox.prototype.name
-	 * @defaultvalue ""
-	 * @public
-	 */
-	@property()
-	name!: string;
-
-	/**
-	 * Defines the active state (pressed or not) of the component.
-	 * @private
-	 */
-	@property({ type: Boolean })
-	active!: boolean;
-
-	/**
-	 * The slot is used to render native <code>input</code> HTML element within Light DOM to enable form submit,
-	 * when <code>name</code> property is set.
-	 * @type {HTMLElement[]}
-	 * @slot
-	 * @private
-	 */
-	@slot()
-	formSupport!: Array<HTMLElement>;
-
-	static i18nBundle: I18nBundle;
-	_deactivate: () => void;
-
-	constructor() {
-		super();
-
-		this._deactivate = () => {
-			if (activeCb) {
-				activeCb.active = false;
-			}
-		};
-
-		if (!isGlobalHandlerAttached) {
-			document.addEventListener("mouseup", this._deactivate);
-			isGlobalHandlerAttached = true;
-		}
-	}
-
-	onBeforeRendering() {
-		this._enableFormSupport();
-	}
-
-	_enableFormSupport() {
-		const formSupport = getFeature<typeof FormSupport>("FormSupport");
-		if (formSupport) {
-			formSupport.syncNativeHiddenInput(this, (element: IFormElement, nativeInput: HTMLInputElement) => {
-				nativeInput.disabled = element.disabled || !element.checked;
-				nativeInput.value = element.checked ? "on" : "";
-			});
-		} else if (this.name) {
-			console.warn(`In order for the "name" property to have effect, you should also: import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";`); // eslint-disable-line
-		}
-	}
-
-	_onclick() {
-		this.toggle();
-	}
-
-	_onmousedown() {
-		if (this.readonly || this.disabled) {
-			return;
-		}
-
-		this.active = true;
-		activeCb = this; // eslint-disable-line
-	}
-
-	_onmouseup() {
-		this.active = false;
-	}
-
-	_onfocusout() {
-		this.active = false;
-	}
-
-	_onkeydown(e: KeyboardEvent) {
-		if (isSpace(e)) {
-			e.preventDefault();
-			this.active = true;
-		}
-
-		if (isEnter(e)) {
-			this.toggle();
-			this.active = true;
-		}
-	}
-
-	_onkeyup(e: KeyboardEvent) {
-		if (isSpace(e)) {
-			this.toggle();
-		}
-
-		this.active = false;
-	}
-
-	toggle() {
-		if (this.canToggle()) {
-			const lastState = {
-				checked: this.checked,
-				indeterminate: this.indeterminate,
-			};
-			if (this.indeterminate) {
-				this.indeterminate = false;
-				this.checked = true;
-			} else {
-				this.checked = !this.checked;
-			}
-
-			const changePrevented = !this.fireEvent("change", null, true);
-			// Angular two way data binding
-			const valueChagnePrevented = !this.fireEvent("value-changed", null, true);
-
-			if (changePrevented || valueChagnePrevented) {
-				this.checked = lastState.checked;
-				this.indeterminate = lastState.indeterminate;
-			}
-		}
-		return this;
-	}
-
-	canToggle() {
-		return !(this.disabled || this.readonly);
-	}
-
-	valueStateTextMappings() {
-		return {
-			"Error": CheckBox.i18nBundle.getText(VALUE_STATE_ERROR),
-			"Warning": CheckBox.i18nBundle.getText(VALUE_STATE_WARNING),
-			"Success": CheckBox.i18nBundle.getText(VALUE_STATE_SUCCESS),
-		};
-	}
-
-	get ariaLabelText() {
-		return getEffectiveAriaLabelText(this);
-	}
-
-	get classes() {
-		return {
-			main: {
-				"ui5-checkbox--hoverable": !this.disabled && !this.readonly && isDesktop(),
-			},
-		};
-	}
-
-	get ariaReadonly() {
-		return this.readonly ? "true" : undefined;
-	}
-
-	get effectiveAriaDisabled() {
-		return this.disabled ? "true" : undefined;
-	}
-
-	get effectiveAriaChecked() {
-		return this.indeterminate && this.checked ? "mixed" : this.checked;
-	}
-
-	get ariaLabelledBy() {
-		if (!this.ariaLabelText) {
-			return this.text ? `${this._id}-label` : undefined;
-		}
-
-		return undefined;
-	}
-
-	get ariaDescribedBy() {
-		return this.hasValueState ? `${this._id}-descr` : undefined;
-	}
-
-	get hasValueState() {
-		return this.valueState !== ValueState.None;
-	}
-
-	get valueStateText() {
-		if (this.valueState !== ValueState.None && this.valueState !== ValueState.Information) {
-			return this.valueStateTextMappings()[this.valueState];
-		}
-	}
-
-	get effectiveTabIndex() {
-		const tabindex = this.getAttribute("tabindex");
-		return this.disabled ? undefined : tabindex || "0";
-	}
-
-	get isCompletelyChecked() {
-		return this.checked && !this.indeterminate;
-	}
-
-	static async onDefine() {
-		CheckBox.i18nBundle = await getI18nBundle("@ui5/webcomponents");
-	}
-}
-
-CheckBox.define();
-
-export default CheckBox;