@pro6pp/infer-react 0.0.2-beta.1 → 0.0.2-beta.11

package/dist/index.d.cts

@@ -0,0 +1,68 @@
+import React from 'react';
+import { InferConfig, InferState, InferCore, InferResult } from '@pro6pp/infer-core';
+export { AddressValue, CountryCode, Fetcher, InferConfig, InferResult, InferState, Stage } from '@pro6pp/infer-core';
+
+/**
+ * A headless React hook that provides the logic for address search using the Infer API.
+ * @param config The engine configuration (authKey, country, etc.).
+ * @returns An object containing the current state, the core instance, and pre-bound input props.
+ */
+declare function useInfer(config: InferConfig): {
+    /** The current UI state (suggestions, loading status, query, etc.). */
+    state: InferState;
+    /** The raw InferCore instance for manual control. */
+    core: InferCore;
+    /** Pre-configured event handlers to spread onto an <input /> element. */
+    inputProps: {
+        value: string;
+        onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+        onKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
+    };
+    /** Function to manually select a specific suggestion. */
+    selectItem: (item: InferResult | string) => boolean;
+    /** Function to load more results. */
+    loadMore: () => void;
+};
+/**
+ * Props for the Pro6PPInfer component.
+ */
+interface Pro6PPInferProps extends InferConfig {
+    /** Optional CSS class for the wrapper div. */
+    className?: string;
+    /** Optional inline styles for the wrapper div. */
+    style?: React.CSSProperties;
+    /** Attributes to pass directly to the underlying input element. */
+    inputProps?: React.InputHTMLAttributes<HTMLInputElement>;
+    /** * Custom placeholder text.
+     * @default 'Start typing an address...'
+     */
+    placeholder?: string;
+    /** A custom render function for individual suggestion items. */
+    renderItem?: (item: InferResult, isActive: boolean) => React.ReactNode;
+    /** * If true, prevents the default CSS theme from being injected.
+     * @default false
+     */
+    disableDefaultStyles?: boolean;
+    /** * The text to show when no results are found.
+     * @default 'No results found'
+     */
+    noResultsText?: string;
+    /** * The text to show on the load more button.
+     * @default 'Show more results...'
+     */
+    loadMoreText?: string;
+    /** A custom render function for the "no results" state. */
+    renderNoResults?: (state: InferState) => React.ReactNode;
+    /**
+     * If true, shows a clear button when the input is not empty.
+     * @default true
+     */
+    showClearButton?: boolean;
+}
+/**
+ * A styled React component for Pro6PP Infer API.
+ * Includes styling, keyboard navigation, and loading states.
+ */
+declare const Pro6PPInfer: React.ForwardRefExoticComponent<Pro6PPInferProps & React.RefAttributes<HTMLInputElement>>;
+
+export { Pro6PPInfer, type Pro6PPInferProps, useInfer };

package/dist/index.d.ts

@@ -1,24 +1,68 @@
+import React from 'react';
 import { InferConfig, InferState, InferCore, InferResult } from '@pro6pp/infer-core';
+export { AddressValue, CountryCode, Fetcher, InferConfig, InferResult, InferState, Stage } from '@pro6pp/infer-core';
 
 /**
- * Hook for the Pro6PP Infer API.
- * @param config - The API configuration.
- * @returns An object containing the current state, input helpers, and selection handler.
- * @example
- * const { state, inputProps, selectItem } = useInfer({
- *   authKey: 'YOUR_KEY',
- *   country: 'NL'
- * });
+ * A headless React hook that provides the logic for address search using the Infer API.
+ * @param config The engine configuration (authKey, country, etc.).
+ * @returns An object containing the current state, the core instance, and pre-bound input props.
  */
 declare function useInfer(config: InferConfig): {
+    /** The current UI state (suggestions, loading status, query, etc.). */
     state: InferState;
+    /** The raw InferCore instance for manual control. */
     core: InferCore;
+    /** Pre-configured event handlers to spread onto an <input /> element. */
     inputProps: {
         value: string;
         onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
         onKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
     };
-    selectItem: (item: InferResult | string) => void;
+    /** Function to manually select a specific suggestion. */
+    selectItem: (item: InferResult | string) => boolean;
+    /** Function to load more results. */
+    loadMore: () => void;
 };
+/**
+ * Props for the Pro6PPInfer component.
+ */
+interface Pro6PPInferProps extends InferConfig {
+    /** Optional CSS class for the wrapper div. */
+    className?: string;
+    /** Optional inline styles for the wrapper div. */
+    style?: React.CSSProperties;
+    /** Attributes to pass directly to the underlying input element. */
+    inputProps?: React.InputHTMLAttributes<HTMLInputElement>;
+    /** * Custom placeholder text.
+     * @default 'Start typing an address...'
+     */
+    placeholder?: string;
+    /** A custom render function for individual suggestion items. */
+    renderItem?: (item: InferResult, isActive: boolean) => React.ReactNode;
+    /** * If true, prevents the default CSS theme from being injected.
+     * @default false
+     */
+    disableDefaultStyles?: boolean;
+    /** * The text to show when no results are found.
+     * @default 'No results found'
+     */
+    noResultsText?: string;
+    /** * The text to show on the load more button.
+     * @default 'Show more results...'
+     */
+    loadMoreText?: string;
+    /** A custom render function for the "no results" state. */
+    renderNoResults?: (state: InferState) => React.ReactNode;
+    /**
+     * If true, shows a clear button when the input is not empty.
+     * @default true
+     */
+    showClearButton?: boolean;
+}
+/**
+ * A styled React component for Pro6PP Infer API.
+ * Includes styling, keyboard navigation, and loading states.
+ */
+declare const Pro6PPInfer: React.ForwardRefExoticComponent<Pro6PPInferProps & React.RefAttributes<HTMLInputElement>>;
 
-export { useInfer };
+export { Pro6PPInfer, type Pro6PPInferProps, useInfer };