@refinitiv-ui/elements 5.12.0-alpha.0 → 5.12.0

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

@@ -0,0 +1,80 @@
+import { JSXInterface } from '../jsx';
+import { PropertyValues } from '@refinitiv-ui/core';
+import '../icon/index.js';
+import { TextField } from '../text-field/index.js';
+import { TemplateMap } from '@refinitiv-ui/core/lib/directives/template-map.js';
+/**
+ * A form control element for email.
+ *
+ * @fires value-changed - Dispatched when value changes
+ * @fires error-changed - Dispatched when error state changes
+ * @fires icon-click - Dispatched when icon is clicked
+ *
+ * @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 {string} icon - Specify icon to display in input. Value can be icon name
+ * @prop {string | null} [icon=null] - Specify icon to display in input. Value can be icon name
+ *
+ * @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} 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 EmailField extends TextField {
+    /**
+     * Set to multiple mode, allows multiple emails in a single input
+     */
+    multiple: boolean;
+    /**
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="email" - always `email`
+     * multiple - defined if supports multiple emails
+     * @returns template map
+     */
+    protected get decorateInputMap(): TemplateMap;
+    /**
+     * Check if input should be re-validated
+     * @param changedProperties Properties that has changed
+     * @returns True if input should be re-validated
+     */
+    protected shouldValidateInput(changedProperties: PropertyValues): boolean;
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'ef-email-field': EmailField;
+  }
+
+  namespace JSX {
+    interface IntrinsicElements {
+      'ef-email-field': Partial<EmailField> | JSXInterface.HTMLAttributes<EmailField>;
+    }
+  }
+}
+
+export {};

package/lib/email-field/index.js

@@ -0,0 +1,86 @@
+import { __decorate } from "tslib";
+import { customElement } from '@refinitiv-ui/core/lib/decorators/custom-element.js';
+import { property } from '@refinitiv-ui/core/lib/decorators/property.js';
+import '../icon/index.js';
+import { TextField } from '../text-field/index.js';
+/**
+ * A form control element for email.
+ *
+ * @fires value-changed - Dispatched when value changes
+ * @fires error-changed - Dispatched when error state changes
+ * @fires icon-click - Dispatched when icon is clicked
+ *
+ * @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 {string} icon - Specify icon to display in input. Value can be icon name
+ * @prop {string | null} [icon=null] - Specify icon to display in input. Value can be icon name
+ *
+ * @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} transparent - Disables all other states and border/background styles.
+ * @prop {boolean} [transparent=false] - Disables all other states and border/background styles.
+ *
+ * @attr {boolean} warning - Set warning state
+ * @prop {boolean} [warning=false] - Set warning state
+ *
+ * @attr {string} value - Input's value
+ * @prop {string} [value=""] - Input's value
+ */
+let EmailField = class EmailField extends TextField {
+    constructor() {
+        super(...arguments);
+        /**
+         * Set to multiple mode, allows multiple emails in a single input
+         */
+        this.multiple = false;
+    }
+    /**
+     * Decorate `<input>` element with common properties extended from text-field:
+     * type="email" - always `email`
+     * multiple - defined if supports multiple emails
+     * @returns template map
+     */
+    get decorateInputMap() {
+        return Object.assign(Object.assign({}, super.decorateInputMap), { 'type': 'email', 'inputmode': 'email', 'multiple': this.multiple });
+    }
+    /**
+     * Check if input should be re-validated
+     * @param changedProperties Properties that has changed
+     * @returns True if input should be re-validated
+     */
+    /* istanbul ignore next */
+    shouldValidateInput(changedProperties) {
+        // TODO: This validation should be refactored
+        return changedProperties.has('value')
+            || changedProperties.has('multiple')
+            || super.shouldValidateInput(changedProperties);
+    }
+};
+__decorate([
+    property({ type: Boolean, reflect: true })
+], EmailField.prototype, "multiple", void 0);
+EmailField = __decorate([
+    customElement('ef-email-field', {
+        alias: 'coral-email-field'
+    })
+], EmailField);
+export { EmailField };

package/lib/email-field/themes/halo/dark/index.js

