@chayns-components/core 5.5.37 → 5.5.40

package/lib/esm/utils/searchBox.test.js

@@ -0,0 +1,32 @@
+import { describe, expect, it } from 'vitest';
+import { searchList } from './searchBox';
+const items = [{
+  id: '2',
+  text: 'Zweite'
+}, {
+  id: '1',
+  text: 'Erste'
+}];
+describe('searchList', () => {
+  it('uses the custom sort function instead of the default sort', () => {
+    const result = searchList({
+      customSortFunction: (a, b) => b.id.localeCompare(a.id),
+      items,
+      searchString: ''
+    });
+    expect(result.map(({
+      id
+    }) => id)).toEqual(['2', '1']);
+  });
+  it('still filters before applying the custom sort function', () => {
+    const result = searchList({
+      customSortFunction: (a, b) => a.id.localeCompare(b.id),
+      items,
+      searchString: 'e'
+    });
+    expect(result.map(({
+      id
+    }) => id)).toEqual(['1', '2']);
+  });
+});
+//# sourceMappingURL=searchBox.test.js.map

package/lib/esm/utils/searchBox.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchBox.test.js","names":["describe","expect","it","searchList","items","id","text","result","customSortFunction","a","b","localeCompare","searchString","map","toEqual"],"sources":["../../../src/utils/searchBox.test.ts"],"sourcesContent":["import { describe, expect, it } from 'vitest';\nimport type { ISearchBoxItem } from '../types/searchBox';\nimport { searchList } from './searchBox';\n\nconst items: ISearchBoxItem[] = [\n    { id: '2', text: 'Zweite' },\n    { id: '1', text: 'Erste' },\n];\n\ndescribe('searchList', () => {\n    it('uses the custom sort function instead of the default sort', () => {\n        const result = searchList({\n            customSortFunction: (a, b) => b.id.localeCompare(a.id),\n            items,\n            searchString: '',\n        });\n\n        expect(result.map(({ id }) => id)).toEqual(['2', '1']);\n    });\n\n    it('still filters before applying the custom sort function', () => {\n        const result = searchList({\n            customSortFunction: (a, b) => a.id.localeCompare(b.id),\n            items,\n            searchString: 'e',\n        });\n\n        expect(result.map(({ id }) => id)).toEqual(['1', '2']);\n    });\n});\n"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,QAAQ;AAE7C,SAASC,UAAU,QAAQ,aAAa;AAExC,MAAMC,KAAuB,GAAG,CAC5B;EAAEC,EAAE,EAAE,GAAG;EAAEC,IAAI,EAAE;AAAS,CAAC,EAC3B;EAAED,EAAE,EAAE,GAAG;EAAEC,IAAI,EAAE;AAAQ,CAAC,CAC7B;AAEDN,QAAQ,CAAC,YAAY,EAAE,MAAM;EACzBE,EAAE,CAAC,2DAA2D,EAAE,MAAM;IAClE,MAAMK,MAAM,GAAGJ,UAAU,CAAC;MACtBK,kBAAkB,EAAEA,CAACC,CAAC,EAAEC,CAAC,KAAKA,CAAC,CAACL,EAAE,CAACM,aAAa,CAACF,CAAC,CAACJ,EAAE,CAAC;MACtDD,KAAK;MACLQ,YAAY,EAAE;IAClB,CAAC,CAAC;IAEFX,MAAM,CAACM,MAAM,CAACM,GAAG,CAAC,CAAC;MAAER;IAAG,CAAC,KAAKA,EAAE,CAAC,CAAC,CAACS,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;EAC1D,CAAC,CAAC;EAEFZ,EAAE,CAAC,wDAAwD,EAAE,MAAM;IAC/D,MAAMK,MAAM,GAAGJ,UAAU,CAAC;MACtBK,kBAAkB,EAAEA,CAACC,CAAC,EAAEC,CAAC,KAAKD,CAAC,CAACJ,EAAE,CAACM,aAAa,CAACD,CAAC,CAACL,EAAE,CAAC;MACtDD,KAAK;MACLQ,YAAY,EAAE;IAClB,CAAC,CAAC;IAEFX,MAAM,CAACM,MAAM,CAACM,GAAG,CAAC,CAAC;MAAER;IAAG,CAAC,KAAKA,EAAE,CAAC,CAAC,CAACS,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;EAC1D,CAAC,CAAC;AACN,CAAC,CAAC","ignoreList":[]}

package/lib/types/components/search-box/SearchBox.d.ts

@@ -1,5 +1,6 @@
 import { ChangeEventHandler, FC, FocusEventHandler, KeyboardEventHandler } from 'react';
 import type { ISearchBoxItem, ISearchBoxItems } from '../../types/searchBox';
+import { type SearchBoxSortFunction } from '../../utils/searchBox';
 import { type InputProps } from '../input/Input';
 import { TagInputProps } from '../tag-input/TagInput';
 import type { DropdownDirection } from '../../types/dropdown';
@@ -22,6 +23,10 @@ export type SearchBoxProps = {
      * An optional callback function to filter the elements to be displayed
      */
     customFilter?: (item: ISearchBoxItem) => boolean;
+    /**
+     * An optional callback function to sort the filtered elements to be displayed
+     */
+    customSortFunction?: SearchBoxSortFunction;
     /**
      * If true, the custom filter replaces the built-in text search instead of narrowing its results.
      */

package/lib/types/index.d.ts

@@ -88,6 +88,7 @@ export type { IListItemRightElements } from './types/list';
 export type { PopupRef } from './types/popup';
 export type { RadioButtonItem } from './types/radioButton';
 export type { ISearchBoxItem as SearchBoxItem, ISearchBoxItems as SearchBoxItems, } from './types/searchBox';
+export type { SearchBoxSortFunction } from './utils/searchBox';
 export type { SelectButtonItem } from './types/selectButton';
 export type { SliderButtonItem } from './types/slider-button';
 export { type MultiActionButtonAction, type MultiActionButtonActionEvent, type MultiActionButtonActionStatus, MultiActionButtonHeight, type MultiActionButtonProps, type MultiActionButtonSecondaryContextMenu, MultiActionButtonStatusType, } from './components/multi-action-button/MultiActionButton.types';

package/lib/types/utils/searchBox.d.ts

@@ -1,9 +1,11 @@
 import type { ISearchBoxItem } from '../types/searchBox';
 export declare const getCurrentGroupName: (element: HTMLElement) => string;
+export type SearchBoxSortFunction = (a: ISearchBoxItem, b: ISearchBoxItem) => number;
 interface SearchListOptions {
+    customSortFunction?: SearchBoxSortFunction;
     items: ISearchBoxItem[];
     searchString: string;
 }
-export declare const sortSearchBoxItems: ({ searchString, items }: SearchListOptions) => ISearchBoxItem[];
-export declare const searchList: ({ searchString, items }: SearchListOptions) => ISearchBoxItem[];
+export declare const sortSearchBoxItems: ({ customSortFunction, searchString, items, }: SearchListOptions) => ISearchBoxItem[];
+export declare const searchList: ({ customSortFunction, searchString, items }: SearchListOptions) => ISearchBoxItem[];
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chayns-components/core",
-    "version": "5.5.37",
+    "version": "5.5.40",
     "description": "A set of beautiful React components for developing your own applications with chayns.",
     "sideEffects": false,
     "browserslist": [
@@ -93,5 +93,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "d54ff7f9ff20ebb76f33a5539cbb610b107a0cc7"
+    "gitHead": "6dbae57c63a1acb4aad518450bc6bc3d911a1d3e"
 }