feat(core): rename searchBoxElement to formElement
#374
Conversation
BREAKING CHANGE
|
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 ed0004b:
|
| @@ -18,9 +18,9 @@ export interface AutocompleteAccessibilityGetters< | |||
|
|
|||
| export type GetEnvironmentProps = (props: { | |||
| [key: string]: unknown; | |||
| searchBoxElement: HTMLElement; | |||
| panelElement: HTMLElement; | |||
| formElement: HTMLElement; | |||
There was a problem hiding this comment.
is this the form or the form container?
There was a problem hiding this comment.
should it not be HTMLFormElement then?
There was a problem hiding this comment.
We could restrict it indeed. It's only used to determine if we should close the panel on scroll so I'm not sure how restrictive we should be: https://github.com/algolia/autocomplete.js/blob/ed0004bc107517c4526491d4b959a483689e5acf/packages/autocomplete-core/src/getPropGetters.ts#L52
There was a problem hiding this comment.
Do we not add submit and reset event listeners on the form to prevent default? Or is that somewhere else? In any case, it's not really blocking the PR
There was a problem hiding this comment.
Nope, this is coming from getFormProps.
This renames the
getEnvironmentPropsparam fromsearchBoxElementtoformElement, which fits better the other namings (e.g.,getFormProps).BREAKING CHANGE.