wj-elements 0.1.199 → 0.1.201

package/dist/packages/wje-icon-picker/icon-picker.element.d.ts

@@ -0,0 +1,187 @@
+import { default as WJElement } from '../wje-element/element.js';
+import { default as Input } from '../wje-input/input.js';
+import { default as InfiniteScroll } from '../wje-infinite-scroll/infinite-scroll.js';
+import { default as Tooltip } from '../wje-tooltip/tooltip.js';
+import { default as Popup } from '../wje-popup/popup.js';
+/**
+ * @summary This element allows users to pick an icon from a set of available options.
+ * `IconPicker` is a custom web component that represents an interactive icon picker. It features
+ * search functionality, infinite scrolling, and popup-based selection. The component is highly customizable
+ * and integrates seamlessly with other `WJElement` components.
+ * @documentation https://elements.webjet.sk/components/icon-picker
+ * @status stable
+ * @augments {WJElement}
+ * @attribute {string} icon - The selected icon's name.
+ * @attribute {number} size - The number of icons displayed per page in infinite scroll. Default is 60.
+ * @csspart native - The native part of the component.
+ * @csspart anchor - The part representing the anchor button displaying the selected icon.
+ * @csspart picker - The picker part containing the search and icon selection interface.
+ * @csspart input - The input part for searching icons.
+ * @cssproperty [--wje-color-picker-value=#ff0000] - The default color value.
+ * @cssproperty [--wje-color-picker-area=transparent] - The background color of the color picker area.
+ * @cssproperty [--wje-color-picker-swatch=transparent] - The background color of the swatch picker.
+ * @cssproperty [--wje-color-picker-size=1rem] - The size of the icons in the picker.
+ * @cssproperty [--wje-color-picker-radius=4px] - The border radius of the picker.
+ * @tag wje-icon-picker
+ */
+export default class IconPicker extends WJElement {
+    /**
+     * Returns the CSS styles for the component.
+     * @static
+     * @returns {CSSStyleSheet}
+     */
+    static get cssStyleSheet(): CSSStyleSheet;
+    /**
+     * Returns the list of attributes to observe for changes.
+     * @static
+     * @returns {Array<string>}
+     */
+    static get observedAttributes(): Array<string>;
+    /**
+     * Dependencies of the IconPicker component.
+     * @property {object} dependencies
+     */
+    dependencies: {
+        'wje-input': typeof Input;
+        'wje-infinite-scroll': typeof InfiniteScroll;
+        'wje-tooltip': typeof Tooltip;
+        'wje-popup': typeof Popup;
+    };
+    /**
+     * Setter for the markerPosition property.
+     * @param {any} value The value to set.
+     */
+    set size(value: any);
+    /**
+     * Getter for the markerPosition property.
+     * @returns {any} size The value of the markerPosition property.
+     */
+    get size(): any;
+    /**
+     * Setter for the value property.
+     * @param value
+     */
+    set icon(value: string);
+    /**
+     * Getter for the value property.
+     * @returns {string}
+     */
+    get icon(): string;
+    /**
+     * Prepares the component before drawing.
+     */
+    beforeDraw(): Promise<void>;
+    tags: any[];
+    transformedObjects: any[];
+    index: any[];
+    /**
+     * Draws the component.
+     * @returns {DocumentFragment}
+     */
+    draw(): DocumentFragment;
+    popup: HTMLElement;
+    input: HTMLElement;
+    anchor: HTMLDivElement;
+    picker: HTMLDivElement;
+    infiniteScroll: InfiniteScroll;
+    /**
+     * Called after the component has been drawn.
+     */
+    afterDraw(): void;
+    value: any;
+    init: boolean;
+    /**
+     * Initializes the component.
+     */
+    initial(): void;
+    /**
+     * Converts an object of tags into a transformed array of objects, separating `filled` and `outline` styles.
+     * The function processes an input object containing tags, extracts its values,
+     * and for each tag that has both `filled` and `outline` styles, splits them into
+     * two separate objects. Tags without `filled` styles remain unchanged.
+     * @param {object} tags The input object containing tags as properties. Each property is an object with a `styles` key.
+     * @param {object} tags[].styles The styles object containing `filled` and/or `outline` styles.
+     * @param {object} [tags[].styles.outline] The outline style object, if present.
+     * @param {object} [tags[].styles.filled] The filled style object, if present.
+     * @returns {Array<object>} An array of transformed objects. Objects with both `filled` and `outline` styles are split into separate objects, each containing only one style.
+     * @example
+     * const tags = {
+     *     hourglass: {
+     *         styles: {
+     *             outline: { ... },
+     *             filled: { ... },
+     *         }
+     *     },
+     *     clock: {
+     *         styles: {
+     *             outline: { ... },
+     *         }
+     *     }
+     * };
+     * const result = convertObject(tags);
+     * console.log(result);
+     * // [
+     * //   { styles: { outline: { ... } } },
+     * //   { styles: { filled: { ... } } },
+     * //   { styles: { outline: { ... } } }
+     * // ]
+     */
+    convertObject: (tags?: {
+        styles: {
+            outline?: object;
+            filled?: object;
+        };
+    }) => Array<object>;
+    /**
+     * Converts an icon data object into an HTML element structure.
+     * This function creates a styled HTML element that represents an icon with a tooltip.
+     * The tooltip displays the name of the icon, and the icon itself is styled based on
+     * whether it uses the `filled` style.
+     * @param {object} data The icon data object.
+     * @returns {HTMLElement} A `div` element containing the icon wrapped in a `wje-tooltip`. The tooltip displays the icon name, and the `wje-icon` element represents the icon with attributes set according to the data.
+     * @example
+     * const iconData = {
+     *     name: "hourglass",
+     *     styles: {
+     *         filled: { ... }
+     *     }
+     * };
+     * const htmlElement = dataToHtml(iconData);
+     * document.body.appendChild(htmlElement);
+     *
+     * // The resulting structure:
+     * // <div class="icon-item">
+     * //   <wje-tooltip content="hourglass">
+     * //     <wje-icon name="hourglass" size="large" filled></wje-icon></wje-icon>
+     * //   </wje-tooltip>
+     * // </div>
+     */
+    dataToHtml: (data: object) => HTMLElement;
+    /**
+     * Gets the category of the tags.
+     * @param {Array} tags The tags to get the category of.
+     * @returns {Array} The category of the tags.
+     */
+    getCategory(tags: any[]): any[];
+    /**
+     * Gets the tags.
+     * @returns {Promise<Array>} The tags of the component.
+     */
+    getTags(): Promise<any[]>;
+    /**
+     * Searches icons based on user input.
+     * This method handles the input event and filters the available icons based on the provided search string.
+     * The filtering is performed on an index that combines icon names and their tags.
+     * The results are then adjusted for infinite scrolling.
+     * @param {Event} e The input event (e.g., `wje-input:input`) containing the search query details.
+     */
+    searchIcon: (e: Event) => void;
+    /**
+     * Clears the icons container.
+     */
+    clearIconsContainer(): void;
+    /**
+     * Closes the component.
+     */
+    onClose: () => void;
+}

