Logo for jsDocs.io

@material/form-field

  • Version 14.0.0
  • Published
  • 187 kB
  • 7 dependencies
  • MIT license

Install

npm i @material/form-field
yarn add @material/form-field
pnpm add @material/form-field

Overview

Material Components for the web wrapper for laying out form fields and labels next to one another

Index

Variables

Classes

Interfaces

Variables

variable cssClasses

const cssClasses: { ROOT: string };

  • Copyright 2017 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.

variable strings

const strings: { LABEL_SELECTOR: string };

    Classes

    class MDCFormField

    class MDCFormField extends MDCComponent<MDCFormFieldFoundation> {}

      property input

      input?: MDCFormFieldInput;

        method attachTo

        static attachTo: (root: HTMLElement) => MDCFormField;

          method getDefaultFoundation

          getDefaultFoundation: () => MDCFormFieldFoundation;

            class MDCFormFieldFoundation

            class MDCFormFieldFoundation extends MDCFoundation<MDCFormFieldAdapter> {}

              constructor

              constructor(adapter?: Partial<MDCFormFieldAdapter>);

                property cssClasses

                static readonly cssClasses: { ROOT: string };

                  property defaultAdapter

                  static readonly defaultAdapter: MDCFormFieldAdapter;

                    property strings

                    static readonly strings: { LABEL_SELECTOR: string };

                      method destroy

                      destroy: () => void;

                        method init

                        init: () => void;

                          Interfaces

                          interface MDCFormFieldAdapter

                          interface MDCFormFieldAdapter {}

                          • 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 activateInputRipple

                          activateInputRipple: () => void;

                            method deactivateInputRipple

                            deactivateInputRipple: () => void;

                              method deregisterInteractionHandler

                              deregisterInteractionHandler: <K extends EventType>(
                                  evtType: K,
                                  handler: SpecificEventListener<K>
                              ) => void;

                                method registerInteractionHandler

                                registerInteractionHandler: <K extends EventType>(
                                    evtType: K,
                                    handler: SpecificEventListener<K>
                                ) => void;

                                  interface MDCFormFieldInput

                                  interface MDCFormFieldInput {}

                                    property ripple

                                    readonly ripple: MDCRipple | undefined;

                                      Package Files (5)

                                      Dependencies (7)

                                      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/form-field.

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