@refinitiv-ui/elements 5.5.0 → 5.8.1

package/lib/radio-button/index.js

@@ -1,23 +1,21 @@
-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 { html, css, customElement, property, ControlElement, query } from '@refinitiv-ui/core';
-import { VERSION } from '../';
-import { registerOverflowTooltip } from '../tooltip';
-import { applyRegistry, removeFromRegistry, getRadioGroup } from './radio-button-registry';
+import { __decorate } from "tslib";
+import { html, css, ControlElement } 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 { VERSION } from '../version.js';
+import { registerOverflowTooltip } from '../tooltip/index.js';
+import { applyRegistry, removeFromRegistry, getRadioGroup } from './radio-button-registry.js';
 /**
  * Basic radio button
  *
  * @fires checked-changed - Fired when the `checked` property changes.
  *
- * @attr {string} [value=] - Value of the radio button
- * @prop {string} [value=] - Value of the radio button
+ * @attr {string} value - Value of the radio button
+ * @prop {string} [value=""] - Value of the radio button
 *
- * @attr {string} [name=] - Group multiple radio buttons by assigning the same name
- * @prop {string} [name=] - Group multiple radio buttons by assigning the same name
+ * @attr {string} name - Group multiple radio buttons by assigning the same name
+ * @prop {string} [name=""] - Group multiple radio buttons by assigning the same name
  *
  * @attr {boolean} readonly - Set readonly state
  * @prop {boolean} [readonly=false] - Set readonly state
@@ -28,10 +26,13 @@ import { applyRegistry, removeFromRegistry, getRadioGroup } from './radio-button
 let RadioButton = class RadioButton extends ControlElement {
     constructor() {
         super(...arguments);
+        this.defaultRole = 'radio';
+        this._checked = false;
         /**
-         * Radio button checked state
+         * Aria indicating checked state
+         * @ignore
          */
