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

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

@@ -1,140 +1,68 @@
 import { JSXInterface } from '../jsx';
-import { ControlElement, CSSResultGroup, PropertyValues, TemplateResult } from '@refinitiv-ui/core';
+import { PropertyValues } from '@refinitiv-ui/core';
 import '../icon/index.js';
+import { TextField } from '../text-field/index.js';
+import { TemplateMap } from '@refinitiv-ui/core/lib/directives/template-map.js';
 /**
- * A form control element for email
+ * A form control element for email.
  *
  * @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 {string} icon - Specify icon to display in input. Value can be icon name
+ * @prop {string | null} [icon=null] - Specify icon to display in input. Value can be icon name
+ *
+ * @attr {boolean} icon-has-action - Specify when icon need to be clickable
+ * @prop {boolean} [iconHasAction=false] - Specify when icon need to be clickable
+ *
+ * @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 EmailField 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 max limit
-     */
-    maxLength: number | null;
-    /**
-     * Set character min limit
-     */
-    minLength: number | null;
+export declare class EmailField extends TextField {
     /**
      * Set to multiple mode, allows multiple emails in a single input
      */
     multiple: boolean;
     /**
-     * Specify icon to display in input. Value can be icon name
-     */
-    icon: string;
-    /**
-     * Specify when icon need to be clickable
-     */
-    iconHasAction: boolean;
-    /**
-     * Get native input element from shadow roots
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="email" - always `email`
+     * multiple - defined if supports multiple emails
+     * @returns template map
      */
-    private inputElement;
-    /**
-     * Select the contents of input
-     * @returns {void}
-     */
-    select(): void;
-    /**
-     * Called when the element’s DOM has been updated and rendered
-     * @param changedProperties Properties that has changed
-     * @returns {void}
-     */
-    protected updated(changedProperties: PropertyValues): void;
+    protected get decorateInputMap(): TemplateMap;
     /**
      * Check if input should be re-validated
      * @param changedProperties Properties that has changed
      * @returns True if input should be re-validated
      */
-    private shouldValidateInput;
-    /**
-     * Check if value is changed and fire event
-     * @returns {void}
-     */
-    private onPossibleValueChange;
-    /**
-     * Validate input according `pattern`, `minLength` and `maxLength` properties
-     * change state of `error` property according pattern validation
-     * @returns {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
-     */
-    private shouldValidateForMinLength;
-    /**
-     * Detect `enter` and `space` keydown and fire
-     * @param event keydown event
-     * @returns {void}
-     */
-    private handleKeyDown;
-    /**
-     * Process internal icon click and fire `icon-click` event
-     * @returns {void}
-     */
-    private iconClick;
-    /**
-     * Fire event on `icon` click
-     * @returns {void}
-     */
-    private notifyIcon;
-    /**
-     * Renders icon element if property present
-     * @returns {TemplateResult | null} Template result
-     */
-    private renderIcon;
-    /**
-     * A `TemplateResult` that will be used
-     * to render the updated internal template.
-     * @return {TemplateResult} Render template
-     */
-    protected render(): TemplateResult;
+    protected shouldValidateInput(changedProperties: PropertyValues): boolean;
 }
 
 declare global {
@@ -144,7 +72,7 @@ declare global {
 
   namespace JSX {
     interface IntrinsicElements {
-      'ef-email-field': Partial<EmailField> | JSXInterface.ControlHTMLAttributes<EmailField>;
+      'ef-email-field': Partial<EmailField> | JSXInterface.HTMLAttributes<EmailField>;
     }
   }
 }

package/lib/email-field/index.js

@@ -1,283 +1,83 @@
 import { __decorate } from "tslib";
-import { ControlElement, css, 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 '../icon/index.js';
-const hasChanged = (newVal, oldVal) => oldVal === undefined ? false : newVal !== oldVal;
+import { TextField } from '../text-field/index.js';
 /**
- * A form control element for email
+ * A form control element for email.
  *
  * @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 {string} icon - Specify icon to display in input. Value can be icon name
+ * @prop {string | null} [icon=null] - Specify icon to display in input. Value can be icon name
+ *
+ * @attr {boolean} icon-has-action - Specify when icon need to be clickable
+ * @prop {boolean} [iconHasAction=false] - Specify when icon need to be clickable
+ *
+ * @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 EmailField = class EmailField extends ControlElement {
+let EmailField = class EmailField 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 max limit
-         */
-        this.maxLength = null;
-        /**
-         * Set character min limit
-         */
-        this.minLength = null;
         /**
          * Set to multiple mode, allows multiple emails in a single input
          */
         this.multiple = false;
-        /**
-         * Specify icon to display in input. Value can be icon name
-         */
-        this.icon = '';
-        /**
-         * Specify when icon need to be clickable
-         */
-        this.iconHasAction = false;
-    }
-    /**
-     * 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;
-      }
-      :host([icon][icon-has-action]) [part=icon] {
-        cursor: pointer;
-      }
-    `;
-    }
-    /**
-     * Select the contents of input
-     * @returns {void}
-     */
-    /* istanbul ignore next */
-    select() {
-        if (!this.disabled && !this.readonly) {
-            this.inputElement.select();
-        }
     }
     /**
-     * Called when the element’s DOM has been updated and rendered
-     * @param changedProperties Properties that has changed
-     * @returns {void}
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="email" - always `email`
+     * multiple - defined if supports multiple emails
+     * @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': 'email', 'inputmode': 'email', 'multiple': this.multiple });
     }
     /**
      * Check if input should be re-validated
      * @param changedProperties Properties that has changed
      * @returns True if input should be re-validated
      */
+    /* istanbul ignore next */
     shouldValidateInput(changedProperties) {
+        // TODO: This validation should be refactored
         return changedProperties.has('value')
-            || changedProperties.has('pattern')
-            || changedProperties.has('minlength');
-    }
-    /**
-     * Check if value is changed and fire event
-     * @returns {void}
-     */
-    onPossibleValueChange() {
-        const value = this.inputElement.value;
-        this.setValueAndNotify(value);
-    }
-    /**
-     * Validate input according `pattern`, `minLength` and `maxLength` properties
-     * change state of `error` property according pattern validation
-     * @returns {void}
-     */
-    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);
-        }
-    }
-    /**
-     * @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);
-    }
-    /**
-     * Detect `enter` and `space` keydown and fire
-     * @param event keydown event
-     * @returns {void}
-     */
-    handleKeyDown(event) {
-        if (event.key === 'Spacebar' || event.key === ' ' || event.key === 'Enter') {
-            this.notifyIcon();
-        }
-    }
-    /**
-     * Process internal icon click and fire `icon-click` event
-     * @returns {void}
-     */
-    iconClick() {
-        this.notifyIcon();
-    }
-    /**
-     * Fire event on `icon` click
-     * @returns {void}
-     */
-    notifyIcon() {
-        if (this.iconHasAction) {
-            /**
-             * Dispatched only when element has icon-has-action attribute and icon is clicked
-             */
-            this.dispatchEvent(new CustomEvent('icon-click', { bubbles: false }));
-        }
-    }
-    /**
-     * Renders icon element if property present
-     * @returns {TemplateResult | null} Template result
-     */
-    renderIcon() {
-        return this.icon ? html `
-    <ef-icon
-        part="icon"
-        icon="${this.icon}"
-        ?readonly="${this.readonly}"
-        ?disabled="${this.disabled}"
-        @tap="${this.iconClick}"
-        @keydown="${this.handleKeyDown}"
-        tabindex="${ifDefined(this.iconHasAction ? '0' : undefined)}"
-      ></ef-icon>
-    ` : null;
-    }
-    /**
-     * A `TemplateResult` that will be used
-     * to render the updated internal template.
-     * @return {TemplateResult} Render template
-     */
-    render() {
-        return html `
-      <input
-        type="email"
-        part="input"
-        ?readonly="${this.readonly}"
-        ?disabled="${this.disabled}"
-        placeholder="${ifDefined(this.placeholder || undefined)}"
-        maxlength="${ifDefined(this.maxLength || undefined)}"
-        minlength="${ifDefined(this.minLength || undefined)}"
-        @input="${this.onPossibleValueChange}"
-        @change="${this.onPossibleValueChange}"
-        pattern="${ifDefined(this.pattern || undefined)}"
-        ?multiple="${this.multiple}"
-        autocomplete="off"
-      />
-      ${this.renderIcon()}
-    `;
+            || changedProperties.has('multiple')
+            || super.shouldValidateInput(changedProperties);
     }
 };
-__decorate([
-    property({ type: String, hasChanged })
-], EmailField.prototype, "pattern", void 0);
-__decorate([
-    property({ type: String })
-], EmailField.prototype, "placeholder", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], EmailField.prototype, "error", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], EmailField.prototype, "warning", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], EmailField.prototype, "transparent", void 0);
-__decorate([
-    property({ type: Number, attribute: 'maxlength', reflect: true })
-], EmailField.prototype, "maxLength", void 0);
-__decorate([
-    property({ type: Number, attribute: 'minlength', reflect: true })
-], EmailField.prototype, "minLength", void 0);
 __decorate([
     property({ type: Boolean, reflect: true })
 ], EmailField.prototype, "multiple", void 0);
-__decorate([
-    property({ type: String, reflect: true })
-], EmailField.prototype, "icon", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true, attribute: 'icon-has-action' })
-], EmailField.prototype, "iconHasAction", void 0);
-__decorate([
-    query('[part="input"]', true)
-], EmailField.prototype, "inputElement", void 0);
 EmailField = __decorate([
     customElement('ef-email-field', {
         alias: 'coral-email-field'

package/lib/flag/custom-elements.md

@@ -0,0 +1,10 @@
+# ef-flag
+
+Provides a collection of flags.
+
+## Properties
+
+| Property | Attribute | Type             | Default | Description                     |
+|----------|-----------|------------------|---------|---------------------------------|
+| `flag`   | `flag`    | `string \| null` | null    | Name of a known flag to render. |
+| `src`    | `src`     | `string \| null` | null    | Src location of an svg flag.    |

package/lib/flag/index.d.ts

@@ -25,6 +25,7 @@ export declare class Flag extends BasicElement {
     /**
      * Name of a known flag to render.
      * @example gb
+     * @default null
      */
     get flag(): string | null;
     set flag(value: string | null);
@@ -32,6 +33,7 @@ export declare class Flag extends BasicElement {
     /**
      * Src location of an svg flag.
      * @example https://cdn.io/flags/gb.svg
+     * @default null
      */
     get src(): string | null;
     set src(value: string | null);

package/lib/flag/index.js

@@ -53,6 +53,7 @@ let Flag = class Flag extends BasicElement {
     /**
      * Name of a known flag to render.
      * @example gb
+     * @default null
      */
     get flag() {
         return this._flag;
@@ -66,6 +67,7 @@ let Flag = class Flag extends BasicElement {
     /**
      * Src location of an svg flag.
      * @example https://cdn.io/flags/gb.svg
+     * @default null
      */
     get src() {
         return this._src;

package/lib/header/custom-elements.md

@@ -0,0 +1,18 @@
+# ef-header
+
+Use to identify and separate different sections of a page.
+Headers helps to organize the page layout content into
+a sensible hierarchy and improve the user experience.
+
+## Properties
+
+| Property | Attribute | Type                | Default | Description                  |
+|----------|-----------|---------------------|---------|------------------------------|
+| `level`  | `level`   | `"1" \| "2" \| "3"` | "2"     | Use level styling from theme |
+
+## Slots
+
+| Name    | Description                                      |
+|---------|--------------------------------------------------|
+| `left`  | Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox |
+| `right` | Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox |

package/lib/heatmap/custom-elements.md

@@ -0,0 +1,26 @@
+# ef-heatmap
+
+A graphical representation of data where the individual
+values contained in a matrix are represented as colors
+
+## Properties
+
+| Property          | Attribute      | Type                     | Default | Description                                      |
+|-------------------|----------------|--------------------------|---------|--------------------------------------------------|
+| `axisHidden`      | `axis-hidden`  | `boolean`                | false   | Hide all axes                                    |
+| `blend`           | `blend`        | `boolean`                | false   | Enable cell color blending                       |
+| `config`          | `config`       | `HeatmapConfig`          | null    | Heatmap configuration options.                   |
+| `labelHidden`     | `label-hidden` | `boolean`                | false   | Hide all labels in the cells                     |
+| `labelWidth`      | `label-width`  | `number`                 | 0       | Number of maximum label width that cell can paint in pixel.<br />e.g. label-width: 30px; cell label hides when text length reaches 30px. |
+| `maxPoint`        | `max-point`    | `number`                 | 1       | Maximum point of the cell coloring               |
+| `midPoint`        | `mid-point`    | `number`                 | 0       | Middle point of the cell coloring                |
+| `minPoint`        | `min-point`    | `number`                 | -1      | Minimum point of the cell coloring               |
+| `renderCallback`  |                | `HeatmapRenderCallback`  |         | Render callback function use for custom cell properties.<br />Accepts custom label, foreground and background color |
+| `saturation`      | `saturation`   | `number`                 | 0.4     | Cell minimum color saturation, value can be from 0 - 1 |
+| `tooltipCallback` |                | `HeatmapTooltipCallback` |         | A callback function that allows tooltip rendering on cell hover |
+
+## Methods
+
+| Method               | Type                | Description                                      |
+|----------------------|---------------------|--------------------------------------------------|
+| `getCellDataAtEvent` | `(event: any): any` | Returns data of interactive cell<br /><br />**event**: an event that occur while the user interacting with element |

package/lib/icon/custom-elements.md

@@ -0,0 +1,8 @@
+# ef-icon
+
+## Properties
+
+| Property | Attribute | Type             | Default | Description                                      |
+|----------|-----------|------------------|---------|--------------------------------------------------|
+| `icon`   | `icon`    | `string \| null` | null    | Name of a known icon to render or URL of SVG icon. |
+| `src`    | `src`     | `string \| null` | null    | Src location of an svg icon.                     |

package/lib/icon/index.d.ts

@@ -18,6 +18,7 @@ export declare class Icon extends BasicElement {
     /**
      * Name of a known icon to render or URL of SVG icon.
      * @example heart | https://cdn.io/icons/heart.svg
+     * @default null
      */
     get icon(): string | null;
     set icon(value: string | null);
@@ -26,6 +27,7 @@ export declare class Icon extends BasicElement {
      * Src location of an svg icon.
      * @example https://cdn.io/icons/heart.svg
      * @deprecated Use `icon` instead
+     * @default null
      */
     get src(): string | null;
     set src(value: string | null);

package/lib/icon/index.js

@@ -50,6 +50,7 @@ let Icon = class Icon extends BasicElement {
     /**
      * Name of a known icon to render or URL of SVG icon.
      * @example heart | https://cdn.io/icons/heart.svg
+     * @default null
      */
     get icon() {
         return this._icon;
@@ -66,6 +67,7 @@ let Icon = class Icon extends BasicElement {
      * Src location of an svg icon.
      * @example https://cdn.io/icons/heart.svg
      * @deprecated Use `icon` instead
+     * @default null
      */
     get src() {
         return this._src;

package/lib/interactive-chart/custom-elements.json

@@ -24,8 +24,9 @@
         },
         {
           "name": "legend-style",
-          "description": "Set legend style i.e. `horizontal`, `vertical`.\nDefault is `vertical`.",
-          "type": "\"vertical\" | \"horizontal\""
+          "description": "Set legend style i.e. `horizontal`, `vertical`.",
+          "type": "\"vertical\" | \"horizontal\"",
+          "default": "\"vertical\""
         }
       ],
       "properties": [
@@ -52,14 +53,9 @@
         {
           "name": "legendStyle",
           "attribute": "legend-style",
-          "description": "Set legend style i.e. `horizontal`, `vertical`.\nDefault is `vertical`.",
-          "type": "\"vertical\" | \"horizontal\""
-        },
-        {
-          "name": "seriesList",
-          "description": "Array of series instances in chart",
-          "type": "object",
-          "default": "[]"
+          "description": "Set legend style i.e. `horizontal`, `vertical`.",
+          "type": "\"vertical\" | \"horizontal\"",
+          "default": "\"vertical\""
         }
       ],
       "events": [