@ahoo-wang/fetcher-viewer 3.12.1 → 3.12.2

package/dist/components/RemoteSelect.d.ts

@@ -3,13 +3,67 @@ import { UseDebouncedCallbackOptions } from '@ahoo-wang/fetcher-react';
 import { StyleCapable } from '../types';
 import { RefAttributes } from 'react';
 import { BaseOptionType, DefaultOptionType } from 'antd/lib/select';
+/**
+ * Props for the RemoteSelect component.
+ *
+ * @template ValueType - The type of the value(s) selected in the Select
+ * @template OptionType - The type of option objects, defaults to antd's DefaultOptionType
+ */
 export interface RemoteSelectProps<ValueType = any, OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType> extends Omit<SelectProps<ValueType, OptionType>, 'loading' | 'onSearch'>, RefAttributes<RefSelectProps>, StyleCapable {
+    /** Debounce options for controlling the search delay */
     debounce?: UseDebouncedCallbackOptions;
+    /**
+     * Callback function to fetch options from remote API.
+     * Called with the current search string when user types.
+     *
+     * @param search - The current search input value
+     * @returns Promise resolving to array of options
+     * @throws Error when the remote API request fails
+     */
     search: (search: string) => Promise<OptionType[]>;
+    /** Initial options displayed before any search is performed */
+    options?: OptionType[];
+    /** Custom key field for deduplication, defaults to 'value' */
+    uniqueKey?: string;
+    /**
+     * Additional options that are always appended to the options list.
+     * These appear after the remote search results or initial options.
+     */
+    additionalOptions?: OptionType[];
 }
 /**
- * A Select component that loads options from a remote API.
- * Supports automatic fetching, loading states, and error handling.
+ * A Select component with built-in remote search functionality.
+ * Supports debounced search, loading states, and combining remote results with static options.
+ *
+ * @example
+ * ```tsx
+ * import { RemoteSelect } from '@ahoo-wang/fetcher-viewer';
+ *
+ * // Basic usage with remote search
+ * const UserSelect = () => (
+ *   <RemoteSelect
+ *     search={async (keyword) => {
+ *       const response = await fetch(`/api/users?q=${keyword}`);
+ *       return response.json();
+ *     }}
+ *     placeholder="Search users..."
+ *   />
+ * );
+ *
+ * // With initial options and additional options
+ * const StatusSelect = () => (
+ *   <RemoteSelect
+ *     search={async (keyword) => fetchOptions(keyword)}
+ *     options={[{ label: 'Pending', value: 'pending' }]}
+ *     additionalOptions={[{ label: 'Unknown', value: 'unknown' }]}
+ *   />
+ * );
+ * ```
+ *
+ * @template ValueType - The type of value(s) selected
+ * @template OptionType - The option object type
+ * @param props - Component props extending antd SelectProps
+ * @returns A Select component with remote search capability
  */
 export declare function RemoteSelect<ValueType = any, OptionType extends BaseOptionType | DefaultOptionType = DefaultOptionType>(props: RemoteSelectProps<ValueType, OptionType>): import("react/jsx-runtime").JSX.Element;
 export declare namespace RemoteSelect {

package/dist/components/RemoteSelect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RemoteSelect.d.ts","sourceRoot":"","sources":["../../src/components/RemoteSelect.tsx"],"names":[],"mappings":"AAaA,OAAO,EAAU,WAAW,EAAE,cAAc,EAAqB,MAAM,MAAM,CAAC;AAC9E,OAAO,EACL,2BAA2B,EAE5B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpE,MAAM,WAAW,iBAAiB,CAChC,SAAS,GAAG,GAAG,EACf,UAAU,SAAS,cAAc,GAAG,iBAAiB,GAAG,iBAAiB,CAEzE,SACE,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC,EAChE,aAAa,CAAC,cAAc,CAAC,EAC7B,YAAY;IACd,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IACvC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;CACnD;AAQD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,SAAS,GAAG,GAAG,EACf,UAAU,SAAS,cAAc,GAAG,iBAAiB,GAAG,iBAAiB,EACzE,KAAK,EAAE,iBAAiB,CAAC,SAAS,EAAE,UAAU,CAAC,2CA8ChD;yBAjDe,YAAY"}
+{"version":3,"file":"RemoteSelect.d.ts","sourceRoot":"","sources":["../../src/components/RemoteSelect.tsx"],"names":[],"mappings":"AAaA,OAAO,EAAU,WAAW,EAAE,cAAc,EAAqB,MAAM,MAAM,CAAC;AAC9E,OAAO,EACL,2BAA2B,EAE5B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,aAAa,EAAW,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB,CAChC,SAAS,GAAG,GAAG,EACf,UAAU,SAAS,cAAc,GAAG,iBAAiB,GAAG,iBAAiB,CAEzE,SAAQ,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC,EACtE,aAAa,CAAC,cAAc,CAAC,EAC7B,YAAY;IACd,wDAAwD;IACxD,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IACvC;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAClD,+DAA+D;IAC/D,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC;CAClC;AA2BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,YAAY,CAC1B,SAAS,GAAG,GAAG,EACf,UAAU,SAAS,cAAc,GAAG,iBAAiB,GAAG,iBAAiB,EACzE,KAAK,EAAE,iBAAiB,CAAC,SAAS,EAAE,UAAU,CAAC,2CAoDhD;yBAvDe,YAAY"}