@@ -0,0 +1,3 @@
+import '@refinitiv-ui/elements/lib/icon/themes/halo/dark';
+
+elf.customStyles.define('ef-email-field', ':host{display:none;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-align:left;font-family:inherit;font-size:12rem;font-weight:400;height:24px;width:152px;max-width:100%;padding:0 8px;margin:1px 0;outline:0;box-sizing:border-box;display:inline-flex;align-items:center;position:relative;vertical-align:middle;border-radius:0;background-color:#0d0d0d;text-overflow:ellipsis;border:1px solid #404040;color:#ccc}:host([disabled]){border:1px solid rgba(64,64,64,.5);color:rgba(204,204,204,.5);background-color:rgba(13,13,13,.5)}:host([type=number]){padding-right:0}:host([warning]){border:1px solid #ffc800}:host([warning][disabled]){color:rgba(204,204,204,.5);border:1px solid rgba(127,100,0,.5)}:host([error]),:host([error][warning]){border:1px solid #f5475b}:host([error][disabled]),:host([error][warning][disabled]){color:rgba(204,204,204,.5);border:1px solid rgba(160,28,43,.5)}:host ::-ms-clear{display:none}:host([focused]){background-size:100% 2px,100% 1px!important;background-position:center bottom!important;border-color:#334bff}:host [part=input]{color:inherit;padding:0;margin:0;flex:1 1 auto;min-width:0;width:100%;height:100%;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-overflow:ellipsis;touch-action:manipulation}:host [part=input]::-webkit-clear-button,:host [part=input]::-webkit-inner-spin-button,:host [part=input]::-webkit-search-cancel-button,:host [part=input]::-webkit-search-decoration{-webkit-appearance:none}:host [part=input]:invalid{box-shadow:none}:host [part=icon]{color:#ccc;min-width:1em;padding-left:2px}:host([disabled]) [part=input]{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}:host ::-moz-selection{color:#fff;background-color:#334bff}:host ::selection{color:#fff;background-color:#334bff}:host(:not([readonly]):not([error]):not([warning]):not([focused]):hover){border-color:grey;color:#fff}:host(:not([readonly]):not([error]):not([warning]):not([focused]):hover) [part=icon]{color:#6678ff}:host([warning]:hover:not([readonly]):not([focused])){color:#fff;border-color:#ffe999}:host([warning][disabled]),:host([warning][readonly]:not([focused])){border-color:rgba(255,233,153,.5)}:host([error]:hover:not([readonly]):not([focused])){color:#fff;border-color:#faa8b1}:host([error][disabled]),:host([error][readonly]:not([focused])),:host([error][warning][disabled]){border-color:rgba(250,168,177,.5)}:host([readonly]:not([focused])){border-color:rgba(64,64,64,.5);background-color:rgba(13,13,13,.5)}:host([readonly]:not([focused])) [part=icon]{color:rgba(204,204,204,.5)}:host([focused]),:host([focused][error][warning]){border-color:#334bff;color:#fff}:host([focused]) [part=icon],:host([focused][error][warning]) [part=icon]{color:#6678ff}');

package/lib/email-field/themes/halo/light/index.js

@@ -0,0 +1,3 @@
+import '@refinitiv-ui/elements/lib/icon/themes/halo/light';
+
+elf.customStyles.define('ef-email-field', ':host{display:none;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-align:left;font-family:inherit;font-size:12rem;font-weight:400;height:24px;width:152px;max-width:100%;padding:0 8px;margin:1px 0;outline:0;box-sizing:border-box;display:inline-flex;align-items:center;position:relative;vertical-align:middle;border-radius:0;background-color:#fff;text-overflow:ellipsis;border:1px solid #595959;color:#404040}:host([disabled]){border:1px solid rgba(89,89,89,.5);color:rgba(64,64,64,.5);background-color:rgba(255,255,255,.5)}:host([type=number]){padding-right:0}:host([warning]){border:1px solid #cca000}:host([warning][disabled]){color:rgba(64,64,64,.5);border:1px solid rgba(204,160,0,.5)}:host([error]),:host([error][warning]){border:1px solid #d94255}:host([error][disabled]),:host([error][warning][disabled]){color:rgba(64,64,64,.5);border:1px solid rgba(182,50,67,.5)}:host ::-ms-clear{display:none}:host([focused]){background-size:100% 2px,100% 1px!important;background-position:center bottom!important;border-color:#334bff}:host [part=input]{color:inherit;padding:0;margin:0;flex:1 1 auto;min-width:0;width:100%;height:100%;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-overflow:ellipsis;touch-action:manipulation}:host [part=input]::-webkit-clear-button,:host [part=input]::-webkit-inner-spin-button,:host [part=input]::-webkit-search-cancel-button,:host [part=input]::-webkit-search-decoration{-webkit-appearance:none}:host [part=input]:invalid{box-shadow:none}:host [part=icon]{color:#404040;min-width:1em;padding-left:2px}:host([disabled]) [part=input]{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}:host ::-moz-selection{color:#fff;background-color:#334bff}:host ::selection{color:#fff;background-color:#334bff}:host(:not([readonly]):not([error]):not([warning]):not([focused]):hover){border-color:#0d0d0d;color:#0d0d0d}:host(:not([readonly]):not([error]):not([warning]):not([focused]):hover) [part=icon]{color:#334bff}:host([warning]:hover:not([readonly]):not([focused])){color:#0d0d0d;border-color:#ffe999}:host([warning][disabled]),:host([warning][readonly]:not([focused])){border-color:rgba(255,233,153,.5)}:host([error]:hover:not([readonly]):not([focused])){color:#0d0d0d;border-color:#eeacb4}:host([error][disabled]),:host([error][readonly]:not([focused])),:host([error][warning][disabled]){border-color:rgba(238,172,180,.5)}:host([readonly]:not([focused])){border-color:rgba(89,89,89,.5);background-color:rgba(255,255,255,.5)}:host([readonly]:not([focused])) [part=icon]{color:rgba(64,64,64,.5)}:host([focused]),:host([focused][error][warning]){border-color:#334bff;color:#0d0d0d}:host([focused]) [part=icon],:host([focused][error][warning]) [part=icon]{color:#334bff}');

