@refinitiv-ui/elements 5.3.3 → 5.3.4

package/lib/events.d.ts

@@ -0,0 +1,121 @@
+import { TapEvent, ResizeEvent } 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 };

package/lib/events.js

@@ -0,0 +1,2 @@
+import { TapEvent } from '@refinitiv-ui/core';
+export { TapEvent };

package/lib/flag/custom-elements.json

@@ -0,0 +1,35 @@
+{
+  "version": "experimental",
+  "tags": [
+    {
+      "name": "ef-flag",
+      "description": "Provides a collection of flags.",
+      "attributes": [
+        {
+          "name": "flag",
+          "description": "Name of a known flag to render.",
+          "type": "string | null"
+        },
+        {
+          "name": "src",
+          "description": "Src location of an svg flag.",
+          "type": "string | null"
+        }
+      ],
+      "properties": [
+        {
+          "name": "flag",
+          "attribute": "flag",
+          "description": "Name of a known flag to render.",
+          "type": "string | null"
+        },
+        {
+          "name": "src",
+          "attribute": "src",
+          "description": "Src location of an svg flag.",
+          "type": "string | null"
+        }
+      ]
+    }
+  ]
+}

package/lib/flag/index.d.ts

@@ -0,0 +1,94 @@
+import { JSXInterface } from '../jsx';
+import { BasicElement, CSSResult, TemplateResult, PropertyValues } from '@refinitiv-ui/core';
+export { preload } from './utils/FlagLoader';
+/**
+ * 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 `CSSResult` that will be used
+     * to style the host, slotted children
+     * and the internal template of the element.
+     * @returns CSS template
+     */
+    static get styles(): CSSResult;
+    private _flag;
+    /**
+     * Name of a known flag to render.
+     * @example gb
+     */
+    get flag(): string | null;
+    set flag(value: string | null);
+    private _src;
+    /**
+     * Src location of an svg flag.
+     * @example https://cdn.io/flags/gb.svg
+     */
+    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 @@
+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, svg, css, customElement, property, unsafeHTML } from '@refinitiv-ui/core';
+import { VERSION } from '../';
+import { FlagLoader } from './utils/FlagLoader';
+export { preload } from './utils/FlagLoader';
+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 `CSSResult` 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
+     */
+    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
+     */
+    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;
+            void 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';
+/**
+ * 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>[];

package/lib/flag/utils/FlagLoader.js

@@ -0,0 +1,86 @@
+import { CdnLoader, Deferred } from '@refinitiv-ui/utils';
+const isUrl = (str) => (/^https?:\/\//i).test(str);
+/**
+ * Caches and provides flag SVGs, Loaded either by name from CDN or directly by URL.
+ * Uses singleton pattern
+ */
+class FlagLoader extends CdnLoader {
+    constructor() {
+        super(...arguments);
+        this.cdnPrefix = new Deferred();
+        this._isPrefixSet = false;
+    }
+    /**
+     * @returns {boolean} clarify whether prefix has been set or not.
+     */
+    get isPrefixSet() {
+        return this._isPrefixSet;
+    }
+    /**
+     * Sets clarify whether prefix has been set or not
+     * @param value - new value that is going to set.
+     */
+    set isPrefixSet(value) {
+        if (this._isPrefixSet !== value) {
+            this._isPrefixSet = value;
+        }
+    }
+    /**
+     * @returns promise, which will be resolved with CDN prefix, once set.
+     */
+    getCdnPrefix() {
+        return this.cdnPrefix.promise;
+    }
+    /**
+     * 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) {
+        if (prefix) {
+            this.cdnPrefix.resolve(prefix);
+            this.isPrefixSet = true;
+        }
+    }
+    /**
+     * 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.
+     */
+    async getSrc(flagName) {
+        return flagName ? `${await this.getCdnPrefix()}${flagName}.svg` : '';
+    }
+    async loadSVG(flag) {
+        if (flag) {
+            if (!isUrl(flag)) {
+                flag = await this.getSrc(flag);
+            }
+            const response = await this.load(flag);
+            if (response && response.status === 200 && response.getResponseHeader('content-type') === 'image/svg+xml') {
+                const container = document.createElement('svg');
+                container.innerHTML = response.responseText;
+                this.stripUnsafeNodes(...container.children);
+                const svgRoot = container.firstElementChild;
+                if (svgRoot) {
+                    svgRoot.setAttribute('focusable', 'false'); /* disable IE11 focus on SVG root element */
+                }
+                return Promise.resolve(container.innerHTML);
+            }
+            return Promise.resolve('');
+        }
+    }
+}
+const flagLoaderInstance = new 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 const preload = (...attrs) => {
+    return attrs.map(flag => flagLoaderInstance.loadSVG(flag));
+};

package/lib/header/custom-elements.json

@@ -0,0 +1,36 @@
+{
+  "version": "experimental",
+  "tags": [
+    {
+      "name": "ef-header",
+      "description": "Use to identify and separate different sections of a page.\nHeaders helps to organize the page layout content into\na sensible hierarchy and improve the user experience.",
+      "attributes": [
+        {
+          "name": "level",
+          "description": "Use level styling from theme",
+          "type": "\"1\" | \"2\" | \"3\"",
+          "default": "\"2\""
+        }
+      ],
+      "properties": [
+        {
+          "name": "level",
+          "attribute": "level",
+          "description": "Use level styling from theme",
+          "type": "\"1\" | \"2\" | \"3\"",
+          "default": "\"2\""
+        }
+      ],
+      "slots": [
+        {
+          "name": "left",
+          "description": "Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox"
+        },
+        {
+          "name": "right",
+          "description": "Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox"
+        }
+      ]
+    }
+  ]
+}

package/lib/header/index.d.ts

@@ -0,0 +1,46 @@
+import { JSXInterface } from '../jsx';
+import { BasicElement, TemplateResult, CSSResult } from '@refinitiv-ui/core';
+/**
+ * Use to identify and separate different sections of a page.
+ * Headers helps to organize the page layout content into
+ * a sensible hierarchy and improve the user experience.
+ *
+ * @slot left - Slot to add custom contents to the left side of header e.g. ef-icon, ef-checkbox
+ * @slot right - Slot to add custom contents to the right side of header e.g. ef-icon, ef-checkbox
+ */
+export declare class Header extends BasicElement {
+    /**
+     * Element version number
+     * @returns version number
+     */
+    static get version(): string;
+    /**
+     * Style definition
+     * @return CSS template
+     */
+    static get styles(): CSSResult | CSSResult[];
+    /**
+     * Use level styling from theme
+     */
+    level: '1' | '2' | '3';
+    /**
+     * A `TemplateResult` that will be used
+     * to render the updated internal template.
+     * @return Render template
+     */
+    protected render(): TemplateResult;
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'ef-header': Header;
+  }
+
+  namespace JSX {
+    interface IntrinsicElements {
+      'ef-header': Partial<Header> | JSXInterface.HTMLAttributes<Header>;
+    }
+  }
+}
+
+export {};