@refinitiv-ui/elements 5.7.0 → 5.8.0

package/lib/search-field/custom-elements.json

@@ -6,45 +6,17 @@
       "description": "Form control to get a search input from users.",
       "attributes": [
         {
-          "name": "pattern",
-          "description": "Set regular expression for input validation",
-          "type": "string",
-          "default": "\"\""
-        },
-        {
-          "name": "placeholder",
-          "description": "Set place holder text",
-          "type": "string",
-          "default": "\"\""
-        },
-        {
-          "name": "error",
-          "description": "Set state to error",
-          "type": "boolean",
-          "default": "false"
-        },
-        {
-          "name": "warning",
-          "description": "Set state to warning",
+          "name": "disabled",
+          "description": "Set disabled state",
           "type": "boolean",
           "default": "false"
         },
         {
-          "name": "transparent",
-          "description": "Disables all other states and border/background styles.\nUse with advanced composite elements requiring e.g. multi selection in\ncombo-box when parent container handles element states.",
+          "name": "error",
+          "description": "Set error state",
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "maxlength",
-          "description": "Set character max limit",
-          "type": "number | null"
-        },
-        {
-          "name": "minlength",
-          "description": "Set character min limit",
-          "type": "number | null"
-        },
         {
           "name": "icon-has-action",
           "description": "Specify when icon need to be clickable",
@@ -52,10 +24,10 @@
           "default": "false"
         },
         {
-          "name": "value",
-          "description": "Input's value",
+          "name": "placeholder",
+          "description": "Set placeholder text",
           "type": "string",
-          "default": "0"
+          "default": "\"\""
         },
         {
           "name": "readonly",
@@ -64,73 +36,83 @@
           "default": "false"
         },
         {
-          "name": "disabled",
-          "description": "Set disabled state",
+          "name": "transparent",
+          "description": "Disables all other states and border/background styles.",
           "type": "boolean",
           "default": "false"
-        }
-      ],
-      "properties": [
+        },
         {
-          "name": "pattern",
-          "attribute": "pattern",
-          "description": "Set regular expression for input validation",
-          "type": "string",
-          "default": "\"\""
+          "name": "warning",
+          "description": "Set warning state",
+          "type": "boolean",
+          "default": "false"
         },
         {
-          "name": "placeholder",
-          "attribute": "placeholder",
-          "description": "Set place holder text",
+          "name": "value",
+          "description": "Input's value",
           "type": "string",
           "default": "\"\""
         },
         {
-          "name": "error",
-          "attribute": "error",
-          "description": "Set state to error",
+          "name": "icon-has-action",
+          "description": "Specify when icon need to be clickable",
+          "type": "boolean"
+        },
+        {
+          "name": "maxlength",
+          "description": "Set character max limit",
+          "type": "number"
+        },
+        {
+          "name": "minlength",
+          "description": "Set character min limit",
+          "type": "number"
+        }
+      ],
+      "properties": [
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "Set disabled state",
           "type": "boolean",
           "default": "false"
         },
         {
-          "name": "warning",
-          "attribute": "warning",
-          "description": "Set state to warning",
+          "name": "error",
+          "attribute": "error",
+          "description": "Set error state",
           "type": "boolean",
           "default": "false"
         },
         {
-          "name": "transparent",
-          "attribute": "transparent",
-          "description": "Disables all other states and border/background styles.\nUse with advanced composite elements requiring e.g. multi selection in\ncombo-box when parent container handles element states.",
+          "name": "iconHasAction",
+          "attribute": "icon-has-action",
+          "description": "Specify when icon need to be clickable",
           "type": "boolean",
           "default": "false"
         },
         {
           "name": "maxLength",
-          "attribute": "maxlength",
           "description": "Set character max limit",
           "type": "number | null"
         },
         {
           "name": "minLength",
-          "attribute": "minlength",
           "description": "Set character min limit",
           "type": "number | null"
         },
         {
-          "name": "iconHasAction",
-          "attribute": "icon-has-action",
-          "description": "Specify when icon need to be clickable",
-          "type": "boolean",
-          "default": "false"
+          "name": "pattern",
+          "description": "Set regular expression for input validation",
+          "type": "string",
+          "default": "\"\""
         },
         {
-          "name": "value",
-          "attribute": "value",
-          "description": "Input's value",
+          "name": "placeholder",
+          "attribute": "placeholder",
+          "description": "Set placeholder text",
           "type": "string",
-          "default": "0"
+          "default": "\"\""
         },
         {
           "name": "readonly",
@@ -140,11 +122,25 @@
           "default": "false"
         },
         {
-          "name": "disabled",
-          "attribute": "disabled",
-          "description": "Set disabled state",
+          "name": "transparent",
+          "attribute": "transparent",
+          "description": "Disables all other states and border/background styles.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "warning",
+          "attribute": "warning",
+          "description": "Set warning state",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "value",
+          "attribute": "value",
+          "description": "Input's value",
+          "type": "string",
+          "default": "\"\""
         }
       ],
       "events": [
@@ -158,13 +154,13 @@
         },
         {
           "name": "icon-click",
-          "description": "Dispatched only when element has icon-has-action attribute and icon is clicked"
+          "description": "Dispatched when icon is clicked"
         }
       ],
       "methods": [
         {
-          "name": "select",
-          "description": "Select the contents of input",
+          "name": "renderIcon",
+          "description": "",
           "params": []
         }
       ]

