@refinitiv-ui/elements 5.0.0-beta.3 → 5.0.0-dev.204

package/lib/datetime-picker/custom-elements.json

@@ -8,12 +8,14 @@
         {
           "name": "min",
           "description": "Set minimum date",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "max",
           "description": "Set maximum date",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "weekdays-only",
@@ -41,12 +43,14 @@
         {
           "name": "value",
           "description": "Current date time value",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "values",
           "description": "Set multiple selected values",
-          "type": "string[]"
+          "type": "string[]",
+          "default": "[]"
         },
         {
           "name": "am-pm",
@@ -63,7 +67,8 @@
         {
           "name": "placeholder",
           "description": "Placeholder to display when no value is set",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "opened",
@@ -104,7 +109,8 @@
         {
           "name": "format",
           "description": "Set the datetime format\nBased on dane-fns datetime formats",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "timepicker",
@@ -120,19 +126,20 @@
         {
           "name": "view",
           "description": "Set the current calendar view.\nAccepted format: 'yyyy-MM'",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "readonly",
           "description": "Set readonly state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         },
         {
           "name": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "properties": [
@@ -140,13 +147,15 @@
           "name": "min",
           "attribute": "min",
           "description": "Set minimum date",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "max",
           "attribute": "max",
           "description": "Set maximum date",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "weekdaysOnly",
@@ -180,21 +189,19 @@
           "type": "boolean",
           "default": "false"
         },
-        {
-          "name": "multiple",
-          "type": "boolean"
-        },
         {
           "name": "value",
           "attribute": "value",
           "description": "Current date time value",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "values",
           "attribute": "values",
           "description": "Set multiple selected values",
-          "type": "string[]"
+          "type": "string[]",
+          "default": "[]"
         },
         {
           "name": "amPm",
@@ -214,7 +221,8 @@
           "name": "placeholder",
           "attribute": "placeholder",
           "description": "Placeholder to display when no value is set",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "opened",
@@ -262,7 +270,8 @@
           "name": "format",
           "attribute": "format",
           "description": "Set the datetime format\nBased on dane-fns datetime formats",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "timepicker",
@@ -281,26 +290,28 @@
           "name": "view",
           "attribute": "view",
           "description": "Set the current calendar view.\nAccepted format: 'yyyy-MM'",
-          "type": "string"
+          "type": "string",
+          "default": "\"\""
         },
         {
           "name": "views",
           "description": "Set the current calendar views for duplex mode\nAccepted format: 'yyyy-MM'",
-          "type": "string[]"
+          "type": "string[]",
+          "default": "[]"
         },
         {
           "name": "readonly",
           "attribute": "readonly",
           "description": "Set readonly state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         },
         {
           "name": "disabled",
           "attribute": "disabled",
           "description": "Set disabled state",
           "type": "boolean",
-          "default": "\"false\""
+          "default": "false"
         }
       ],
       "events": [
@@ -321,10 +332,28 @@
           "description": "Dispatched when internal view changes"
         }
       ],
+      "slots": [
+        {
+          "name": "header",
+          "description": "Slot to add custom contents at the top of popup"
+        },
+        {
+          "name": "right",
+          "description": "Slot to add custom contents at the right of popup"
+        },
+        {
+          "name": "footer",
+          "description": "Slot to add custom contents at the bottom of popup"
+        },
+        {
+          "name": "left",
+          "description": "Slot to add custom contents at the left of popup"
+        }
+      ],
       "methods": [
         {
           "name": "validateInput",
-          "description": "Validate input. Mark as error if input is invalid",
+          "description": "Validates the input, marking the element as invalid if its value does not meet the validation criteria.",
           "params": []
         }
       ]

package/lib/datetime-picker/custom-elements.md

@@ -0,0 +1,57 @@
+# ef-datetime-picker
+
+Control to pick date and time
+
+## Properties
+
+| Property               | Attribute                | Type                             | Default | Description                                      |
+|------------------------|--------------------------|----------------------------------|---------|--------------------------------------------------|
+| `amPm`                 | `am-pm`                  | `boolean`                        | false   | Toggles 12hr time display                        |
+| `disabled`             | `disabled`               | `boolean`                        | false   | Set disabled state                               |
+| `duplex`               | `duplex`                 | `"" \| "consecutive" \| "split"` | null    | Display two calendar pickers.                    |
+| `error`                | `error`                  | `boolean`                        | false   | Set state to error                               |
+| `filter`               |                          | `DatetimePickerFilter \| null`   | null    | Custom filter, used for enabling/disabling certain dates |
+| `firstDayOfWeek`       | `first-day-of-week`      | `number \| undefined`            |         | Set the first day of the week.<br />0 - for Sunday, 6 - for Saturday |
+| `format`               | `format`                 | `string`                         | ""      | Set the datetime format<br />Based on dane-fns datetime formats |
+| `inputDisabled`        | `input-disabled`         | `boolean`                        | false   | Disable input part of the picker                 |
+| `inputTriggerDisabled` | `input-trigger-disabled` | `boolean`                        | false   | Only open picker panel when calendar icon is clicked.<br />Clicking on the input will no longer open the picker. |
+| `max`                  | `max`                    | `string`                         | ""      | Set maximum date                                 |
+| `min`                  | `min`                    | `string`                         | ""      | Set minimum date                                 |
+| `opened`               | `opened`                 | `boolean`                        | false   | Toggles the opened state of the list             |
+| `placeholder`          | `placeholder`            | `string`                         | ""      | Placeholder to display when no value is set      |
+| `popupDisabled`        | `popup-disabled`         | `boolean`                        | false   | Disable the popup                                |
+| `range`                | `range`                  | `boolean`                        | false   | Set to switch to range select mode               |
+| `readonly`             | `readonly`               | `boolean`                        | false   | Set readonly state                               |
+| `showSeconds`          | `show-seconds`           | `boolean`                        | false   | Flag to show seconds time segment in display.<br />Seconds are automatically shown when `hh:mm:ss` time format is provided as a value. |
+| `timepicker`           | `timepicker`             | `boolean`                        | false   | Toggle to display the time picker                |
+| `value`                | `value`                  | `string`                         | ""      | Current date time value                          |
+| `values`               | `values`                 | `string[]`                       | []      | Set multiple selected values                     |
+| `view`                 | `view`                   | `string`                         | ""      | Set the current calendar view.<br />Accepted format: 'yyyy-MM' |
+| `views`                |                          | `string[]`                       | []      | Set the current calendar views for duplex mode<br />Accepted format: 'yyyy-MM' |
+| `warning`              | `warning`                | `boolean`                        | false   | Set state to warning                             |
+| `weekdaysOnly`         | `weekdays-only`          | `boolean`                        | false   | Only enable weekdays                             |
+| `weekendsOnly`         | `weekends-only`          | `boolean`                        | false   | Only enable weekends                             |
+
+## Methods
+
+| Method          | Type       | Description                                      |
+|-----------------|------------|--------------------------------------------------|
+| `validateInput` | `(): void` | Validates the input, marking the element as invalid if its value does not meet the validation criteria. |
+
+## Events
+
+| Event            | Description                                      |
+|------------------|--------------------------------------------------|
+| `error-changed`  | Dispatched when error state changes              |
+| `opened-changed` | Dispatched when when opened attribute changes internally |
+| `value-changed`  | Dispatched when value changes                    |
+| `view-changed`   | Dispatched when internal view changes            |
+
+## Slots
+
+| Name     | Description                                      |
+|----------|--------------------------------------------------|
+| `footer` | Slot to add custom contents at the bottom of popup |
+| `header` | Slot to add custom contents at the top of popup  |
+| `left`   | Slot to add custom contents at the left of popup |
+| `right`  | Slot to add custom contents at the right of popup |

package/lib/datetime-picker/index.d.ts

@@ -1,13 +1,13 @@
 import { JSXInterface } from '../jsx';
-import { ControlElement, TemplateResult, MultiValue, PropertyValues, CSSResult } from '@refinitiv-ui/core';
-import '../calendar';
-import '../icon';
-import '../overlay';
-import '../text-field';
-import '../time-picker';
-import { DatetimePickerDuplex, DatetimePickerFilter } from './types';
+import { ControlElement, TemplateResult, MultiValue, PropertyValues, CSSResultGroup } from '@refinitiv-ui/core';
+import type { DatetimePickerDuplex, DatetimePickerFilter } from './types';
+import '../calendar/index.js';
+import '../icon/index.js';
+import '../overlay/index.js';
+import '../text-field/index.js';
+import '../time-picker/index.js';
 import { TranslateDirective } from '@refinitiv-ui/translate';
-export { DatetimePickerFilter, DatetimePickerDuplex };
+export type { DatetimePickerFilter, DatetimePickerDuplex };
 /**
  * Control to pick date and time
  *
@@ -22,19 +22,24 @@ export { DatetimePickerFilter, DatetimePickerDuplex };
  * @attr {boolean} disabled - Set disabled state
  * @prop {boolean} [disabled=false] - Set disabled state
  *
- * @slots header - Header slot
- * @slots right - Right slot
- * @slots footer - Footer slot
- * @slots left - Left slot
+ * @slot header - Slot to add custom contents at the top of popup
+ * @slot right - Slot to add custom contents at the right of popup
+ * @slot footer - Slot to add custom contents at the bottom of popup
+ * @slot left - Slot to add custom contents at the left of popup
  */
 export declare class DatetimePicker extends ControlElement implements MultiValue {
     /**
-     * A `CSSResult` that will be used
+     * 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(): CSSResult | CSSResult[];
+    static get styles(): CSSResultGroup;
     private lazyRendered;
     private calendarValues;
     private timepickerValues;
@@ -45,6 +50,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     /**
     * Set minimum date
     * @param min date
+    * @default -
     */
     set min(min: string);
     get min(): string;
@@ -53,6 +59,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     /**
     * Set maximum date
     * @param max date
+    * @default -
     */
     set max(max: string);
     get max(): string;
@@ -85,10 +92,14 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     * @param multiple Multiple
     */
     set multiple(multiple: boolean);
+    /**
+    * @ignore
+    */
     get multiple(): boolean;
     /**
     * Current date time value
     * @param value Calendar value
+    * @default -
     */
     set value(value: string);
     get value(): string;
@@ -98,6 +109,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     * Set multiple selected values
     * @param values Values to set
     * @type {string[]}
+    * @default []
     */
     set values(values: string[]);
     get values(): string[];
@@ -114,6 +126,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     /**
     * Placeholder to display when no value is set
     * @param placeholder Placeholder
+    * @default -
     */
     set placeholder(placeholder: string);
     get placeholder(): string;
@@ -147,6 +160,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     * Set the datetime format
     * Based on dane-fns datetime formats
     * @param format Date format
+    * @default -
     */
     set format(format: string);
     get format(): string;
@@ -163,6 +177,7 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     * Set the current calendar view.
     * Accepted format: 'yyyy-MM'
     * @param view view date
+    * @default -
     */
     set view(view: string);
     get view(): string;
@@ -172,11 +187,12 @@ export declare class DatetimePicker extends ControlElement implements MultiValue
     * Accepted format: 'yyyy-MM'
     * @param views view dates
     * @type {string[]}
+    * @default []
     */
     set views(views: string[]);
     get views(): string[];
     /**
-     * Validate input. Mark as error if input is invalid
+     * Validates the input, marking the element as invalid if its value does not meet the validation criteria.
      * @returns {void}
      */
     validateInput(): void;
@@ -488,4 +504,6 @@ declare global {
       'ef-datetime-picker': Partial<DatetimePicker> | JSXInterface.ControlHTMLAttributes<DatetimePicker>;
     }
   }
-}
+}
+
+export {};

package/lib/datetime-picker/index.js

@@ -1,21 +1,23 @@
-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, html, css, customElement, property, query, ifDefined, WarningNotice } from '@refinitiv-ui/core';
-import '../calendar';
-import '../icon';
-import '../overlay';
-import '../text-field';
-import '../time-picker';
-import { getDateFNSLocale } from './locales';
+import { __decorate } from "tslib";
+import { ControlElement, html, css, WarningNotice } 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 '../calendar/index.js';
+import '../icon/index.js';
+import '../overlay/index.js';
+import '../text-field/index.js';
+import '../time-picker/index.js';
 import { translate, getLocale, TranslatePropertyKey } from '@refinitiv-ui/translate';
-import { format as inputFormat, parse as inputParse, isValid } from 'date-fns';
-import { addMonths, subMonths, isAfter, isBefore, isValidDate, isValidDateTime, DateFormat, DateTimeFormat, parse, format } from '@refinitiv-ui/utils';
-import { DateTimeSegment, formatToView, getCurrentTime } from './utils';
-import { preload } from '../icon';
+import { getDateFNSLocale } from './locales.js';
+import inputFormat from 'date-fns/esm/format/index.js';
+import inputParse from 'date-fns/esm/parse/index.js';
+import isValid from 'date-fns/esm/isValid/index.js';
+import { addMonths, subMonths, isAfter, isBefore, isValidDate, isValidDateTime, DateFormat, DateTimeFormat, parse, format } from '@refinitiv-ui/utils/lib/date.js';
+import { DateTimeSegment, formatToView, getCurrentTime } from './utils.js';
+import { preload } from '../icon/index.js';
 preload('calendar', 'down', 'left', 'right'); /* preload calendar icons for faster loading */
 const POPUP_POSITION = ['bottom-start', 'top-start', 'bottom-end', 'top-end', 'bottom-middle', 'top-middle'];
 const INPUT_FORMAT = {
@@ -39,10 +41,10 @@ const INPUT_FORMAT = {
  * @attr {boolean} disabled - Set disabled state
  * @prop {boolean} [disabled=false] - Set disabled state
  *
- * @slots header - Header slot
- * @slots right - Right slot
- * @slots footer - Footer slot
- * @slots left - Left slot
+ * @slot header - Slot to add custom contents at the top of popup
+ * @slot right - Slot to add custom contents at the right of popup
+ * @slot footer - Slot to add custom contents at the bottom of popup
+ * @slot left - Slot to add custom contents at the left of popup
  */
 let DatetimePicker = class DatetimePicker extends ControlElement {
     constructor() {
@@ -124,7 +126,14 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
         this._interimSegments = [];
     }
     /**
-     * A `CSSResult` that will be used
+     * 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
@@ -173,6 +182,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     /**
     * Set minimum date
     * @param min date
+    * @default -
     */
     set min(min) {
         if (!this.isValidValue(min)) {
@@ -183,7 +193,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
         if (oldMin !== min) {
             this._min = min;
             this.minDate = min ? format(parse(min), DateFormat.yyyyMMdd) : '';
-            void this.requestUpdate('min', oldMin);
+            this.requestUpdate('min', oldMin);
         }
     }
     get min() {
@@ -192,6 +202,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     /**
     * Set maximum date
     * @param max date
+    * @default -
     */
     set max(max) {
         if (!this.isValidValue(max)) {
@@ -202,7 +213,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
         if (oldMax !== max) {
             this._max = max;
             this.maxDate = max ? format(parse(max), DateFormat.yyyyMMdd) : '';
-            void this.requestUpdate('max', oldMax);
+            this.requestUpdate('max', oldMax);
         }
     }
     get max() {
@@ -217,12 +228,16 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     set multiple(multiple) {
         new WarningNotice('multiple is not currently supported').show();
     }
+    /**
+    * @ignore
+    */
     get multiple() {
         return false;
     }
     /**
     * Current date time value
     * @param value Calendar value
+    * @default -
     */
     set value(value) {
         this.values = value ? [value] : [];
@@ -234,12 +249,14 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     * Set multiple selected values
     * @param values Values to set
     * @type {string[]}
+    * @default []
     */
     set values(values) {
         const oldValues = this._values;
         if (String(oldValues) !== String(values)) {
             this._values = values;
-            void this.requestUpdate('_values', oldValues); /* segments are populated in update */
+            this.valuesToSegments();
+            this.requestUpdate('_values', oldValues); /* segments are populated in update */
         }
     }
     get values() {
@@ -248,12 +265,13 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     /**
     * Placeholder to display when no value is set
     * @param placeholder Placeholder
+    * @default -
     */
     set placeholder(placeholder) {
         const oldPlaceholder = this._placeholder;
         if (oldPlaceholder !== placeholder) {
             this._placeholder = placeholder;
-            void this.requestUpdate('placeholder', oldPlaceholder);
+            this.requestUpdate('placeholder', oldPlaceholder);
         }
     }
     get placeholder() {
@@ -263,12 +281,13 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     * Set the datetime format
     * Based on dane-fns datetime formats
     * @param format Date format
+    * @default -
     */
     set format(format) {
         const oldFormat = this._format;
         if (oldFormat !== format) {
             this._format = format;
-            void this.requestUpdate('format', oldFormat);
+            this.requestUpdate('format', oldFormat);
         }
     }
     get format() {
@@ -282,6 +301,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     * Set the current calendar view.
     * Accepted format: 'yyyy-MM'
     * @param view view date
+    * @default -
     */
     set view(view) {
         this.views = view ? [view] : [];
@@ -294,13 +314,14 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     * Accepted format: 'yyyy-MM'
     * @param views view dates
     * @type {string[]}
+    * @default []
     */
     set views(views) {
         const oldViews = this._views;
         views = this.filterAndWarnInvalidViews(views);
         if (oldViews.toString() !== views.toString()) {
             this._views = views;
-            void this.requestUpdate('views', oldViews);
+            this.requestUpdate('views', oldViews);
         }
     }
     get views() {
@@ -321,7 +342,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
         return [formatToView(from), formatToView(to)];
     }
     /**
-     * Validate input. Mark as error if input is invalid
+     * Validates the input, marking the element as invalid if its value does not meet the validation criteria.
      * @returns {void}
      */
     validateInput() {
@@ -337,9 +358,6 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
      * @returns {void}
      */
     update(changedProperties) {
-        if (changedProperties.has('_values')) {
-            this.valuesToSegments();
-        }
         if (changedProperties.has('opened') && this.opened) {
             this.lazyRendered = true;
         }
@@ -362,8 +380,8 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
      */
     firstUpdated(changedProperties) {
         super.firstUpdated(changedProperties);
-        this.addEventListener('keydown', event => this.onKeyDown(event));
-        this.addEventListener('tap', event => this.onTap(event));
+        this.addEventListener('keydown', this.onKeyDown);
+        this.addEventListener('tap', this.onTap);
     }
     /**
      * Overwrite validation method for value
@@ -375,7 +393,9 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
         if (value === '') {
             return true;
         }
-        return this.timepicker
+        // Need to check for the attribute to cover the case when
+        // timepicker and value attributes are set
+        return (this.timepicker || this.hasAttribute('timepicker'))
             ? isValidDateTime(value)
             : isValidDate(value, DateFormat.yyyyMMdd);
     }
@@ -594,7 +614,6 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
     notifyValuesChange(values) {
         if (this.values.toString() !== values.toString()) {
             this.values = values;
-            this.valuesToSegments(); /* need to be here to get correct value synchronously */
             this.notifyPropertyChange('value', this.value);
         }
     }
@@ -768,7 +787,7 @@ let DatetimePicker = class DatetimePicker extends ControlElement {
             const inputValues = [...this.inputValues];
             inputValues[index] = formattedValue;
             this.inputValues = inputValues;
-            void this.requestUpdate();
+            this.requestUpdate();
         }
     }
     /**
@@ -1154,4 +1173,3 @@ DatetimePicker = __decorate([
     })
 ], DatetimePicker);
 export { DatetimePicker };
-//# sourceMappingURL=index.js.map

package/lib/datetime-picker/locales.d.ts

@@ -1,4 +1,4 @@
-import { Locale } from 'date-fns';
+import type { Locale } from 'date-fns';
 /**
  * Get date-fns locale or default locale
  * @param [locale] BCP47 locale tag