-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Answers -> Search #143
Answers -> Search #143
Conversation
* Update README.md * README and package updates * prelim renaming * Deprecation tag and exports updates * public deprecation message * Deprecation fix * Update index.ts * Delete deprecation.test.tsx * deprecated file * fix lint issues * more updates * test fixes * readme fix * fix types exports
* renamed answers-headless imports * Automated update to THIRD-PARTY-NOTICES from github action's 3rd party notices check * version update * update license Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
README.md
Outdated
|
||
For users that want to use class components instead of functional components, you can use the `AnswersHeadlessContext` directly to dispatch actions and receive updates from state. | ||
For users that want to use class components instead of functional components, you can use the `SearchHeadlessContext` directly to dispatch actions, and the `subscribeToStateUpdates` HOC to receive updates from state. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
subscribeToStateUpdates
was recently deprecated, so it looks like some changes in develop
were reverted. this feature branch may need to be rebased off of the latest develop
src/deprecated.ts
Outdated
} | ||
|
||
/** | ||
* @deprecated useAnswersUtilities has been deprecated and repalced by useSearchUtilities |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: "replaced"
src/deprecated.ts
Outdated
export function useAnswersUtilities(): SearchUtilities { return useSearchUtilities(); } | ||
|
||
/** | ||
* @deprecated AnswersHeadlessProvider has been deprecated and replaced by SearfchHeadlessProvider |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: "SearchHeadlessProvider"
## Version 1.3.0 `@yext/answers-headless-react` is now `@yext/search-headless-react`! This means that much of the `answers` terminology is now deprecated and have been replaced by new `search` terms. ### Changes - The following identifiers were renamed in (#143): - `AnswersHeadlessContext` → `SearchHeadlessContext` - `AnswersActions` → `SearchActions` - `AnswersUtilities` → `SearchUtilities` - `useAnswersActions` → `useSearchActions` - `useAnswersState` → `useSearchState` - `useAnswersUtilities` → `useSearchUtilities` - `AnswersHeadlessProvider` → `SearchHeadlessProvider` - Additionally, direct exports from what was previously `@yext/answers-headless` have been replaced by their `@yext/search-headless` counterparts: - `answersUtilities` → `searchUtilities` - `provideAnswersHeadless` → `provideHeadless` - `AnswersHeadless` → `SearchHeadless` - `AnswersConfig` → `SearchConfig` - `AnswersConfigWithToken` → `SearchConfigWithToken` - `AnswersConfigWithApiKey` → `SearchConfigWithApiKey` - `AnswersCore` → `SearchCore` - `AnswersError` → `SearchError` - `AnswersRequest` → `SearchRequest` - `BaseAnswersConfig` → `BaseSearchConfig` - Finally, `subscribeToStateUpdates` was deprecated in (#142)
J=SLAP-2196
TEST=auto