You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.
The release of v1.0.0 of this package has been very delayed, apologies for that.
Considering the package is still being used by some people and is getting regular downloads, getting a head-start on the second version is only necessary.
Why?
The second version will be a complete rewrite of the package. In the current version, the package was written very casually. Simple stuff like PropTypes were ignored in order to get the package out as quick as possible.
Version 2 aims to rectify these discrepancies, and make the component compatible with future versions of React.
What's in the new version?
There will be some breaking changes in terms of methods and properties both. Right now, the entire functionality is written in one file. The focus on maintainability and scalability, coupled with better documentation and warnings in dev mode.
onKeyUp and onKeyDown methods will be deprecated in favour of onKeyPress
Custom rendering for options
openUp improvements
disableEnter to be removed
inputProps to add props directly to the input tag
Native support for debouncing/throttling
Asynchronous options support
Additionally
In v1.0.1, ESLint, Prettier and lint rules were added. v2.0.0 plans to build the entire code-base on it, something which should have been done from the start.
There will be tests written using Enzyme, and proper coverage provided.
The docs are also going to be written from scratch. That being said, the entire code will be documented, to enable contributors to easily understand the code. A lot more usage and code examples will be created.
The text was updated successfully, but these errors were encountered:
The release of
v1.0.0
of this package has been very delayed, apologies for that.Considering the package is still being used by some people and is getting regular downloads, getting a head-start on the second version is only necessary.
Why?
The second version will be a complete rewrite of the package. In the current version, the package was written very casually. Simple stuff like PropTypes were ignored in order to get the package out as quick as possible.
Version 2 aims to rectify these discrepancies, and make the component compatible with future versions of React.
What's in the new version?
There will be some breaking changes in terms of methods and properties both. Right now, the entire functionality is written in one file. The focus on maintainability and scalability, coupled with better documentation and warnings in dev mode.
onKeyUp
andonKeyDown
methods will be deprecated in favour ofonKeyPress
openUp
improvementsdisableEnter
to be removedinputProps
to add props directly to the input tagAdditionally
In
v1.0.1
, ESLint, Prettier and lint rules were added.v2.0.0
plans to build the entire code-base on it, something which should have been done from the start.There will be tests written using Enzyme, and proper coverage provided.
The docs are also going to be written from scratch. That being said, the entire code will be documented, to enable contributors to easily understand the code. A lot more usage and code examples will be created.
The text was updated successfully, but these errors were encountered: