@docsearch/react 3.0.0-alpha.39 → 3.0.0-alpha.50

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 (49) hide show
  1. package/README.md +30 -4
  2. package/dist/esm/AlgoliaLogo.d.ts +8 -1
  3. package/dist/esm/AlgoliaLogo.js +7 -3
  4. package/dist/esm/DocSearch.d.ts +20 -10
  5. package/dist/esm/DocSearch.js +8 -4
  6. package/dist/esm/DocSearchButton.d.ts +3 -4
  7. package/dist/esm/DocSearchButton.js +3 -1
  8. package/dist/esm/DocSearchModal.d.ts +13 -5
  9. package/dist/esm/DocSearchModal.js +57 -40
  10. package/dist/esm/ErrorScreen.d.ts +9 -1
  11. package/dist/esm/ErrorScreen.js +9 -3
  12. package/dist/esm/Footer.d.ts +11 -1
  13. package/dist/esm/Footer.js +33 -18
  14. package/dist/esm/Hit.d.ts +2 -2
  15. package/dist/esm/NoResultsScreen.d.ts +12 -4
  16. package/dist/esm/NoResultsScreen.js +29 -8
  17. package/dist/esm/Results.d.ts +8 -8
  18. package/dist/esm/Results.js +1 -1
  19. package/dist/esm/ResultsScreen.d.ts +3 -3
  20. package/dist/esm/ResultsScreen.js +2 -2
  21. package/dist/esm/ScreenState.d.ts +17 -7
  22. package/dist/esm/ScreenState.js +19 -4
  23. package/dist/esm/SearchBox.d.ts +13 -5
  24. package/dist/esm/SearchBox.js +25 -3
  25. package/dist/esm/Snippet.d.ts +2 -2
  26. package/dist/esm/Snippet.js +8 -5
  27. package/dist/esm/StartScreen.d.ts +14 -5
  28. package/dist/esm/StartScreen.js +40 -14
  29. package/dist/esm/__tests__/api.test.js +336 -0
  30. package/dist/esm/icons/SourceIcon.js +14 -13
  31. package/dist/esm/stored-searches.d.ts +4 -4
  32. package/dist/esm/stored-searches.js +3 -1
  33. package/dist/esm/types/DocSearchHit.d.ts +2 -2
  34. package/dist/esm/types/DocSearchHit.js +1 -0
  35. package/dist/esm/types/InternalDocSearchHit.d.ts +2 -2
  36. package/dist/esm/types/InternalDocSearchHit.js +1 -0
  37. package/dist/esm/types/StoredDocSearchHit.d.ts +1 -1
  38. package/dist/esm/types/StoredDocSearchHit.js +1 -0
  39. package/dist/esm/useDocSearchKeyboardEvents.d.ts +3 -3
  40. package/dist/esm/useSearchClient.d.ts +1 -1
  41. package/dist/esm/useTouchEvents.d.ts +1 -1
  42. package/dist/esm/utils/groupBy.d.ts +1 -1
  43. package/dist/esm/utils/removeHighlightTags.d.ts +1 -1
  44. package/dist/esm/utils/removeHighlightTags.js +6 -2
  45. package/dist/esm/version.d.ts +1 -1
  46. package/dist/esm/version.js +1 -1
  47. package/dist/umd/index.js +2 -2
  48. package/dist/umd/index.js.map +1 -1
  49. package/package.json +4 -4
@@ -1,18 +1,36 @@
1
+ var _excluded = ["translations"];
2
+
1
3
  function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
2
4
 
3
5
  function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
4
6
 
5
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); }
6
8
 
7
- 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); }
8
10
 
9
11
  function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
10
12
 
11
13
  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; }
12
14
 
15
+ function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
16
+
17
+ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
18
+
13
19
  import React from 'react';
14
20
  import { NoResultsIcon } from './icons';