package/lib/email-field/themes/solar/charcoal/index.js

@@ -0,0 +1,3 @@
+import '@refinitiv-ui/elements/lib/icon/themes/solar/charcoal';
+
+elf.customStyles.define('ef-email-field', ':host{display:none;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-align:left;font-family:inherit;font-size:13rem;font-weight:400;height:23px;width:140px;max-width:100%;padding:0 5px;margin:1px 0;outline:0;box-sizing:border-box;display:inline-flex;align-items:center;position:relative;vertical-align:middle;color:#c2c2c2;border-radius:0;text-overflow:ellipsis;background-color:#000;border:1px solid #4a4a52}:host([type=number]){padding-right:0}:host([error]),:host([error][warning]){border:1px solid #f5475b}:host([error][disabled]),:host([error][warning][disabled]){color:rgba(194,194,194,.6);border:1px solid rgba(245,71,91,.6)}:host ::-ms-clear{display:none}:host [part=input]{color:inherit;padding:0;margin:0;flex:1 1 auto;min-width:0;width:100%;height:100%;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-overflow:ellipsis;touch-action:manipulation}:host [part=input]::-webkit-clear-button,:host [part=input]::-webkit-inner-spin-button,:host [part=input]::-webkit-search-cancel-button,:host [part=input]::-webkit-search-decoration{-webkit-appearance:none}:host [part=input]:invalid{box-shadow:none}:host [part=icon]{color:#e2e2e2;min-width:1em}:host([disabled]) [part=input]{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}:host([disabled]){border:1px solid rgba(74,74,82,.6);color:rgba(194,194,194,.6)}:host([readonly]){border:1px solid rgba(74,74,82,.6)}:host(:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #77777d}:host([warning]){background-color:#000;border:1px solid #f93}:host([warning][disabled]){border:1px solid rgba(255,153,51,.6);color:rgba(194,194,194,.6)}:host([warning][readonly]){border:1px solid rgba(255,153,51,.6)}:host([warning]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #ffb366}:host([error]),:host([error][warning]:not([focused])){background-color:#000;border:1px solid #f5475b}:host([error][disabled]),:host([error][warning]:not([focused])[disabled]){border:1px solid rgba(245,71,91,.6);color:rgba(194,194,194,.6)}:host([error][readonly]),:host([error][warning]:not([focused])[readonly]){border:1px solid rgba(245,71,91,.6)}:host([error]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover),:host([error][warning]:not([focused]):not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #f87584}:host([highlight]){background-color:#1b252f;border:1px solid #4a4a52}:host([highlight][disabled]){border:1px solid rgba(74,74,82,.6);color:rgba(194,194,194,.6);background-color:rgba(27,37,47,.6)}:host([highlight][readonly]){border:1px solid rgba(74,74,82,.6)}:host([highlight]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #77777d}:host([indirect]){color:#0fd;background-color:#000;border:1px solid #898623}:host([indirect][disabled]){border:1px solid rgba(137,134,35,.6);color:rgba(0,255,221,.6)}:host([indirect][readonly]){border:1px solid rgba(137,134,35,.6)}:host([indirect]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #a7a45a}:host([focused]){background-size:100% 2px,100% 1px!important;background-position:center bottom!important;border-color:#f93;border-style:dotted}:host([disabled]) [part=input]::-webkit-input-placeholder{color:rgba(102,101,112,.6)}:host([disabled]) [part=input]::-moz-placeholder{color:rgba(102,101,112,.6)}:host([disabled]) [part=input]:-ms-input-placeholder{color:rgba(102,101,112,.6)}');

