@docsearch/react 4.6.3 → 5.0.0-beta.0

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["DocSearchProvider"],"sources":["../../src/DocSearch.tsx"],"sourcesContent":["import type {\n  AutocompleteOptions,\n  AutocompleteState,\n} from '@algolia/autocomplete-core';\nimport { DocSearch as DocSearchProvider, useDocSearch } from '@docsearch/core';\nimport type { DocSearchModalShortcuts, DocSearchRef } from '@docsearch/core';\nimport type { LiteClient, SearchParamsObject } from 'algoliasearch/lite';\nimport React, { type JSX } from 'react';\nimport { createPortal } from 'react-dom';\n\nimport { DocSearchButton } from './DocSearchButton';\nimport type { ButtonTranslations } from './DocSearchButton';\nimport { DocSearchModal } from './DocSearchModal';\nimport type { ModalTranslations } from './DocSearchModal';\nimport type {\n  DocSearchHit,\n  DocSearchTheme,\n  InternalDocSearchHit,\n  StoredDocSearchHit,\n} from './types';\n\nexport type { DocSearchRef } from '@docsearch/core';\n\nexport type DocSearchTranslations = Partial<{\n  button: ButtonTranslations;\n  modal: ModalTranslations;\n}>;\n\n// The interface that describes the minimal implementation required for the algoliasearch client, when using the [`transformSearchClient`](https://docsearch.algolia.com/docs/api/#transformsearchclient) option.\nexport type DocSearchTransformClient = {\n  search: LiteClient['search'];\n  addAlgoliaAgent: LiteClient['addAlgoliaAgent'];\n  transporter: Pick<LiteClient['transporter'], 'algoliaAgent'>;\n};\n\nexport interface DocSearchIndex {\n  name: string;\n  searchParameters?: SearchParamsObject;\n}\n\nexport interface DocSearchFacet {\n  key: string;\n  label?: string;\n}\n\nexport interface DocSearchProps {\n  /** Algolia application id used by the search client. */\n  appId: string;\n  /** Public api key with search permissions for the index. */\n  apiKey: string;\n  /**\n   * Name of the algolia index to query.\n   *\n   * @deprecated `indexName` will be removed in a future version. Please use\n   *   `indices` property going forward.\n   */\n  indexName?: string;\n  /**\n   * List of indices and _optional_ searchParameters to be used for search.\n   *\n   * @see {@link https://docsearch.algolia.com/docs/api#indices}\n   */\n  indices?: Array<DocSearchIndex | string>;\n  /**\n   * Facets to display as keyword-search filter controls. Values are read\n   * dynamically from the configured Algolia indices.\n   *\n   * @default [ ]\n   */\n  facets?: DocSearchFacet[];\n  /** Theme overrides applied to the modal and related components. */\n  theme?: DocSearchTheme;\n  /** Placeholder text for the search input. */\n  placeholder?: string;\n  /**\n   * Additional algolia search parameters to merge into each query.\n   *\n   * @deprecated `searchParameters` will be removed in a future version. Please\n   *   use `indices` property going forward.\n   */\n  searchParameters?: SearchParamsObject;\n  /** Maximum number of hits to display per source/group. */\n  maxResultsPerGroup?: number;\n  /** Hook to post-process hits before rendering. */\n  transformItems?: (items: DocSearchHit[]) => DocSearchHit[];\n  /**\n   * Custom component to render an individual hit. Supports template patterns:\n   *\n   * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`\n   * - JSX templates: (props) => <div>...</div>\n   * - Function-based templates: (props) => string | JSX.Element | Function.\n   */\n  hitComponent?: (\n    props: {\n      hit: InternalDocSearchHit | StoredDocSearchHit;\n      children: React.ReactNode;\n    },\n    helpers?: {\n      html: (template: TemplateStringsArray, ...values: any[]) => any;\n    }\n  ) => JSX.Element;\n  /**\n   * Custom component rendered at the bottom of the results panel. Supports\n   * template patterns:\n   *\n   * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`\n   * - JSX templates: (props) => <div>...</div>\n   * - Function-based templates: (props) => string | JSX.Element | Function.\n   */\n  resultsFooterComponent?: (\n    props: {\n      state: AutocompleteState<InternalDocSearchHit>;\n    },\n    helpers?: {\n      html: (template: TemplateStringsArray, ...values: any[]) => any;\n    }\n  ) => JSX.Element | null;\n  /** Hook to wrap or modify the algolia search client. */\n  transformSearchClient?: (\n    searchClient: DocSearchTransformClient\n  ) => DocSearchTransformClient;\n  /** Disable storage and usage of recent and favorite searches. */\n  disableUserPersonalization?: boolean;\n  /** Query string to prefill when opening the modal. */\n  initialQuery?: string;\n  /** Custom navigator for controlling link navigation. */\n  navigator?: AutocompleteOptions<InternalDocSearchHit>['navigator'];\n  /** Localized strings for the button and modal ui. */\n  translations?: DocSearchTranslations;\n  /** Builds a url to report missing results for a given query. */\n  getMissingResultsUrl?: ({ query }: { query: string }) => string;\n  /** Insights client integration options to send analytics events. */\n  insights?: AutocompleteOptions<InternalDocSearchHit>['insights'];\n  /**\n   * The container element where the modal should be portaled to. Defaults to\n   * document.body.\n   */\n  portalContainer?: DocumentFragment | Element;\n  /**\n   * Limit of how many recent searches should be saved/displayed..\n   *\n   * @default 7\n   */\n  recentSearchesLimit?: number;\n  /**\n   * Limit of how many recent searches should be saved/displayed when there are\n   * favorited searches..\n   *\n   * @default 4\n   */\n  recentSearchesWithFavoritesLimit?: number;\n  /**\n   * Configuration for keyboard shortcuts. Allows enabling/disabling specific\n   * shortcuts.\n   *\n   * @default `{ 'Ctrl/Cmd+K': true, '/': true }`\n   */\n  keyboardShortcuts?: DocSearchModalShortcuts;\n  /**\n   * The key used to render a custom badge for each hit. Key must match a\n   * property returned in `searchParameters.attributesToRetrieve`.\n   *\n   * @example\n   *   'version';\n   *   'hierarchy.lvl1';\n   *   'tags[2]';\n   *\n   * @default undefined\n   */\n  resultBadgeKey?: string;\n}\n\nfunction DocSearchComponent(\n  props: DocSearchProps,\n  ref: React.ForwardedRef<DocSearchRef>\n): JSX.Element {\n  return (\n    <DocSearchProvider {...props} ref={ref}>\n      <DocSearchInner {...props} />\n    </DocSearchProvider>\n  );\n}\n\nexport const DocSearch = React.forwardRef(DocSearchComponent);\n\nexport function DocSearchInner(props: DocSearchProps): JSX.Element {\n  const {\n    searchButtonRef,\n    keyboardShortcuts,\n    isModalActive,\n    initialQuery,\n    openModal,\n    closeModal,\n  } = useDocSearch();\n\n  return (\n    <>\n      <DocSearchButton\n        keyboardShortcuts={keyboardShortcuts}\n        ref={searchButtonRef}\n        translations={props.translations?.button}\n        onClick={openModal}\n      />\n      {isModalActive &&\n        createPortal(\n          <DocSearchModal\n            {...props}\n            initialScrollY={window.scrollY}\n            initialQuery={initialQuery}\n            translations={props?.translations?.modal}\n            onClose={closeModal}\n          />,\n          props.portalContainer ?? document.body\n        )}\n    </>\n  );\n}\n"],"mappings":";;;;;;;;;;;;AA4KA,SAAS,mBACP,OACA,KACa;CACb,OACE,oCAACA,+CAAsB,cAAY,KAEhB,GADjB,oCAAC,gBAAmB,KAAQ,CACX;AAEvB;AAEA,MAAa,YAAY,MAAM,WAAW,kBAAkB;AAE5D,SAAgB,eAAe,OAAoC;;CACjE,MAAM,EACJ,iBACA,mBACA,eACA,cACA,WACA,eACE,aAAa;CAEjB,OACE,0DACE,oCAAC,iBAAD;EACqB;EACnB,KAAK;EACL,qCAAc,MAAM,wFAAc;EAClC,SAAS;CACV,IACA,iBACC,aACE,oCAAC,kDACK;EACJ,gBAAgB,OAAO;EACT;EACd,4EAAc,MAAO,0FAAc;EACnC,SAAS;EACV,6BACD,MAAM,wFAAmB,SAAS,IACpC,CACF;AAEN"}

