Wondering what’s next for npm?Check out our public roadmap! »

react-radio-group
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/react-radio-group package

2.0.1 • Public • Published

React-radio-group

npm install react-radio-group

Then either require('react-radio-group') or add node_modules/react-radio-group/lib/index.js into your HTML file.

What This Solves

This is your average radio buttons group:

<form>
  <input type="radio" name="fruit" value="apple" />Apple
  <input type="radio" name="fruit" value="orange" />Orange
  <input type="radio" name="fruit" value="watermelon" />Watermelon
</form>

A few problems:

  • Repetitive fields (name, type, checked, onChange).
  • Hard to set the checked value. You need to put e.g. checked={'apple' === this.state.selectedFruitName} on every input.
  • Hard to retrieve the selected value.

Here's a better version (full example here)

<RadioGroup name="fruit" selectedValue={this.state.selectedValue} onChange={this.handleChange}>
  {Radio => (
    <div>
      <Radio value="apple" />Apple
      <Radio value="orange" />Orange
      <Radio value="watermelon" />Watermelon
    </div>
  )}
</RadioGroup>

Repetitive fields are either lifted onto the RadioGroup wrapper or already implicitly set on the Radio component, which is a simple wrapper around the radio input.

Formal API

<RadioGroup />

Exposes 4 optional props:

  • name: String: what you'd normally put on the radio inputs themselves.
  • selectedValue: String | Number: the currently selected value. This will be used to compare against the values on the Radio components to select the right one.
  • onChange: Function: will be passed the newly selected value.
  • children: Function: will be passed a Radio component (a thin wrapper around input) some fields like type, name and checked already set.

<Radio />

(Since you're getting that as the argument of your children function, you could have named it anything you wanted really.) Any prop you pass onto it will be transferred to the actual input under the hood.

License

MIT

Install

npm i [email protected]

Version

2.0.1

License

MIT

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar