vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
31294de36c
DefinitelyTyped/types/react-autosuggest/README.md
Kevin Ross ed9e0f6d14 Update react-autosuggest signatures, documentation, use generic type 
- Convert Autosuggest component to a generic
- Update the renderSuggestionsContainer signature
- Add readme with usage example
- Document component props
- Export function types for easier reuse/passing in as props
2017-11-29 09:28:28 -06:00

914 B
Raw Blame History

react-autosuggest usage notes

The definition uses generics for stronger typing. Read the TypeScript deep dive on JSX Generic components for details on consuming these type definitions.

Example

import * as Autosuggest from 'react-autosuggest'
interface Language {
    name: string
    year: number
}

const LanguageAutosuggest = Autosuggest as { new (): Autosuggest<Language> }

<LanguageAutosuggest
    suggestions={suggestions}
    onSuggestionsFetchRequested={this.onSuggestionsFetchRequested.bind(this)}
    getSuggestionValue={this.getSuggestionValue}
    renderSuggestion={this.renderSuggestion}
    onSuggestionSelected={this.onSuggestionsSelected}
    alwaysRenderSuggestions={true}
    inputProps={inputProps}
    theme={theme}
/>

Find multiple full examples in react-autosuggest-tests.tsx