Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@redocly/react-dropdown-aria
Advanced tools
Readme
Simple, lightweight, and accessible React dropdown component.
This component was created to be a light weight and fully accessible dropdown component for React. For a more feature heavy and powerful dropdown look to the react-select package. (This dropdown is inspired by react-select)
Please take note when upgrading from v1 to v2 there are breaking changes. Be sure to carefully read the changelog entry for v2.0.0.
For demo and examples see https://jfangrad.github.io/react-dropdown-aria/
Simply use npm or yarn to install the package.
// Yarn
$ yarn add react-dropdown-aria
// npm
$ npm install --save react-dropdown-aria
You can then include it in your project as needed:
import Dropdown from 'react-dropdown-aria';
Options should be provided to the Dropdown as an array of objects.
<Dropdown
...
options: {[
{ value: 'one' },
{ value: 'two' },
{ value: 'three' }
]}
/>
Each option object in the array of options can have the following keys:
key | Type | Default | Description |
---|---|---|---|
ariaLabel | string | null | Aria Label to be applied to the option |
className | string | null | CSS class to be applied to this option |
title | string | null | HTML title to be used for the option |
value | string | null | The value to be displayed in the dropdown (Required) |
Groups of items can also be implemented by pasing an array of objects of the following form to the dropdown options prop:
<Dropdown
...
options: {[
{ label: 'Group 1', groupOptions: optionsGroup1 },
{ label: 'Group 2', groupOptions: optionsGroup2 },
]}
/>
Where the groupOptions
is an array of options as described above, and the label
is the string to display above the group in the dropdown.
Custom styling can be applied using CSS className props (As seen in props table below)
Property | Type | Default | Description |
---|---|---|---|
ariaDescribedBy | string | null | ID of element that should be used to describe the dropdown |
ariaLabel | string | null | Aria Label to be applied to the main dropdown button |
ariaLabelledBy | string | null | ID of element that should be used as the label for the dropdown |
arrowRenderer | function | undefined | Custom function to render the arrow for the dropdown |
centerText | boolean | false | Whether main dropdown button text should be centered or not |
className | string | undefined | CSS class to be applied to the drodown |
contentClassName | string | undefined | CSS class to be applied to the dropdown option ul container |
defaultOpen | boolean | false | Whether the dropdown should be open by default |
disabled | boolean | false | Whether the dropdown should be disabled or not |
height | number | null | Use to set the dropdown height manually |
hideArrow | boolean | false | Controls whether dropdown component has the arrow or not |
id | string | undefined | id to be passed to the main dropdown button |
maxContentHeight | number | null | Controls the max height of the dropdown area that contains all options |
openUp | boolean | false | Whether dropdown should open up or not |
optionRenderer | function | undefined | Custom function to render the options displayed in the dropdown |
options | array | [] | Array of option objects |
optionClassName | string | undefined | CSS class to be applied to all options in the dropdown |
pageKeyTraverseSize | number | 10 | Number of options page up or page down will move the current focused by |
placeholder | string | Select... | Placeholder value for dropdown |
value | string | null | The value of the option that is currently selected (as set by setSelected ). |
selectedValueClassName | string | undefined | CSS class to be applied to main drodown button text |
searchable | boolean | true | Whether or not the keyboard can be used to quickly navigate to an item through typing |
onChange | function | undefined | Function called when the selected value changes |
style | object | {} | Use to change the style of the dropdown through js instead of css (see styling section) |
width | number | null | Use to set the dropdown width manually |
Clone the repo
git clone https://github.com/jfangrad/react-dropdown-aria.git
Install node modules
yarn install
Then in two seperate consoles start the library and demo
yarn lib:dev
yarn demo:dev
FAQs
Simple and accessible React dropdown component
The npm package @redocly/react-dropdown-aria receives a total of 33,719 weekly downloads. As such, @redocly/react-dropdown-aria popularity was classified as popular.
We found that @redocly/react-dropdown-aria demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.