@refinitiv-ui/elements 6.11.0 → 6.12.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.12.0](https://github.com/Refinitiv/refinitiv-ui/compare/@refinitiv-ui/elements@6.11.0...@refinitiv-ui/elements@6.12.0) (2023-09-18)
+
+### Bug Fixes
+
+- **slider:** incorrect updating to value ([#947](https://github.com/Refinitiv/refinitiv-ui/issues/947)) ([f883987](https://github.com/Refinitiv/refinitiv-ui/commit/f883987482cf91c7b6b687c9c67d733bf7a9e4d3))
+- **slider:** number field not revalidate when error state changes ([#953](https://github.com/Refinitiv/refinitiv-ui/issues/953)) ([d4b952e](https://github.com/Refinitiv/refinitiv-ui/commit/d4b952e9d376b0e751584afc6de7a5527dbc11c3))
+
+### Features
+
+- **utils:** add `selectedAt` property to `DataItem` interface ([181066b](https://github.com/Refinitiv/refinitiv-ui/commit/181066bad6842f0b06d0607150d3d633bf89f0e7))
+
 # [6.11.0](https://github.com/Refinitiv/refinitiv-ui/compare/@refinitiv-ui/elements@6.10.2...@refinitiv-ui/elements@6.11.0) (2023-09-11)
 
 ### Features

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2023, Refinitiv.
+Copyright © 2023, LSEG
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/README.md

@@ -1,6 +1,6 @@
 # Element Framework
 
-Element Framework (EF) is a collection of elements that includes theming capability within the Refinitiv Workspace's design system. The elements are a set of web components which is a standard web technology and can be utilized across all browsers.
+Element Framework (EF) is a collection of elements that includes theming capability within the LSEG Workspace's design system. The elements are a set of web components which is a standard web technology and can be utilized across all browsers.
 
 ## Usage
 
@@ -10,17 +10,17 @@ EF elements are published under single package.
 npm install @refinitiv-ui/elements
 ```
 
-The elements are required theme to instantiate itself in the app. Refinitiv Workspace's design system is called Halo theme and you can install it from npm command.
+The elements are required theme to instantiate itself in the app. LSEG Workspace's design system is called Halo theme and you can install it from npm command.
 
 ```sh
 npm install @refinitiv-ui/halo-theme
 ```
 
-Finally, import both elements that you want to use and its themes into your application and it is ready to go. To follow Refinitiv Workspace's design system, it is required styles of some native elements e.g. typography.
+Finally, import both elements that you want to use and its themes into your application and it is ready to go. To follow LSEG Workspace's design system, it is required styles of some native elements e.g. typography.
 
 <br>
 
-> The font "Proxima Nova Fin" shall only be used within Refinitiv products or services. The copyright owner must approve any use of such font outside of Refinitiv products or services, which may be subject to a fee. Please see https://www.fontspring.com/lic/fontspring/webfont#license_text
+> The font "Proxima Nova Fin" shall only be used within LSEG products or services. The copyright owner must approve any use of such font outside of LSEG products or services, which may be subject to a fee. Please see https://www.fontspring.com/lic/fontspring/webfont#license_text
 
 <br>
 
@@ -57,4 +57,4 @@ See list of elements, demo and more tutorial by visiting [EF Documentation](http
 
 # License
 
-Apache License 2.0. However, Halo theme shall only be used within Refinitiv products or services due to license of the font "Proxima Nova Fin".
+Apache License 2.0. However, Halo theme shall only be used within LSEG products or services due to license of the font "Proxima Nova Fin".

package/lib/combo-box/index.js

@@ -288,9 +288,11 @@ let ComboBox = class ComboBox extends FormFieldElement {
      * @returns {void}
      */
     updateComposerValues(newValues) {
+        const selectedAt = Date.now();
         this.queryItems((item, composer) => {
             if (newValues.includes(composer.getItemPropertyValue(item, 'value'))) {
                 composer.setItemPropertyValue(item, 'selected', true);
+                composer.setItemPropertyValue(item, 'selectedAt', selectedAt + newValues.indexOf(item.value ?? '')); // Sequential selection
                 return true;
             }
             composer.setItemPropertyValue(item, 'selected', false);

package/lib/slider/custom-elements.json

@@ -177,7 +177,7 @@
         },
         {
           "name": "input",
-          "description": "Fired when the user inputs a value by interacting with the slider or updating its input field."
+          "description": "Fired with the value of the input in `e.detail.value` like another custom events when the user inputs a value by interacting with the slider or updating its input field."
         },
         {
           "name": "from-input",

package/lib/slider/custom-elements.md

@@ -25,7 +25,7 @@ Allows users to make selections from a range of values
 |-----------------|--------------------------------------------------|
 | `from-changed`  | Fired when the user changes from's value. The event is not triggered if `from` property is changed programmatically. |
 | `from-input`    | Fired when the user inputs from's value by interacting with the slider or updating its input field. |
-| `input`         | Fired when the user inputs a value by interacting with the slider or updating its input field. |
+| `input`         | Fired with the value of the input in `e.detail.value` like another custom events when the user inputs a value by interacting with the slider or updating its input field. |
 | `to-changed`    | Fired when the user changes to's value. The event is not triggered if `to` property is changed programmatically. |
 | `to-input`      | Fired when the user inputs to's value by interacting with the slider or updating its input field. |
 | `value-changed` | Fired when the user commits a value change. The event is not triggered if `value` property is changed programmatically. |

package/lib/slider/index.d.ts

@@ -18,7 +18,7 @@ import '../number-field/index.js';
  * @fires value-changed - Fired when the user commits a value change. The event is not triggered if `value` property is changed programmatically.
  * @fires from-changed - Fired when the user changes from's value. The event is not triggered if `from` property is changed programmatically.
  * @fires to-changed - Fired when the user changes to's value. The event is not triggered if `to` property is changed programmatically.
- * @fires input - Fired when the user inputs a value by interacting with the slider or updating its input field.
+ * @fires input - Fired with the value of the input in `e.detail.value` like another custom events when the user inputs a value by interacting with the slider or updating its input field.
  * @fires from-input - Fired when the user inputs from's value by interacting with the slider or updating its input field.
  * @fires to-input - Fired when the user inputs to's value by interacting with the slider or updating its input field.
  */
@@ -341,6 +341,11 @@ export declare class Slider extends ControlElement {
      * @returns validated to value.
      */
     private validateTo;
+    /**
+     * Validate number field from changed thumb
+     * @returns {void}
+     */
+    private validateNumberField;
     /**
      * Calculate the nearest possible step value depending on step interval
      * @param thumbPosition current thumb position in fraction

package/lib/slider/index.js

@@ -27,7 +27,7 @@ import { clamp, countDecimalPlace, isDecimalNumber, preventDefault } from './uti
  * @fires value-changed - Fired when the user commits a value change. The event is not triggered if `value` property is changed programmatically.
  * @fires from-changed - Fired when the user changes from's value. The event is not triggered if `from` property is changed programmatically.
  * @fires to-changed - Fired when the user changes to's value. The event is not triggered if `to` property is changed programmatically.
- * @fires input - Fired when the user inputs a value by interacting with the slider or updating its input field.
+ * @fires input - Fired with the value of the input in `e.detail.value` like another custom events when the user inputs a value by interacting with the slider or updating its input field.
  * @fires from-input - Fired when the user inputs from's value by interacting with the slider or updating its input field.
  * @fires to-input - Fired when the user inputs to's value by interacting with the slider or updating its input field.
  */
@@ -766,6 +766,7 @@ let Slider = class Slider extends ControlElement {
             this.valuePreviousInput = this.value;
         }
         this.onDrag(event);
+        this.validateNumberField();
         if (event.changedTouches) {
             this.addEventListener('touchmove', this.onDrag);
             this.addEventListener('touchend', this.onDragEnd);
@@ -859,6 +860,17 @@ let Slider = class Slider extends ControlElement {
         }
         return this.fromNumber + this.minRangeNumber;
     }
+    /**
+     * Validate number field from changed thumb
+     * @returns {void}
+     */
+    validateNumberField() {
+        if (this.isShowInputField) {
+            const name = this.changedThumb?.getAttribute('name');
+            const numberField = this[`${name}Input`];
+            requestAnimationFrame(() => numberField.reportValidity());
+        }
+    }
     /**
      * Calculate the nearest possible step value depending on step interval
      * @param thumbPosition current thumb position in fraction
@@ -1000,7 +1012,7 @@ let Slider = class Slider extends ControlElement {
             if (valueFor === SliderDataName.to && value < this.fromNumber + this.minRangeNumber) {
                 return false;
             }
-            else if (value > this.toNumber - this.minRangeNumber) {
+            else if (valueFor === SliderDataName.from && value > this.toNumber - this.minRangeNumber) {
                 return false;
             }
         }

package/lib/tree/elements/tree.js

@@ -376,7 +376,7 @@ let Tree = class Tree extends List {
      */
     get values() {
         return this.manager.checkedItems.map((item) => {
-            return this.composer.getItemPropertyValue(item, 'value') || '';
+            return this.composer.getItemPropertyValue(item, 'value') ?? '';
         });
     }
     set values(values) {
@@ -386,9 +386,9 @@ let Tree = class Tree extends List {
         }
         else {
             // Clone value arrays
-            const newValue = [...values].sort().toString();
-            const oldValue = [...this.values].sort().toString();
-            if (newValue !== oldValue) {
+            const newValue = [...values];
+            const oldValue = [...this.values];
+            if (newValue.toString() !== oldValue.toString()) {
                 this.manager.uncheckAllItems();
                 values.some((value) => {
                     this.queryItemsByPropertyValue('value', value).forEach((item) => {

package/lib/tree/managers/tree-manager.d.ts

@@ -24,6 +24,10 @@ export declare class TreeManager<T extends TreeDataItem> {
      * Mode (algorithm) the tree manage is using
      */
     private mode;
+    /**
+     * Last selected item timestamp
+     */
+    private lastSelectedAt?;
     constructor(composer: CollectionComposer<T>, mode?: TreeManagerMode);
     /**
      * Is the manager maintaining parent/child relationships
@@ -42,6 +46,10 @@ export declare class TreeManager<T extends TreeDataItem> {
      * When managing relationships, this excludes groups/parents from the result.
      */
     get checkedItems(): readonly T[];
+    /**
+     * Compare items function order by sequential selected timestamp
+     */
+    protected get orderBySelectedAt(): (itemA: T, itemB: T) => number;
     /**
      * Items which should be visibly displayed.
      * This can be used to render items.

package/lib/tree/managers/tree-manager.js

@@ -47,12 +47,24 @@ export class TreeManager {
      * When managing relationships, this excludes groups/parents from the result.
      */
     get checkedItems() {
-        return this.composer.queryItems((item) => {
+        const items = this.composer.queryItems((item) => {
             if (this.manageRelationships && this.isItemParent(item)) {
                 return false;
             }
             return this.isItemChecked(item);
         }, Infinity);
+        return Object.freeze(items.slice().sort(this.orderBySelectedAt));
+    }
+    /**
+     * Compare items function order by sequential selected timestamp
+     */
+    get orderBySelectedAt() {
+        // Order by sequential selected timestamp
+        return (itemA, itemB) => {
+            const timeA = this.composer.getItemPropertyValue(itemA, 'selectedAt') ?? 0;
+            const timeB = this.composer.getItemPropertyValue(itemB, 'selectedAt') ?? 0;
+            return timeA - timeB;
+        };
     }
     /**
      * Items which should be visibly displayed.
@@ -341,7 +353,13 @@ export class TreeManager {
     }
     _checkItem(item, manageRelationships = this.manageRelationships) {
         if (this.canCheckItem(item)) {
+            // Create unique timestamp base on the latest selection for sequential selection.
+            const timestamp = Date.now();
+            this.lastSelectedAt =
+                this.lastSelectedAt && this.lastSelectedAt >= timestamp ? this.lastSelectedAt + 1 : timestamp;
+            // Set item selected with timestamp
             this.composer.setItemPropertyValue(item, 'selected', true);
+            this.composer.setItemPropertyValue(item, 'selectedAt', this.lastSelectedAt);
             if (manageRelationships) {
                 this.forceUpdateOnPath(item);
                 this.getItemDescendants(item).forEach((descendant) => this._checkItem(descendant, false));

package/lib/tree-select/index.d.ts

@@ -59,7 +59,11 @@ export declare class TreeSelect extends ComboBox<TreeSelectDataItem> {
     /**
      * Extracted values from {@link this.checkedGroupedItems}
      */
-    protected pillsData: TreeSelectDataItem[];
+    protected pillsData: Readonly<TreeSelectDataItem[]>;
+    /**
+     * Cache old selection timestamps for revert selected timestamps when cancel selection
+     */
+    protected oldSelection: Map<string, number | undefined>;
     /**
      * Are there pills visible
      */
@@ -207,10 +211,15 @@ export declare class TreeSelect extends ComboBox<TreeSelectDataItem> {
      */
     protected persistSelection(): void;
     /**
-     * Reverse selection. Run on Esc or Cancel
+     * Revert modified selection to old values. Run on Esc or Cancel
+     * @returns {void}
+     */
+    protected revertModifiedSelection(): void;
+    /**
+     * Revert all selected timestamps to the previous state which affect to item sorting
      * @returns {void}
      */
-    protected cancelSelection(): void;
+    protected revertSelectionTimestamps(): void;
     /**
      * Update memoized track
      *

package/lib/tree-select/index.js

@@ -1,5 +1,5 @@
 import { __decorate } from "tslib";
-import { css, html, nothing, triggerResize } from '@refinitiv-ui/core';
+import { WarningNotice, css, html, nothing, triggerResize } from '@refinitiv-ui/core';
 import { customElement } from '@refinitiv-ui/core/decorators/custom-element.js';
 import { property } from '@refinitiv-ui/core/decorators/property.js';
 import { query } from '@refinitiv-ui/core/decorators/query.js';
@@ -21,6 +21,7 @@ import { VERSION } from '../version.js';
 export { TreeSelectRenderer };
 const MEMO_THROTTLE = 16;
 const POPUP_POSITION = ['bottom-start', 'top-start'];
+const valueFormatWarning = new WarningNotice("The specified 'values' format does not conform to the required format.");
 /**
  * Dropdown control that allows selection from the tree list
  *
@@ -65,6 +66,10 @@ let TreeSelect = class TreeSelect extends ComboBox {
          * Extracted values from {@link this.checkedGroupedItems}
          */
         this.pillsData = [];
+        /**
+         * Cache old selection timestamps for revert selected timestamps when cancel selection
+         */
+        this.oldSelection = new Map();
         /**
          * Are there pills visible
          */
@@ -165,8 +170,26 @@ let TreeSelect = class TreeSelect extends ComboBox {
         return this._values;
     }
     set values(values) {
-        super.values = values;
-        this._values = values;
+        if (!Array.isArray(values)) {
+            valueFormatWarning.show();
+            this.values = [];
+            return;
+        }
+        // Update the selection state when found new value
+        const newValues = values.slice(0, this.multiple ? values.length : 1);
+        const oldValues = this.values.slice();
+        if (newValues.toString() !== oldValues.toString()) {
+            this._values = values;
+            this.updateComposerValues(values);
+            this.updatePills();
+            if (this.freeText) {
+                // free text mode is only supported in single selection mode
+                // so if there is no valid selection in the composer, we can assume
+                // the first item can be used as the free text item.
+                this.freeTextValue = !this.composerValues.length ? newValues[0] : '';
+            }
+            this.requestUpdate('values', oldValues);
+        }
     }
     /**
      * Set maximum number of selected items
@@ -228,7 +251,7 @@ let TreeSelect = class TreeSelect extends ComboBox {
      * @override
      */
     get selectedLabels() {
-        return this.checkedGroupedItems.map((selected) => this.getItemPropertyValue(selected, 'label') || '');
+        return this.checkedGroupedItems.map((selected) => this.getItemPropertyValue(selected, 'label') ?? '');
     }
     /**
      * Returns memoized selected state
@@ -332,29 +355,37 @@ let TreeSelect = class TreeSelect extends ComboBox {
      * @returns {void}
      */
     persistSelection() {
-        const oldValues = this.values.slice();
+        const oldValues = this.values;
         const newValues = this.composerValues;
-        const oldComparison = oldValues.sort().toString();
-        const newComparison = newValues.sort().toString();
-        if (oldComparison !== newComparison) {
+        if (oldValues.toString() !== newValues.toString()) {
+            // Set new values order by sequential selection
             this.values = newValues;
             this.notifyPropertyChange('value', this.value);
         }
     }
     /**
-     * Reverse selection. Run on Esc or Cancel
+     * Revert modified selection to old values. Run on Esc or Cancel
      * @returns {void}
      */
-    cancelSelection() {
-        const oldValues = this.values.slice();
+    revertModifiedSelection() {
+        const oldValues = this.values;
         const newValues = this.composerValues;
-        const oldComparison = oldValues.sort().toString();
-        const newComparison = newValues.sort().toString();
-        if (oldComparison !== newComparison) {
-            // revert selected item by updating the collection composer
-            this.updateComposerValues(this._values);
+        if (oldValues.toString() !== newValues.toString()) {
+            // Revert selected item by updating the collection composer
+            this.updateComposerValues(oldValues);
         }
     }
+    /**
+     * Revert all selected timestamps to the previous state which affect to item sorting
+     * @returns {void}
+     */
+    revertSelectionTimestamps() {
+        this.selection.forEach((item) => {
+            const oldSelectedAt = this.oldSelection.get(item.value);
+            this.composer.setItemPropertyValue(item, 'selectedAt', oldSelectedAt);
+        });
+        this.oldSelection.clear(); // Clear cache old selection
+    }
     /**
      * Update memoized track
      *
@@ -419,6 +450,7 @@ let TreeSelect = class TreeSelect extends ComboBox {
         const event = new CustomEvent('cancel');
         this.dispatchEvent(event);
         if (!event.defaultPrevented) {
+            this.revertSelectionTimestamps();
             this.closeAndReset();
             // reset always happens on popup close action
         }
@@ -487,6 +519,10 @@ let TreeSelect = class TreeSelect extends ComboBox {
     onPopupOpened() {
         super.onPopupOpened();
         this.clearSelectionFilter();
+        // Cache current selection timestamps for reverting modified selection when user cancel
+        this.selection.forEach((item) => {
+            this.oldSelection.set(item.value, this.getItemPropertyValue(item, 'selectedAt'));
+        });
         this.updatePills();
         this.updateMemo();
     }
@@ -504,7 +540,7 @@ let TreeSelect = class TreeSelect extends ComboBox {
     onPopupClosed() {
         super.onPopupClosed();
         this.updateMemo();
-        this.cancelSelection();
+        this.revertModifiedSelection();
         this.exitEditSelection();
     }
     /**
@@ -731,7 +767,7 @@ let TreeSelect = class TreeSelect extends ComboBox {
      */
     updatePills() {
         if (this.showPills) {
-            this.pillsData = this.checkedGroupedItems.slice();
+            this.pillsData = this.checkedGroupedItems;
             this.hasPills = !!this.pillsData.length;
         }
     }

package/lib/version.js

@@ -1 +1 @@
-export const VERSION = '6.11.0';
+export const VERSION = '6.12.0';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@refinitiv-ui/elements",
-  "version": "6.11.0",
+  "version": "6.12.0",
   "description": "Element Framework Elements",
-  "author": "Refinitiv",
+  "author": "LSEG",
   "license": "Apache-2.0",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -339,8 +339,8 @@
   },
   "dependencies": {
     "@lit-labs/context": "^0.3.1",
-    "@refinitiv-ui/halo-theme": "^6.6.0",
-    "@refinitiv-ui/solar-theme": "^6.4.0",
+    "@refinitiv-ui/halo-theme": "^6.6.1",
+    "@refinitiv-ui/solar-theme": "^6.4.1",
     "@types/chart.js": "^2.9.31",
     "chart.js": "~2.9.4",
     "d3-interpolate": "^3.0.1",
@@ -349,25 +349,25 @@
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@refinitiv-ui/core": "^6.5.0",
-    "@refinitiv-ui/demo-block": "^6.1.11",
-    "@refinitiv-ui/i18n": "^6.0.17",
-    "@refinitiv-ui/phrasebook": "^6.3.6",
-    "@refinitiv-ui/test-helpers": "^6.0.14",
-    "@refinitiv-ui/translate": "^6.0.26",
-    "@refinitiv-ui/utils": "^6.2.9",
+    "@refinitiv-ui/core": "^6.5.1",
+    "@refinitiv-ui/demo-block": "^6.1.12",
+    "@refinitiv-ui/i18n": "^6.0.18",
+    "@refinitiv-ui/phrasebook": "^6.3.7",
+    "@refinitiv-ui/test-helpers": "^6.0.15",
+    "@refinitiv-ui/translate": "^6.0.27",
+    "@refinitiv-ui/utils": "^6.3.0",
     "@types/d3-interpolate": "^3.0.1"
   },
   "peerDependencies": {
     "@refinitiv-ui/browser-sparkline": "^1.0.0 || ^2.0.0",
-    "@refinitiv-ui/core": "^6.5.0",
-    "@refinitiv-ui/i18n": "^6.0.17",
-    "@refinitiv-ui/phrasebook": "^6.3.6",
-    "@refinitiv-ui/translate": "^6.0.26",
-    "@refinitiv-ui/utils": "^6.2.9"
+    "@refinitiv-ui/core": "^6.5.1",
+    "@refinitiv-ui/i18n": "^6.0.18",
+    "@refinitiv-ui/phrasebook": "^6.3.7",
+    "@refinitiv-ui/translate": "^6.0.27",
+    "@refinitiv-ui/utils": "^6.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fc7e8d1a792bc0f33ccf70360397abb37f1e4e3a"
+  "gitHead": "14c76686cee42f70897fd6234691ac09fd318858"
 }