@ukic/web-components 2.0.0-alpha.124 → 2.0.0

package/dist/types/utils/helpers.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from "../stencil-public-runtime";
-import { IcCallbackFunctionNoReturn, IcInformationStatusOrEmpty, IcNavParentDetails, IcPropObject, IcColorRGB } from "./types";
+import { IcCallbackFunctionNoReturn, IcInformationStatusOrEmpty, IcNavParentDetails, IcPropObject, IcColorRGB, IcSearchMatchPositions } from "./types";
 import { IcMenuOption, IcThemeForeground } from "../utils/types";
 /**
  * Used to inherit global attributes set on the host. Called in componentWillLoad and assigned
@@ -58,9 +58,18 @@ export declare const isEmptyString: (value: string) => boolean;
  * Extracts the label using the value from an object. Requires the object to have a label and value property.
  * @param value - value from object
  * @param options - list of menu items
- * @returns - label correspoonding to value
+ * @returns - label corresponding to value
  */
 export declare const getLabelFromValue: (value: string, options: IcMenuOption[]) => string | undefined;
+/**
+ * Filters the options based on the search string.
+ * @param options - array of options
+ * @param includeDescriptions - determines whether option descriptions are included when filtering options
+ * @param searchString - string used to filter the options
+ * @param position - whether the search string matches the start of or anywhere in the options
+ * @returns filtered array of options
+ */
+export declare const getFilteredMenuOptions: (options: IcMenuOption[], includeDescriptions: boolean, searchString: string, position: IcSearchMatchPositions) => IcMenuOption[];
 export declare const deviceSizeMatches: (size: number) => boolean;
 export declare const getCurrentDeviceSize: () => number;
 export declare const getCssProperty: (cssVar: string) => string;

package/dist/types/utils/types.d.ts

@@ -13,6 +13,7 @@ export declare enum IcThemeForegroundEnum {
   Light = "light"
 }
 export declare type IcThemeForeground = "default" | "dark" | "light";
+export declare type IcThemeForegroundNoDefault = "dark" | "light";
 export declare type IcTheme = {
   mode: IcThemeForeground;
   color: IcColorRGB;
@@ -38,6 +39,7 @@ export interface IcMenuOption {
   recommended?: boolean;
   children?: IcMenuOption[];
 }
+export declare type IcSearchMatchPositions = "start" | "anywhere";
 export declare type IcCallbackFunctionNoReturn = (...args: unknown[]) => void;
 export declare type IcRequiredPropsTypes = string | boolean | number | HTMLElement | IcMenuOption[];
 export declare type IcPropObject = {