Reference Source
import {Radio} from '@adobe/coral-spectrum'
public class | source

Radio

Expression Extends:

class Radio extends BaseFormField(BaseComponent(HTMLElement))

A Radio component to be used as a form field.

See:

Example:

Markup
<coral-radio></coral-radio>
JS constructor
new Coral.Radio();

Member Summary

Public Members
public

Checked state for the radio, true is checked and false is unchecked.

public

Whether this field is disabled or not.

public

The radios's label element.

  • content-zone

public

Inherited from BaseFormField#labelled.

public

Name used to submit the data in a form.

public

Whether this field is readOnly or not.

public

Whether this field is required or not.

public
public

The value this radio should submit when checked.

Method Summary

Public Methods
public

clear()

Inherited from BaseFormField#clear.

public

reset()

Inherited from BaseFormField#reset.

Public Members

public checked: Boolean source

Checked state for the radio, true is checked and false is unchecked.

  • false by default.
  • reflected

Emit:

change

public disabled: Boolean source

Whether this field is disabled or not.

  • false by default.
  • reflected

public label: RadioLabel source

The radios's label element.

  • content-zone

public labelled: * source

Inherited from BaseFormField#labelled.

public name: String source

Name used to submit the data in a form.

  • "" by default.
  • reflected

public readOnly: Boolean source

Whether this field is readOnly or not. Indicating that the user cannot modify the value of the control.

  • false by default.
  • reflected

public required: Boolean source

Whether this field is required or not.

  • false by default.
  • reflected

public trackingElement: * source

Inherited from BaseComponent#trackingElement.

public value: String source

The value this radio should submit when checked. Changing this value will not trigger an event.

  • "on" by default.

Public Methods

public clear() source

Inherited from BaseFormField#clear.

public reset() source

Inherited from BaseFormField#reset.