File size: 3,652 Bytes
1e92f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | import React, { Component, Children } from 'react';
import PropTypes from 'prop-types';
import type { InstantSearchContext, IndexContext } from '../core/context';
import { InstantSearchConsumer, IndexProvider } from '../core/context';
function getIndexContext(props: Props): IndexContext {
return {
targetedIndex: props.indexId,
};
}
type Props = {
indexName: string;
indexId: string;
children?: React.ReactNode;
};
type InnerProps = Props & { contextValue: InstantSearchContext };
type State = {
indexContext: IndexContext;
};
/**
* The component that allows you to apply widgets to a dedicated index. It's
* useful if you want to build an interface that targets multiple indices.
*
* @example
* import React from 'react';
* import algoliasearch from 'algoliasearch/lite';
* import { InstantSearch, Index, SearchBox, Hits, Configure } from 'react-instantsearch-dom';
*
* const searchClient = algoliasearch(
* 'latency',
* '6be0576ff61c053d5f9a3225e2a90f76'
* );
*
* const App = () => (
* <InstantSearch
* searchClient={searchClient}
* indexName="instant_search"
* >
* <Configure hitsPerPage={5} />
* <SearchBox />
* <Index indexName="instant_search">
* <Hits />
* </Index>
* <Index indexName="bestbuy">
* <Hits />
* </Index>
* </InstantSearch>
* );
*/
class Index extends Component<InnerProps, State> {
static propTypes = {
indexName: PropTypes.string.isRequired,
indexId: PropTypes.string.isRequired,
children: PropTypes.node,
};
static displayName = 'AlgoliaIndex';
static $$type = 'ais.index';
static $$widgetType = 'ais.index';
static getDerivedStateFromProps(props: InnerProps) {
return {
indexContext: getIndexContext(props),
};
}
state = {
indexContext: getIndexContext(this.props),
};
unregisterWidget?: () => void;
constructor(props: InnerProps) {
super(props);
this.props.contextValue.onSearchParameters(
this.getSearchParameters.bind(this),
{
ais: this.props.contextValue,
multiIndexContext: this.state.indexContext,
},
this.props,
undefined,
Index.displayName
);
}
componentDidMount() {
this.unregisterWidget =
this.props.contextValue.widgetsManager.registerWidget(this);
}
componentDidUpdate(prevProps: InnerProps) {
if (this.props.indexName !== prevProps.indexName) {
this.props.contextValue.widgetsManager.update();
}
}
componentWillUnmount() {
if (typeof this.unregisterWidget === 'function') {
this.unregisterWidget();
}
}
getSearchParameters(searchParameters, props: InnerProps) {
return searchParameters.setIndex(
this.props ? this.props.indexName : props.indexName
);
}
render() {
const childrenCount = Children.count(this.props.children);
if (childrenCount === 0) {
return null;
}
return (
<IndexProvider value={this.state.indexContext}>
{this.props.children}
</IndexProvider>
);
}
}
type IndexWrapperProps = {
indexName: string;
indexId?: string;
};
const IndexWrapper: React.FC<IndexWrapperProps> = (props) => {
const inferredIndexId = props.indexName;
return (
<InstantSearchConsumer>
{(contextValue) => (
<Index
contextValue={contextValue}
indexId={inferredIndexId}
{...props}
/>
)}
</InstantSearchConsumer>
);
};
IndexWrapper.propTypes = {
indexName: PropTypes.string.isRequired,
indexId: PropTypes.string,
};
export const IndexComponentWithoutContext = Index;
export default IndexWrapper;
|