This repository has been archived by the owner on Dec 16, 2022. It is now read-only.
feat(react instantsearch widget): add connector and widget metadata #570
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dhayab
commented
May 19, 2022
Comment on lines
8
to
13
| type Connector<TProvided = {}, TExposed = {}> = (( | ||
| stateless: React.FunctionComponent<ConnectorProvided<TProvided>> | ||
| ) => React.ComponentClass<TExposed>) & | ||
| (<TProps extends Partial<ConnectorProvided<TProvided>>>( | ||
| Composed: React.ComponentType<TProps> | ||
| ) => ConnectedComponentClass<TProps, ConnectorProvided<TProvided>, TExposed>); |
There was a problem hiding this comment.
The only way I could find to fix a TypeScript error during build:types is to explicitly set the type (by copying it from @types/react-instantsearch-core) and assign it to the connector.
Here's the issue for reference:
$ tsc -p tsconfig.declaration.json
src/lib/connector.ts:19:14 - error TS2742: The inferred type of 'connectWidget' cannot be named without a reference to 'react-instantsearch-core/node_modules/@types/react'. This is likely not portable. A type annotation is necessary.
19 export const connectWidget = createConnector<ProvidedProps>({
~~~~~~~~~~~~~
dhayab
commented
May 19, 2022
| type WidgetParams = { | ||
| /** | ||
| * Placeholder text for input element. | ||
| */ | ||
| placeholder?: string; | ||
| }; | ||
|
|
||
| export const {{ pascalCaseName }}: ElementType<WidgetParams> = | ||
| connect{{ pascalCaseName }}({{ pascalCaseName }}Component); | ||
| export const {{ pascalCaseName }}: React.ElementType<WidgetParams> = connect{{ pascalCaseName }}( |
There was a problem hiding this comment.
The change from ElementType to React.ElementType fixes a TypeScript error during build:types. I don't know why though.
dhayab
requested review from
a team,
FabienMotte,
sarahdayan and
Haroenv
and removed request for
a team
Haroenv
reviewed
May 19, 2022
Haroenv
approved these changes
May 19, 2022
aymeric-giraudet
pushed a commit
to algolia/instantsearch
that referenced
this pull request
Dec 14, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for
$$typeand$$widgetTypein the React InstantSearch Widget template. It also addresses some build issues.Ticket: FX-993
Result
$$typeand$$widgetType(to{{ organization }}.{{ widgetName }}by default)InstantSearchfromreact-instantsearch-dom