@refinitiv-ui/elements 5.5.0 → 5.8.1

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

@@ -1,122 +1,65 @@
 import { JSXInterface } from '../jsx';
-import { ControlElement, CSSResult, PropertyValues, TemplateResult } from '@refinitiv-ui/core';
-import '../icon';
+import { TemplateResult } from '@refinitiv-ui/core';
+import { TemplateMap } from '@refinitiv-ui/core/lib/directives/template-map.js';
+import '../icon/index.js';
+import { TextField } from '../text-field/index.js';
+import { Translate } from '@refinitiv-ui/translate';
+import '@refinitiv-ui/phrasebook/lib/locale/en/search-field.js';
 /**
  * Form control to get a search input from users.
  *
  * @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 {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 SearchField extends ControlElement {
-    /**
-     * Element version number
-     * @returns version number
-     */
-    static get version(): string;
-    /**
-     * A `CSSResult` that will be used
-     * to style the host, slotted children
-     * and the internal template of the element.
-     * @return CSS template
-     */
-    static get styles(): CSSResult | CSSResult[];
-    /**
-     * Set regular expression for input validation
-     */
-    pattern: string;
-    /**
-     * Set place holder text
-     */
-    placeholder: string;
-    /**
-     * Set state to error
-     */
-    error: boolean;
-    /**
-     * Set state to warning
-     */
-    warning: boolean;
+export declare class SearchField extends TextField {
     /**
-     * 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.
+     * Used for translations
      */
-    transparent: boolean;
+    protected t: Translate;
     /**
-     * Set character max limit
-     */
-    maxLength: number | null;
-    /**
-     * Set character min limit
-     */
-    minLength: number | null;
-    /**
-     * Specify when icon need to be clickable
-     */
-    iconHasAction: boolean;
-    /**
-     * Get native input element from shadow roots
-     */
-    private inputElement;
-    /**
-     * Select the contents of input
-     * @returns void
-     */
-    select(): void;
-    /**
-     * A `TemplateResult` that will be used
-     * to render the updated internal template.
-     * @return Render template
-     */
-    protected render(): TemplateResult;
-    /**
-     * Called when the element’s DOM has been updated and rendered
-     * @param changedProperties Properties that has changed
-     * @returns {void}
-     */
-    protected updated(changedProperties: PropertyValues): void;
-    /**
-     * Check if input should be re-validated
-     * @param changedProperties Properties that has changed
-     * @returns True if input should be re-validated
-     */
-    private shouldValidateInput;
-    /**
-     * 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;
-    /**
-     * Check if value is changed
-     * @returns {void}
-     */
-    private onPossibleValueChange;
-    /**
-     * Detect `enter` and `space` keydown and fire
-     * @param event keydown event
-     * @returns {void}
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="search" - always `search`
+     * @returns template map
      */
-    private handleKeyDown;
+    protected get decorateInputMap(): TemplateMap;
     /**
-     * Fire event on icon click
+     * Renders icon element
      * @returns {void}
      */
-    private notifyIcon;
+    protected renderIcon(): TemplateResult | null;
 }
 
 declare global {
@@ -126,7 +69,7 @@ declare global {
 
   namespace JSX {
     interface IntrinsicElements {
-      'ef-search-field': Partial<SearchField> | JSXInterface.ControlHTMLAttributes<SearchField>;
+      'ef-search-field': Partial<SearchField> | JSXInterface.HTMLAttributes<SearchField>;
     }
   }
 }

package/lib/search-field/index.js

@@ -1,251 +1,81 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { ControlElement, css, customElement, html, ifDefined, property, query } from '@refinitiv-ui/core';
-import { VERSION } from '../';
-import '../icon';
-const hasChanged = (newVal, oldVal) => oldVal === undefined ? false : newVal !== oldVal;
-const isIE = (/Trident/g).test(navigator.userAgent);
+import { __decorate } from "tslib";
+import { html } from '@refinitiv-ui/core';
+import { customElement } from '@refinitiv-ui/core/lib/decorators/custom-element.js';
+import { ifDefined } from '@refinitiv-ui/core/lib/directives/if-defined.js';
+import '../icon/index.js';
+import { TextField } from '../text-field/index.js';
+import { translate } from '@refinitiv-ui/translate';
+import '@refinitiv-ui/phrasebook/lib/locale/en/search-field.js';
 /**
  * Form control to get a search input from users.
  *
  * @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 {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 SearchField = class SearchField extends ControlElement {
-    constructor() {
-        super(...arguments);
-        /**
-         * Set regular expression for input validation
-         */
-        this.pattern = '';
-        /**
-         * Set place holder 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;
-        /**
-         * Specify when icon need to be clickable
-         */
-        this.iconHasAction = false;
-    }
-    /**
-     * Element version number
-     * @returns version number
-     */
-    static get version() {
-        return VERSION;
-    }
-    /**
-     * A `CSSResult` 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-has-action]) [part=icon] {
-        cursor: pointer;
-      }
-    `;
-    }
+let SearchField = class SearchField extends TextField {
     /**
-     * Select the contents of input
-     * @returns void
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="search" - always `search`
+     * @returns template map
      */