package/dist/packages/wje-img/img.d.ts

@@ -0,0 +1,2 @@
+import { default as Img } from './img.element.js';
+export default Img;

package/dist/packages/wje-img/img.element.d.ts

@@ -0,0 +1,118 @@
+import { default as WJElement } from '../wje-element/element.js';
+/**
+ * @summary This element represents an image. `Img` is a custom web component that represents an image. It extends from `WJElement`.
+ * @documentation https://elements.webjet.sk/components/img
+ * @status stable
+ * @augments {WJElement}
+ * @cssproperty --img-width - The width of the image
+ * @cssproperty --img-height - The height of the image
+ * @property {string} src - The source URL of the image.
+ * @property {string} alt - The alternative text for the image.
+ * @property {string} fallout - The action to perform when an error occurs while loading the image. The value can be a function or a predefined action like 'delete'.
+ * @property {string} loader - The URL of the image loader to display while the image is loading.
+ * @tag wje-img
+ */
+export default class Img extends WJElement {
+    /**
+     * Returns the CSS styles for the component.
+     * @static
+     * @returns {CSSStyleSheet}
+     */
+    static get cssStyleSheet(): CSSStyleSheet;
+    /**
+     * Returns the list of attributes to observe for changes.
+     * @static
+     * @returns {Array<string>}
+     */
+    static get observedAttributes(): Array<string>;
+    _fallout: boolean;
+    actions: {
+        delete: () => void;
+        log: () => void;
+    };
+    /**
+     * Sets the value of the `src` attribute for the element.
+     * @param {string} value The value to set for the `src` attribute.
+     */
+    set src(value: string);
+    /**
+     * Retrieves the value of the 'src' attribute from the element.
+     * @returns {string} The value of the 'src' attribute.
+     */
+    get src(): string;
+    /**
+     * Sets the value of the 'alt' attribute for the element.
+     * @param {string} value The new value to set for the 'alt' attribute.
+     */
+    set alt(value: string);
+    /**
+     * Retrieves the value of the 'alt' attribute for the current element.
+     * @returns {string|null} The value of the 'alt' attribute, or null if the attribute is not set.
+     */
+    get alt(): string | null;
+    /**
+     * Sets the fallout property. Updates the `fallout` attribute if the value is a string;
+     * otherwise, assigns the value to the `_fallout` property.
+     * @param {string|*} value The value to set for the fallout property. If a string, it will update the `fallout` attribute; for other types, it will assign it to the `_fallout` property.
+     */
+    set fallout(value: string | any);
+    /**
+     * Retrieves the value of the 'fallout' attribute if it exists, otherwise returns the internal `_fallout` property.
+     * @returns {string|null} The value of the 'fallout' attribute or the `_fallout` property if the attribute is not present. Returns null if no value is found.
+     */
+    get fallout(): string | null;
+    /**
+     * Sets the value of the loader attribute.
+     * @param {string} value The value to set for the loader attribute.
+     */
+    set loader(value: string);
+    /**
+     * Retrieves the value of the 'loader' attribute from the element.
+     * @returns {string|null} The value of the 'loader' attribute if set, otherwise null.
+     */
+    get loader(): string | null;
+    /**
+     * Creates and assembles a lazy-loaded image element within a document fragment.
+     * @returns {DocumentFragment} A document fragment containing the image element.
+     */
+    draw(): DocumentFragment;
+    native: HTMLImageElement;
+    /**
+     * Handles post-draw operations, such as setting up a lazy image loader using an IntersectionObserver.
+     * Observes when the target element becomes visible in the viewport and updates its source with the provided image source.
+     * Removes the `lazy` class once the image source is updated and unobserves the element.
+     * It also invokes the `onerrorFunc` method at the beginning to handle potential error scenarios.
+     * @returns {void} Does not return a value.
+     */
+    afterDraw(): void;
+    setAvatarInitials: (value?: boolean) => void;
+    /**
+     * Deletes the current image by calling the remove method.
+     * This function is typically used to trigger the removal of an image element
+     * or perform cleanup operations related to the image.
+     */
+    deleteImage: () => void;
+    /**
+     * Adds a new action to the internal actions object.
+     * @param {string} name The name of the action to be added.
+     * @param {Function} func The function representing the action logic.
+     * @returns {void} This method does not return a value.
+     */
+    addAction(name: string, func: Function): void;
+    /**
+     * Removes an action from the actions list if it exists.
+     * @param {string} name The name of the action to remove.
+     * @returns {void} Does not return a value.
+     */
+    removeAction(name: string): void;
+    /**
+     * Handles error scenarios by checking the `fallout` property and performing
+     * corresponding actions. If `fallout` is not defined, the function terminates
+     * early. Logs the active actions and attempts to assign an error handler
+     * based on the `fallout` value. If the `fallout` value does not correspond to
+     * a recognized action, it logs an error message.
+     * @function onerrorFunc
+     * @memberof Img
+     */
+    onerrorFunc: (img: any) => void;
+}