package/lib/email-field/themes/solar/pearl/index.js

@@ -0,0 +1,3 @@
+import '@refinitiv-ui/elements/lib/icon/themes/solar/pearl';
+
+elf.customStyles.define('ef-email-field', ':host{display:none;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-align:left;font-family:inherit;font-size:13rem;font-weight:400;height:23px;width:140px;max-width:100%;padding:0 5px;margin:1px 0;outline:0;box-sizing:border-box;display:inline-flex;align-items:center;position:relative;vertical-align:middle;color:#484848;border-radius:0;text-overflow:ellipsis;background-color:#fff;border:1px solid #a9afba}:host([type=number]){padding-right:0}:host([error]),:host([error][warning]){border:1px solid #d94255}:host([error][disabled]),:host([error][warning][disabled]){color:rgba(72,72,72,.6);border:1px solid rgba(217,66,85,.6)}:host ::-ms-clear{display:none}:host [part=input]{color:inherit;padding:0;margin:0;flex:1 1 auto;min-width:0;width:100%;height:100%;-webkit-appearance:none;-moz-appearance:none;appearance:none;text-overflow:ellipsis;touch-action:manipulation}:host [part=input]::-webkit-clear-button,:host [part=input]::-webkit-inner-spin-button,:host [part=input]::-webkit-search-cancel-button,:host [part=input]::-webkit-search-decoration{-webkit-appearance:none}:host [part=input]:invalid{box-shadow:none}:host [part=icon]{color:#acafb5;min-width:1em}:host([disabled]) [part=input]{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}:host([disabled]){border:1px solid rgba(169,175,186,.6);color:rgba(72,72,72,.6)}:host([readonly]){border:1px solid rgba(169,175,186,.6)}:host(:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #bfc3cb}:host([warning]){background-color:#fff;border:1px solid #f93}:host([warning][disabled]){border:1px solid rgba(255,153,51,.6);color:rgba(72,72,72,.6)}:host([warning][readonly]){border:1px solid rgba(255,153,51,.6)}:host([warning]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #ffb366}:host([error]),:host([error][warning]:not([focused])){background-color:#fff;border:1px solid #d94255}:host([error][disabled]),:host([error][warning]:not([focused])[disabled]){border:1px solid rgba(217,66,85,.6);color:rgba(72,72,72,.6)}:host([error][readonly]),:host([error][warning]:not([focused])[readonly]){border:1px solid rgba(217,66,85,.6)}:host([error]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover),:host([error][warning]:not([focused]):not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #e37180}:host([highlight]){background-color:#b0ffff;border:1px solid #a9afba}:host([highlight][disabled]){border:1px solid rgba(169,175,186,.6);color:rgba(72,72,72,.6);background-color:rgba(176,255,255,.6)}:host([highlight][readonly]){border:1px solid rgba(169,175,186,.6)}:host([highlight]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #bfc3cb}:host([indirect]){color:#009494;background-color:#effefe;border:1px solid #898623}:host([indirect][disabled]){border:1px solid rgba(137,134,35,.6);color:rgba(0,148,148,.6)}:host([indirect][readonly]){border:1px solid rgba(137,134,35,.6)}:host([indirect]:not([focused]):not(:focus):not([disabled]):not([readonly]):hover){border:1px solid #a7a45a}:host([focused]){background-size:100% 2px,100% 1px!important;background-position:center bottom!important;border-color:#ffb266;border-style:dotted}:host([disabled]) [part=input]::-webkit-input-placeholder{color:rgba(102,101,112,.6)}:host([disabled]) [part=input]::-moz-placeholder{color:rgba(102,101,112,.6)}:host([disabled]) [part=input]:-ms-input-placeholder{color:rgba(102,101,112,.6)}');

package/lib/events.d.ts

