Skip to content
This repository has been archived by the owner on Dec 30, 2022. It is now read-only.

docs(connectors): fix spelling and wording [STEP 8] #2190

Merged
merged 1 commit into from
Apr 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,17 @@ export default createConnector({
});
},

/* connectAutoComplete needs to be considered as a widget to trigger a search if no others widgets are used.
* To be considered as a widget you need either getSearchParameters, getMetadata or getTransitionState
* See createConnector.js
* */
/**
* AutoComplete needs to be considered as a widget to trigger a search,
* even if no other widgets are used.
*
* To be considered as a widget you need either:
* - getSearchParameters
* - getMetadata
* - transitionState
*
* See: createConnector.tsx
*/
getSearchParameters(searchParameters, props, searchState) {
return searchParameters.setQuery(
getCurrentRefinement(props, searchState, {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,17 @@ export default createConnector({
return { hits: hitsWithPositionsAndQueryID };
},

/* Hits needs to be considered as a widget to trigger a search,
/**
* Hits needs to be considered as a widget to trigger a search,
* even if no other widgets are used.
*
* To be considered as a widget you need either:
* - getSearchParameters
* - getMetadata
* - getTransitionState
* - transitionState
*
* See: createConnector.tsx
* */
*/
getSearchParameters(searchParameters) {
return searchParameters;
},
Expand Down
9 changes: 5 additions & 4 deletions packages/react-instantsearch/index.umd.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
/* eslint-disable */

// This file exists only for the legacy UMD `Core` file. Sinc eRollup
// This file exists only for the legacy UMD `Core` file. Since Rollup
// is not able to correctly tree-shake the file we directly import the
// exported file. It avoid to have a huge jump in filesize (8KB => 40 KB).
// exported file. It avoid to have a huge jump in file size (8KB => 40 KB).

// prettier-ignore
export { default as createConnector } from 'react-instantsearch-core/dist/es/core/createConnector';
export {
default as createConnector,
} from 'react-instantsearch-core/dist/es/core/createConnector';