Anchor Design System
Form

Radio2.0

Radio allow users to select a single option from a list of mutually exclusive options.

Installation

npm i @tryg/ui-library

Usage

Individual only imports the desired component, and only needs to be included once within the application. Which is beneficial to keep the application size small.

Webcomponent
<script type="module">
  import { defineCustomElement } from '@tryg/ui-library/dist/components/anchor-radio';
  defineCustomElement();
</script>
<anchor-radio>Hello</anchor-radio>

Global only needs to be defined once in the application, but it will import all components even the ones that are not in use..

Webcomponent
<script type="module">
  import { defineCustomElements } from '@tryg/ui-library/dist/loader';
  defineCustomElements();
</script>
<anchor-radio>Hello</anchor-radio>

Disabled

Webcomponent
<anchor-radio disabled>Hello</anchor-radio>

Checked

Webcomponent
<anchor-radio checked>Hello</anchor-radio>

Accessibility

  • Radio groups are exposed to assistive technology via ARIA.
  • Each radio is built with a native HTML <input> element, which can be optionally visually hidden to allow custom styling.
  • Full support for browser features like form autofill.
  • Keyboard event support for arrows keys.
  • Keyboard focus management and cross browser normalization.
  • Group and radio labeling support for assistive technology.

API

anchor-radio

Properties

PropertyAttributeDescriptionTypeDefault
backgroundbackgroundSet a white background for the radio button. Use this when the radio button is placed on a non-white backgroundbooleanfalse
checkedcheckedThe radio button is checkedbooleanfalse
disableddisabledDisable the radio buttonbooleanfalse
inputIdinput-idThis is name that the label refers tostringundefined
namenameThis is the name for the entire radio button groupstringundefined
requiredrequiredMark the field as requiredbooleanfalse
validityMissingValueTextvalidity-missing-value-textText to be displayed if when value is missing an native form validation is usedstringundefined
valuevalueThis is the string that is returned as a value, when the form is submittedstring''

Events

EventDescriptionType
toggledCustomEvent<any>

Methods

toggleRadio(e?: any) => Promise<void>

Parameters

NameTypeDescription
eany

Returns

Type: Promise<void>

Dependencies

Depends on

Graph


Built with StencilJS

On this page