15
- export function NoResultsScreen(props) {
21
+ export function NoResultsScreen(_ref) {
22
+ var _ref$translations = _ref.translations,
23
+ translations = _ref$translations === void 0 ? {} : _ref$translations,
24
+ props = _objectWithoutProperties(_ref, _excluded);
25
+
26
+ var _translations$noResul = translations.noResultsText,
27
+ noResultsText = _translations$noResul === void 0 ? 'No results for' : _translations$noResul,
28
+ _translations$suggest = translations.suggestedQueryText,
29
+ suggestedQueryText = _translations$suggest === void 0 ? 'Try searching for' : _translations$suggest,
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;
16
34
  var searchSuggestions = props.state.context.searchSuggestions;
17
35
  return /*#__PURE__*/React.createElement("div", {
18
36
  className: "DocSearch-NoResults"
@@ -20,27 +38,30 @@ export function NoResultsScreen(props) {
20
38
  className: "DocSearch-Screen-Icon"
21
39
  }, /*#__PURE__*/React.createElement(NoResultsIcon, null)), /*#__PURE__*/React.createElement("p", {
22
40
  className: "DocSearch-Title"
23
- }, "No results for \"", /*#__PURE__*/React.createElement("strong", null, props.state.query), "\""), searchSuggestions && searchSuggestions.length > 0 && /*#__PURE__*/React.createElement("div", {
41
+ }, noResultsText, " \"", /*#__PURE__*/React.createElement("strong", null, props.state.query), "\""), searchSuggestions && searchSuggestions.length > 0 && /*#__PURE__*/React.createElement("div", {
24
42
  className: "DocSearch-NoResults-Prefill-List"
25
43
  }, /*#__PURE__*/React.createElement("p", {
26
44
  className: "DocSearch-Help"
27
- }, "Try searching for:"), /*#__PURE__*/React.createElement("ul", null, searchSuggestions.slice(0, 3).reduce(function (acc, search) {
45
+ }, suggestedQueryText, ":"), /*#__PURE__*/React.createElement("ul", null, searchSuggestions.slice(0, 3).reduce(function (acc, search) {
28
46
  return [].concat(_toConsumableArray(acc), [/*#__PURE__*/React.createElement("li", {
29
47
  key: search
30
48
  }, /*#__PURE__*/React.createElement("button", {
31
49
  className: "DocSearch-Prefill",
32
50
  key: search,
51
+ type: "button",
33
52
  onClick: function onClick() {
34
53
  props.setQuery(search.toLowerCase() + ' ');
35
54
  props.refresh();
36
55
  props.inputRef.current.focus();
37
56
  }
38
57
  }, search))]);
39
- }, []))), /*#__PURE__*/React.createElement("p", {
58
+ }, []))), props.getMissingResultsUrl && /*#__PURE__*/React.createElement("p", {
40
59
  className: "DocSearch-Help"
41
- }, "Believe this query should return results?", ' ', /*#__PURE__*/React.createElement("a", {
42
- 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
+ }),
43
64
  target: "_blank",
44
65
  rel: "noopener noreferrer"
45
- }, "Let us know"), "."));
66
+ }, reportMissingResultsLinkText)));
46
67
  }
@@ -1,20 +1,20 @@
1
- import { AutocompleteApi, AutocompleteState, BaseItem } from '@algolia/autocomplete-core';
1
+ import type { AutocompleteApi, AutocompleteState, BaseItem } from '@algolia/autocomplete-core';
2
2
  import React from 'react';
3
- import { DocSearchProps } from './DocSearch';
4
- import { StoredDocSearchHit } from './types';
3
+ import type { DocSearchProps } from './DocSearch';
4
+ import type { StoredDocSearchHit } from './types';
5
5
  interface ResultsProps<TItem extends BaseItem> extends AutocompleteApi<TItem, React.FormEvent, React.MouseEvent, React.KeyboardEvent> {
6
6
  title: string;
7
7
  collection: AutocompleteState<TItem>['collections'][0];
8
- renderIcon(props: {
8
+ renderIcon: (props: {
9
9
  item: TItem;
10
10
  index: number;
11
- }): React.ReactNode;
12
- renderAction(props: {
11
+ }) => React.ReactNode;
12
+ renderAction: (props: {
13
13
  item: TItem;
14
14
  runDeleteTransition: (cb: () => void) => void;
15
15
  runFavoriteTransition: (cb: () => void) => void;
16
- }): React.ReactNode;
17
- onItemClick(item: TItem): void;
16
+ }) => React.ReactNode;
17
+ onItemClick: (item: TItem) => void;
18
18
  hitComponent: DocSearchProps['hitComponent'];
19
19
  }
