/github-issue-search

Primary LanguageTypeScript

Github Issue Search

This project was bootstrapped with Create React App.

It provides a component for searching Github issues. The repo is configured for facebook/react, but can easily be changed via the repo prop. The search input will autocomplete results, allowing the user to either click on results or use the up/down/enter keys to select a desired result. The format of the autocomplete results can be customized using the renderItem render prop and the selected result can be retrieved by the parent using the onSelect callback. The Github search API has a small rate limit, so a debounce on the search is provided.

<GithubIssueSearch
  renderItem={({ item }) => <>{item.title}</>}
  onSelect={(item) => setItem(item)}
  debounceDelay={600}
  repo="facebook/react"
/>

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.