Skip to content
This repository has been archived by the owner on Oct 30, 2022. It is now read-only.

Latest commit

 

History

History
71 lines (44 loc) · 3.05 KB

radio-group.md

File metadata and controls

71 lines (44 loc) · 3.05 KB

Radio Group

Manages a set of Radio Buttons.

Main features

  • Facilitates managing radio buttons

Usage

Described in:

Options

Radio Group options

Parameter Required Type Default Description
name required String Name for all radio button elements
buttons use buttons or content Array List of Radio Button options
defaultCheckedValue optional String The value of the default checked Radio Button; ignored if Radio Button's checked is used
checkedValue optional String Checks the Radio Button that has this value. It is ignored when one of the group's Radio Buttons uses option checked. This is useful when you maintain the state of the value yourself.
onChange optional Function ({ event: Event, checked: boolean, value: string }) => undefined See: Handling state
all optional Options Object Radio Button options that will be applied to all Radio Buttons

Common component options

Parameter Required Type Default Description
after optional String, hyperscript or component Extra content after main content; note that this content is placed right of preceding elements with a higher stacking depth
before optional String, hyperscript or component Extra content before main content; note that this content is placed left of subsequent elements with a lower stacking depth
className optional String Extra CSS class appended to pe-radio-group
content use buttons or content String, hyperscript or component See: buttons
element optional String "div" HTML element tag for the Radio Button container
id optional String HTML element id for the radio button container
tone optional String: "dark" or "light" Renders the component light on dark (sets class pe-dark-tone); use "light" to locally inverse (sets class pe-light-tone)

CSS classes