@docsearch/react 3.0.0-alpha.42 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +3 -3
  2. package/dist/esm/AlgoliaLogo.d.ts +0 -1
  3. package/dist/esm/AlgoliaLogo.js +4 -2
  4. package/dist/esm/DocSearch.d.ts +4 -1
  5. package/dist/esm/DocSearch.js +1 -1
  6. package/dist/esm/DocSearchButton.js +2 -2
  7. package/dist/esm/DocSearchModal.d.ts +1 -2
  8. package/dist/esm/DocSearchModal.js +7 -6
  9. package/dist/esm/ErrorScreen.d.ts +0 -1
  10. package/dist/esm/Footer.d.ts +4 -1
  11. package/dist/esm/Footer.js +27 -9
  12. package/dist/esm/NoResultsScreen.d.ts +2 -3
  13. package/dist/esm/NoResultsScreen.js +11 -9
  14. package/dist/esm/Results.js +1 -1
  15. package/dist/esm/ResultsScreen.d.ts +0 -1
  16. package/dist/esm/ScreenState.d.ts +1 -0
  17. package/dist/esm/Snippet.js +2 -2
  18. package/dist/esm/StartScreen.d.ts +0 -1
  19. package/dist/esm/__tests__/api.test.js +353 -86
  20. package/dist/esm/icons/ControlKeyIcon.d.ts +0 -1
  21. package/dist/esm/icons/ErrorIcon.d.ts +0 -1
  22. package/dist/esm/icons/GoToExternalIcon.d.ts +0 -1
  23. package/dist/esm/icons/LoadingIcon.d.ts +0 -1
  24. package/dist/esm/icons/NoResultsIcon.d.ts +0 -1
  25. package/dist/esm/icons/RecentIcon.d.ts +0 -1
  26. package/dist/esm/icons/ResetIcon.d.ts +0 -1
  27. package/dist/esm/icons/SearchIcon.d.ts +0 -1
  28. package/dist/esm/icons/SelectIcon.d.ts +0 -1
  29. package/dist/esm/icons/SourceIcon.d.ts +0 -1
  30. package/dist/esm/icons/StarIcon.d.ts +0 -1
  31. package/dist/esm/version.d.ts +1 -1
  32. package/dist/esm/version.js +1 -1
  33. package/dist/umd/index.js +2 -2
  34. package/dist/umd/index.js.map +1 -1
  35. package/package.json +6 -8
