https://github.com/reactwaylabs/dropdown

A flexible React dropdown component.
https://github.com/reactwaylabs/dropdown

component dropdown react react-component

Last synced: 8 days ago
JSON representation

A flexible React dropdown component.

• Host: GitHub
• URL: https://github.com/reactwaylabs/dropdown
• Owner: reactwaylabs
• License: mit
• Created: 2017-04-06T17:26:21.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T15:14:52.000Z (about 2 years ago)
• Last Synced: 2025-01-07T19:28:27.556Z (21 days ago)
• Topics: component, dropdown, react, react-component
• Language: TypeScript
• Homepage:
• Size: 624 KB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![NPM version](https://img.shields.io/npm/v/@reactway/dropdown.svg?logo=npm)](https://www.npmjs.com/package/@reactway/dropdown)

[![Build Status](https://img.shields.io/azure-devops/build/reactway/reactway/1/master.svg?logo=azuredevops)](https://dev.azure.com/reactway/ReactWay/_build?definitionId=1)

[![Code coverage](https://img.shields.io/azure-devops/coverage/reactway/reactway/1/master.svg)](https://dev.azure.com/reactway/ReactWay/_build?definitionId=1)

[![Dependencies](https://img.shields.io/david/reactway/dropdown.svg)](https://dev.azure.com/reactway/ReactWay/_build?definitionId=1)

[![Dev dependencies](https://img.shields.io/david/dev/reactway/dropdown.svg)](https://dev.azure.com/reactway/ReactWay/_build?definitionId=1)

# @reactway/dropdown

## [Docs](./docs/index.md) | [API](./docs/api/index.md)

A flexible React dropdown component. Created with hooks :tada:.

## Get started 

```sh

$ npm install @reactway/dropdown

```

## Features

- Toggles dropdown when clicked on `DropdownHeader` component

- Closes dropdown when clicked outside of `DropdownHandler` component*

- Closes dropdown when clicked on `DropdownSection` component

- Closes dropdown when clicked Escape button on keyboard

- Extendable base components

- Supports server side rendering

* This will not work when click event has stopped propagation (`event.stopPropagation()`) and therefore `window.addEventListener("click", ...)` will not receive event.

## License

Released under the [MIT license](LICENSE).