@refinitiv-ui/elements 5.6.0 → 5.8.2-alpha.0

package/lib/password-field/index.d.ts

@@ -1,76 +1,55 @@
 import { JSXInterface } from '../jsx';
-import { ControlElement, CSSResultGroup, PropertyValues, TemplateResult } from '@refinitiv-ui/core';
+import { PropertyValues, TemplateResult } from '@refinitiv-ui/core';
+import { TemplateMap } from '@refinitiv-ui/core/lib/directives/template-map.js';
+import { TextField } from '../text-field/index.js';
 import '../icon/index.js';
+import '@refinitiv-ui/phrasebook/lib/locale/en/password-field.js';
+import { Translate } from '@refinitiv-ui/translate';
 /**
- * A form control element for password
+ * A form control element for password.
  *
  * @fires value-changed - Dispatched when value changes
  * @fires error-changed - Dispatched when error state changes
+ * @fires icon-click - Dispatched when icon is clicked
  *
- * @attr {string} value - Input's value
- * @prop {string} [value=] - Input's value
+ * @attr {boolean} disabled - Set disabled state
+ * @prop {boolean} [disabled=false] - Set disabled state
+ *
+ * @attr {boolean} error - Set error state
+ * @prop {boolean} [error=false] - Set error state
+ *
+ * @attr {number} maxlength - Set character max limit
+ * @prop {number | null} [maxLength=null] - Set character max limit
+ *
+ * @attr {number} minlength - Set character min limit
+ * @prop {number | null} [minLength=null] - Set character min limit
+ *
+ * @prop {string} [pattern=""] - Set regular expression for input validation
+ *
+ * @attr {string} placeholder - Set placeholder text
+ * @prop {string} [placeholder=""] - Set placeholder text
  *
  * @attr {boolean} readonly - Set readonly state
  * @prop {boolean} [readonly=false] - Set readonly state
  *
- * @attr {boolean} disabled - Set disabled state
- * @prop {boolean} [disabled=false] - Set disabled state
+ * @attr {boolean} transparent - Disables all other states and border/background styles.
+ * @prop {boolean} [transparent=false] - Disables all other states and border/background styles.
+ *
+ * @attr {boolean} warning - Set warning state
+ * @prop {boolean} [warning=false] - Set warning state
+ *
+ * @attr {string} value - Input's value
+ * @prop {string} [value=""] - Input's value
  */
-export declare class PasswordField extends ControlElement {
-    /**
-     * Element version number
-     * @returns version number
-     */
-    static get version(): string;
-    /**
-     * A `CSSResultGroup` that will be used to style the host,
-     * slotted children and the internal template of the element.
-     * @return CSS template
-     */
-    static get styles(): CSSResultGroup;
-    /**
-     * Set regular expression for input validation
-     */
-    pattern: string;
-    /**
-     * Set placeholder text
-     */
-    placeholder: string;
-    /**
-     * Set state to error
-     */
-    error: boolean;
-    /**
-     * Set state to warning
-     */
-    warning: boolean;
-    /**
-     * Disables all other states and border/background styles.
-     * Use with advanced composite elements requiring e.g. multi selection in
-     * combo-box when parent container handles element states.
-     */
-    transparent: boolean;
-    /**
-     * Set character minimum limit
-     */
-    minLength: number | null;
-    /**
-     * Set character maximum limit
-     */
-    maxLength: number | null;
+export declare class PasswordField extends TextField {
     /**
-     * Get native input element from shadow roots
+     * Used for translations
      */
-    private inputElement;
+    protected t: Translate;
     /**
      * Defines whether password is visible or not
      */
     private isPasswordVisible;
-    /**
-     * Select the contents of input
-     * @return void
-     */
-    select(): void;
     /**
      * Called when the element’s DOM has been updated and rendered for the first time
      * @param changedProperties Properties that has changed
@@ -78,52 +57,21 @@ export declare class PasswordField extends ControlElement {
      */
     protected firstUpdated(changedProperties: PropertyValues): void;
     /**
-     * Called when the element’s DOM has been updated and rendered
-     * @param changedProperties Properties that has changed
-     * @return shouldUpdate
-     */
-    protected updated(changedProperties: PropertyValues): void;
-    /**
-     * A `TemplateResult` that will be used
-     * to render the updated internal template.
-     * @return Render template
-     */
-    protected render(): TemplateResult;
-    /**
-     * Check if input should be re-validated
-     * True if value changed and pattern or minlength is present
-     * True if pattern or minlength changed
-     * @param changedProperties Properties that has changed
-     * @return True if input should be re-validated
-     */
-    private shouldValidateInput;
-    /**
-     * check if value is changed and fire event
-     * @return {void}
-     */
-    private onPossibleValueChange;
-    /**
-     * validate input according `pattern`, `min` and `max` properties
-     * change state of `error` property according pattern validation
-     * @return void
-     */
-    private validateInput;
-    /**
-     * @param error existing state of error
-     * @returns true if there is no error and browser is IE11 and minLength more than 0 and value exists
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="text|password" - text if password is visible
+     * @returns template map
      */
-    private shouldValidateForMinLength;
+    protected get decorateInputMap(): TemplateMap;
     /**
-     * Detect `enter` and `space` keydown and fire
-     * @param event keydown event
+     * Renders icon element
      * @returns {void}
      */
-    private handleKeyDown;
+    protected renderIcon(): TemplateResult | null;
     /**
      * Toggles password visibility state
      * @return void
      */
-    private togglePasswordVisibility;
+    protected togglePasswordVisibility(): void;
 }
 
 declare global {
@@ -133,7 +81,7 @@ declare global {
 
   namespace JSX {
     interface IntrinsicElements {
-      'ef-password-field': Partial<PasswordField> | JSXInterface.ControlHTMLAttributes<PasswordField>;
+      'ef-password-field': Partial<PasswordField> | JSXInterface.HTMLAttributes<PasswordField>;
     }
   }
 }

package/lib/password-field/index.js

@@ -1,146 +1,56 @@
 import { __decorate } from "tslib";
-import { ControlElement, css, html } from '@refinitiv-ui/core';
+import { html } from '@refinitiv-ui/core';
 import { customElement } from '@refinitiv-ui/core/lib/decorators/custom-element.js';
-import { property } from '@refinitiv-ui/core/lib/decorators/property.js';
-import { query } from '@refinitiv-ui/core/lib/decorators/query.js';
-import { ifDefined } from '@refinitiv-ui/core/lib/directives/if-defined.js';
-import { VERSION } from '../version.js';
-import { isIE } from '@refinitiv-ui/utils/lib/browser.js';
+import { state } from '@refinitiv-ui/core/lib/decorators/state.js';
 import { preload } from '../icon/index.js';
+import { TextField } from '../text-field/index.js';
 import '../icon/index.js';
-const hasChanged = (newVal, oldVal) => oldVal === undefined ? false : newVal !== oldVal;
+import '@refinitiv-ui/phrasebook/lib/locale/en/password-field.js';
+import { translate } from '@refinitiv-ui/translate';
 let isEyeOffPreloadRequested = false;
 /**
- * A form control element for password
+ * A form control element for password.
  *
  * @fires value-changed - Dispatched when value changes
  * @fires error-changed - Dispatched when error state changes
+ * @fires icon-click - Dispatched when icon is clicked
  *
- * @attr {string} value - Input's value
- * @prop {string} [value=] - Input's value
+ * @attr {boolean} disabled - Set disabled state
+ * @prop {boolean} [disabled=false] - Set disabled state
+ *
+ * @attr {boolean} error - Set error state
+ * @prop {boolean} [error=false] - Set error state
+ *
+ * @attr {number} maxlength - Set character max limit
+ * @prop {number | null} [maxLength=null] - Set character max limit
+ *
+ * @attr {number} minlength - Set character min limit
+ * @prop {number | null} [minLength=null] - Set character min limit
+ *
+ * @prop {string} [pattern=""] - Set regular expression for input validation
+ *
+ * @attr {string} placeholder - Set placeholder text
+ * @prop {string} [placeholder=""] - Set placeholder text
  *
  * @attr {boolean} readonly - Set readonly state
  * @prop {boolean} [readonly=false] - Set readonly state
  *
- * @attr {boolean} disabled - Set disabled state
- * @prop {boolean} [disabled=false] - Set disabled state
+ * @attr {boolean} transparent - Disables all other states and border/background styles.
+ * @prop {boolean} [transparent=false] - Disables all other states and border/background styles.
+ *
+ * @attr {boolean} warning - Set warning state
+ * @prop {boolean} [warning=false] - Set warning state
+ *
+ * @attr {string} value - Input's value
+ * @prop {string} [value=""] - Input's value
  */
-let PasswordField = class PasswordField extends ControlElement {
+let PasswordField = class PasswordField extends TextField {
     constructor() {
         super(...arguments);
-        /**
-         * Set regular expression for input validation
-         */
-        this.pattern = '';
-        /**
-         * Set placeholder text
-         */
-        this.placeholder = '';
-        /**
-         * Set state to error
-         */
-        this.error = false;
-        /**
-         * Set state to warning
-         */
-        this.warning = false;
-        /**
-         * Disables all other states and border/background styles.
-         * Use with advanced composite elements requiring e.g. multi selection in
-         * combo-box when parent container handles element states.
-         */
-        this.transparent = false;
-        /**
-         * Set character minimum limit
-         */
-        this.minLength = null;
-        /**
-         * Set character maximum limit
-         */
-        this.maxLength = null;
         /**
          * Defines whether password is visible or not
          */
         this.isPasswordVisible = false;
-        /**
-         * check if value is changed and fire event
-         * @return {void}
-         */
-        this.onPossibleValueChange = () => {
-            const value = this.inputElement.value;
-            this.setValueAndNotify(value);
-        };
-        /**
-         * validate input according `pattern`, `min` and `max` properties
-         * change state of `error` property according pattern validation
-         * @return void
-         */
-        this.validateInput = () => {
-            let error = !this.inputElement.checkValidity();
-            if (this.shouldValidateForMinLength(error)) {
-                error = !!this.minLength && (this.minLength > this.value.length);
-            }
-            if (this.error !== error) {
-                this.error = error;
-                this.notifyPropertyChange('error', this.error);
-            }
-        };
-        /**
-         * Detect `enter` and `space` keydown and fire
-         * @param event keydown event
-         * @returns {void}
-         */
-        this.handleKeyDown = (event) => {
-            if (event.key === 'Spacebar' || event.key === ' ' || event.key === 'Enter') {
-                this.togglePasswordVisibility();
-            }
-        };
-    }
-    /**
-     * Element version number
-     * @returns version number
-     */
-    static get version() {
-        return VERSION;
-    }
-    /**
-     * A `CSSResultGroup` that will be used to style the host,
-     * slotted children and the internal template of the element.
-     * @return CSS template
-     */
-    static get styles() {
-        return css `
-      :host {
-        display: inline-block;
-      }
-      :host(:focus), :host input:focus {
-        outline: none;
-      }
-      [part=input] {
-        font: inherit;
-        background: none;
-        color: currentColor;
-        border: none;
-        text-align: inherit;
-      }
-      :host [part=icon]{
-        display: flex;
-        outline: none;
-      }
-      :host([transparent]) {
-        background: none !important;
-        border: none !important;
-      }
-    `;
-    }
-    /**
-     * Select the contents of input
-     * @return void
-     */
-    select() {
-        if (!this.disabled && !this.readonly) {
-            this.inputElement.select();
-        }
     }
     /**
      * Called when the element’s DOM has been updated and rendered for the first time
@@ -155,101 +65,45 @@ let PasswordField = class PasswordField extends ControlElement {
         }
     }
     /**
-     * Called when the element’s DOM has been updated and rendered
-     * @param changedProperties Properties that has changed
-     * @return shouldUpdate
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="text|password" - text if password is visible
+     * @returns template map
      */
-    updated(changedProperties) {
-        super.updated(changedProperties);
-        if (this.inputElement.value !== this.value) {
-            this.inputElement.value = this.value;
-        }
-        if (this.shouldValidateInput(changedProperties)) {
-            this.validateInput();
-        }
+    get decorateInputMap() {
+        return Object.assign(Object.assign({}, super.decorateInputMap), { 'type': this.isPasswordVisible ? 'text' : 'password' });
     }
     /**
-     * A `TemplateResult` that will be used
-     * to render the updated internal template.
-     * @return Render template
+     * Renders icon element
+     * @returns {void}
      */
-    render() {
+    renderIcon() {
         return html `
-      <input
-        type=${this.isPasswordVisible ? 'text' : 'password'}
-        part="input"
-        ?readonly="${this.readonly}"
-        ?disabled="${this.disabled}"
-        placeholder="${ifDefined(this.placeholder || undefined)}"
-        minlength="${ifDefined(this.minLength || undefined)}"
-        maxlength="${ifDefined(this.maxLength || undefined)}"
-        pattern="${ifDefined(this.pattern || undefined)}"
-        @input="${this.onPossibleValueChange}"
-        @change="${this.onPossibleValueChange}"
-        autocomplete="off"
-      />
       <ef-icon
+        part="icon"
+        role="button"
+        tabindex="0"
+        aria-label="${this.isPasswordVisible ? this.t('HIDE_PASSWORD') : this.t('SHOW_PASSWORD')}"
         icon=${this.isPasswordVisible ? 'eye-off' : 'eye'}
         ?readonly="${this.readonly}"
         ?disabled="${this.disabled}"
         @tap="${this.togglePasswordVisibility}"
-        @keydown="${this.handleKeyDown}"
-        part="icon"
-        tabindex="0"
       ></ef-icon>
     `;
     }
-    /**
-     * Check if input should be re-validated
-     * True if value changed and pattern or minlength is present
-     * True if pattern or minlength changed
-     * @param changedProperties Properties that has changed
-     * @return True if input should be re-validated
-     */
-    shouldValidateInput(changedProperties) {
-        return (changedProperties.has('pattern') || !!(this.pattern && changedProperties.has('value')))
-            || (changedProperties.has('minLength') || !!(this.minLength && changedProperties.has('value')));
-    }
-    /**
-     * @param error existing state of error
-     * @returns true if there is no error and browser is IE11 and minLength more than 0 and value exists
-     */
-    shouldValidateForMinLength(error) {
-        return !!(!error && isIE && this.minLength && !!this.value);
-    }
     /**
      * Toggles password visibility state
      * @return void
      */
     togglePasswordVisibility() {
         this.isPasswordVisible = !this.isPasswordVisible;
-        this.requestUpdate();
     }
 };
 __decorate([
-    property({ type: String, hasChanged })
-], PasswordField.prototype, "pattern", void 0);
-__decorate([
-    property({ type: String })
-], PasswordField.prototype, "placeholder", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], PasswordField.prototype, "error", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], PasswordField.prototype, "warning", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], PasswordField.prototype, "transparent", void 0);
-__decorate([
-    property({ type: Number, attribute: 'minlength', reflect: true, hasChanged })
-], PasswordField.prototype, "minLength", void 0);
-__decorate([
-    property({ type: Number, attribute: 'maxlength', reflect: true })
-], PasswordField.prototype, "maxLength", void 0);
+    translate({ scope: 'ef-password-field' })
+], PasswordField.prototype, "t", void 0);
 __decorate([
-    query('[part="input"]')
-], PasswordField.prototype, "inputElement", void 0);
+    state()
+], PasswordField.prototype, "isPasswordVisible", void 0);
 PasswordField = __decorate([
     customElement('ef-password-field', {
         alias: 'coral-password-field'

package/lib/pill/custom-elements.json

@@ -26,19 +26,20 @@
         {
           "name": "value",
           "description": "Value of pill",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "readonly",
           "description": "Set readonly state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         },
         {
           "name": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "properties": [
@@ -67,21 +68,22 @@
           "name": "value",
           "attribute": "value",
           "description": "Value of pill",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "readonly",
           "attribute": "readonly",
           "description": "Set readonly state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         },
         {
           "name": "disabled",
           "attribute": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "events": [

package/lib/pill/custom-elements.md

@@ -0,0 +1,22 @@
+# ef-pill
+
+A small button style component
+which is used to show one or multiple selected item.
+It is rarely used in the UI but inside other components to visualize multiple item selection item.
+
+## Properties
+
+| Property   | Attribute  | Type      | Default | Description                  |
+|------------|------------|-----------|---------|------------------------------|
+| `active`   | `active`   | `boolean` | false   | Add to pill for active state |
+| `clears`   | `clears`   | `boolean` | false   | Set pill to clearable        |
+| `disabled` | `disabled` | `boolean` | false   | Set disabled state           |
+| `readonly` | `readonly` | `boolean` | false   | Set readonly state           |
+| `toggles`  | `toggles`  | `boolean` | false   | Set pill to toggle mode      |
+| `value`    | `value`    | `string`  | ""      | Value of pill                |
+
+## Events
+
+| Event   | Description                                  |
+|---------|----------------------------------------------|
+| `clear` | Dispatched when click on cross button occurs |

package/lib/pill/index.d.ts

@@ -6,7 +6,7 @@ import '../icon/index.js';
  * which is used to show one or multiple selected item.
  * It is rarely used in the UI but inside other components to visualize multiple item selection item.
  * @attr {string} value - Value of pill
- * @prop {string} value - Value of pill
+ * @prop {string} [value=""] - Value of pill
  *
  * @attr {boolean} readonly - Set readonly state
  * @prop {boolean} [readonly=false] - Set readonly state

package/lib/pill/index.js

@@ -10,7 +10,7 @@ import '../icon/index.js';
  * which is used to show one or multiple selected item.
  * It is rarely used in the UI but inside other components to visualize multiple item selection item.
  * @attr {string} value - Value of pill
- * @prop {string} value - Value of pill
+ * @prop {string} [value=""] - Value of pill
  *
  * @attr {boolean} readonly - Set readonly state
  * @prop {boolean} [readonly=false] - Set readonly state

package/lib/progress-bar/custom-elements.md

@@ -0,0 +1,18 @@
+# ef-progress-bar
+
+Data visualisation component,
+showing a simple percentage bar.
+
+## Properties
+
+| Property    | Attribute   | Type     | Default | Description                                      |
+|-------------|-------------|----------|---------|--------------------------------------------------|
+| `alignment` | `alignment` | `string` | "left"  | The alignment of the bar.<br />The bar can either start from the `left` or `right`. |
+| `label`     | `label`     | `string` | ""      | The current label to be displayed next to the bar.<br />This is affixed to the end of the bar, so make sure to cater for this. |
+| `value`     | `value`     | `string` | "100"   | The current value of the bar.<br />This can range from `0-100` and<br />will be represented as a percentage bar |
+
+## Slots
+
+| Name    | Description                                      |
+|---------|--------------------------------------------------|
+| `label` | Overrides the label property and places custom content. Useful for modifying the color, or, adding icons. |

package/lib/radio-button/custom-elements.json

@@ -8,7 +8,8 @@
         {
           "name": "checked",
           "description": "Radio button checked state",
-          "type": "boolean"
+          "type": "boolean",
+          "default": "false"
         },
         {
           "name": "value",
@@ -26,13 +27,13 @@
           "name": "readonly",
           "description": "Set readonly state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         },
         {
           "name": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "properties": [
@@ -40,7 +41,8 @@
           "name": "checked",
           "attribute": "checked",
           "description": "Radio button checked state",
-          "type": "boolean"
+          "type": "boolean",
+          "default": "false"
         },
         {
           "name": "value",
@@ -61,14 +63,14 @@
           "attribute": "readonly",
           "description": "Set readonly state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         },
         {
           "name": "disabled",
           "attribute": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "events": [

package/lib/radio-button/custom-elements.md

@@ -0,0 +1,19 @@
+# ef-radio-button
+
+Basic radio button
+
+## Properties
+
+| Property   | Attribute  | Type      | Default | Description                                      |
+|------------|------------|-----------|---------|--------------------------------------------------|
+| `checked`  | `checked`  | `boolean` | false   | Radio button checked state                       |
+| `disabled` | `disabled` | `boolean` | false   | Set disabled state                               |
+| `name`     | `name`     | `string`  | ""      | Group multiple radio buttons by assigning the same name |
+| `readonly` | `readonly` | `boolean` | false   | Set readonly state                               |
+| `value`    | `value`    | `string`  | ""      | Value of the radio button                        |
+
+## Events
+
+| Event             | Description                                |
+|-------------------|--------------------------------------------|
+| `checked-changed` | Fired when the `checked` property changes. |