package/README.md CHANGED
@@ -5,15 +5,15 @@ React package for [DocSearch](http://docsearch.algolia.com/), the best search ex
5
5
  ## Installation
6
6
 
7
7
  ```bash
8
- yarn add @docsearch/react@alpha
8
+ yarn add @docsearch/react@3
9
9
  # or
10
- npm install @docsearch/react@alpha
10
+ npm install @docsearch/react@3
11
11
  ```
12
12
 
13
13
  If you don’t want to use a package manager, you can use a standalone endpoint:
14
14
 
15
15
  ```html
16
- <script src="https://cdn.jsdelivr.net/npm/@docsearch/react@alpha"></script>
16
+ <script src="https://cdn.jsdelivr.net/npm/@docsearch/react@3"></script>
17
17
  ```
18
18
 
19
19
  ## Get started
package/dist/esm/AlgoliaLogo.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  declare type AlgoliaLogoTranslations = Partial<{
3
2
  searchByText: string;
4
3
  }>;
package/dist/esm/AlgoliaLogo.js CHANGED
@@ -5,14 +5,16 @@ export function AlgoliaLogo(_ref) {
5
5
  var _translations$searchB = translations.searchByText,
6
6
  searchByText = _translations$searchB === void 0 ? 'Search by' : _translations$searchB;
7
7
  return /*#__PURE__*/React.createElement("a", {
8
- href: "https://www.algolia.com/docsearch",
8
+ href: "https://www.algolia.com/ref/docsearch/?utm_source=".concat(window.location.hostname, "&utm_medium=referral&utm_content=powered_by&utm_campaign=docsearch"),
9
9
  target: "_blank",
10
10
  rel: "noopener noreferrer"
11
11
  }, /*#__PURE__*/React.createElement("span", {
12
12
  className: "DocSearch-Label"
13
13
  }, searchByText), /*#__PURE__*/React.createElement("svg", {
14
14
  width: "77",
15
- height: "19"
15
+ height: "19",
16
+ "aria-label": "Algolia",
17
+ role: "img"
16
18
  }, /*#__PURE__*/React.createElement("path", {
17
19
  d: "M2.5067 0h14.0245c1.384.001 2.5058 1.1205 2.5068 2.5017V16.5c-.0014 1.3808-1.1232 2.4995-2.5068 2.5H2.5067C1.1232 18.9995.0014 17.8808 0 16.5V2.4958A2.495 2.495 0 01.735.7294 2.505 2.505 0 012.5068 0zM37.95 15.0695c-3.7068.0168-3.7068-2.986-3.7068-3.4634L34.2372.3576 36.498 0v11.1794c0 .2715 0 1.9889 1.452 1.994v1.8961zm-9.1666-1.8388c.694 0 1.2086-.0397 1.5678-.1088v-2.2934a5.3639 5.3639 0 00-1.3303-.1679 4.8283 4.8283 0 00-.758.0582 2.2845 2.2845 0 00-.688.2024c-.2029.0979-.371.2362-.4919.4142-.1268.1788-.185.2826-.185.5533 0 .5297.185.8359.5205 1.0375.3355.2016.7928.3053 1.365.3053v-.0008zm-.1969-8.1817c.7463 0 1.3768.092 1.8856.2767.5088.1838.9195.4428 1.2204.7717.3068.334.5147.7777.6423 1.251.1327.4723.196.991.196 1.5603v5.798c-.5235.1036-1.05.192-1.5787.2649-.7048.1037-1.4976.156-2.3774.156-.5832 0-1.1215-.0582-1.6016-.167a3.385 3.385 0 01-1.2432-.5364 2.6034 2.6034 0 01-.8037-.9565c-.191-.3922-.29-.9447-.29-1.5208 0-.5533.11-.905.3246-1.2863a2.7351 2.7351 0 01.8849-.9329c.376-.242.8029-.415 1.2948-.5187a7.4517 7.4517 0 011.5381-.156 7.1162 7.1162 0 011.6667.2024V8.886c0-.259-.0296-.5061-.093-.7372a1.5847 1.5847 0 00-.3245-.6158 1.5079 1.5079 0 00-.6119-.4158 2.6788 2.6788 0 00-.966-.173c-.5206 0-.9948.0634-1.4283.1384a6.5481 6.5481 0 00-1.065.259l-.2712-1.849c.2831-.0986.7048-.1964 1.2491-.2943a9.2979 9.2979 0 011.752-.1501v.0008zm44.6597 8.1193c.6947 0 1.2086-.0405 1.567-.1097v-2.2942a5.3743 5.3743 0 00-1.3303-.1679c-.2485 0-.503.0177-.7573.0582a2.2853 2.2853 0 00-.688.2024 1.2333 1.2333 0 00-.4918.4142c-.1268.1788-.1843.2826-.1843.5533 0 .5297.1843.8359.5198 1.0375.3414.2066.7927.3053 1.365.3053v.0009zm-.191-8.1767c.7463 0 1.3768.0912 1.8856.2759.5087.1847.9195.4436 1.2204.7717.3.329.5147.7786.6414 1.251a5.7248 5.7248 0 01.197 1.562v5.7972c-.3466.0742-.874.1602-1.5788.2648-.7049.1038-1.4976.1552-2.3774.1552-.5832 0-1.1215-.0573-1.6016-.167a3.385 3.385 0 01-1.2432-.5356 2.6034 2.6034 0 01-.8038-.9565c-.191-.3922-.2898-.9447-.2898-1.5216 0-.5533.1098-.905.3245-1.2854a2.7373 2.7373 0 01.8849-.9338c.376-.2412.8029-.4141 1.2947-.5178a7.4545 7.4545 0 012.325-.1097c.2781.0287.5672.081.879.156v-.3686a2.7781 2.7781 0 00-.092-.738 1.5788 1.5788 0 00-.3246-.6166 1.5079 1.5079 0 00-.612-.415 2.6797 2.6797 0 00-.966-.1729c-.5205 0-.9947.0633-1.4282.1384a6.5608 6.5608 0 00-1.065.259l-.2712-1.8498c.283-.0979.7048-.1957 1.2491-.2935a9.8597 9.8597 0 011.752-.1494zm-6.79-1.072c-.7576.001-1.373-.6103-1.3759-1.3664 0-.755.6128-1.3664 1.376-1.3664.764 0 1.3775.6115 1.3775 1.3664s-.6195 1.3664-1.3776 1.3664zm1.1393 11.1507h-2.2726V5.3409l2.2734-.3568v10.0845l-.0008.0017zm-3.984 0c-3.707.0168-3.707-2.986-3.707-3.4642L59.7069.3576 61.9685 0v11.1794c0 .2715 0 1.9889 1.452 1.994V15.0703zm-7.3512-4.979c0-.975-.2138-1.7873-.6305-2.3516-.4167-.571-.9998-.852-1.747-.852-.7454 0-1.3302.281-1.7452.852-.4166.5702-.6195 1.3765-.6195 2.3516 0 .9851.208 1.6473.6254 2.2183.4158.576.9998.8587 1.7461.8587.7454 0 1.3303-.2885 1.747-.8595.4158-.5761.6237-1.2315.6237-2.2184v.0009zm2.3132-.006c0 .7609-.1099 1.3361-.3356 1.9654a4.654 4.654 0 01-.9533 1.6076A4.214 4.214 0 0155.613 14.69c-.579.2412-1.4697.3795-1.9143.3795-.4462-.005-1.3303-.1324-1.9033-.3795a4.307 4.307 0 01-1.474-1.0316c-.4115-.4445-.7293-.9801-.9609-1.6076a5.3423 5.3423 0 01-.3465-1.9653c0-.7608.104-1.493.3356-2.1155a4.683 4.683 0 01.9719-1.5958 4.3383 4.3383 0 011.479-1.0257c.5739-.242 1.2043-.3567 1.8864-.3567.6829 0 1.3125.1197 1.8906.3567a4.1245 4.1245 0 011.4816 1.0257 4.7587 4.7587 0 01.9592 1.5958c.2426.6225.3643 1.3547.3643 2.1155zm-17.0198 0c0 .9448.208 1.9932.6238 2.431.4166.4386.955.6579 1.6142.6579.3584 0 .6998-.0523 1.0176-.1502.3186-.0978.5721-.2134.775-.3517V7.0784a8.8706 8.8706 0 00-1.4926-.1906c-.8206-.0236-1.4452.312-1.8847.8468-.4335.5365-.6533 1.476-.6533 2.3516v-.0008zm6.2863 4.4485c0 1.5385-.3938 2.662-1.1866 3.3773-.791.7136-2.0005 1.0712-3.6308 1.0712-.5958 0-1.834-.1156-2.8228-.334l.3643-1.7865c.8282.173 1.9202.2193 2.4932.2193.9077 0 1.555-.1847 1.943-.5533.388-.3686.578-.916.578-1.643v-.3687a6.8289 6.8289 0 01-.8848.3349c-.3634.1096-.786.167-1.261.167-.6246 0-1.1917-.0979-1.7055-.2944a3.5554 3.5554 0 01-1.3244-.8645c-.3642-.3796-.6541-.8579-.8561-1.4289-.2028-.571-.3068-1.59-.3068-2.339 0-.7034.1099-1.5856.3245-2.1735.2198-.5871.5316-1.0949.9542-1.515.4167-.42.9255-.743 1.5213-.98a5.5923 5.5923 0 012.052-.3855c.7353 0 1.4114.092 2.0707.2024.6592.1088 1.2204.2236 1.6776.35v8.945-.0008zM11.5026 4.2418v-.6511c-.0005-.4553-.3704-.8241-.8266-.8241H8.749c-.4561 0-.826.3688-.8265.824v.669c0 .0742.0693.1264.1445.1096a6.0346 6.0346 0 011.6768-.2362 6.125 6.125 0 011.6202.2185.1116.1116 0 00.1386-.1097zm-5.2806.852l-.3296-.3282a.8266.8266 0 00-1.168 0l-.393.3922a.8199.8199 0 000 1.164l.3237.323c.0524.0515.1268.0397.1733-.0117.191-.259.3989-.507.6305-.7372.2374-.2362.48-.4437.7462-.6335.0575-.0354.0634-.1155.017-.1687zm3.5159 2.069v2.818c0 .081.0879.1392.1622.0987l2.5102-1.2964c.0574-.0287.0752-.0987.0464-.1552a3.1237 3.1237 0 00-2.603-1.574c-.0575 0-.115.0456-.115.1097l-.0008-.0009zm.0008 6.789c-2.0933.0005-3.7915-1.6912-3.7947-3.7804C5.9468 8.0821 7.6452 6.39 9.7387 6.391c2.0932-.0005 3.7911 1.6914 3.794 3.7804a3.7783 3.7783 0 01-1.1124 2.675 3.7936 3.7936 0 01-2.6824 1.1054h.0008zM9.738 4.8002c-1.9218 0-3.6975 1.0232-4.6584 2.6841a5.359 5.359 0 000 5.3683c.9609 1.661 2.7366 2.6841 4.6584 2.6841a5.3891 5.3891 0 003.8073-1.5725 5.3675 5.3675 0 001.578-3.7987 5.3574 5.3574 0 00-1.5771-3.797A5.379 5.379 0 009.7387 4.801l-.0008-.0008z",
18
20
  fill: "currentColor",
package/dist/esm/DocSearch.d.ts CHANGED
@@ -9,7 +9,7 @@ export declare type DocSearchTranslations = Partial<{
9
9
  modal: ModalTranslations;
10
10
  }>;
11
11
  export interface DocSearchProps {
12
- appId?: string;
12
+ appId: string;
13
13
  apiKey: string;
14
14
  indexName: string;
15
15
  placeholder?: string;
@@ -27,5 +27,8 @@ export interface DocSearchProps {
27
27
  initialQuery?: string;
28
28
  navigator?: AutocompleteOptions<InternalDocSearchHit>['navigator'];
29
29
  translations?: DocSearchTranslations;
30
+ getMissingResultsUrl?: ({ query: string }: {
31
+ query: any;
32
+ }) => string;
30
33
  }
31
34
  export declare function DocSearch(props: DocSearchProps): JSX.Element;
package/dist/esm/DocSearch.js CHANGED
@@ -8,7 +8,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
8
8
 
9
9
  function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
10
10
 
11
- function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
11
+ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
12
12
 
13
13
  function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
14
14
 
package/dist/esm/DocSearchButton.js CHANGED
@@ -44,9 +44,9 @@ export var DocSearchButton = React.forwardRef(function (_ref, ref) {
44
44
  className: "DocSearch-Button-Placeholder"
45
45
  }, buttonText)), /*#__PURE__*/React.createElement("span", {
46
46
  className: "DocSearch-Button-Keys"
47
- }, key !== null && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("span", {
47
+ }, key !== null && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("kbd", {
48
48
  className: "DocSearch-Button-Key"
49
- }, key === ACTION_KEY_DEFAULT ? /*#__PURE__*/React.createElement(ControlKeyIcon, null) : key), /*#__PURE__*/React.createElement("span", {
49
+ }, key === ACTION_KEY_DEFAULT ? /*#__PURE__*/React.createElement(ControlKeyIcon, null) : key), /*#__PURE__*/React.createElement("kbd", {
50
50
  className: "DocSearch-Button-Key"
51
51
  }, "K"))));
52
52
  });
package/dist/esm/DocSearchModal.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import type { DocSearchProps } from './DocSearch';
3
2
  import type { FooterTranslations } from './Footer';
4
3
  import type { ScreenStateTranslations } from './ScreenState';
@@ -12,4 +11,4 @@ export declare type DocSearchModalProps = DocSearchProps & {
12
11
  onClose?: () => void;
13
12
  translations?: ModalTranslations;
14
13
  };
15
- export declare function DocSearchModal({ appId, apiKey, indexName, placeholder, searchParameters, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, }: DocSearchModalProps): JSX.Element;
14
+ export declare function DocSearchModal({ appId, apiKey, indexName, placeholder, searchParameters, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, }: DocSearchModalProps): JSX.Element;
package/dist/esm/DocSearchModal.js CHANGED
@@ -2,9 +2,9 @@ var _excluded = ["footer", "searchBox"];
2
2
 
3
3
  function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
4
4
 
5
- function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
5
+ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
6
6
 
7
- function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
7
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
8
8
 
9
9
  function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
10
10
 
@@ -16,7 +16,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
16
16
 
17
17
  function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
18
18
 
19
- function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
19
+ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
20
20
 
21
21
  function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
22
22
 
@@ -37,8 +37,7 @@ import { useTouchEvents } from './useTouchEvents';
37
37
  import { useTrapFocus } from './useTrapFocus';
38
38
  import { groupBy, identity, noop, removeHighlightTags } from './utils';
39
39
  export function DocSearchModal(_ref) {
40
- var _ref$appId = _ref.appId,
41
- appId = _ref$appId === void 0 ? 'BH4D9OD16A' : _ref$appId,
40
+ var appId = _ref.appId,
42
41
  apiKey = _ref.apiKey,
43
42
  indexName = _ref.indexName,
44
43
  _ref$placeholder = _ref.placeholder,
@@ -64,7 +63,8 @@ export function DocSearchModal(_ref) {
64
63
  _ref$initialQuery = _ref.initialQuery,
65
64
  initialQueryFromProp = _ref$initialQuery === void 0 ? '' : _ref$initialQuery,
66
65
  _ref$translations = _ref.translations,
67
- translations = _ref$translations === void 0 ? {} : _ref$translations;
66
+ translations = _ref$translations === void 0 ? {} : _ref$translations,
67
+ getMissingResultsUrl = _ref.getMissingResultsUrl;
68
68
 
69
69
  var footerTranslations = translations.footer,
70
70
  searchBoxTranslations = translations.searchBox,
@@ -362,6 +362,7 @@ export function DocSearchModal(_ref) {
362
362
  favoriteSearches: favoriteSearches,
363
363
  inputRef: inputRef,
364
364
  translations: screenStateTranslations,
365
+ getMissingResultsUrl: getMissingResultsUrl,
365
366
  onItemClick: function onItemClick(item) {
366
367
  saveRecentSearch(item);
367
368
  onClose();
package/dist/esm/ErrorScreen.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  export declare type ErrorScreenTranslations = Partial<{
3
2
  titleText: string;
4
3
  helpText: string;
package/dist/esm/Footer.d.ts CHANGED
@@ -1,8 +1,11 @@
1
- /// <reference types="react" />
2
1
  export declare type FooterTranslations = Partial<{
3
2
  selectText: string;
3
+ selectKeyAriaLabel: string;
4
4
  navigateText: string;
5
+ navigateUpKeyAriaLabel: string;
6
+ navigateDownKeyAriaLabel: string;
5
7
  closeText: string;
8
+ closeKeyAriaLabel: string;
6
9
  searchByText: string;
7
10
  }>;
8
11
  declare type FooterProps = Partial<{
package/dist/esm/Footer.js CHANGED
@@ -4,7 +4,9 @@ import { AlgoliaLogo } from './AlgoliaLogo';
4
4
  function CommandIcon(props) {
5
5
  return /*#__PURE__*/React.createElement("svg", {
6
6
  width: "15",
7
- height: "15"
7
+ height: "15",
8
+ "aria-label": props.ariaLabel,
9
+ role: "img"
8
10
  }, /*#__PURE__*/React.createElement("g", {
9
11
  fill: "none",
10
12
  stroke: "currentColor",
@@ -19,10 +21,18 @@ export function Footer(_ref) {
19
21
  translations = _ref$translations === void 0 ? {} : _ref$translations;
20
22
  var _translations$selectT = translations.selectText,
21
23
  selectText = _translations$selectT === void 0 ? 'to select' : _translations$selectT,
24
+ _translations$selectK = translations.selectKeyAriaLabel,
25
+ selectKeyAriaLabel = _translations$selectK === void 0 ? 'Enter key' : _translations$selectK,
22
26
  _translations$navigat = translations.navigateText,
23
27
  navigateText = _translations$navigat === void 0 ? 'to navigate' : _translations$navigat,
28
+ _translations$navigat2 = translations.navigateUpKeyAriaLabel,
29
+ navigateUpKeyAriaLabel = _translations$navigat2 === void 0 ? 'Arrow up' : _translations$navigat2,
30
+ _translations$navigat3 = translations.navigateDownKeyAriaLabel,
31
+ navigateDownKeyAriaLabel = _translations$navigat3 === void 0 ? 'Arrow down' : _translations$navigat3,
24
32
  _translations$closeTe = translations.closeText,
25
33
  closeText = _translations$closeTe === void 0 ? 'to close' : _translations$closeTe,
34
+ _translations$closeKe = translations.closeKeyAriaLabel,
35
+ closeKeyAriaLabel = _translations$closeKe === void 0 ? 'Escape key' : _translations$closeKe,
26
36
  _translations$searchB = translations.searchByText,
27
37
  searchByText = _translations$searchB === void 0 ? 'Search by' : _translations$searchB;
28
38
  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("div", {
@@ -33,25 +43,33 @@ export function Footer(_ref) {
33
43
  }
34
44
  })), /*#__PURE__*/React.createElement("ul", {
35
45
  className: "DocSearch-Commands"
36
- }, /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("span", {
46
+ }, /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("kbd", {
37
47
  className: "DocSearch-Commands-Key"
38
- }, /*#__PURE__*/React.createElement(CommandIcon, null, /*#__PURE__*/React.createElement("path", {
48
+ }, /*#__PURE__*/React.createElement(CommandIcon, {
49
+ ariaLabel: selectKeyAriaLabel
50
+ }, /*#__PURE__*/React.createElement("path", {
39
51
  d: "M12 3.53088v3c0 1-1 2-2 2H4M7 11.53088l-3-3 3-3"
40
52
  }))), /*#__PURE__*/React.createElement("span", {
41
53
  className: "DocSearch-Label"
42
- }, selectText)), /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("span", {
54
+ }, selectText)), /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("kbd", {
43
55
  className: "DocSearch-Commands-Key"
44
- }, /*#__PURE__*/React.createElement(CommandIcon, null, /*#__PURE__*/React.createElement("path", {
56
+ }, /*#__PURE__*/React.createElement(CommandIcon, {
57
+ ariaLabel: navigateDownKeyAriaLabel
58
+ }, /*#__PURE__*/React.createElement("path", {
45
59
  d: "M7.5 3.5v8M10.5 8.5l-3 3-3-3"
46
- }))), /*#__PURE__*/React.createElement("span", {
60
+ }))), /*#__PURE__*/React.createElement("kbd", {
47
61
  className: "DocSearch-Commands-Key"
48
- }, /*#__PURE__*/React.createElement(CommandIcon, null, /*#__PURE__*/React.createElement("path", {
62
+ }, /*#__PURE__*/React.createElement(CommandIcon, {
63
+ ariaLabel: navigateUpKeyAriaLabel
64
+ }, /*#__PURE__*/React.createElement("path", {
49
65
  d: "M7.5 11.5v-8M10.5 6.5l-3-3-3 3"
50
66
  }))), /*#__PURE__*/React.createElement("span", {
51
67
  className: "DocSearch-Label"
52
- }, navigateText)), /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("span", {
68
+ }, navigateText)), /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("kbd", {
53
69
  className: "DocSearch-Commands-Key"
54
- }, /*#__PURE__*/React.createElement(CommandIcon, null, /*#__PURE__*/React.createElement("path", {
70
+ }, /*#__PURE__*/React.createElement(CommandIcon, {
71
+ ariaLabel: closeKeyAriaLabel
72
+ }, /*#__PURE__*/React.createElement("path", {
55
73
  d: "M13.6167 8.936c-.1065.3583-.6883.962-1.4875.962-.7993 0-1.653-.9165-1.653-2.1258v-.5678c0-1.2548.7896-2.1016 1.653-2.1016.8634 0 1.3601.4778 1.4875 1.0724M9 6c-.1352-.4735-.7506-.9219-1.46-.8972-.7092.0246-1.344.57-1.344 1.2166s.4198.8812 1.3445.9805C8.465 7.3992 8.968 7.9337 9 8.5c.032.5663-.454 1.398-1.4595 1.398C6.6593 9.898 6 9 5.963 8.4851m-1.4748.5368c-.2635.5941-.8099.876-1.5443.876s-1.7073-.6248-1.7073-2.204v-.4603c0-1.0416.721-2.131 1.7073-2.131.9864 0 1.6425 1.031 1.5443 2.2492h-2.956"
56
74
  }))), /*#__PURE__*/React.createElement("span", {
57
75
  className: "DocSearch-Label"
package/dist/esm/NoResultsScreen.d.ts CHANGED
@@ -1,11 +1,10 @@
1
- /// <reference types="react" />
2
1
  import type { ScreenStateProps } from './ScreenState';
3
2
  import type { InternalDocSearchHit } from './types';
4
3
  export declare type NoResultsScreenTranslations = Partial<{
5
4
  noResultsText: string;
6
5
  suggestedQueryText: string;
7
- openIssueText: string;
8
- openIssueLinkText: string;
6
+ reportMissingResultsText: string;
7
+ reportMissingResultsLinkText: string;
9
8
  }>;
10
9
  declare type NoResultsScreenProps = Omit<ScreenStateProps<InternalDocSearchHit>, 'translations'> & {
11
10
  translations?: NoResultsScreenTranslations;
package/dist/esm/NoResultsScreen.js CHANGED
@@ -6,7 +6,7 @@ function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread n
6
6
 
7
7
  function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
8
8
 
9
- function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter); }
9
+ function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
10
10
 
11
11
  function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
12
12
 
@@ -27,10 +27,10 @@ export function NoResultsScreen(_ref) {
27
27
  noResultsText = _translations$noResul === void 0 ? 'No results for' : _translations$noResul,
28
28
  _translations$suggest = translations.suggestedQueryText,
29
29
  suggestedQueryText = _translations$suggest === void 0 ? 'Try searching for' : _translations$suggest,
30
- _translations$openIss = translations.openIssueText,
31
- openIssueText = _translations$openIss === void 0 ? 'Believe this query should return results?' : _translations$openIss,
32
- _translations$openIss2 = translations.openIssueLinkText,
33
- openIssueLinkText = _translations$openIss2 === void 0 ? 'Let us know' : _translations$openIss2;
30
+ _translations$reportM = translations.reportMissingResultsText,
31
+ reportMissingResultsText = _translations$reportM === void 0 ? 'Believe this query should return results?' : _translations$reportM,
32
+ _translations$reportM2 = translations.reportMissingResultsLinkText,
33
+ reportMissingResultsLinkText = _translations$reportM2 === void 0 ? 'Let us know.' : _translations$reportM2;
34
34
  var searchSuggestions = props.state.context.searchSuggestions;
35
35
  return /*#__PURE__*/React.createElement("div", {
36
36
  className: "DocSearch-NoResults"
@@ -55,11 +55,13 @@ export function NoResultsScreen(_ref) {
55
55
  props.inputRef.current.focus();
56
56
  }
57
57
  }, search))]);
58
- }, []))), /*#__PURE__*/React.createElement("p", {
58
+ }, []))), props.getMissingResultsUrl && /*#__PURE__*/React.createElement("p", {
59
59
  className: "DocSearch-Help"
60
- }, "".concat(openIssueText, " "), /*#__PURE__*/React.createElement("a", {
61
- href: "https://github.com/algolia/docsearch-configs/issues/new?template=Missing_results.md&title=[".concat(props.indexName, "]+Missing+results+for+query+\"").concat(props.state.query, "\""),
60
+ }, "".concat(reportMissingResultsText, " "), /*#__PURE__*/React.createElement("a", {
61
+ href: props.getMissingResultsUrl({
62
+ query: props.state.query
63
+ }),
62
64
  target: "_blank",
63
65
  rel: "noopener noreferrer"
64
- }, openIssueLinkText), "."));
66
+ }, reportMissingResultsLinkText)));
65
67
  }
package/dist/esm/Results.js CHANGED
@@ -6,7 +6,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
6
6
 
7
7
  function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
8
8
 
9
- function _iterableToArrayLimit(arr, i) { if (typeof Symbol === "undefined" || !(Symbol.iterator in Object(arr))) return; var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
9
+ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
10
10
 
11
11
  function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
12
12
 
package/dist/esm/ResultsScreen.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import type { ScreenStateProps } from './ScreenState';
3
2
  import type { InternalDocSearchHit } from './types';
4
3
  declare type ResultsScreenProps = Omit<ScreenStateProps<InternalDocSearchHit>, 'translations'>;
package/dist/esm/ScreenState.d.ts CHANGED
@@ -22,5 +22,6 @@ export interface ScreenStateProps<TItem extends BaseItem> extends AutocompleteAp
22
22
  disableUserPersonalization: boolean;
23
23
  resultsFooterComponent: DocSearchProps['resultsFooterComponent'];
24
24
  translations: ScreenStateTranslations;
25
+ getMissingResultsUrl?: DocSearchProps['getMissingResultsUrl'];
25
26
  }
26
27
  export declare const ScreenState: React.MemoExoticComponent<({ translations, ...props }: ScreenStateProps<InternalDocSearchHit>) => JSX.Element>;
package/dist/esm/Snippet.js CHANGED
@@ -1,8 +1,8 @@
1
1
  var _excluded = ["hit", "attribute", "tagName"];
2
2
 
3
- function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
3
+ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
4
4
 
5
- function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
5
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
6
6
 
7
7
  function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
8
8
 
package/dist/esm/StartScreen.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import type { ScreenStateProps } from './ScreenState';
3
2
  import type { InternalDocSearchHit } from './types';
4
3
  export declare type StartScreenTranslations = Partial<{