@@ -0,0 +1,121 @@
+import type { TapEvent, ResizeEvent, FocusedChangedEvent } from '@refinitiv-ui/core';
+/**
+ * Dispatched when `opened` state changes
+ * Prevent default to stop opening/closing pipeline
+ */
+declare type OpenedChangedEvent = CustomEvent<{
+    /**
+     * `opened` value
+     */
+    value: boolean;
+}>;
+/**
+ * Dispatched when `value` changes
+ */
+declare type ValueChangedEvent = CustomEvent<{
+    /**
+     * new `value`
+     */
+    value: string;
+}>;
+/**
+ * Dispatched when `error` state changes
+ */
+declare type ErrorChangedEvent = CustomEvent<{
+    /**
+     * `error` value
+     */
+    value: boolean;
+}>;
+/**
+ * Dispatched when `active` state changes
+ */
+declare type ActiveChangedEvent = CustomEvent<{
+    /**
+     * `active` value
+     */
+    value: boolean;
+}>;
+/**
+ * Dispatched when `query` state changes
+ */
+declare type QueryChangedEvent = CustomEvent<{
+    /**
+     * `query` value
+     */
+    value: string;
+}>;
+/**
+ * Dispatched when `view` state changes
+ */
+declare type ViewChangedEvent = CustomEvent<{
+    /**
+     * `view` value
+     */
+    value: string;
+}>;
+/**
+ * Dispatched when `page` state changes
+ */
+declare type PageChangedEvent = CustomEvent<{
+    /**
+     * `page` value
+     */
+    value: string;
+}>;
+/**
+ * Dispatched when `from` state changes
+ */
+declare type FromChangedEvent = CustomEvent<{
+    /**
+     * `from` value
+     */
+    value: string;
+}>;
+/**
+ * Dispatched when `to` state changes
+ */
+declare type ToChangedEvent = CustomEvent<{
+    /**
+     * `to` value
+     */
+    value: string;
+}>;
+/**
+ * Dispatched when `checked` state changes
+ */
+declare type CheckChangedEvent = CustomEvent<{
+    /**
+     * `checked` value
+     */
+    value: boolean;
+}>;
+/**
+ * Dispatched when `offset` state changes
+ */
+declare type OffsetChangedEvent = CustomEvent<{
+    /**
+     * `offset` value
+     */
+    value: number;
+}>;
+/**
+ * Dispatched when `expanded` state changes
+ * Prevent default to stop expand/collapse pipeline
+ */
+declare type ExpandedChangedEvent = CustomEvent<{
+    /**
+     * `expanded` value
+     */
+    value: boolean;
+}>;
+/**
+ * Dispatched when the user clicks on internal `item`
+ */
+declare type ItemTriggerEvent = CustomEvent<{
+    /**
+     * `item` value
+     */
+    value: string;
+}>;
+export { OpenedChangedEvent, ValueChangedEvent, ErrorChangedEvent, ActiveChangedEvent, ViewChangedEvent, ItemTriggerEvent, CheckChangedEvent, OffsetChangedEvent, ExpandedChangedEvent, QueryChangedEvent, PageChangedEvent, FromChangedEvent, ToChangedEvent, TapEvent, ResizeEvent, FocusedChangedEvent };

package/lib/events.js

@@ -0,0 +1 @@
+export {};

package/lib/flag/index.d.ts

@@ -0,0 +1,96 @@
+import { JSXInterface } from '../jsx';
+import { BasicElement, CSSResultGroup, TemplateResult, PropertyValues } from '@refinitiv-ui/core';
+export { preload } from './utils/FlagLoader.js';
+/**
+ * Provides a collection of flags.
+ *
+ * @attr {string | null} src - Src location of a svg flag.
+ * @prop {string | null} src - Src location of a svg flag
+ *
+ */
+export declare class Flag extends BasicElement {
+    /**
+     * 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.
+     * @returns CSS template
+     */
+    static get styles(): CSSResultGroup;
+    private _flag;
+    /**
+     * Name of a known flag to render.
+     * @example gb
+     * @default null
+     */
+    get flag(): string | null;
+    set flag(value: string | null);
+    private _src;
+    /**
+     * Src location of an svg flag.
+     * @example https://cdn.io/flags/gb.svg
+     * @default null
+     */
+    get src(): string | null;
+    set src(value: string | null);
+    private _template;
+    /**
+     * The flag template to render
+     */
+    private get template();
+    private set template(value);
+    /**
+     * Called after the component is first rendered
+     * @param changedProperties Properties which have changed
+     * @returns {void}
+     */
+    protected firstUpdated(changedProperties: PropertyValues): void;
+    /**
+     * Helper method, used to set the flag src.
+     * @returns {void}
+     */
+    private setFlagSrc;
+    /**
+     * Tries to load an flag from the url provided
+     * and the renders this into the flag template.
+     * @param src Source location of the svg flag.
+     * @returns {void}
+     */
+    private loadAndRenderFlag;
+    /**
+     * Get and cache CDN prefix
+     * This is a private URL which is set in the theme
+     * and should not be configured again via the variable.
+     * @returns {void}
+     */
+    private setPrefix;
+    /**
+     * Clears SVG body from the flag template
+     * @returns {void}
+     */
+    private clearFlag;
+    /**
+     * A `TemplateResult` that will be used
+     * to render the updated internal template.
+     * @return {TemplateResult} Render template
+     */
+    protected render(): TemplateResult;
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'ef-flag': Flag;
+  }
+
+  namespace JSX {
+    interface IntrinsicElements {
+      'ef-flag': Partial<Flag> | JSXInterface.HTMLAttributes<Flag>;
+    }
+  }
+}
+
+export {};

