REACT VIRTUAL SELECT

Use React Select with virtualized options.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

This project was initially built as a side project, because we spent a some time tweaking React Select to work with our specific use cases, and we used React Virtualized in another part of an application we were working together in.

We saw there was another library, React Virtual, that might be more updated than React Virtualized, and this was a use case we could try and learn how to use it as well.

Built With

• React-Select
• React-Virtual

(back to top)

Getting Started

This project has a monorepo structure and uses yarn workspaces to handle dependencies. To get a local copy up and running follow these steps.

Installation

1. Clone the repo

   git clone https://github.com/lucbpz/react-virtual-select.git

2. Install NPM packages

   yarn install

3. Launch a demo app with React Virtual Select

   yarn dev

4. Launch documentation website locally

   cd docs && yarn dev

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• [] Make React Virtual Select work!
• [] Export types
• [] Have nice docs
• [] Test with Cypress

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Check out our Contributing file!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Adrián Serrano - @adrserr

Lucas Bernalte - @lucasbernalte

Project Link: https://github.com/lucbpz/react-virtual-select

(back to top)