@luigi-project/core-modular 0.0.10-dev.202606230108 → 0.0.10-dev.202606250110

package/core-api/global-search.d.ts

@@ -0,0 +1,78 @@
+import { GlobalSearchService } from '../services/global-search.service';
+import { Luigi } from './luigi';
+export interface GlobalSearchProvider {
+    customSearchResultItemRenderer?: (searchResultItem: any, slot: HTMLLIElement, searchApiObj: any) => object;
+    customSearchResultRenderer?: (searchResults: any[], slot: HTMLDivElement, searchApiObj: any) => object;
+    disableInputHandlers?: boolean;
+    inputPlaceholder?: any;
+    onEnter?: () => void;
+    onEscape?: () => void;
+    onInput?: () => void;
+    onSearchBtnClick?: () => void;
+    onSearchResultItemSelected?: (searchResultItem: any) => void;
+    searchFieldCentered?: boolean;
+    toggleSearch?: (element: HTMLInputElement, visible: boolean) => void;
+}
+export interface SearchResultItem {
+    description: string;
+    label: string;
+    pathObject: Record<string, any>;
+}
+export declare class GlobalSearch {
+    luigi: Luigi;
+    globalSearchService: GlobalSearchService;
+    constructor(luigi: Luigi);
+    /**
+     * Opens the global search field.
+     * @example Luigi.globalSearch().openSearchField();
+     */
+    openSearchField(): void;
+    /**
+     * Closes the global search field.
+     * @example Luigi.globalSearch().closeSearchField();
+     */
+    closeSearchField(): void;
+    /**
+     * Clears the global search field.
+     * @example Luigi.globalSearch().clearSearchField();
+     */
+    clearSearchField(): void;
+    /**
+     * Opens the global search result. By standard it is a popover.
+     * @param {Array<SearchResultItem>} searchResultItems
+     * @example
+     * let searchResultItem = {
+     *   pathObject: {
+     *     link,
+     *     params: {}
+     *   },
+     *   label,
+     *   description
+     * }
+     *
+     * Luigi.globalSearch().showSearchResult([searchResultItem1, searchResultItem2]);
+     */
+    showSearchResult(searchResultItems: SearchResultItem[]): void;
+    /**
+     * Closes the global search result. By standard it is rendered as a popover.
+     * @example Luigi.globalSearch().closeSearchResult();
+     */
+    closeSearchResult(): void;
+    /**
+     * Gets the value of the search input field.
+     * @example Luigi.globalSearch().getSearchString();
+     */
+    getSearchString(): string;
+    /**
+     * Sets the value of the search input field.
+     * @param searchString search value
+     * @example Luigi.globalSearch().setSearchString('searchString');
+     */
+    setSearchString(searchString: string): void;
+    /**
+     * Sets the value of the Placeholder search input field.
+     * @param placeholder placeholder value
+     * @example Luigi.globalSearch().setSearchInputPlaceholder('HERE input Placeholder');
+     */
+    setSearchInputPlaceholder(placeholder: string): void;
+}

package/core-api/luigi.d.ts

@@ -3,6 +3,7 @@ import { i18nService } from '../services/i18n.service';
 import { Elements } from './dom-elements';
 import { LuigiAuthClass } from './auth';
 import { FeatureToggles } from './feature-toggles';
+import { GlobalSearch } from './global-search';
 import { Navigation } from './navigation';
 import { Routing } from './routing';
 import { Theming } from './theming';
@@ -14,6 +15,7 @@ export declare class Luigi {
     _customMessages?: CustomMessages;
     _store: any;
     _featureToggles?: FeatureToggles;
+    _globalSearch?: GlobalSearch;
     _i18n: i18nService;
     _theming?: Theming;
     _routing?: Routing;
@@ -111,6 +113,7 @@ export declare class Luigi {
     navigation: () => Navigation;
     ux: () => UX;
     featureToggles: () => FeatureToggles;
+    globalSearch: () => GlobalSearch;
     routing: () => Routing;
     theming: () => Theming;
     auth: () => LuigiAuthClass;