package/lib/flag/index.js

@@ -0,0 +1,168 @@
+import { __decorate } from "tslib";
+import { BasicElement, svg, 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 { unsafeHTML } from '@refinitiv-ui/core/lib/directives/unsafe-html.js';
+import { VERSION } from '../version.js';
+import { FlagLoader } from './utils/FlagLoader.js';
+export { preload } from './utils/FlagLoader.js';
+const EmptyTemplate = svg ``;
+/**
+ * Provides a collection of flags.
+ *
+ * @attr {string | null} src - Src location of a svg flag.
+ * @prop {string | null} src - Src location of a svg flag
+ *
+ */
+let Flag = class Flag extends BasicElement {
+    constructor() {
+        super(...arguments);
+        this._flag = null;
+        this._src = null;
+        this._template = EmptyTemplate;
+    }
+    /**
+     * 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.
+     * @returns CSS template
+     */
+    static get styles() {
+        return css `
+      :host {
+        display: inline-block;
+        box-sizing: border-box;
+        width: 1.33em;
+        height: 1em;
+      }
+      svg {
+        display: block;
+        box-sizing: border-box;
+        width: 100%;
+        height: 100%;
+      }
+    `;
+    }
+    /**
+     * Name of a known flag to render.
+     * @example gb
+     * @default null
+     */
+    get flag() {
+        return this._flag;
+    }
+    set flag(value) {
+        if (this.flag !== value) {
+            this._flag = value;
+            void this.setFlagSrc();
+        }
+    }
+    /**
+     * Src location of an svg flag.
+     * @example https://cdn.io/flags/gb.svg
+     * @default null
+     */
+    get src() {
+        return this._src;
+    }
+    set src(value) {
+        if (this.src !== value) {
+            this._src = value;
+            this.clearFlag();
+            if (value) {
+                void this.loadAndRenderFlag(value);
+            }
+        }
+    }
+    /**
+     * The flag template to render
+     */
+    get template() {
+        return this._template;
+    }
+    set template(value) {
+        if (this._template !== value) {
+            this._template = value;
+            this.requestUpdate();
+        }
+    }
+    /**
+     * Called after the component is first rendered
+     * @param changedProperties Properties which have changed
+     * @returns {void}
+     */
+    firstUpdated(changedProperties) {
+        super.firstUpdated(changedProperties);
+        /**
+         * We have to call this here because
+         * polyfilled browsers only get variables at this point.
+         */
+        this.setPrefix();
+    }
+    /**
+     * Helper method, used to set the flag src.
+     * @returns {void}
+     */
+    async setFlagSrc() {
+        this.src = this.flag ? await FlagLoader.getSrc(this.flag) : null;
+    }
+    /**
+     * Tries to load an flag from the url provided
+     * and the renders this into the flag template.
+     * @param src Source location of the svg flag.
+     * @returns {void}
+     */
+    async loadAndRenderFlag(src) {
+        const svgBody = await FlagLoader.loadSVG(src);
+        if (svgBody) {
+            this.template = svg `${unsafeHTML(svgBody)}`;
+        }
+    }
+    /**
+     * Get and cache CDN prefix
+     * This is a private URL which is set in the theme
+     * and should not be configured again via the variable.
+     * @returns {void}
+     */
+    setPrefix() {
+        if (!FlagLoader.isPrefixSet) {
+            const CDNPrefix = this.getComputedVariable('--cdn-prefix')
+                .replace(/^('|")|('|")$/g, '');
+            FlagLoader.setCdnPrefix(CDNPrefix);
+        }
+    }
+    /**
+     * Clears SVG body from the flag template
+     * @returns {void}
+     */
+    clearFlag() {
+        this.template = EmptyTemplate;
+    }
+    /**
+     * A `TemplateResult` that will be used
+     * to render the updated internal template.
+     * @return {TemplateResult} Render template
+     */
+    render() {
+        return this.template;
+    }
+};
+__decorate([
+    property({ type: String })
+], Flag.prototype, "flag", null);
+__decorate([
+    property({ type: String })
+], Flag.prototype, "src", null);
+Flag = __decorate([
+    customElement('ef-flag', {
+        alias: 'coral-flag'
+    })
+], Flag);
+export { Flag };

package/lib/flag/themes/halo/dark/index.js

@@ -0,0 +1,2 @@
+
+elf.customStyles.define('ef-flag', ':host{--cdn-prefix:\'https://cdn.refinitiv.net/public/libs/elf/assets/elf-theme-halo/resources/flags/\'}');

package/lib/flag/themes/halo/light/index.js

@@ -0,0 +1,2 @@
+
+elf.customStyles.define('ef-flag', ':host([flag=ar]),:host([flag=as]),:host([flag=at]),:host([flag=bg]),:host([flag=bh]),:host([flag=bi]),:host([flag=bl]),:host([flag=bq]),:host([flag=ca]),:host([flag=ci]),:host([flag=cl]),:host([flag=cy]),:host([flag=cz]),:host([flag=dj]),:host([flag=do]),:host([flag=dz]),:host([flag=ee]),:host([flag=eg]),:host([flag=es-ga]),:host([flag=fi]),:host([flag=fo]),:host([flag=fr]),:host([flag=gb-eng]),:host([flag=gb-nir]),:host([flag=gb-sct]),:host([flag=gb-wls]),:host([flag=ge]),:host([flag=gf]),:host([flag=gg]),:host([flag=gi]),:host([flag=gl]),:host([flag=gp]),:host([flag=gt]),:host([flag=hn]),:host([flag=hr]),:host([flag=hu]),:host([flag=id]),:host([flag=ie]),:host([flag=il]),:host([flag=in]),:host([flag=iq]),:host([flag=ir]),:host([flag=it]),:host([flag=je]),:host([flag=jp]),:host([flag=kr]),:host([flag=lb]),:host([flag=ls]),:host([flag=lu]),:host([flag=mc]),:host([flag=mf]),:host([flag=mg]),:host([flag=mq]),:host([flag=mt]),:host([flag=mx]),:host([flag=ne]),:host([flag=nf]),:host([flag=ng]),:host([flag=ni]),:host([flag=nl]),:host([flag=np]),:host([flag=om]),:host([flag=pa]),:host([flag=pe]),:host([flag=pf]),:host([flag=ph]),:host([flag=pk]),:host([flag=pl]),:host([flag=pm]),:host([flag=py]),:host([flag=qa]),:host([flag=re]),:host([flag=rs]),:host([flag=ru]),:host([flag=sg]),:host([flag=si]),:host([flag=sk]),:host([flag=sl]),:host([flag=sm]),:host([flag=sv]),:host([flag=sx]),:host([flag=sy]),:host([flag=tj]),:host([flag=uy]),:host([flag=uz]),:host([flag=va]),:host([flag=vi]),:host([flag=wf]),:host([flag=ye]),:host([flag=yt]),:host([flag=zw]){border:1px solid #595959}:host{--cdn-prefix:\'https://cdn.refinitiv.net/public/libs/elf/assets/elf-theme-halo/resources/flags/\'}');

package/lib/flag/themes/solar/charcoal/index.js

@@ -0,0 +1,2 @@
+
+elf.customStyles.define('ef-flag', ':host{--cdn-prefix:\'https://cdn.refinitiv.net/public/libs/elf/assets/elf-theme-halo/resources/flags/\';--cdn-prefix:\'https://cdn.refinitiv.net/public/libs/elf/assets/elf-theme-solar/resources/flags/\'}');

package/lib/flag/themes/solar/pearl/index.js

@@ -0,0 +1,2 @@
+
+elf.customStyles.define('ef-flag', ':host{--cdn-prefix:\'https://cdn.refinitiv.net/public/libs/elf/assets/elf-theme-halo/resources/flags/\';--cdn-prefix:\'https://cdn.refinitiv.net/public/libs/elf/assets/elf-theme-solar/resources/flags/\'}:host([flag=ar]),:host([flag=as]),:host([flag=at]),:host([flag=bg]),:host([flag=bh]),:host([flag=bi]),:host([flag=bl]),:host([flag=bq]),:host([flag=ca]),:host([flag=ci]),:host([flag=cl]),:host([flag=cy]),:host([flag=cz]),:host([flag=dj]),:host([flag=do]),:host([flag=dz]),:host([flag=ee]),:host([flag=eg]),:host([flag=es-ga]),:host([flag=fi]),:host([flag=fo]),:host([flag=fr]),:host([flag=gb-eng]),:host([flag=gb-nir]),:host([flag=gb-sct]),:host([flag=gb-wls]),:host([flag=ge]),:host([flag=gf]),:host([flag=gg]),:host([flag=gi]),:host([flag=gl]),:host([flag=gp]),:host([flag=gt]),:host([flag=hn]),:host([flag=hr]),:host([flag=hu]),:host([flag=id]),:host([flag=ie]),:host([flag=il]),:host([flag=in]),:host([flag=iq]),:host([flag=ir]),:host([flag=it]),:host([flag=je]),:host([flag=jp]),:host([flag=kr]),:host([flag=lb]),:host([flag=ls]),:host([flag=lu]),:host([flag=mc]),:host([flag=mf]),:host([flag=mg]),:host([flag=mq]),:host([flag=mt]),:host([flag=mx]),:host([flag=ne]),:host([flag=nf]),:host([flag=ng]),:host([flag=ni]),:host([flag=nl]),:host([flag=np]),:host([flag=om]),:host([flag=pa]),:host([flag=pe]),:host([flag=pf]),:host([flag=ph]),:host([flag=pk]),:host([flag=pl]),:host([flag=pm]),:host([flag=py]),:host([flag=qa]),:host([flag=re]),:host([flag=rs]),:host([flag=ru]),:host([flag=sg]),:host([flag=si]),:host([flag=sk]),:host([flag=sl]),:host([flag=sm]),:host([flag=sv]),:host([flag=sx]),:host([flag=sy]),:host([flag=tj]),:host([flag=uy]),:host([flag=uz]),:host([flag=va]),:host([flag=vi]),:host([flag=wf]),:host([flag=ye]),:host([flag=yt]),:host([flag=zw]){border:1px solid #a9afba}');

package/lib/flag/utils/FlagLoader.d.ts

@@ -0,0 +1,47 @@
+import { CdnLoader } from '@refinitiv-ui/utils/lib/loader.js';
+/**
+ * Caches and provides flag SVGs, Loaded either by name from CDN or directly by URL.
+ * Uses singleton pattern
+ */
+declare class FlagLoader extends CdnLoader {
+    private cdnPrefix;
+    private _isPrefixSet;
+    /**
+     * @returns {boolean} clarify whether prefix has been set or not.
+     */
+    get isPrefixSet(): boolean;
+    /**
+     * Sets clarify whether prefix has been set or not
+     * @param value - new value that is going to set.
+     */
+    set isPrefixSet(value: boolean);
+    /**
+     * @returns promise, which will be resolved with CDN prefix, once set.
+     */
+    getCdnPrefix(): Promise<string>;
+    /**
+     * Sets CDN prefix to load source.
+     * Resolves deferred promise with CDN prefix and sets src used to check whether prefix is already set or not.
+     * @param prefix - CDN prefix.
+     * @returns {void}
+     */
+    setCdnPrefix(prefix: string): void;
+    /**
+     * Creates complete source using CDN prefix and src.
+     * Waits for CDN prefix to be set.
+     * @param flagName - resource path for download
+     * @returns Promise, which will be resolved with complete source.
+     */
+    getSrc(flagName: string): Promise<string>;
+    loadSVG(flag: string): Promise<string | undefined>;
+}
+declare const flagLoaderInstance: FlagLoader;
+export { flagLoaderInstance as FlagLoader };
+/**
+ * Helper function to preload set of flags.
+ * It could help to reduce flag loading delay when flag has a known set of flags that it can use.
+ * @param attrs - list of arguments, representing flags.
+ * Could be flag names, complete flag URLs or mix of both.
+ * @returns Array of promises, which will be resolved with SVG bodies.
+ */
+export declare const preload: (...attrs: string[]) => Promise<string | undefined>[];