@limetech/lime-elements 37.1.0-next.55 → 37.1.0-next.57

package/dist/types/components/chip-set/chip.types.d.ts

@@ -1,3 +1,4 @@
+import { Icon } from '../../interface';
 export interface Chip<T = any> {
   /**
    * ID of the chip. Must be unique.
@@ -10,17 +11,44 @@ export interface Chip<T = any> {
   /**
    * Name of the icon to use. Not valid for `filter`.
    */
-  icon?: string;
+  icon?: string | Icon;
   /**
    * Color of the icon. Overrides `--icon-color`.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    color: string,
+   * },
+   * ```
    */
   iconFillColor?: string;
   /**
    * `title` attribute of the icon
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    title: string,
+   * },
+   * ```
    */
   iconTitle?: string;
   /**
    * Background color of the icon. Overrides `--icon-background-color`.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    backgroundColor: string,
+   * },
+   * ```
    */
   iconBackgroundColor?: string;
   /**

package/dist/types/components/file/file.types.d.ts

@@ -1,3 +1,4 @@
+import { Icon } from '../../interface';
 export interface FileInfo {
   /**
    * ID of the file. Must be unique.
@@ -30,13 +31,29 @@ export interface FileInfo {
   /**
    * Name of the icon to use.
    */
-  icon?: string;
+  icon?: string | Icon;
   /**
    * Icon color. Overrides `--icon-color`.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    color: string,
+   * },
    */
   iconColor?: string;
   /**
    * Background color of the icon. Overrides `--icon-background-color`.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    backgroundColor: string,
+   * },
    */
   iconBackgroundColor?: string;
   /**

package/dist/types/components/icon/get-icon-props.d.ts

@@ -0,0 +1,48 @@
+import { Icon } from '../../interface';
+/**
+ * Get the icon name.
+ * This helps in setting the right icon, both if the consumer only types `icon: string`,
+ * and if they use the `Icon` interface for writing the icon name.
+ * @param {string | Icon | undefined} icon - The icon to retrieve the name from.
+ * @returns {string | undefined} The icon name or the provided string, or `undefined` if `icon` is falsy.
+ */
+export declare function getIconName(icon: string | Icon | undefined): string | undefined;
+/**
+ * Get the icon color.
+ * This is added because the old way of specifying `iconColor`
+ * deprecated in our components. So consumers should now use the new
+ * `Icon` interface instead. But our components must still support the
+ * old way of writing `iconColor: string`.
+ * @param {string | Icon | undefined} icon - The icon to retrieve the color from.
+ * @param {string | undefined} [iconColor] - The color to use when the deprecated `iconColor` is used.
+ * @returns {string | undefined} The icon color or the provided color string, or `undefined` if `iconColor` is falsy.
+ */
+export declare function getIconColor(icon: string | Icon | undefined, iconColor?: string | undefined): string | undefined;
+/**
+ * Get the icon color.
+ * This is added because the old way of specifying `iconFillColor` is
+ * deprecated in our components. So consumers should now use the new
+ * `Icon` interface instead. But our components must still support the
+ * old way of writing `iconFillColor: string`.
+ * @param {string | Icon} icon - The icon to retrieve the color from.
+ * @param {string | undefined} [iconFillColor] - The color to use when `iconFillColor` is used.
+ * @returns {string | undefined} The icon color or the provided color string, or `undefined` if `iconColor` is falsy.
+ */
+export declare function getIconFillColor(icon: string | Icon | undefined, iconFillColor?: string | undefined): string;
+/**
+ * Get the icon background color.
+ * This function is used to retrieve the background color associated with an icon,
+ * whether provided as a string or using the `Icon` interface.
+ * @param {string | Icon | undefined} icon - The icon to retrieve the background color from.
+ * @param {string | undefined} [iconBackgroundColor] - The background color to use when provided explicitly.
+ * @returns {string | undefined} The icon background color or the provided background color string, or `undefined` if `iconBackgroundColor` is falsy.
+ */
+export declare function getIconBackgroundColor(icon: string | Icon | undefined, iconBackgroundColor?: string | undefined): string | undefined;
+/**
+ * Get the icon title.
+ * This function is used to retrieve the title associated with an icon, whether provided as a string or using the `Icon` interface.
+ * @param {string | Icon | undefined} icon - The icon to retrieve the title from.
+ * @param {string | undefined} [iconTitle] - The title to use when provided explicitly.
+ * @returns {string | undefined} The icon title or the provided title string, or `undefined` if `iconTitle` is falsy.
+ */
+export declare function getIconTitle(icon: string | Icon | undefined, iconTitle?: string | undefined): string | undefined;

package/dist/types/components/list/list-item.types.d.ts

@@ -1,4 +1,4 @@
-import { MenuItem } from '../../interface';
+import { MenuItem, Icon } from '../../interface';
 export interface ListItem<T = any> {
   /**
    * Text to display in the list item.
@@ -15,9 +15,18 @@ export interface ListItem<T = any> {
   /**
    * Name of the icon to use.
    */
-  icon?: string;
+  icon?: string | Icon;
   /**
    * Background color of the icon. Overrides `--icon-background-color`.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    color: string,
+   * },
+   * ```
    */
   iconColor?: string;
   /**

package/dist/types/components/list/list.d.ts

@@ -73,4 +73,5 @@ export declare class List {
   private handleSingleSelect;
   private handleMultiSelect;
   private isListItem;
+  private triggerIconColorWarning;
 }

package/dist/types/components/menu/menu.types.d.ts

@@ -1,3 +1,4 @@
+import { Icon } from '../../interface';
 export type OpenDirection = 'left-start' | 'left' | 'left-end' | 'right-start' | 'right' | 'right-end' | 'top-start' | 'top' | 'top-end' | 'bottom-start' | 'bottom' | 'bottom-end';
 /**
  * Any element in the UI can be configured to open a menu.
@@ -33,9 +34,18 @@ export interface MenuItem<T = any> {
   /**
    * Name of the icon to use.
    */
-  icon?: string;
+  icon?: string | Icon;
   /**
    * Background color of the icon. Overrides `--icon-background-color`.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    color: string,
+   * },
+   * ```
    */
   iconColor?: string;
   /**

package/dist/types/components/menu-list/menu-list.d.ts

@@ -49,4 +49,5 @@ export declare class MenuList {
   private handleMenuSelect;
   private handleSingleSelect;
   private isMenuItem;
+  private triggerIconColorWarning;
 }

package/dist/types/components/progress-flow/progress-flow.types.d.ts

@@ -16,6 +16,15 @@ export interface FlowItem extends ListItem {
   /**
    * Fill color of the icon on the step,
    * when it is neither selected nor passed.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    color: string,
+   * },
+   * ```
    */
   iconColor?: string;
 }

package/dist/types/components/select/option.types.d.ts

@@ -1,3 +1,4 @@
+import { Icon } from '../../interface';
 /**
  * Describes an option for limel-select.
  */
@@ -26,9 +27,18 @@ export interface Option<T extends string = string> {
   /**
    * Displays an icon beside the name of the option.
    */
-  icon?: string;
+  icon?: string | Icon;
   /**
    * Adds a color to the icon.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    color: string,
+   * },
+   * ```
    */
   iconColor?: string;
 }

package/dist/types/components/select/select.template.d.ts

@@ -22,4 +22,5 @@ interface SelectTemplateProps {
   dropdownZIndex: string;
 }
 export declare const SelectTemplate: FunctionalComponent<SelectTemplateProps>;
+export declare function triggerIconColorWarning(options: Option[]): void;
 export {};

package/dist/types/components/tab-bar/tab-bar.d.ts

@@ -52,4 +52,5 @@ export declare class TabBar {
   private handleRightScrollClick;
   private renderIcon;
   private renderTab;
+  private triggerIconColorWarning;
 }

package/dist/types/components/tab-bar/tab.types.d.ts

@@ -1,3 +1,4 @@
+import { Icon } from '../../interface';
 export interface Tab {
   /**
    * Id of the tab. Must be unique.
@@ -10,13 +11,22 @@ export interface Tab {
   /**
    * Name of the icon to use.
    */
-  icon?: string;
+  icon?: string | Icon;
   /**
    * True if the tab should be selected.
    */
   active?: boolean;
   /**
    * Color of the icon.
+   * @deprecated This property is deprecated and will be removed soon!
+   *
+   * Use the new `Icon` interface instead and write:
+   * ```
+   * icon {
+   *    name: string,
+   *    color: string,
+   * },
+   * ```
    */
   iconColor?: string;
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "37.1.0-next.55",
+  "version": "37.1.0-next.57",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -50,8 +50,8 @@
     "@types/html-escaper": "^3.0.1",
     "@types/jest": "^27.4.0",
     "@types/lodash-es": "^4.17.10",
-    "@types/react": "^18.2.36",
-    "@types/react-dom": "^18.2.14",
+    "@types/react": "^18.2.37",
+    "@types/react-dom": "^18.2.15",
     "@types/tabulator-tables": "^4.9.4",
     "@typescript-eslint/eslint-plugin": "^5.61.0",
     "@typescript-eslint/parser": "^5.62.0",