package/dist/esm/keyboard-BkSdCzTU.js

@@ -0,0 +1,9 @@
+//#region src/utils/keyboard.ts
+const ACTION_KEY_DEFAULT = "Ctrl";
+function isAppleDevice() {
+	return /(Mac|iPhone|iPod|iPad)/i.test(navigator.platform);
+}
+
+//#endregion
+export { isAppleDevice as n, ACTION_KEY_DEFAULT as t };
+//# sourceMappingURL=keyboard-BkSdCzTU.js.map

package/dist/esm/keyboard-BkSdCzTU.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard-BkSdCzTU.js","names":[],"sources":["../../src/utils/keyboard.ts"],"sourcesContent":["export const ACTION_KEY_DEFAULT = 'Ctrl';\nexport const ACTION_KEY_APPLE = '⌘';\n\nexport function isAppleDevice(): boolean {\n  return /(Mac|iPhone|iPod|iPad)/i.test(navigator.platform);\n}\n"],"mappings":";AAAA,MAAa,qBAAqB;AAGlC,SAAgB,gBAAyB;CACvC,OAAO,0BAA0B,KAAK,UAAU,QAAQ;AAC1D"}

package/dist/esm/keyboardShortcuts-C-lx6Xt7.js

@@ -0,0 +1,25 @@
+import { t as _objectSpread2 } from "./objectSpread2-BNmiQYyW.js";
+
+//#region src/constants/keyboardShortcuts.ts
+/**
+* Default keyboard shortcuts configuration for DocSearch. These values are used
+* when no keyboardShortcuts prop is provided or when specific shortcuts are not
+* configured.
+*/
+const DEFAULT_KEYBOARD_SHORTCUTS = {
+	"Ctrl/Cmd+K": true,
+	"/": true
+};
+/**
+* Merges user-provided keyboard shortcuts with defaults.
+*
+* @param userShortcuts - Optional user configuration.
+* @returns Complete keyboard shortcuts configuration with defaults applied.
+*/
+function getKeyboardShortcuts(userShortcuts) {
+	return _objectSpread2(_objectSpread2({}, DEFAULT_KEYBOARD_SHORTCUTS), userShortcuts);
+}
+
+//#endregion
+export { getKeyboardShortcuts as t };
+//# sourceMappingURL=keyboardShortcuts-C-lx6Xt7.js.map