-        this.checked = false;
+        this.ariaChecked = String(this.checked);
     }
     /**
      * Element version number
@@ -41,7 +42,7 @@ let RadioButton = class RadioButton extends ControlElement {
         return VERSION;
     }
     /**
-     * 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
@@ -70,6 +71,23 @@ let RadioButton = class RadioButton extends ControlElement {
       }
     `;
     }
+    /**
+     * Radio button checked state
+     * @param value checked state
+     * @default false
+     * @returns {void}
+     */
+    set checked(value) {
+        const oldValue = this._checked;
+        if (oldValue !== value) {
+            this._checked = value;
+            this.ariaChecked = String(value);
+            void this.requestUpdate('checked', oldValue);
+        }
+    }
+    get checked() {
+        return this._checked;
+    }
     /**
      * Called when connected to DOM
      * @returns {void}
@@ -94,7 +112,7 @@ let RadioButton = class RadioButton extends ControlElement {
      */
     update(changedProperties) {
         if (this.isConnected && this.hasUpdated && changedProperties.has('name')) {
-            applyRegistry(this);
+            applyRegistry(this, changedProperties.get('name'));
         }
         // Ensure only one radio button is checked
         if (this.isConnected && this.hasUpdated && (changedProperties.has('checked') || (changedProperties.has('name')))) {
@@ -119,8 +137,12 @@ let RadioButton = class RadioButton extends ControlElement {
      */
     manageGroupState() {
         if (this.checked && this.name) {
+            // restore tab index when checked
+            this.tabIndex = 0;
             getRadioGroup(this).filter(radio => radio !== this).forEach(radio => {
-                radio.checked = false; // unchecking the rest of the group members
+                // uncheck and hide the rest of the group members from focusability
+                radio.checked = false;
+                radio.tabIndex = -1;
             });
         }
     }
@@ -141,15 +163,26 @@ let RadioButton = class RadioButton extends ControlElement {
      * @returns {void}
      */
     onKeyDown(event) {
-        if (this.disabled || this.readonly || event.defaultPrevented) {
+        if (this.disabled || event.defaultPrevented) {
             return;
         }
         switch (event.key) {
             case 'Enter':
             case ' ':
             case 'Spacebar':
+                if (this.readonly) {
+                    return;
+                }
                 this.handleChangeChecked();
                 break;
+            case 'ArrowRight':
+            case 'ArrowDown':
+                this.navigateToSibling('next');
+                break;
+            case 'ArrowLeft':
+            case 'ArrowUp':
+                this.navigateToSibling('previous');
+                break;
             default:
                 return;
         }
@@ -167,6 +200,33 @@ let RadioButton = class RadioButton extends ControlElement {
             this.notifyPropertyChange('checked', this.checked);
         }
     }
+    /**
+     * Navigate to next or previous checkable sibling in the same group if present
+     * @param direction up/next; down/previous
+     * @returns {void}
+     */
+    navigateToSibling(direction) {
+        if (!this.name) {
+            return;
+        }
+        const group = getRadioGroup(this).filter(radio => !radio.disabled);
+        const index = group.indexOf(this);
+        let element;
+        if (direction === 'next') {
+            element = index === -1 ? group[0] : group[index + 1];
+        }
+        else {
+            element = index === -1 ? group[group.length - 1] : group[index - 1];
+        }
+        if (!element) {
+            element = direction === 'next' ? group[0] : group[group.length - 1];
+        }
+        if (!element.readonly) {
+            this.checked = false;
+            element.checked = true;
+        }
+        element.focus();
+    }
     /**
      * A `TemplateResult` that will be used
      * to render the updated internal template.
@@ -183,7 +243,10 @@ let RadioButton = class RadioButton extends ControlElement {
 };
 __decorate([
     property({ type: Boolean, reflect: true })
-], RadioButton.prototype, "checked", void 0);
+], RadioButton.prototype, "checked", null);
+__decorate([
+    property({ type: String, reflect: true, attribute: 'aria-checked' })
+], RadioButton.prototype, "ariaChecked", void 0);
 __decorate([
     query('[part=label]', true)
 ], RadioButton.prototype, "labelEl", void 0);

package/lib/radio-button/radio-button-registry.d.ts

@@ -1,4 +1,4 @@
-import { RadioButton } from './index';
+import type { RadioButton } from './index';
 /**
  * Remove radio button from registry
  * @param radio Radio button to remove
@@ -9,9 +9,10 @@ declare const removeFromRegistry: (radio: RadioButton) => void;
  * Add radio button to registry group of radio has a name
  * If radio does not have the name, remove from the group
  * @param radio Radio button to add
+ * @param oldGroupName group name of radio button before changed
  * @returns {void}
  */
-declare const applyRegistry: (radio: RadioButton) => void;
+declare const applyRegistry: (radio: RadioButton, oldGroupName?: string) => void;
 /**
  * Get the group of same name radio buttons
  * @param radio A radio to get a group for

package/lib/radio-button/radio-button-registry.js

@@ -14,16 +14,69 @@ const removeFromRegistry = (radio) => {
  * Add radio button to registry group of radio has a name
  * If radio does not have the name, remove from the group
  * @param radio Radio button to add
+ * @param oldGroupName group name of radio button before changed
  * @returns {void}
  */
-const applyRegistry = (radio) => {
-    const idx = registry.indexOf(radio);
-    if (radio.name && idx === -1) {
+const applyRegistry = (radio, oldGroupName = '') => {
+    const isNewRadioButton = registry.indexOf(radio) === -1;
+    if (radio.name && isNewRadioButton) {
         registry.push(radio);
+        if (registry.length === 1) {
+            return;
+        }
+        // Set tabIndex to -1 if radio either uncheck or not the first radio button in the group.
+        const radioGroup = getRadioGroup(radio);
+        if (!radio.checked && radioGroup.length > 1) {
+            radio.tabIndex = -1;
+        }
     }
-    else if (!radio.name && idx !== -1) {
+    // Removed from the group
+    else if (!radio.name && !isNewRadioButton) {
         removeFromRegistry(radio);
+        radio.tabIndex = 0; // Restores tabIndex and switch to single mode
+        // Re-compute tabIndex for old radio group
+        const oldRadioGroup = registry.filter(radio => radio.name === oldGroupName);
+        restoreTabIndex(oldRadioGroup);
+    }
+    // Changes group
+    else if (radio.name && !isNewRadioButton) {
+        // Re-compute tabIndex for new radio group when name attribute has changed
+        const newRadioGroup = getRadioGroup(radio);
+        if (radio.checked) {
+            radio.tabIndex = 0;
+            // uncheck and hide the rest of the group members from focusability
+            newRadioGroup.filter((newRadio) => newRadio !== radio).forEach(newRadio => {
+                newRadio.checked = false;
+                newRadio.tabIndex = -1;
+            });
+        }
+        else {
+            radio.tabIndex = -1;
+            restoreTabIndex(newRadioGroup);
+        }
+        // Re-compute tabIndex for old radio group when name attribute has changed.
+        const oldRadioGroup = registry.filter(radio => radio.name === oldGroupName);
+        restoreTabIndex(oldRadioGroup);
+    }
+};
+/**
+ * Re-compute tabIndex for the radio group
+ * Set tabIndex to 0 for first radio button in the group.
+ * Set tabIndex to -1 for the rest of button in group.
+ * @param radioGroup collection of radio buttons
+ * @returns {void}
+ */
+const restoreTabIndex = (radioGroup) => {
+    if (!radioGroup.length) {
+        return;
+    }
+    const checkedRadio = radioGroup.filter(radio => radio.checked);
+    if (checkedRadio.length) {
+        return;
     }
+    radioGroup.forEach((radio, index) => {
+        radio.tabIndex = index === 0 ? 0 : -1;
+    });
 };
 /**
  * Get the group of same name radio buttons

package/lib/rating/custom-elements.md

@@ -0,0 +1,17 @@
+# ef-rating
+
+Star visualisation component that is generally used for ranking
+
+## Properties
+
+| Property      | Attribute     | Type      | Default | Description                                      |
+|---------------|---------------|-----------|---------|--------------------------------------------------|
+| `interactive` | `interactive` | `boolean` | false   | Make it possible to interact with rating control and change the value |
+| `max`         | `max`         | `string`  | "5"     | Set number of total stars                        |
+| `value`       | `value`       | `string`  | "0"     | Set number of selected stars. Value can be any number between 0 and `max`.<br />Decimal values are calculated to empty star (0 - .25); half-star (.25 - .75) and full star (.75 - 1) |
+
+## Events
+
+| Event           | Description                     |
+|-----------------|---------------------------------|
+| `value-changed` | Fired when the `value` changes. |

package/lib/rating/index.d.ts

@@ -1,5 +1,5 @@
 import { JSXInterface } from '../jsx';
-import { BasicElement, TemplateResult, CSSResult, PropertyValues } from '@refinitiv-ui/core';
+import { BasicElement, TemplateResult, CSSResultGroup, PropertyValues } from '@refinitiv-ui/core';
 /**
  * Star visualisation component that is generally used for ranking
  * @fires value-changed - Fired when the `value` changes.
@@ -62,12 +62,12 @@ export declare class Rating extends BasicElement {
      */
     protected updated(changedProperties: PropertyValues): void;
     /**
-     * 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.
      * @returns CSS template
      */
-    static get styles(): CSSResult | CSSResult[];
+    static get styles(): CSSResultGroup;
     /**
      * A `TemplateResult` that will be used
      * to render the updated internal template.

package/lib/rating/index.js

@@ -1,11 +1,10 @@
-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 { BasicElement, html, css, customElement, property, queryAll, repeat } from '@refinitiv-ui/core';
-import { VERSION } from '../';
+import { __decorate } from "tslib";
+import { BasicElement, html, css } 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 { queryAll } from '@refinitiv-ui/core/lib/decorators/query-all.js';
+import { repeat } from '@refinitiv-ui/core/lib/directives/repeat.js';
+import { VERSION } from '../version.js';
 /**
  * Star visualisation component that is generally used for ranking
  * @fires value-changed - Fired when the `value` changes.
@@ -78,7 +77,7 @@ let Rating = class Rating extends BasicElement {
             this.items.push({ item: selected ? `icon icon-${selected}` : 'icon' });
         }
         this.valuePrevious = value;
-        void this.requestUpdate();
+        this.requestUpdate();
     }
     /**
      * Process click event to set the new value
@@ -115,7 +114,7 @@ let Rating = class Rating extends BasicElement {
         });
     }
     /**
-     * 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.
      * @returns CSS template

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

@@ -6,48 +6,44 @@
       "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": "disabled",
+          "description": "Set disabled state",
+          "type": "boolean",
+          "default": "false"
         },
         {
           "name": "error",
-          "description": "Set state to error",
+          "description": "Set error state",
           "type": "boolean",
           "default": "false"
         },
         {
-          "name": "warning",
-          "description": "Set state to warning",
+          "name": "icon-has-action",
+          "description": "Specify when icon need to be clickable",
           "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.",
-          "type": "boolean",
-          "default": "false"
+          "name": "placeholder",
+          "description": "Set placeholder text",
+          "type": "string",
+          "default": "\"\""
         },
         {
-          "name": "maxlength",
-          "description": "Set character max limit",
-          "type": "number | null"
+          "name": "readonly",
+          "description": "Set readonly state",
+          "type": "boolean",
+          "default": "false"
         },
         {
-          "name": "minlength",
-          "description": "Set character min limit",
-          "type": "number | null"
+          "name": "transparent",
+          "description": "Disables all other states and border/background styles.",
+          "type": "boolean",
+          "default": "false"
         },
         {
-          "name": "icon-has-action",
-          "description": "Specify when icon need to be clickable",
+          "name": "warning",
+          "description": "Set warning state",
           "type": "boolean",
           "default": "false"
         },
@@ -58,77 +54,63 @@
           "default": "\"\""
         },
         {
-          "name": "readonly",
-          "description": "Set readonly state",
-          "type": "boolean",
-          "default": "\"false\""
+          "name": "icon-has-action",
+          "description": "Specify when icon need to be clickable",
+          "type": "boolean"
         },
         {
-          "name": "disabled",
-          "description": "Set disabled state",
-          "type": "boolean",
-          "default": "\"false\""
+          "name": "maxlength",
+          "description": "Set character max limit",
+          "type": "number"
+        },
+        {
+          "name": "minlength",
+          "description": "Set character min limit",
+          "type": "number"
         }
       ],
       "properties": [
         {
-          "name": "pattern",
-          "attribute": "pattern",
-          "description": "Set regular expression for input validation",
-          "type": "string",
-          "default": "\"\""
-        },
-        {
-          "name": "placeholder",
-          "attribute": "placeholder",
-          "description": "Set place holder text",
-          "type": "string",
-          "default": "\"\""
-        },
-        {
-          "name": "error",
-          "attribute": "error",
-          "description": "Set state to error",
+          "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": "\"\""
         },
@@ -137,14 +119,28 @@
           "attribute": "readonly",
           "description": "Set readonly state",
           "type": "boolean",
-          "default": "\"false\""
+          "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\""
+          "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

@@ -0,0 +1,41 @@
+# ef-search-field
+
+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 error state                                  |
+| `iconHasAction` | `icon-has-action` | `boolean`        | false   | Specify when icon need to be clickable           |
+| `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. |
+| `value`         | `value`           | `string`         | ""      | Input's value                                    |
+| `warning`       | `warning`         | `boolean`        | false   | Set warning state                                |
+
+## Methods
+
+| Method       | Type      |
+|--------------|-----------|
+| `renderIcon` | `(): any` |
+
+## Events
+
+| Event           | Description                         |
+|-----------------|-------------------------------------|
+| `error-changed` | Dispatched when error state changes |
+| `icon-click`    | Dispatched when icon is clicked     |
+| `value-changed` | Dispatched when value changes       |