@snmt-react-ui/async-select 1.7.1 → 1.7.3

package/dist/AsyncSelect.d.ts

@@ -1,12 +1,16 @@
 import { OptionProps, SingleSelectProps, MultiSelectProps } from '@snmt-react-ui/select';
 
+/**
+ * AsyncSelect is a flexible select component that loads its options asynchronously.
+ * It is suitable for large or remote datasets, supporting both single and multiple selection modes.
+ */
 export type AsyncSelectProps = BaseAsyncSelectProps & (Omit<SingleSelectProps, 'options'> | Omit<MultiSelectProps, 'options'>);
 export type AsyncSelectRef = {
     refetchOptions: () => Promise<void>;
 };
 interface BaseAsyncSelectProps {
     /** Function for load options asynchronously */
-    loadOptions: (pagination: {
+    loadOptions: (params: {
         offset: number;
         limit: number;
         search?: string;
@@ -15,7 +19,15 @@ interface BaseAsyncSelectProps {
         count: number;
         limit: number;
     }>;
+    /**
+     * If true, options are loaded when the dropdown is closed (e.g., in the background).
+     * If false, options are reloaded every time the dropdown
+     * is opened (previous options are reset on each open).
+     */
+    /**@deprecated Use preloadOptions instead*/
     loadOnClosedState?: boolean;
+    /**Use preloadOptions instead. */
+    preloadOptions?: boolean;
 }
 export declare const AsyncSelect: import('react').ForwardRefExoticComponent<AsyncSelectProps & import('react').RefAttributes<AsyncSelectRef>>;
 export {};