Logo for jsDocs.io

@angular2-material/radio

  • Version 2.0.0-alpha.8-3
  • Published
  • No dependencies
  • MIT license

Install

npm i @angular2-material/radio
yarn add @angular2-material/radio
pnpm add @angular2-material/radio

Overview

Angular 2 Material radio

Index

Variables

Classes

Variables

variable MD_RADIO_GROUP_CONTROL_VALUE_ACCESSOR

const MD_RADIO_GROUP_CONTROL_VALUE_ACCESSOR: any;

  • Provider Expression that allows md-radio-group to register as a ControlValueAccessor. This allows it to support [(ngModel)] and ngControl.

Classes

class MdRadioButton

class MdRadioButton implements OnInit {}

    constructor

    constructor(
        radioGroup: MdRadioGroup,
        radioDispatcher: MdUniqueSelectionDispatcher
    );

      property align

      align: 'start' | 'end';

        property ariaLabel

        ariaLabel: string;

        • Used to set the 'aria-label' attribute on the underlying input element.

        property ariaLabelledby

        ariaLabelledby: string;

        • The 'aria-labelledby' attribute takes precedence as the element's text alternative.

        property change

        change: EventEmitter<MdRadioChange>;

        • Event emitted when the group value changes.

        property checked

        checked: boolean;

          property disabled

          disabled: boolean;

            property id

            id: string;

            • The unique ID for the radio button.

            property inputId

            readonly inputId: string;

              property name

              name: string;

              • Analog to HTML 'name' attribute used to group radios for unique selection.

              property radioDispatcher

              radioDispatcher: MdUniqueSelectionDispatcher;

                property radioGroup

                radioGroup: MdRadioGroup;

                • The parent radio group. May or may not be present.

                property value

                value: any;

                • MdRadioGroup reads this to assign its own value.

                method ngOnInit

                ngOnInit: () => void;

                • TODO: internal

                class MdRadioChange

                class MdRadioChange {}

                • A simple change event emitted by either MdRadioButton or MdRadioGroup.

                property source

                source: MdRadioButton;

                  property value

                  value: any;

                    class MdRadioGroup

                    class MdRadioGroup implements AfterContentInit, ControlValueAccessor {}

                      property align

                      align: 'start' | 'end';

                        property change

                        change: EventEmitter<MdRadioChange>;

                        • Event emitted when the group value changes.

                        property disabled

                        disabled: boolean;

                          property name

                          name: string;

                            property onTouched

                            onTouched: () => any;

                            • onTouch function registered via registerOnTouch (ControlValueAccessor).

                            property selected

                            selected: MdRadioButton;

                              property value

                              value: any;

                                method ngAfterContentInit

                                ngAfterContentInit: () => void;

                                • Initialize properties once content children are available. This allows us to propagate relevant attributes to associated buttons. TODO: internal

                                method registerOnChange

                                registerOnChange: (fn: (value: any) => void) => void;

                                • Implemented as part of ControlValueAccessor. TODO: internal

                                method registerOnTouched

                                registerOnTouched: (fn: any) => void;

                                • Implemented as part of ControlValueAccessor. TODO: internal

                                method writeValue

                                writeValue: (value: any) => void;

                                • Implemented as part of ControlValueAccessor. TODO: internal

                                class MdRadioModule

                                class MdRadioModule {}

                                  method forRoot

                                  static forRoot: () => ModuleWithProviders;

                                    Package Files (2)

                                    Dependencies (0)

                                    No dependencies.

                                    Dev Dependencies (0)

                                    No dev dependencies.

                                    Peer Dependencies (2)

                                    Badge

                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@angular2-material/radio.

                                    • Markdown
                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@angular2-material/radio)
                                    • HTML
                                      <a href="https://www.jsdocs.io/package/@angular2-material/radio"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>