package/dist/packages/wje-img-comparer/img-comparer.d.ts

@@ -0,0 +1,2 @@
+import { default as ImgComparer } from './img-comparer.element.js';
+export default ImgComparer;

package/dist/packages/wje-img-comparer/img-comparer.element.d.ts

@@ -0,0 +1,60 @@
+import { default as WJElement } from '../wje-element/element.js';
+import { default as Icon } from '../wje-icon/icon.js';
+/**
+ * @summary This element allows users to compare two images. `ImgComparer` is a custom web component that represents an image comparer.
+ * It extends from `WJElement` and uses the `Icon` component.
+ * @documentation https://elements.webjet.sk/components/img-comparer
+ * @status stable
+ * @augments {WJElement}
+ * @slot before - The before image slot.
+ * @slot after - The after image slot.
+ * @csspart divider - The divider part.
+ * @cssproperty [--wje-img-compare-divider-area=12px] - The area of the divider. This is the size of the divider. Accepts any valid CSS size.
+ * @cssproperty [--wje-img-compare-divider-background=white] - Sets the background color of the divider in the image comparison component. Accepts any valid CSS color value (e.g., `red`, `#ff0000`, `rgba(255, 255, 255, 0.5)`). The default value is `white`, which ensures high contrast in most designs.
+ * @cssproperty [--wje-img-compare-divider-size=2px] - The size of the divider. This is the thickness of the divider. Accepts any valid CSS size.
+ * @cssproperty [--wje-img-compare-divider-left=50%] - The left position of the divider. This is the initial position of the divider.
+ * @cssproperty [--wje-img-compare-position=50%] - The position of the divider. This is the position of the divider.
+ * @cssproperty [--wje-img-compare-clip-path=inset(0 calc(100% - var(--wje-img-compare-position)) 0 0)] - The clip path of the divider. This is the clip path of the divider.
+ * @tag wje-img-comparer
+ */
+export default class ImgComparer extends WJElement {
+    /**
+     * Returns the CSS styles for the component.
+     * @static
+     * @returns {CSSStyleSheet}
+     */
+    static get cssStyleSheet(): CSSStyleSheet;
+    /**
+     * Returns the list of attributes to observe for changes.
+     * @static
+     * @returns {Array<string>}
+     */
+    static get observedAttributes(): Array<string>;
+    /**
+     * Dependencies of the ImgComparer component.
+     * @property {object} dependencies
+     */
+    dependencies: {
+        'wje-icon': typeof Icon;
+    };
+    /**
+     * Draws the component.
+     * @returns {DocumentFragment}
+     */
+    draw(): DocumentFragment;
+    native: HTMLDivElement;
+    /**
+     * Handles the drag event.
+     * @param {Event} e The event.
+     */
+    handleDrag: (e: Event) => void;
+    position: number;
+    /**
+     * Clamps a number between a minimum and maximum value.
+     * @param {number} num The number to clamp.
+     * @param {number} min The minimum value.
+     * @param {number} max The maximum value.
+     * @returns {number} The clamped number.
+     */
+    clamp: (num: number, min: number, max: number) => number;
+}

