react-radio-select v0.3.8

React Radio Select

<RadioSelect> is a customizable alternative for html <select> made of radio buttons.

Demo

http://radio-select.veikko.it/

Installation

npm install react-radio-select  

How to use

Basic example

Step 1: Define the options list

const Option = ({title, price}) => (
  <div className="coffee-option">
    <div>{title}</div>
    <div>{price}</div>
  </div>
)

const coffees = [
  {id: "1001", title: "Espresso", price: "1.50 €"},
  {id: "1002", title: "Cappuccino", price: "2.00 €"},
  {id: "1003", title: "Flat white", price: "2.20 €"},
  {id: "1004", title: "Americano", price: "1.80 €"},
];

// The options must be an array of objects with at least keys "value" (string), 
// "component" (node) and "ariaLabel" (string). "inputAttrs" (object) and "labelAttrs" 
// (object) may be included to add additional attributes to the input and label tags.
const options = coffees.map(item => ({
    value: item.id,
    component: <Option title={item.title} price={item.price}/>,
    ariaLabel: item.title + " " + item.price
}));

Step 2: Use <RadioSelect> in your app

import RadioSelect from 'react-radio-select'

...

<form>
  <fieldset>
    <legend>Choose coffee</legend>
    <RadioSelect id="coffee-selection" name="coffee" options={options} />
  </fieldset>
</form>

Step 3: Define styles for the widget

#coffee-selection {
  .value {
    border: 1px solid #dddddd;
  }
  
  &.focused .value {
    border-color: #0ca3ff;
  }
  
  .option-list {
    border: 1px solid #dddddd;
  }
  
  .option {
    border-bottom: 1px solid #dddddd;
    background-color: #ffffff;
    
    &.highlight {
      background-color: #0ca3ff;
      color: #ffffff;
    }
  }
}

API

<RadioSelect>

Props

Required props

• name (string): The name attribute of the generated radio inputs.
• options (array of objects): The options in the select widget. Each object shall include properties "value" (string), "component" (node) and "ariaLabel (string).

Optional props

• required (bool): Adds the "required" attribute to the generated radio inputs.
• defaultOption (number): Index of the preselected option. 0 by default.
• className (string): Additional classes
• onChange (func): Callback when the value changes.
• onFocus (func): Callback when the widget receives focus.
• onBlur (func): Callback when the widget looses focus.