@chayns-components/core 5.2.5 → 5.2.8

package/lib/types/types/filter.d.ts

@@ -1,28 +1,79 @@
 import { FilterButtonsProps } from '../components/filter-buttons/FilterButtons';
 import { CheckboxProps } from '../components/checkbox/Checkbox';
 import { ComboBoxProps } from '../components/combobox/ComboBox.types';
+/**
+ * Search configuration for the `Filter` component.
+ */
 export interface SearchConfig {
+    /**
+     * Callback invoked whenever the search input changes.
+     */
     onSearchChange: (search: string) => void;
+    /**
+     * Current search value.
+     */
     searchValue: string;
 }
+/**
+ * Item configuration used by the sort dropdown.
+ */
 export interface SortItem {
+    /**
+     * Display text of the item.
+     */
     text: string;
+    /**
+     * Stable value or identifier of the item.
+     */
     id: string | number;
 }
+/**
+ * Sort configuration for the `Filter` component.
+ */
 export interface SortConfig {
+    /**
+     * Callback invoked when a sort item is selected.
+     */
     onSortChange: (item: SortItem) => void;
+    /**
+     * Currently selected sort item.
+     */
     selectedItem: SortItem;
+    /**
+     * Available sort items.
+     */
     items: SortItem[];
 }
+/**
+ * Checkbox configuration for the `Filter` component.
+ */
 export type CheckboxConfig = CheckboxProps;
+/**
+ * Filter button group configuration for the `Filter` component.
+ */
 export type FilterButtonConfig = FilterButtonsProps;
+/**
+ * Combobox configuration used by `FilterContent`.
+ */
 export type ComboboxConfig = ComboBoxProps & {
     label: string;
 };
+/**
+ * Ref interface for the `Filter` component.
+ */
 export type FilterRef = {
+    /**
+     * Hides the filter popup.
+     */
     hide: VoidFunction;
+    /**
+     * Shows the filter popup.
+     */
     show: VoidFunction;
 };
+/**
+ * Different layout modes supported by the `Filter` component.
+ */
 export declare enum FilterType {
     ONLY_SEARCH = 0,
     ONLY_FILTER = 1,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chayns-components/core",
-    "version": "5.2.5",
+    "version": "5.2.8",
     "description": "A set of beautiful React components for developing your own applications with chayns.",
     "sideEffects": false,
     "browserslist": [
@@ -88,5 +88,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "0b2c4471ad3dfb85b9881578c30b09bb9e9d782e"
+    "gitHead": "e5e85b31aac323874390c57012e5241c802670eb"
 }