feat(core): introduce getWidgetUiState lifecycle hook (1/n)
#4454
+256
−156
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
This deprecates `getWidgetState` to `getWidgetUiState` to make the upcoming `getWidgetRenderState` less confusing.
ghost
requested review from
eunjae-lee and
yannickcr
and removed request for
a team
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 387c285:
|
Haroenv
reviewed
Jul 27, 2020
| @@ -426,6 +435,11 @@ const index = (props: IndexProps): Index => { | |||
| }); | |||
|
|
|||
| localWidgets.forEach(widget => { | |||
| warning( | |||
There was a problem hiding this comment.
Suggested change
| warning( | |
| // @major drop support for getWidgetState alias | |
| warning( |
Not sure if here's the good spot, but I think we should have a comment we can easily search for somewhere for this change
Haroenv
pushed a commit
that referenced
this pull request
Nov 30, 2020
This deprecates `getWidgetState` to `getWidgetUiState` to make the upcoming `getWidgetRenderState` less confusing.
Haroenv
pushed a commit
that referenced
this pull request
Nov 30, 2020
This deprecates `getWidgetState` to `getWidgetUiState` to make the upcoming `getWidgetRenderState` less confusing.
Haroenv
added a commit
that referenced
this pull request
Dec 9, 2020
* feat(core): introduce `getWidgetUiState` lifecycle hook (1/n) (#4454) This deprecates `getWidgetState` to `getWidgetUiState` to make the upcoming `getWidgetRenderState` less confusing. * feat(core): introduce `getWidgetRenderState` (2/n) (#4457) This introduces the widget lifecycle hook `getWidgetRenderState` and implements it for `connectSearchBox`. * feat(autocomplete): implement `getWidgetRenderState` (#4466) * feat(breadcrumb): implement `getWidgetRenderState` (#4467) * feat(clearRefinements): implement `getWidgetRenderState` (#4468) * feat(configure): implement `getWidgetRenderState` (#4469) * feat(currentRefinements): implement `getWidgetRenderState` (#4470) * fix(breadcrumb): add attribute to render state (#4472) * feat(hierarchicalMenu): implement `getWidgetRenderState` (#4471) * fix: provide both `getWidgetRenderState` and `getRenderState` in connectors (#4518) * WIP * remove temporary implementation * rename getWidgetRenderState to getRenderState * fix wrong parameter name * update panel * update comment * chore: remove panel-related code * fixing types WIP * fix type * do not cast the return of getWidgetRenderState * Revert "do not cast the return of getWidgetRenderState" This reverts commit 614bc53. * Revert "fix type" This reverts commit 54e31fc. * add TWidgetRenderState to connector * add generics to Widget for getWidgetRenderState * fix to allow nullish getWidgetRenderState when unknown * remove exclamation marks * remove the type for widgetParams (was experimental) * make getRenderState optional for widgets with default generics * update other connectors to follow new connector type * update types in tests * add comment * do not declare individual widget render state types * feat(hits): implement `getWidgetRenderState` (#4525) * feat(range): implement `getRenderState` and `getWidgetRenderState` (#4536) * fix(types): fix type errors (#4537) * fix type errors * fix type errors * simplify test util * update type of widgetParams * add lifecycle methods * fixing breadcrumb widget * revert the change (let's do this in later iteration) * add lifecycle methods for places widget * replace WidgetFactory with Factory * remove unnecessary part * rename options to params * Revert "remove unnecessary part" This reverts commit 5b2ed14. * Revert "replace WidgetFactory with Factory" This reverts commit ee125bd. * fix getRenderState of places and analytics * feat(poweredBy): getWidgetRenderState (#4551) * feat(poweredBy): getWidgetRenderState DX-206 * fix jsdoc * feat(menu): implement `getRenderState` and `getWidgetRenderState` (#4540) * feat(menu): implement `getRenderState` and `getWidgetRenderState` * Removed duplicated declaration of `jsHelper`, moved `cachedToggleShowMore` binding to `init` to avoid it happens more than once * feat(renderState): add connectNumericMenu (#4550) * feat(renderState): add connectNumericMenu DX-204 * Apply suggestions from code review Co-authored-by: Yannick Croissant <[email protected]> * Apply suggestions from code review Co-authored-by: Yannick Croissant <[email protected]> * POC: Add telemetry * Update src/widgets/configure-related-items/configure-related-items.ts Co-authored-by: Haroen Viaene <[email protected]> * Use full Schema * POC: Add telemetry 2 * Use middleware * move code a little * chore: fix type of middleware TODO: make sure this stays on rebase Co-authored-by: François Chalifour <[email protected]> Co-authored-by: Eunjae Lee <[email protected]> Co-authored-by: Yannick Croissant <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]> Co-authored-by: Yannick Croissant <[email protected]>
Haroenv
added a commit
that referenced
this pull request
Dec 18, 2020
* feat(core): introduce `getWidgetUiState` lifecycle hook (1/n) (#4454) This deprecates `getWidgetState` to `getWidgetUiState` to make the upcoming `getWidgetRenderState` less confusing. * feat(core): introduce `getWidgetRenderState` (2/n) (#4457) This introduces the widget lifecycle hook `getWidgetRenderState` and implements it for `connectSearchBox`. * feat(autocomplete): implement `getWidgetRenderState` (#4466) * feat(breadcrumb): implement `getWidgetRenderState` (#4467) * feat(clearRefinements): implement `getWidgetRenderState` (#4468) * feat(configure): implement `getWidgetRenderState` (#4469) * feat(currentRefinements): implement `getWidgetRenderState` (#4470) * fix(breadcrumb): add attribute to render state (#4472) * feat(hierarchicalMenu): implement `getWidgetRenderState` (#4471) * fix: provide both `getWidgetRenderState` and `getRenderState` in connectors (#4518) * WIP * remove temporary implementation * rename getWidgetRenderState to getRenderState * fix wrong parameter name * update panel * update comment * chore: remove panel-related code * fixing types WIP * fix type * do not cast the return of getWidgetRenderState * Revert "do not cast the return of getWidgetRenderState" This reverts commit 614bc53. * Revert "fix type" This reverts commit 54e31fc. * add TWidgetRenderState to connector * add generics to Widget for getWidgetRenderState * fix to allow nullish getWidgetRenderState when unknown * remove exclamation marks * remove the type for widgetParams (was experimental) * make getRenderState optional for widgets with default generics * update other connectors to follow new connector type * update types in tests * add comment * do not declare individual widget render state types * feat(hits): implement `getWidgetRenderState` (#4525) * feat(range): implement `getRenderState` and `getWidgetRenderState` (#4536) * fix(types): fix type errors (#4537) * fix type errors * fix type errors * simplify test util * update type of widgetParams * add lifecycle methods * fixing breadcrumb widget * revert the change (let's do this in later iteration) * add lifecycle methods for places widget * replace WidgetFactory with Factory * remove unnecessary part * rename options to params * Revert "remove unnecessary part" This reverts commit 5b2ed14. * Revert "replace WidgetFactory with Factory" This reverts commit ee125bd. * fix getRenderState of places and analytics * feat(poweredBy): getWidgetRenderState (#4551) * feat(poweredBy): getWidgetRenderState DX-206 * fix jsdoc * feat(menu): implement `getRenderState` and `getWidgetRenderState` (#4540) * feat(menu): implement `getRenderState` and `getWidgetRenderState` * Removed duplicated declaration of `jsHelper`, moved `cachedToggleShowMore` binding to `init` to avoid it happens more than once * feat(renderState): add connectNumericMenu (#4550) * feat(renderState): add connectNumericMenu DX-204 * Apply suggestions from code review Co-authored-by: Yannick Croissant <[email protected]> * Apply suggestions from code review Co-authored-by: Yannick Croissant <[email protected]> * POC: Add telemetry * Update src/widgets/configure-related-items/configure-related-items.ts Co-authored-by: Haroen Viaene <[email protected]> * Use full Schema * POC: Add telemetry 2 * Use middleware * move code a little * chore: fix type of middleware TODO: make sure this stays on rebase Co-authored-by: François Chalifour <[email protected]> Co-authored-by: Eunjae Lee <[email protected]> Co-authored-by: Yannick Croissant <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]> Co-authored-by: Yannick Croissant <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This deprecates
getWidgetStatetogetWidgetUiStateto make the upcominggetWidgetRenderStateless confusing.getWidgetStatestill works a previously, but displays a warning. We'll stop supporting this naming from InstantSearch.js v5.Related