package/lib/search-field/custom-elements.md

@@ -2,32 +2,40 @@
 
 Form control to get a search input from users.
 
+## Attributes
+
+| Attribute         | Type      | Description                            |
+|-------------------|-----------|----------------------------------------|
+| `icon-has-action` | `boolean` | Specify when icon need to be clickable |
+| `maxlength`       | `number`  | Set character max limit                |
+| `minlength`       | `number`  | Set character min limit                |
+
 ## Properties
 
 | Property        | Attribute         | Type             | Default | Description                                      |
 |-----------------|-------------------|------------------|---------|--------------------------------------------------|
 | `disabled`      | `disabled`        | `boolean`        | false   | Set disabled state                               |
-| `error`         | `error`           | `boolean`        | false   | Set state to error                               |
+| `error`         | `error`           | `boolean`        | false   | Set error state                                  |
 | `iconHasAction` | `icon-has-action` | `boolean`        | false   | Specify when icon need to be clickable           |
-| `maxLength`     | `maxlength`       | `number \| null` | null    | Set character max limit                          |
-| `minLength`     | `minlength`       | `number \| null` | null    | Set character min limit                          |
-| `pattern`       | `pattern`         | `string`         | ""      | Set regular expression for input validation      |
-| `placeholder`   | `placeholder`     | `string`         | ""      | Set place holder text                            |
+| `maxLength`     |                   | `number \| null` | null    | Set character max limit                          |
+| `minLength`     |                   | `number \| null` | null    | Set character min limit                          |
+| `pattern`       |                   | `string`         | ""      | Set regular expression for input validation      |
+| `placeholder`   | `placeholder`     | `string`         | ""      | Set placeholder text                             |
 | `readonly`      | `readonly`        | `boolean`        | false   | Set readonly state                               |
-| `transparent`   | `transparent`     | `boolean`        | false   | Disables all other states and border/background styles.<br />Use with advanced composite elements requiring e.g. multi selection in<br />combo-box when parent container handles element states. |
-| `value`         | `value`           | `string`         | 0       | Input's value                                    |
-| `warning`       | `warning`         | `boolean`        | false   | Set state to warning                             |
+| `transparent`   | `transparent`     | `boolean`        | false   | Disables all other states and border/background styles. |
+| `value`         | `value`           | `string`         | ""      | Input's value                                    |
+| `warning`       | `warning`         | `boolean`        | false   | Set warning state                                |
 
 ## Methods
 
-| Method   | Type       | Description                  |
-|----------|------------|------------------------------|
-| `select` | `(): void` | Select the contents of input |
+| Method       | Type      |
+|--------------|-----------|
+| `renderIcon` | `(): any` |
 
 ## Events
 
-| Event           | Description                                      |
-|-----------------|--------------------------------------------------|
-| `error-changed` | Dispatched when error state changes              |
-| `icon-click`    | Dispatched only when element has icon-has-action attribute and icon is clicked |
-| `value-changed` | Dispatched when value changes                    |
+| Event           | Description                         |
+|-----------------|-------------------------------------|
+| `error-changed` | Dispatched when error state changes |
+| `icon-click`    | Dispatched when icon is clicked     |
+| `value-changed` | Dispatched when value changes       |

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

@@ -1,122 +1,65 @@
 import { JSXInterface } from '../jsx';
-import { ControlElement, CSSResultGroup, PropertyValues, TemplateResult } from '@refinitiv-ui/core';
+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 `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 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>;
     }
   }
 }