docs: fix AutoCompleteInput example in usage docs #266
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.
Overview
This PR fixes issues in the AutoCompleteInput example code in the documentation:
clearTimeout(searchTimeoutRef.current)
logic and kept cleanup-only execution.useOutsideClickEffect
usage by directly passingcloseSearchBox
.Separated
component prop fromwith
toby
, which matches the correct API signature.These changes make the docs match the intended API usage and improve readability for contributors and users.
Checklist
yarn run fix
to format and lint the code and docs?yarn run test:coverage
to make sure there is no uncovered line? (Not applicable, documentation only)additinal comment
react-simplikit, 선택의 이유 docs
with-react-simplikit.tsx
In the example code,searchResults
is an asynchronous function, so TypeScript infers its return type asPromise<void>
.However, the debounced function returned by useDebounce is designed to return void when called, so its actual runtime return type is void.
Therefore, passing it as an argument to
startLoading
, which expects a Promise, causes a type error.To fix this, either the return type of debounce should be changed to
Promise<void>
or in the example code,
startLoading
should be called with an explicit Promise, like this:This way, the expected Promise type is matched properly.
I'd like to hear from admins on which of the two approaches would be better, or if the example should be changed!