-    select() {
-        if (!this.disabled && !this.readonly) {
-            this.inputElement.select();
-        }
+    get decorateInputMap() {
+        return Object.assign(Object.assign({}, super.decorateInputMap), { 'type': 'search', 'inputmode': 'search' });
     }
     /**
-     * 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="search"
-        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)}"
-        autocomplete="off"
-      />
       <ef-icon
         part="icon"
+        role="${ifDefined(this.iconHasAction ? 'button' : undefined)}"
         icon="search"
+        aria-label="${this.t('SEARCH')}"
         ?readonly="${this.readonly}"
         ?disabled="${this.disabled}"
-        @tap="${this.notifyIcon}"
-        @keydown="${this.handleKeyDown}"
+        @tap="${this.iconClick}"
         tabindex="${ifDefined(this.iconHasAction ? '0' : undefined)}"
       ></ef-icon>
     `;
     }
-    /**
-     * Called when the element’s DOM has been updated and rendered
-     * @param changedProperties Properties that has changed
-     * @returns {void}
-     */
-    updated(changedProperties) {
-        super.updated(changedProperties);
-        if (this.inputElement.value !== this.value) {
-            this.inputElement.value = this.value;
-        }
-        if (this.shouldValidateInput(changedProperties)) {
-            this.validateInput();
-        }
-    }
-    /**
-     * Check if input should be re-validated
-     * @param changedProperties Properties that has changed
-     * @returns 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')));
-    }
-    /**
-     * 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);
-    }
-    /**
-     * Check if value is changed
-     * @returns {void}
-     */
-    onPossibleValueChange() {
-        const value = this.inputElement.value;
-        this.setValueAndNotify(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();
-        }
-    }
-    /**
-     * 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 }));
-        }
-    }
 };
 __decorate([
-    property({ type: String, hasChanged })
-], SearchField.prototype, "pattern", void 0);
-__decorate([
-    property({ type: String })
-], SearchField.prototype, "placeholder", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], SearchField.prototype, "error", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], SearchField.prototype, "warning", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true })
-], SearchField.prototype, "transparent", void 0);
-__decorate([
-    property({ type: Number, attribute: 'maxlength', reflect: true })
-], SearchField.prototype, "maxLength", void 0);
-__decorate([
-    property({ type: Number, attribute: 'minlength', reflect: true, hasChanged })
-], SearchField.prototype, "minLength", void 0);
-__decorate([
-    property({ type: Boolean, reflect: true, attribute: 'icon-has-action' })
-], SearchField.prototype, "iconHasAction", void 0);
-__decorate([
-    query('[part="input"]')
-], SearchField.prototype, "inputElement", void 0);
+    translate({ scope: 'ef-search-field' })
+], SearchField.prototype, "t", void 0);
 SearchField = __decorate([
     customElement('ef-search-field', {
         alias: 'coral-search-field'

package/lib/select/custom-elements.json

@@ -33,12 +33,12 @@
           "name": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "properties": [
         {
-          "name": "label",
+          "name": "label (readonly)",
           "description": "Current text content of the selected value",
           "type": "string"
         },
@@ -78,14 +78,15 @@
         {
           "name": "value",
           "description": "Value of the element",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "disabled",
           "attribute": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "events": [

package/lib/select/custom-elements.md

@@ -0,0 +1,24 @@
+# ef-select
+
+Expands upon the native select element,
+providing a fully themeable dropdown element.
+
+## Properties
+
+| Property           | Attribute     | Type                 | Default | Description                                      |
+|--------------------|---------------|----------------------|---------|--------------------------------------------------|
+| `data`             |               | `SelectData \| null` | null    | Construct the menu from data object. Cannot be used with slotted content |
+| `disabled`         | `disabled`    | `boolean`            | false   | Set disabled state                               |
+| `error`            | `error`       | `boolean`            | false   | Set state to error                               |
+| `label (readonly)` |               | `string`             |         | Current text content of the selected value       |
+| `opened`           | `opened`      | `boolean`            | false   | Toggles the opened state of the list             |
+| `placeholder`      | `placeholder` | `string`             | ""      | Placeholder to display when no value is set      |
+| `value`            |               | `string`             | ""      | Value of the element                             |
+| `warning`          | `warning`     | `boolean`            | false   | Set state to warning                             |
+
+## Events
+
+| Event            | Description                             |
+|------------------|-----------------------------------------|
+| `opened-changed` | Fired when the opened property changes. |
+| `value-changed`  | Fired when the value property changes.  |

package/lib/select/helpers/types.d.ts

@@ -1,3 +1,3 @@
-import { ItemData } from '../../item';
+import type { ItemData } from '../../item';
 export declare type SelectData = ItemData[];
 export declare type SelectDataItem = ItemData;

package/lib/select/index.d.ts

@@ -1,10 +1,10 @@
 import { JSXInterface } from '../jsx';
-import { ControlElement, TemplateResult, CSSResult, PropertyValues, MultiValue } from '@refinitiv-ui/core';
-import '../overlay';
-import '../item';
-import '../icon';
-import { SelectData, SelectDataItem } from './helpers/types';
-export { SelectData, SelectDataItem };
+import { ControlElement, TemplateResult, CSSResultGroup, PropertyValues, MultiValue } from '@refinitiv-ui/core';
+import '../overlay/index.js';
+import '../item/index.js';
+import '../icon/index.js';
+import type { SelectData, SelectDataItem } from './helpers/types';
+export type { SelectData, SelectDataItem };
 /**
  * Expands upon the native select element,
  * providing a fully themeable dropdown element.
@@ -21,13 +21,14 @@ export declare class Select extends ControlElement implements MultiValue {
      * @returns version number
      */
     static get version(): string;
+    protected readonly defaultRole: string | null;
     /**
-     * A `CSSResult` that will be used
+     * 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(): CSSResult | CSSResult[];
+    static get styles(): CSSResultGroup;
     private composer;
     private _data;
     private mutationObserver?;
@@ -79,6 +80,7 @@ export declare class Select extends ControlElement implements MultiValue {
     /**
     * Construct the menu from data object. Cannot be used with slotted content
     * @type {SelectData | null}
+    * @default null
     */
     get data(): SelectData | null;
     set data(value: SelectData | null);
@@ -91,6 +93,7 @@ export declare class Select extends ControlElement implements MultiValue {
     /**
     * Value of the element
     * @param value Element value
+    * @default -
     */
     set value(value: string);
     get value(): string;
@@ -101,6 +104,11 @@ export declare class Select extends ControlElement implements MultiValue {
      */
     get values(): string[];
     private menuEl?;
+    /**
+     * Called when connected to DOM
+     * @returns {void}
+     */
+    connectedCallback(): void;
     /**
      * Updates the element
      * @param changedProperties Properties that has changed
@@ -239,8 +247,8 @@ export declare class Select extends ControlElement implements MultiValue {
      */
     private isValidFilterKey;
     /**
-     * Focus and highlight the next/previous element
-     * @param direction Focus next or previous element
+     * Focus and highlight element according to specified direction
+     * @param direction previous, next, first or last focusable element
      * @returns {void}
      */
     private focusElement;