package/dist/packages/wje-img-comparer/service/service.d.ts

@@ -0,0 +1 @@
+export function drag(container: any, options: any): void;

package/dist/packages/wje-infinite-scroll/infinite-scroll.d.ts

@@ -0,0 +1,2 @@
+import { default as InfiniteScroll } from './infinite-scroll.element.js';
+export default InfiniteScroll;

package/dist/packages/wje-infinite-scroll/infinite-scroll.element.d.ts

@@ -0,0 +1,172 @@
+import { default as WJElement } from '../wje-element/element.js';
+/**
+ * `InfiniteScroll` is a custom web component that represents an infinite scroll.
+ * It extends from `WJElement`.
+ * @summary This element allows users to scroll through a potentially infinite amount of content.
+ * @documentation https://elements.webjet.sk/components/infinite-scroll
+ * @status stable
+ * @augments {WJElement}
+ * @csspart loader - The loader part of the infinite scroll.
+ * @slot - The default slot for the infinite scroll.
+ * @cssproperty [--wje-infinite-scroll-width=100%] - Sets the width of the infinite scroll container. his property determines how wide the infinite scroll area will be relative to its parent element. Accepts any valid CSS width value, such as percentages (`%`), pixels (`px`), or viewport units (`vw`). The default value is `100%`, which makes it span the full width of its container.
+ * @cssproperty [--wje-infinite-scroll-height=300px] - Defines the height of the infinite scroll container. This property specifies how tall the infinite scroll area should be. Accepts any valid CSS height value, such as pixels (`px`), percentages (`%`), or viewport units (`vh`). The default value is `300px`, providing a fixed height suitable for most use cases.
+ * //@fires wje-infinite-scroll:click-item - Event fired when an item is clicked.
+ * @tag wje-infinite-scroll
+ */
+export default class InfiniteScroll extends WJElement {
+    /**
+     * Returns the CSS styles for the component.
+     * @static
+     * @returns {CSSStyleSheet}
+     */
+    static get cssStyleSheet(): CSSStyleSheet;
+    /**
+     * Returns the list of attributes to observe for changes.
+     * @static
+     * @returns {Array<string>}
+     */
+    static get observedAttributes(): Array<string>;
+    totalPages: number;
+    isLoading: any[];
+    iterate: Element;
+    placementObj: this;
+    /**
+     * Dependencies of the InfiniteScroll component.
+     * @param value
+     */
+    set infiniteScrollTemplate(value: null);
+    /**
+     * Getter for the infiniteScrollTemplate property.
+     * @returns {null}
+     */
+    get infiniteScrollTemplate(): null;
+    /**
+     * Dependencies of the InfiniteScroll component.
+     * @param value
+     */
+    set response(value: any | {});
+    /**
+     * Getter for the response property.
+     * @returns {*|{}}
+     */
+    get response(): any | {};
+    /**
+     * Dependencies of the InfiniteScroll component.
+     * @param value
+     */
+    set objectName(value: string);
+    get objectName(): string;
+    /**
+     * Prepares the component for updates before it is drawn.
+     * This method handles the removal of templates for iteration, adjusts the height styling of the component,
+     * and manages abort signals for loading operations.
+     * @returns {void} No return value.
+     */
+    beforeDraw(): void;
+    /**
+     * Creates and returns a document fragment containing the structure for an infinite scroll component.
+     * The structure includes native elements, slots for customization, and optional loading content.
+     * @returns {DocumentFragment} The document fragment containing the component's DOM structure.
+     */
+    draw(): DocumentFragment;
+    loadingEl: HTMLDivElement;
+    endingEl: HTMLSlotElement;
+    /**
+     * Called after the component has been drawn.
+     */
+    afterDraw(): Promise<void>;
+    queryParams: any;
+    size: any;
+    currentPage: number;
+    /**
+     * Attaches a scroll event listener to the current object.
+     * The `scrollEvent` function binds the `onScroll` method to the 'scroll' event
+     * of the current object. This enables handling of scroll events for
+     * specific functionality such as updating UI elements, loading content dynamically,
+     * or tracking user interaction with scrollable content.
+     */
+    scrollEvent: () => void;
+    /**
+     * A function that removes the scroll event listener from the current context.
+     * This function is used to unbind the `onScroll` event listener
+     * from the `scroll` event of the current object. It ensures that
+     * the scroll event no longer triggers the `onScroll` handler.
+     * @function
+     */
+    unScrollEvent: () => void;
+    /**
+     * A scroll event handler function that checks the scroll position and triggers loading additional content
+     * when the user scrolls near the bottom of the page.
+     * Properties accessed:
+     * - `scrollTop`: The number of pixels that the content of an element is scrolled vertically.
+     * - `scrollHeight`: The total height of the element's content.
+     * - `clientHeight`: The inner height of the element in pixels, including padding but excluding borders and scrollbars.
+     * Conditions:
+     * - Determines if the scroll position is within 300 pixels of the bottom of the element.
+     * - Verifies that the current page number is less than or equal to the total number of pages.
+     * - Checks if the current page is already in the loading state.
+     * Actions:
+     * - Increments the current page number when the conditions are met.
+     * - Initiates loading for the next page by calling the `loadPages` function.
+     * @param {Event} e The scroll event object.
+     */
+    onScroll: (e: Event) => void;
+    /**
+     * Fetches the pages from the server.
+     * @param {number} page The page number.
+     * @returns {Promise<object>} The response from the server.
+     */
+    getPages(page: number): Promise<object>;
+    /**
+     * Hides the loader.
+     */
+    hideLoader(): void;
+    /**
+     * Displays the loader element by adding the 'show' class to its class list.
+     * This method is useful for indicating a loading or processing state in the UI.
+     * @returns {void} No return value.
+     */
+    showLoader(): void;
+    /**
+     * Checks if there are more pages to load.
+     * @param {number} page The page number.
+     * @returns {boolean} Whether there are more pages to load.
+     */
+    hasMorePages(page: number): boolean;
+    /**
+     * Loads the pages.
+     * @param {number} page The page number.
+     */
+    loadPages(page: number): Promise<void>;
+    parser: DOMParser;
+    compareFunction: (i: any, item: any) => boolean;
+    /**
+     * Converts a data item into an HTML element based on a template.
+     * This function takes a data item, interpolates it into a predefined template,
+     * parses the resulting HTML string, and returns the first child element of the parsed HTML content.
+     * @param {object} item The data object to interpolate into the HTML template.
+     * @returns {Element} The first child element generated from the interpolated HTML string.
+     */
+    dataToHtml: (item: object) => Element;
+    /**
+     * A custom implementation of the forEach method designed to iterate over an array of data,
+     * transform each item into an HTML element, and append the element to a specified placement object.
+     * Additionally, it adds an event listener to each generated element for handling click events.
+     * @param {Array} data An array of items to process. Each item is transformed into an HTML element
+     * and appended to the placement object specified in the context of `this`.
+     */
+    customForeach: (data: any[]) => void;
+    /**
+     * Interpolates a string template with values from the provided parameters object.
+     * The template contains placeholders in the format `{{key}}` or `{{key.subkey}}`,
+     * which are replaced with the corresponding values from the `params` object.
+     * Placeholders support dot notation for accessing nested properties within the `params` object.
+     * @param {string} template The string template containing placeholders to be replaced.
+     * @param {object} params The object containing key-value pairs used for substitution in the template.
+     * @returns {string} A string with all placeholders replaced by their respective values from the `params` object.
+     */
+    interpolate: (template: string, params: object) => string;
+    addItem(item: any, place?: string): void;
+    removeItem(item: any): void;
+    #private;
+}

package/dist/packages/wje-input/input.d.ts

@@ -0,0 +1,2 @@
+import { default as Input } from './input.element.js';
+export default Input;