package/dist/esm/keyboardShortcuts-C-lx6Xt7.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboardShortcuts-C-lx6Xt7.js","names":[],"sources":["../../src/constants/keyboardShortcuts.ts"],"sourcesContent":["import type { KeyboardShortcuts } from '../types';\n\n/**\n * Default keyboard shortcuts configuration for DocSearch. These values are used\n * when no keyboardShortcuts prop is provided or when specific shortcuts are not\n * configured.\n */\nexport const DEFAULT_KEYBOARD_SHORTCUTS: Required<KeyboardShortcuts> = {\n  'Ctrl/Cmd+K': true,\n  '/': true,\n} as const;\n\n/**\n * Merges user-provided keyboard shortcuts with defaults.\n *\n * @param userShortcuts - Optional user configuration.\n * @returns Complete keyboard shortcuts configuration with defaults applied.\n */\nexport function getKeyboardShortcuts(\n  userShortcuts?: KeyboardShortcuts\n): Required<KeyboardShortcuts> {\n  return {\n    ...DEFAULT_KEYBOARD_SHORTCUTS,\n    ...userShortcuts,\n  };\n}\n"],"mappings":";;;;;;;;AAOA,MAAa,6BAA0D;CACrE,cAAc;CACd,KAAK;AACP;;;;;;;AAQA,SAAgB,qBACd,eAC6B;CAC7B,yCACK,6BACA,aACL;AACF"}

package/dist/esm/modal.d.ts

@@ -0,0 +1,2 @@
+import { d as ModalTranslations, l as DocSearchModal, u as DocSearchModalProps } from "./DocSearch-Dq5Utfyb.js";
+export { DocSearchModal, DocSearchModalProps, ModalTranslations };

package/dist/esm/modal.js

@@ -0,0 +1,3 @@
+import { t as DocSearchModal } from "./DocSearchModal-CpvDjo1O.js";
+
+export { DocSearchModal };