react-dropd v1.1.3-alpha.0

✨ Pros:

• 📦 ~3kb (gzipped)
• 🙅‍♂️ Zero dependencies
• 📱Supports touch devices
• ⚒ CommonJS and ES Modules support
• ✅ Optimized for Accessibilty
• 🌈 Easy to customize
• 🦄 Optimized for performance
• 💅 More-reliant on CSS over JavaScript

🔧 Installation

$ npm install react-dropd --save

📖 Usage

Import the component

import Dropd from 'react-dropd'

Now, you can use it:

<Dropd
  placeholder="Choose an ice cream topping"
  onOpen={(list, event) => console.log(list, event)}
  list={['Caramel', 'Peanut butter', 'Sundae', 'Oreos']}
/>

Props

list: {Array}

Default: []

Description: An array of strings or objects to be used as dropdown items. If you are using an array of objects, ensure you have a label key. e.g [{label: 'Caramel', value: 'caramel'}]).

closeOnBlur: {Boolean}

Default: true

Description: Specifies whether the dropdown should be closed when the user clicks away.

defaultOpen: {Boolean}

Default: false

Description: Specifies whether the dropdown should be open by default (i.e when the component is mounted).

value: {String|Object}

Default: null

Description: Specifies the currently selected item. value can be from list or manually set.

placeholder: {String|Object}

Default: Please select an item

Description: Specifies a placeholder for the dropdown. Very similar to the placeholder attribute on html inputs.

revealOn: {mousedown|mouseover}

Note: Not implemented yet.

Default: mousedown

Description: Specifies what event should trigger opening and closing the dropdown.

Events

onOpen: {(list, event)}

list: The list that was received via props.

event: If triggered by #1 condition below, null, otherwise SyntheticEvent of whatever triggered opening of the dropdown.

This event is only emitted when:

1. defaultOpen is set to true. Note that event here would be set to null since the dropdown was programatically opened.
2. A mouse down event is fired on the toggle button when the dropdown is closed.
3. The toggle button is focused via navigation with the tab key.

onItemChange: {(currentItem, event)}

currentItem: The new item that was selected from the list.

event: SyntheticEvent of the element when clicked.

This event is only emitted when an item in the dropdown list is clicked.

👀 Examples

⚡️ React Dropd on CodeSandbox

👷 Contributing

Please see Projects for a list of things to do.

1. Fork this repo and clone on your machine
2. Navigate to the main folder, dropd
3. Create a new branch using the format, feature/feature-name
4. Run yarn install -W to install all of the dependencies in the workspace
5. Use yarn dev:react to monitor the changes you make in /packages/react-dropd and concurrently re-build or
6. Use yarn build:react to compile packages/react-dropd/index.js (shows bundlesize info too)

🔗 See Also

vue-dropd

🤝 License

MIT © Olaolu Olawuyi