@searchcraft/react-sdk 0.15.0 → 0.16.0

package/dist/client/index.d.ts

@@ -46,36 +46,21 @@ export declare interface SearchcraftFilterPanelProps extends Components.Searchcr
  *
  * @example
  * ```tsx
- * import React from 'react';
  * import { SearchcraftInputForm } from '@searchcraft/react-sdk';
- * import searchcraftConfig from './searchcraftConfig';
- *
- * const MySearchComponent = () => {
- *   const handleQuerySubmit = (event: CustomEvent<string>) => {
- *     console.log("Query submitted", event.detail);
- *   };
  *
- *   return (
- *     <SearchcraftInputForm
- *       config={searchcraftConfig}
- *       autoSearch={true}
- *       buttonPlacement="right"
- *       buttonLabel="Search"
- *       inputLabel="Search Database"
- *       customStyles={{ border: "1px solid gray", padding: "5px" }}
- *       placeholderValue="Search here..."
- *       searchTerm=""
- *       onQuerySubmit={handleQuerySubmit}
- *       onInputCleared={() => console.log("Input cleared")}
- *       onNoResultsReceived={() => console.log("No results found")}
- *       onInputFocus={() => console.log("Input focused")}
- *       onInputBlur={() => console.log("Input blurred")}
- *       onInputInit={() => console.log("Input initialized")}
- *     />
- *   );
- * };
- *
- * export default MySearchComponent;
+ * const MySearchInput = () => (
+ *   <SearchcraftInputForm
+ *     autoSearch={true}
+ *     buttonPlacement="right"
+ *     buttonLabel="Search"
+ *     inputLabel="Search articles"
+ *     placeholderValue="Search here..."
+ *     onInputFocus={() => console.log('Input focused')}
+ *     onInputBlur={() => console.log('Input blurred')}
+ *   />
+ * );
+ *
+ * export default MySearchInput;
  * ```
  */
 export declare const SearchcraftInputForm: FC<SearchcraftInputFormProps>;
@@ -148,13 +133,11 @@ export declare interface SearchcraftPopoverButtonProps extends Components.Search
  * ```tsx
  * import React from 'react';
  * import { SearchcraftPopoverForm } from '@searchcraft/react-sdk';
- * import searchcraftConfig from './searchcraftConfig';
  * import popoverResultMappings from './popoverResultMappings';
  *
  * const MyPopoverSearch = () => {
  *   return (
  *     <SearchcraftPopoverForm
- *       config={searchcraftConfig}
  *       type="fullscreen"
  *       popoverResultMappings={popoverResultMappings}
  *       hotkey="k"
@@ -179,19 +162,15 @@ export declare interface SearchcraftPopoverFormProps extends Components.Searchcr
  *
  * @example
  * ```tsx
- * import React, { useEffect, useRef } from 'react';
  * import { SearchcraftResultsInfo } from '@searchcraft/react-sdk';
  *
- * const MyResultsInfo = () => {
- *   const ref = useRef();
- *
- *   useEffect(() => {
- *     ref.current.customFormatter = (range, count, responseTime) =>
- *       `${range[0]}-${range[1]} of ${count} results in ${responseTime}ms`;
- *   });
- *
- *   return <SearchcraftResultsInfo ref={ref} />;
- * };
+ * const MyResultsInfo = () => (
+ *   <SearchcraftResultsInfo
+ *     template={({ range, count, responseTime }, { html }) => html`
+ *       ${range[0]}-${range[1]} of ${count} results in ${responseTime}ms
+ *     `}
+ *   />
+ * );
  *
  * export default MyResultsInfo;
  * ```
@@ -231,26 +210,19 @@ export declare interface SearchcraftResultsSummaryProps extends Components.Searc
  *
  * @example
  * ```tsx
- * import React from 'react';
  * import { SearchcraftSearchResults } from '@searchcraft/react-sdk';
- * import searchResultMappings from './searchResultMappings';
- *
- * const MySearchComponent = () => {
- *   return (
- *     <SearchcraftSearchResults
- *       searchResultMappings={searchResultMappings}
- *       resultImagePlacement="left"
- *       buttonLabel="View More"
- *       buttonTarget="_blank"
- *       buttonRel="noopener"
- *       containerTarget="_self"
- *       containerRel="nofollow"
- *       onNoResults={() => console.log("No search results found")}
- *     />
- *   );
- * };
  *
- * export default MySearchComponent;
+ * const MySearchResults = () => (
+ *   <SearchcraftSearchResults
+ *     template={(item, index, { html, safeUrl }) => html`
+ *       <a href="${safeUrl(item.url)}">
+ *         <h2>${item.title}</h2>
+ *       </a>
+ *     `}
+ *   />
+ * );
+ *
+ * export default MySearchResults;
  * ```
  */
 export declare const SearchcraftSearchResults: FC<SearchcraftSearchResultsProps>;