20
20
  export declare function Results<TItem extends StoredDocSearchHit>(props: ResultsProps<TItem>): JSX.Element | null;
@@ -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
 
@@ -1,6 +1,6 @@
1
1
  /// <reference types="react" />
2
- import { ScreenStateProps } from './ScreenState';
3
- import { InternalDocSearchHit } from './types';
4
- declare type ResultsScreenProps = ScreenStateProps<InternalDocSearchHit>;
2
+ import type { ScreenStateProps } from './ScreenState';
3
+ import type { InternalDocSearchHit } from './types';
4
+ declare type ResultsScreenProps = Omit<ScreenStateProps<InternalDocSearchHit>, 'translations'>;
5
5
  export declare function ResultsScreen(props: ResultsScreenProps): JSX.Element;
6
6
  export {};
@@ -7,14 +7,14 @@ import { removeHighlightTags } from './utils';
7
7
  export function ResultsScreen(props) {
8
8
  return /*#__PURE__*/React.createElement("div", {
9
9
  className: "DocSearch-Dropdown-Container"
10
- }, props.state.collections.map(function (collection, index) {
10
+ }, props.state.collections.map(function (collection) {
11
11
  if (collection.items.length === 0) {
12
12
  return null;
13
13
  }
14
14
 
15
15
  var title = removeHighlightTags(collection.items[0]);
16
16
  return /*#__PURE__*/React.createElement(Results, _extends({}, props, {
17
- key: index,
17
+ key: collection.source.sourceId,
18
18
  title: title,
19
19
  collection: collection,
20
20
  renderIcon: function renderIcon(_ref) {
@@ -1,17 +1,27 @@
1
- import { AutocompleteApi, AutocompleteState, BaseItem } from '@algolia/autocomplete-core';
1
+ import type { AutocompleteApi, AutocompleteState, BaseItem } from '@algolia/autocomplete-core';
2
2
  import React from 'react';
3
- import { DocSearchProps } from './DocSearch';
4
- import { StoredSearchPlugin } from './stored-searches';
5
- import { InternalDocSearchHit, StoredDocSearchHit } from './types';
3
+ import type { DocSearchProps } from './DocSearch';
4
+ import type { ErrorScreenTranslations } from './ErrorScreen';
5
+ import type { NoResultsScreenTranslations } from './NoResultsScreen';
6
+ import type { StartScreenTranslations } from './StartScreen';
7
+ import type { StoredSearchPlugin } from './stored-searches';
8
+ import type { InternalDocSearchHit, StoredDocSearchHit } from './types';
9
+ export declare type ScreenStateTranslations = Partial<{
10
+ errorScreen: ErrorScreenTranslations;
11
+ startScreen: StartScreenTranslations;
12
+ noResultsScreen: NoResultsScreenTranslations;
13
+ }>;
6
14
  export interface ScreenStateProps<TItem extends BaseItem> extends AutocompleteApi<TItem, React.FormEvent, React.MouseEvent, React.KeyboardEvent> {
7
15
  state: AutocompleteState<TItem>;
8
16
  recentSearches: StoredSearchPlugin<StoredDocSearchHit>;
9
17
  favoriteSearches: StoredSearchPlugin<StoredDocSearchHit>;
10
- onItemClick(item: InternalDocSearchHit): void;
11
- inputRef: React.MutableRefObject<null | HTMLInputElement>;
18
+ onItemClick: (item: InternalDocSearchHit) => void;
19
+ inputRef: React.MutableRefObject<HTMLInputElement | null>;
12
20
  hitComponent: DocSearchProps['hitComponent'];
13
21
  indexName: DocSearchProps['indexName'];
14
22
  disableUserPersonalization: boolean;
15
23
  resultsFooterComponent: DocSearchProps['resultsFooterComponent'];
24
+ translations: ScreenStateTranslations;
25
+ getMissingResultsUrl?: DocSearchProps['getMissingResultsUrl'];
16
26
  }
17
- export declare const ScreenState: React.MemoExoticComponent<(props: ScreenStateProps<InternalDocSearchHit>) => JSX.Element>;
27
+ export declare const ScreenState: React.MemoExoticComponent<({ translations, ...props }: ScreenStateProps<InternalDocSearchHit>) => JSX.Element>;
@@ -1,13 +1,25 @@
1
+ var _excluded = ["translations"];
2
+
1
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); }
2
4
 
5
+ function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
6
+
7
+ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
8
+
3
9
  import React from 'react';
4
10
  import { ErrorScreen } from './ErrorScreen';
5
11
  import { NoResultsScreen } from './NoResultsScreen';
6
12
  import { ResultsScreen } from './ResultsScreen';
7
13
  import { StartScreen } from './StartScreen';
8
- export var ScreenState = React.memo(function (props) {
14
+ export var ScreenState = React.memo(function (_ref) {
15
+ var _ref$translations = _ref.translations,
16
+ translations = _ref$translations === void 0 ? {} : _ref$translations,
17
+ props = _objectWithoutProperties(_ref, _excluded);
18
+
9
19
  if (props.state.status === 'error') {
10
- return /*#__PURE__*/React.createElement(ErrorScreen, null);
20
+ return /*#__PURE__*/React.createElement(ErrorScreen, {
21
+ translations: translations === null || translations === void 0 ? void 0 : translations.errorScreen
22
+ });
11
23
  }
12
24
 
13
25
  var hasCollections = props.state.collections.some(function (collection) {
@@ -16,12 +28,15 @@ export var ScreenState = React.memo(function (props) {
16
28
 
17
29
  if (!props.state.query) {
18
30
  return /*#__PURE__*/React.createElement(StartScreen, _extends({}, props, {
19
- hasCollections: hasCollections
31
+ hasCollections: hasCollections,
32
+ translations: translations === null || translations === void 0 ? void 0 : translations.startScreen
20
33
  }));
21
34
  }
22
35
 
23
36
  if (hasCollections === false) {
24
- return /*#__PURE__*/React.createElement(NoResultsScreen, props);
37
+ return /*#__PURE__*/React.createElement(NoResultsScreen, _extends({}, props, {
38
+ translations: translations === null || translations === void 0 ? void 0 : translations.noResultsScreen
39
+ }));
25
40
  }
26
41
 
27
42
  return /*#__PURE__*/React.createElement(ResultsScreen, props);
@@ -1,12 +1,20 @@
1
- import { AutocompleteApi, AutocompleteState } from '@algolia/autocomplete-core';
2
- import React, { MutableRefObject } from 'react';
3
- import { InternalDocSearchHit } from './types';
1
+ import type { AutocompleteApi, AutocompleteState } from '@algolia/autocomplete-core';
2
+ import type { MutableRefObject } from 'react';
3
+ import React from 'react';
4
+ import type { InternalDocSearchHit } from './types';
5
+ export declare type SearchBoxTranslations = Partial<{
6
+ resetButtonTitle: string;
7
+ resetButtonAriaLabel: string;
8
+ cancelButtonText: string;
9
+ cancelButtonAriaLabel: string;
10
+ }>;
4
11
  interface SearchBoxProps extends AutocompleteApi<InternalDocSearchHit, React.FormEvent, React.MouseEvent, React.KeyboardEvent> {
5
12
  state: AutocompleteState<InternalDocSearchHit>;
6
13
  autoFocus: boolean;
7
14
  inputRef: MutableRefObject<HTMLInputElement | null>;
8
- onClose(): void;
15
+ onClose: () => void;
9
16
  isFromSelection: boolean;
17
+ translations?: SearchBoxTranslations;
10
18
  }
11
- export declare function SearchBox(props: SearchBoxProps): JSX.Element;
19
+ export declare function SearchBox({ translations, ...props }: SearchBoxProps): JSX.Element;
12
20
  export {};
@@ -1,11 +1,30 @@
1
+ var _excluded = ["translations"];
2
+
1
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); }
2
4
 
5
+ function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
6
+
7
+ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
8
+
3
9
  import React from 'react';
4
10
  import { MAX_QUERY_SIZE } from './constants';
5
11
  import { LoadingIcon } from './icons/LoadingIcon';
6
12
  import { ResetIcon } from './icons/ResetIcon';
7
13
  import { SearchIcon } from './icons/SearchIcon';
8
- export function SearchBox(props) {
14
+ export function SearchBox(_ref) {
15
+ var _ref$translations = _ref.translations,
16
+ translations = _ref$translations === void 0 ? {} : _ref$translations,
17
+ props = _objectWithoutProperties(_ref, _excluded);
18
+
19
+ var _translations$resetBu = translations.resetButtonTitle,
20
+ resetButtonTitle = _translations$resetBu === void 0 ? 'Clear the query' : _translations$resetBu,
21
+ _translations$resetBu2 = translations.resetButtonAriaLabel,
22
+ resetButtonAriaLabel = _translations$resetBu2 === void 0 ? 'Clear the query' : _translations$resetBu2,
23
+ _translations$cancelB = translations.cancelButtonText,
24
+ cancelButtonText = _translations$cancelB === void 0 ? 'Cancel' : _translations$cancelB,
25
+ _translations$cancelB2 = translations.cancelButtonAriaLabel,
26
+ cancelButtonAriaLabel = _translations$cancelB2 === void 0 ? 'Cancel' : _translations$cancelB2;
27
+
9
28
  var _props$getFormProps = props.getFormProps({
10
29
  inputElement: props.inputRef.current
11
30
  }),
@@ -40,11 +59,14 @@ export function SearchBox(props) {
40
59
  maxLength: MAX_QUERY_SIZE
41
60
  }))), /*#__PURE__*/React.createElement("button", {
42
61
  type: "reset",
43
- title: "Clear the query",
62
+ title: resetButtonTitle,
44
63
  className: "DocSearch-Reset",
64
+ "aria-label": resetButtonAriaLabel,
45
65
  hidden: !props.state.query
46
66
  }, /*#__PURE__*/React.createElement(ResetIcon, null))), /*#__PURE__*/React.createElement("button", {
47
67
  className: "DocSearch-Cancel",
68
+ type: "reset",
69
+ "aria-label": cancelButtonAriaLabel,
48
70
  onClick: props.onClose
49
- }, "Cancel"));
71
+ }, cancelButtonText));
50
72
  }
@@ -1,10 +1,10 @@
1
1
  /// <reference types="react" />
2
- import { StoredDocSearchHit } from './types';
2
+ import type { StoredDocSearchHit } from './types';
3
3
  interface SnippetProps<TItem> {
4
- [prop: string]: unknown;
5
4
  hit: TItem;
6
5
  attribute: string;
7
6
  tagName?: string;
7
+ [prop: string]: unknown;
8
8
  }
9
9
  export declare function Snippet<TItem extends StoredDocSearchHit>({ hit, attribute, tagName, ...rest }: SnippetProps<TItem>): import("react").DOMElement<{
10
10
  dangerouslySetInnerHTML: {
@@ -1,6 +1,8 @@
1
- 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; }
1
+ var _excluded = ["hit", "attribute", "tagName"];
2
2
 
3
- 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; }
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
+
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; }
4
6
 
5
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; }
6
8
 
@@ -12,8 +14,9 @@ import { createElement } from 'react';
12
14
 
13
15
  function getPropertyByPath(object, path) {
14
16
  var parts = path.split('.');
15
- return parts.reduce(function (current, key) {
16
- return current && current[key];
17
+ return parts.reduce(function (prev, current) {
18
+ if (prev !== null && prev !== void 0 && prev[current]) return prev[current];
19
+ return null;
17
20
  }, object);
18
21
  }
19
22
 
@@ -22,7 +25,7 @@ export function Snippet(_ref) {
22
25
  attribute = _ref.attribute,
23
26
  _ref$tagName = _ref.tagName,
24
27
  tagName = _ref$tagName === void 0 ? 'span' : _ref$tagName,
25
- rest = _objectWithoutProperties(_ref, ["hit", "attribute", "tagName"]);
28
+ rest = _objectWithoutProperties(_ref, _excluded);
26
29
 
27
30
  return createElement(tagName, _objectSpread(_objectSpread({}, rest), {}, {
28
31
  dangerouslySetInnerHTML: {
@@ -1,8 +1,17 @@
1
1
  /// <reference types="react" />
2
- import { ScreenStateProps } from './ScreenState';
3
- import { InternalDocSearchHit } from './types';
4
- interface StartScreenProps extends ScreenStateProps<InternalDocSearchHit> {
2
+ import type { ScreenStateProps } from './ScreenState';
3
+ import type { InternalDocSearchHit } from './types';
4
+ export declare type StartScreenTranslations = Partial<{
5
+ recentSearchesTitle: string;
6
+ noRecentSearchesText: string;
7
+ saveRecentSearchButtonTitle: string;
8
+ removeRecentSearchButtonTitle: string;
9
+ favoriteSearchesTitle: string;
10
+ removeFavoriteSearchButtonTitle: string;
11
+ }>;
12
+ declare type StartScreenProps = Omit<ScreenStateProps<InternalDocSearchHit>, 'translations'> & {
5
13
  hasCollections: boolean;
6
- }
7
- export declare function StartScreen(props: StartScreenProps): JSX.Element | null;
14
+ translations?: StartScreenTranslations;
15
+ };
16
+ export declare function StartScreen({ translations, ...props }: StartScreenProps): JSX.Element | null;
8
17
  export {};
@@ -1,9 +1,32 @@
1
+ var _excluded = ["translations"];
2
+
1
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); }
2
4
 
5
+ function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
6
+
7
+ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
8
+
3
9
  import React from 'react';
4
10
  import { RecentIcon, ResetIcon, StarIcon } from './icons';
5
11
  import { Results } from './Results';
6
- export function StartScreen(props) {
12
+ export function StartScreen(_ref) {
13
+ var _ref$translations = _ref.translations,
14
+ translations = _ref$translations === void 0 ? {} : _ref$translations,
15
+ props = _objectWithoutProperties(_ref, _excluded);
16
+
17
+ var _translations$recentS = translations.recentSearchesTitle,
18
+ recentSearchesTitle = _translations$recentS === void 0 ? 'Recent' : _translations$recentS,
19
+ _translations$noRecen = translations.noRecentSearchesText,
20
+ noRecentSearchesText = _translations$noRecen === void 0 ? 'No recent searches' : _translations$noRecen,
21
+ _translations$saveRec = translations.saveRecentSearchButtonTitle,
22
+ saveRecentSearchButtonTitle = _translations$saveRec === void 0 ? 'Save this search' : _translations$saveRec,
23
+ _translations$removeR = translations.removeRecentSearchButtonTitle,
24
+ removeRecentSearchButtonTitle = _translations$removeR === void 0 ? 'Remove this search from history' : _translations$removeR,
25
+ _translations$favorit = translations.favoriteSearchesTitle,
26
+ favoriteSearchesTitle = _translations$favorit === void 0 ? 'Favorite' : _translations$favorit,
27
+ _translations$removeF = translations.removeFavoriteSearchButtonTitle,
28
+ removeFavoriteSearchButtonTitle = _translations$removeF === void 0 ? 'Remove this search from favorites' : _translations$removeF;
29
+
7
30
  if (props.state.status === 'idle' && props.hasCollections === false) {
8
31
  if (props.disableUserPersonalization) {
9
32
  return null;
@@ -13,7 +36,7 @@ export function StartScreen(props) {
13
36
  className: "DocSearch-StartScreen"
14
37
  }, /*#__PURE__*/React.createElement("p", {
15
38
  className: "DocSearch-Help"
16
- }, "No recent searches"));
39
+ }, noRecentSearchesText));
17
40
  }
18
41
 
19
42
  if (props.hasCollections === false) {
@@ -23,22 +46,23 @@ export function StartScreen(props) {
23
46
  return /*#__PURE__*/React.createElement("div", {
24
47
  className: "DocSearch-Dropdown-Container"
25
48
  }, /*#__PURE__*/React.createElement(Results, _extends({}, props, {
26
- title: "Recent",
49
+ title: recentSearchesTitle,
27
50
  collection: props.state.collections[0],
28
51
  renderIcon: function renderIcon() {
29
52
  return /*#__PURE__*/React.createElement("div", {
30
53
  className: "DocSearch-Hit-icon"
31
54
  }, /*#__PURE__*/React.createElement(RecentIcon, null));
32
55
  },
33
- renderAction: function renderAction(_ref) {
34
- var item = _ref.item,
35
- runFavoriteTransition = _ref.runFavoriteTransition,
36
- runDeleteTransition = _ref.runDeleteTransition;
56
+ renderAction: function renderAction(_ref2) {
57
+ var item = _ref2.item,
58
+ runFavoriteTransition = _ref2.runFavoriteTransition,
59
+ runDeleteTransition = _ref2.runDeleteTransition;
37
60
  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("div", {
38
61
  className: "DocSearch-Hit-action"
39
62
  }, /*#__PURE__*/React.createElement("button", {
40
63
  className: "DocSearch-Hit-action-button",
41
- title: "Save this search",
64
+ title: saveRecentSearchButtonTitle,
65
+ type: "submit",
42
66
  onClick: function onClick(event) {
43
67
  event.preventDefault();
44
68
  event.stopPropagation();
@@ -52,7 +76,8 @@ export function StartScreen(props) {
52
76
  className: "DocSearch-Hit-action"
53
77
  }, /*#__PURE__*/React.createElement("button", {
54
78
  className: "DocSearch-Hit-action-button",
55
- title: "Remove this search from history",
79
+ title: removeRecentSearchButtonTitle,
80
+ type: "submit",
56
81
  onClick: function onClick(event) {
57
82
  event.preventDefault();
58
83
  event.stopPropagation();
@@ -64,21 +89,22 @@ export function StartScreen(props) {
64
89
  }, /*#__PURE__*/React.createElement(ResetIcon, null))));
65
90
  }
66
91
  })), /*#__PURE__*/React.createElement(Results, _extends({}, props, {
67
- title: "Favorites",
92
+ title: favoriteSearchesTitle,
68
93
  collection: props.state.collections[1],
69
94
  renderIcon: function renderIcon() {
70
95
  return /*#__PURE__*/React.createElement("div", {
71
96
  className: "DocSearch-Hit-icon"
72
97
  }, /*#__PURE__*/React.createElement(StarIcon, null));
73
98
  },
74
- renderAction: function renderAction(_ref2) {
75
- var item = _ref2.item,
76
- runDeleteTransition = _ref2.runDeleteTransition;
99
+ renderAction: function renderAction(_ref3) {
100
+ var item = _ref3.item,
101
+ runDeleteTransition = _ref3.runDeleteTransition;
77
102
  return /*#__PURE__*/React.createElement("div", {
78
103
  className: "DocSearch-Hit-action"
79
104
  }, /*#__PURE__*/React.createElement("button", {
80
105
  className: "DocSearch-Hit-action-button",
81
- title: "Remove this search from favorites",
106
+ title: removeFavoriteSearchButtonTitle,
107
+ type: "submit",
82
108
  onClick: function onClick(event) {
83
109
  event.preventDefault();
84
110
  event.stopPropagation();