ayo/lion
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
lion/packages/radio-group/README.md
Thomas Allmer 0c53b1d4bb fix: update links in stories
2020-01-23 18:24:38 +01:00

1.3 KiB
Raw Blame History

Radio-group

lion-radio-group component is webcomponent that enhances the functionality of the native <input type="radio"> element. Its purpose is to provide a way for users to check a single option amongst a set of choices.

You should use lion-radio's inside this element.

Live Demo/Documentation

See our storybook for a live demo and API documentation

How to use

Installation

npm i --save @lion/radio @lion/radio-group

import '@lion/radio/lion-radio.js';
import '@lion/radio-group/lion-radio-group.js';

Example

<lion-radio-group name="dinosGroup" label="What are your favourite dinosaurs?">
  <lion-radio name="dinos[]" label="allosaurus" .choiceValue=${'allosaurus'}></lion-radio>
  <lion-radio name="dinos[]" label="brontosaurus" .choiceValue=${'brontosaurus'}></lion-radio>
  <lion-radio name="dinos[]" label="diplodocus" .choiceValue=${'diplodocus'} checked></lion-radio>
</lion-radio-group>
  • Make sure that to use a name attribute as it is necessary for the lion-form's serialization result.
  • If you have many options for a user to pick from, consider using lion-select instead