@docsearch/react 3.0.0-alpha.41 → 3.0.0-alpha.42
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.
- package/dist/esm/AlgoliaLogo.d.ts +8 -1
- package/dist/esm/AlgoliaLogo.js +6 -2
- package/dist/esm/DocSearch.d.ts +17 -10
- package/dist/esm/DocSearch.js +7 -3
- package/dist/esm/DocSearchButton.d.ts +3 -4
- package/dist/esm/DocSearchButton.js +3 -1
- package/dist/esm/DocSearchModal.d.ts +13 -5
- package/dist/esm/DocSearchModal.js +54 -39
- package/dist/esm/ErrorScreen.d.ts +9 -1
- package/dist/esm/ErrorScreen.js +9 -3
- package/dist/esm/Footer.d.ts +11 -1
- package/dist/esm/Footer.js +33 -18
- package/dist/esm/Hit.d.ts +2 -2
- package/dist/esm/NoResultsScreen.d.ts +12 -4
- package/dist/esm/NoResultsScreen.js +25 -6
- package/dist/esm/Results.d.ts +8 -8
- package/dist/esm/Results.js +1 -1
- package/dist/esm/ResultsScreen.d.ts +3 -3
- package/dist/esm/ResultsScreen.js +2 -2
- package/dist/esm/ScreenState.d.ts +16 -7
- package/dist/esm/ScreenState.js +19 -4
- package/dist/esm/SearchBox.d.ts +13 -5
- package/dist/esm/SearchBox.js +25 -3
- package/dist/esm/Snippet.d.ts +2 -2
- package/dist/esm/Snippet.js +7 -4
- package/dist/esm/StartScreen.d.ts +14 -5
- package/dist/esm/StartScreen.js +40 -14
- package/dist/esm/__tests__/api.test.js +224 -0
- package/dist/esm/icons/SourceIcon.js +14 -13
- package/dist/esm/stored-searches.d.ts +4 -4
- package/dist/esm/stored-searches.js +3 -1
- package/dist/esm/types/DocSearchHit.d.ts +2 -2
- package/dist/esm/types/DocSearchHit.js +1 -0
- package/dist/esm/types/InternalDocSearchHit.d.ts +2 -2
- package/dist/esm/types/InternalDocSearchHit.js +1 -0
- package/dist/esm/types/StoredDocSearchHit.d.ts +1 -1
- package/dist/esm/types/StoredDocSearchHit.js +1 -0
- package/dist/esm/useDocSearchKeyboardEvents.d.ts +3 -3
- package/dist/esm/useDocSearchKeyboardEvents.js +4 -1
- package/dist/esm/useSearchClient.d.ts +1 -1
- package/dist/esm/useTouchEvents.d.ts +1 -1
- package/dist/esm/utils/groupBy.d.ts +1 -1
- package/dist/esm/utils/removeHighlightTags.d.ts +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/dist/umd/index.js +2 -2
- package/dist/umd/index.js.map +1 -1
- package/package.json +4 -4
package/dist/esm/Results.d.ts
CHANGED
|
@@ -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
|
-
})
|
|
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
|
-
})
|
|
17
|
-
onItemClick(item: TItem)
|
|
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;
|
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) {
|
|
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; }
|
|
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
|
|
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:
|
|
17
|
+
key: collection.source.sourceId,
|
|
18
18
|
title: title,
|
|
19
19
|
collection: collection,
|
|
20
20
|
renderIcon: function renderIcon(_ref) {
|
|
@@ -1,17 +1,26 @@
|
|
|
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 {
|
|
5
|
-
import {
|
|
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)
|
|
11
|
-
inputRef: React.MutableRefObject<
|
|
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;
|
|
16
25
|
}
|
|
17
|
-
export declare const ScreenState: React.MemoExoticComponent<(props: ScreenStateProps<InternalDocSearchHit>) => JSX.Element>;
|
|
26
|
+
export declare const ScreenState: React.MemoExoticComponent<({ translations, ...props }: ScreenStateProps<InternalDocSearchHit>) => JSX.Element>;
|
package/dist/esm/ScreenState.js
CHANGED
|
@@ -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 (
|
|
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,
|
|
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);
|
package/dist/esm/SearchBox.d.ts
CHANGED
|
@@ -1,12 +1,20 @@
|
|
|
1
|
-
import { AutocompleteApi, AutocompleteState } from '@algolia/autocomplete-core';
|
|
2
|
-
import
|
|
3
|
-
import
|
|
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()
|
|
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 {};
|
package/dist/esm/SearchBox.js
CHANGED
|
@@ -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(
|
|
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:
|
|
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
|
-
},
|
|
71
|
+
}, cancelButtonText));
|
|
50
72
|
}
|
package/dist/esm/Snippet.d.ts
CHANGED
|
@@ -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: {
|
package/dist/esm/Snippet.js
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
var _excluded = ["hit", "attribute", "tagName"];
|
|
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; }
|
|
2
4
|
|
|
3
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; }
|
|
4
6
|
|
|
@@ -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 (
|
|
16
|
-
|
|
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,
|
|
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
|
-
|
|
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
|
-
|
|
14
|
+
translations?: StartScreenTranslations;
|
|
15
|
+
};
|
|
16
|
+
export declare function StartScreen({ translations, ...props }: StartScreenProps): JSX.Element | null;
|
|
8
17
|
export {};
|
package/dist/esm/StartScreen.js
CHANGED
|
@@ -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(
|
|
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
|
-
},
|
|
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:
|
|
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(
|
|
34
|
-
var item =
|
|
35
|
-
runFavoriteTransition =
|
|
36
|
-
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:
|
|
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:
|
|
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:
|
|
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(
|
|
75
|
-
var item =
|
|
76
|
-
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:
|
|
106
|
+
title: removeFavoriteSearchButtonTitle,
|
|
107
|
+
type: "submit",
|
|
82
108
|
onClick: function onClick(event) {
|
|
83
109
|
event.preventDefault();
|
|
84
110
|
event.stopPropagation();
|
|
@@ -0,0 +1,224 @@
|
|
|
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; }
|
|
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; }
|
|
4
|
+
|
|
5
|
+
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
|
+
|
|
7
|
+
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
|
|
8
|
+
|
|
9
|
+
function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
|
|
10
|
+
|
|
11
|
+
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); }
|
|
12
|
+
|
|
13
|
+
import { render, fireEvent, waitFor, screen, act } from '@testing-library/react';
|
|
14
|
+
import React from 'react';
|
|
15
|
+
import '@testing-library/jest-dom';
|
|
16
|
+
import { DocSearch as DocSearchComponent } from '../DocSearch';
|
|
17
|
+
|
|
18
|
+
function DocSearch(props) {
|
|
19
|
+
return /*#__PURE__*/React.createElement(DocSearchComponent, _extends({
|
|
20
|
+
apiKey: "foo",
|
|
21
|
+
indexName: "bar"
|
|
22
|
+
}, props));
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
describe('api', function () {
|
|
26
|
+
beforeEach(function () {
|
|
27
|
+
document.body.innerHTML = '';
|
|
28
|
+
});
|
|
29
|
+
it('renders with minimal parameters', function () {
|
|
30
|
+
render( /*#__PURE__*/React.createElement(DocSearch, null));
|
|
31
|
+
expect(document.querySelector('.DocSearch')).toBeInTheDocument();
|
|
32
|
+
});
|
|
33
|
+
describe('translations', function () {
|
|
34
|
+
it('overrides the default DocSearchButton text', function () {
|
|
35
|
+
render( /*#__PURE__*/React.createElement(DocSearch, {
|
|
36
|
+
translations: {
|
|
37
|
+
button: {
|
|
38
|
+
buttonText: 'Recherche',
|
|
39
|
+
buttonAriaLabel: 'Recherche'
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}));
|
|
43
|
+
expect(document.querySelector('.DocSearch-Button-Placeholder').innerHTML).toBe('Recherche');
|
|
44
|
+
expect(document.querySelector('.DocSearch-Button').getAttribute('aria-label')).toBe('Recherche');
|
|
45
|
+
});
|
|
46
|
+
it('overrides the default DocSearchModal startScreen text', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
|
|
47
|
+
return regeneratorRuntime.wrap(function _callee$(_context) {
|
|
48
|
+
while (1) {
|
|
49
|
+
switch (_context.prev = _context.next) {
|
|
50
|
+
case 0:
|
|
51
|
+
render( /*#__PURE__*/React.createElement(DocSearch, {
|
|
52
|
+
translations: {
|
|
53
|
+
modal: {
|
|
54
|
+
startScreen: {
|
|
55
|
+
noRecentSearchesText: 'Pas de recherche récentes'
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}));
|
|
60
|
+
_context.next = 3;
|
|
61
|
+
return waitFor(function () {
|
|
62
|
+
fireEvent.click(document.querySelector('.DocSearch-Button'));
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
case 3:
|
|
66
|
+
expect(screen.getByText('Pas de recherche récentes')).toBeInTheDocument();
|
|
67
|
+
|
|
68
|
+
case 4:
|
|
69
|
+
case "end":
|
|
70
|
+
return _context.stop();
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}, _callee);
|
|
74
|
+
})));
|
|
75
|
+
it('overrides the default DocSearchModal noResultsScreen text', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
|
|
76
|
+
return regeneratorRuntime.wrap(function _callee3$(_context3) {
|
|
77
|
+
while (1) {
|
|
78
|
+
switch (_context3.prev = _context3.next) {
|
|
79
|
+
case 0:
|
|
80
|
+
render( /*#__PURE__*/React.createElement(DocSearch // mock empty response
|
|
81
|
+
, {
|
|
82
|
+
transformSearchClient: function transformSearchClient(searchClient) {
|
|
83
|
+
return _objectSpread(_objectSpread({}, searchClient), {}, {
|
|
84
|
+
search: function search() {
|
|
85
|
+
return new Promise(function (resolve) {
|
|
86
|
+
resolve({
|
|
87
|
+
results: [{
|
|
88
|
+
hits: [],
|
|
89
|
+
hitsPerPage: 0,
|
|
90
|
+
nbHits: 0,
|
|
91
|
+
nbPages: 0,
|
|
92
|
+
page: 0,
|
|
93
|
+
processingTimeMS: 0,
|
|
94
|
+
exhaustiveNbHits: true,
|
|
95
|
+
params: '',
|
|
96
|
+
query: ''
|
|
97
|
+
}]
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
},
|
|
103
|
+
translations: {
|
|
104
|
+
modal: {
|
|
105
|
+
noResultsScreen: {
|
|
106
|
+
noResultsText: 'Pas de résultats pour',
|
|
107
|
+
openIssueText: 'Ouvrez une issue sur docsearch-configs',
|
|
108
|
+
openIssueLinkText: 'Lien du repo'
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}));
|
|
113
|
+
_context3.next = 3;
|
|
114
|
+
return act( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee2() {
|
|
115
|
+
return regeneratorRuntime.wrap(function _callee2$(_context2) {
|
|
116
|
+
while (1) {
|
|
117
|
+
switch (_context2.prev = _context2.next) {
|
|
118
|
+
case 0:
|
|
119
|
+
_context2.next = 2;
|
|
120
|
+
return waitFor(function () {
|
|
121
|
+
fireEvent.click(document.querySelector('.DocSearch-Button'));
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
case 2:
|
|
125
|
+
fireEvent.input(document.querySelector('.DocSearch-Input'), {
|
|
126
|
+
target: {
|
|
127
|
+
value: 'q'
|
|
128
|
+
}
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
case 3:
|
|
132
|
+
case "end":
|
|
133
|
+
return _context2.stop();
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
}, _callee2);
|
|
137
|
+
})));
|
|
138
|
+
|
|
139
|
+
case 3:
|
|
140
|
+
expect(screen.getByText(/Pas de résultats pour/)).toBeInTheDocument();
|
|
141
|
+
expect(screen.getByText(/Ouvrez une issue sur docsearch-configs/)).toBeInTheDocument();
|
|
142
|
+
expect(screen.getByRole('link', {
|
|
143
|
+
name: 'Lien du repo'
|
|
144
|
+
})).toBeInTheDocument();
|
|
145
|
+
|
|
146
|
+
case 6:
|
|
147
|
+
case "end":
|
|
148
|
+
return _context3.stop();
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}, _callee3);
|
|
152
|
+
})));
|
|
153
|
+
it('overrides the default DocSearchModal searchbox text', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee4() {
|
|
154
|
+
return regeneratorRuntime.wrap(function _callee4$(_context4) {
|
|
155
|
+
while (1) {
|
|
156
|
+
switch (_context4.prev = _context4.next) {
|
|
157
|
+
case 0:
|
|
158
|
+
render( /*#__PURE__*/React.createElement(DocSearch, {
|
|
159
|
+
translations: {
|
|
160
|
+
modal: {
|
|
161
|
+
searchBox: {
|
|
162
|
+
resetButtonTitle: 'Effacer',
|
|
163
|
+
resetButtonAriaLabel: 'Effacer',
|
|
164
|
+
cancelButtonText: 'Annuler',
|
|
165
|
+
cancelButtonAriaLabel: 'Annuler'
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
}));
|
|
170
|
+
_context4.next = 3;
|
|
171
|
+
return waitFor(function () {
|
|
172
|
+
fireEvent.click(document.querySelector('.DocSearch-Button'));
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
case 3:
|
|
176
|
+
expect(document.querySelector('.DocSearch-Cancel').innerHTML).toBe('Annuler');
|
|
177
|
+
expect(document.querySelector('.DocSearch-Cancel').getAttribute('aria-label')).toBe('Annuler');
|
|
178
|
+
expect(document.querySelector('.DocSearch-Reset').getAttribute('title')).toBe('Effacer');
|
|
179
|
+
expect(document.querySelector('.DocSearch-Reset').getAttribute('aria-label')).toBe('Effacer');
|
|
180
|
+
|
|
181
|
+
case 7:
|
|
182
|
+
case "end":
|
|
183
|
+
return _context4.stop();
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
}, _callee4);
|
|
187
|
+
})));
|
|
188
|
+
it('overrides the default DocSearchModal footer text', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee5() {
|
|
189
|
+
return regeneratorRuntime.wrap(function _callee5$(_context5) {
|
|
190
|
+
while (1) {
|
|
191
|
+
switch (_context5.prev = _context5.next) {
|
|
192
|
+
case 0:
|
|
193
|
+
render( /*#__PURE__*/React.createElement(DocSearch, {
|
|
194
|
+
translations: {
|
|
195
|
+
modal: {
|
|
196
|
+
footer: {
|
|
197
|
+
closeText: 'Fermer',
|
|
198
|
+
navigateText: 'Naviguer',
|
|
199
|
+
searchByText: 'Recherche par',
|
|
200
|
+
selectText: 'Selectionner'
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
}));
|
|
205
|
+
_context5.next = 3;
|
|
206
|
+
return waitFor(function () {
|
|
207
|
+
fireEvent.click(document.querySelector('.DocSearch-Button'));
|
|
208
|
+
});
|
|
209
|
+
|
|
210
|
+
case 3:
|
|
211
|
+
expect(screen.getByText('Recherche par')).toBeInTheDocument();
|
|
212
|
+
expect(screen.getByText('Fermer')).toBeInTheDocument();
|
|
213
|
+
expect(screen.getByText('Naviguer')).toBeInTheDocument();
|
|
214
|
+
expect(screen.getByText('Selectionner')).toBeInTheDocument();
|
|
215
|
+
|
|
216
|
+
case 7:
|
|
217
|
+
case "end":
|
|
218
|
+
return _context5.stop();
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
}, _callee5);
|
|
222
|
+
})));
|
|
223
|
+
});
|
|
224
|
+
});
|