Logo for jsDocs.io

@material/radio

  • Version 14.0.0
  • Published
  • 561 kB
  • 10 dependencies
  • MIT license

Install

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

Overview

The Material Components for the web radio component

Index

Variables

Classes

Interfaces

Variables

variable cssClasses

const cssClasses: { DISABLED: string; ROOT: string };

    variable strings

    const strings: { NATIVE_CONTROL_SELECTOR: string };

    • Copyright 2016 Google Inc.

      Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

      The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Classes

    class MDCRadio

    class MDCRadio
        extends MDCComponent<MDCRadioFoundation>
        implements MDCRippleCapableSurface {}

      property checked

      checked: boolean;

        property disabled

        disabled: boolean;

          property ripple

          readonly ripple: MDCRipple;

            property value

            value: string;

              method attachTo

              static attachTo: (root: Element) => MDCRadio;

                method destroy

                destroy: () => void;

                  method getDefaultFoundation

                  getDefaultFoundation: () => MDCRadioFoundation;

                    class MDCRadioFoundation

                    class MDCRadioFoundation extends MDCFoundation<MDCRadioAdapter> {}

                      constructor

                      constructor(adapter?: Partial<MDCRadioAdapter>);

                        property cssClasses

                        static readonly cssClasses: { DISABLED: string; ROOT: string };

                          property defaultAdapter

                          static readonly defaultAdapter: MDCRadioAdapter;

                            property strings

                            static readonly strings: { NATIVE_CONTROL_SELECTOR: string };

                              method setDisabled

                              setDisabled: (disabled: boolean) => void;

                                Interfaces

                                interface MDCRadioAdapter

                                interface MDCRadioAdapter {}

                                • Defines the shape of the adapter expected by the foundation. Implement this adapter for your framework of choice to delegate updates to the component in your framework of choice. See architecture documentation for more details. https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md

                                method addClass

                                addClass: (className: string) => void;

                                  method removeClass

                                  removeClass: (className: string) => void;

                                    method setNativeControlDisabled

                                    setNativeControlDisabled: (disabled: boolean) => void;

                                      Package Files (5)

                                      Dependencies (10)

                                      Dev Dependencies (0)

                                      No dev dependencies.

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      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/@material/radio.

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