@material/notched-outline

  • Version 11.0.0
  • Published
  • 214 kB
  • 7 dependencies
  • MIT license

Install

npm i @material/notched-outline
yarn add @material/notched-outline
pnpm add @material/notched-outline

Overview

The Material Components for the web notched-outline component

Index

Namespaces

namespace @material/notched-outline

module '@material/notched-outline' {}

    variable cssClasses

    const cssClasses: {
    NO_LABEL: string;
    OUTLINE_NOTCHED: string;
    OUTLINE_UPGRADED: string;
    };

      variable numbers

      const numbers: { NOTCH_ELEMENT_PADDING: number };

        variable strings

        const strings: { NOTCH_ELEMENT_SELECTOR: string };
        • Copyright 2018 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.

        class MDCNotchedOutline

        class MDCNotchedOutline extends MDCComponent<MDCNotchedOutlineFoundation> {}

          method attachTo

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

            method closeNotch

            closeNotch: () => void;
            • Updates classes and styles to close the notch.

            method getDefaultFoundation

            getDefaultFoundation: () => MDCNotchedOutlineFoundation;

              method initialSyncWithDOM

              initialSyncWithDOM: () => void;

                method notch

                notch: (notchWidth: number) => void;
                • Updates classes and styles to open the notch to the specified width.

                  Parameter notchWidth

                  The notch width in the outline.

                class MDCNotchedOutlineFoundation

                class MDCNotchedOutlineFoundation extends MDCFoundation<MDCNotchedOutlineAdapter> {}

                  constructor

                  constructor(adapter?: Partial<MDCNotchedOutlineAdapter>);

                    property cssClasses

                    static readonly cssClasses: {
                    NO_LABEL: string;
                    OUTLINE_NOTCHED: string;
                    OUTLINE_UPGRADED: string;
                    };

                      property defaultAdapter

                      static readonly defaultAdapter: MDCNotchedOutlineAdapter;

                      property numbers

                      static readonly numbers: { NOTCH_ELEMENT_PADDING: number };

                        property strings

                        static readonly strings: { NOTCH_ELEMENT_SELECTOR: string };

                          method closeNotch

                          closeNotch: () => void;
                          • Removes notched outline selector to close the notch in the outline.

                          method notch

                          notch: (notchWidth: number) => void;
                          • Adds the outline notched selector and updates the notch width calculated based off of notchWidth.

                          interface MDCNotchedOutlineAdapter

                          interface MDCNotchedOutlineAdapter {}
                          • 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;
                          • Adds a class to the root element.

                          method removeClass

                          removeClass: (className: string) => void;
                          • Removes a class from the root element.

                          method removeNotchWidthProperty

                          removeNotchWidthProperty: () => void;
                          • Removes the width style property from the notch element.

                          method setNotchWidthProperty

                          setNotchWidthProperty: (width: number) => void;
                          • Sets the width style property of the notch element.

                          type MDCNotchedOutlineFactory

                          type MDCNotchedOutlineFactory = (
                          el: Element,
                          foundation?: MDCNotchedOutlineFoundation
                          ) => MDCNotchedOutline;

                            namespace @material/notched-outline/adapter

                            module '@material/notched-outline/adapter' {}

                              interface MDCNotchedOutlineAdapter

                              interface MDCNotchedOutlineAdapter {}
                              • 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;
                              • Adds a class to the root element.

                              method removeClass

                              removeClass: (className: string) => void;
                              • Removes a class from the root element.

                              method removeNotchWidthProperty

                              removeNotchWidthProperty: () => void;
                              • Removes the width style property from the notch element.

                              method setNotchWidthProperty

                              setNotchWidthProperty: (width: number) => void;
                              • Sets the width style property of the notch element.

                              namespace @material/notched-outline/component

                              module '@material/notched-outline/component' {}

                                class MDCNotchedOutline

                                class MDCNotchedOutline extends MDCComponent<MDCNotchedOutlineFoundation> {}

                                  method attachTo

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

                                    method closeNotch

                                    closeNotch: () => void;
                                    • Updates classes and styles to close the notch.

                                    method getDefaultFoundation

                                    getDefaultFoundation: () => MDCNotchedOutlineFoundation;

                                      method initialSyncWithDOM

                                      initialSyncWithDOM: () => void;

                                        method notch

                                        notch: (notchWidth: number) => void;
                                        • Updates classes and styles to open the notch to the specified width.

                                          Parameter notchWidth

                                          The notch width in the outline.

                                        type MDCNotchedOutlineFactory

                                        type MDCNotchedOutlineFactory = (
                                        el: Element,
                                        foundation?: MDCNotchedOutlineFoundation
                                        ) => MDCNotchedOutline;

                                          namespace @material/notched-outline/constants

                                          module '@material/notched-outline/constants' {}

                                            variable cssClasses

                                            const cssClasses: {
                                            NO_LABEL: string;
                                            OUTLINE_NOTCHED: string;
                                            OUTLINE_UPGRADED: string;
                                            };

                                              variable numbers

                                              const numbers: { NOTCH_ELEMENT_PADDING: number };

                                                variable strings

                                                const strings: { NOTCH_ELEMENT_SELECTOR: string };
                                                • Copyright 2018 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.

                                                namespace @material/notched-outline/foundation

                                                module '@material/notched-outline/foundation' {}

                                                  class MDCNotchedOutlineFoundation

                                                  class MDCNotchedOutlineFoundation extends MDCFoundation<MDCNotchedOutlineAdapter> {}

                                                    constructor

                                                    constructor(adapter?: Partial<MDCNotchedOutlineAdapter>);

                                                      property cssClasses

                                                      static readonly cssClasses: {
                                                      NO_LABEL: string;
                                                      OUTLINE_NOTCHED: string;
                                                      OUTLINE_UPGRADED: string;
                                                      };

                                                        property defaultAdapter

                                                        static readonly defaultAdapter: MDCNotchedOutlineAdapter;

                                                        property numbers

                                                        static readonly numbers: { NOTCH_ELEMENT_PADDING: number };

                                                          property strings

                                                          static readonly strings: { NOTCH_ELEMENT_SELECTOR: string };

                                                            method closeNotch

                                                            closeNotch: () => void;
                                                            • Removes notched outline selector to close the notch in the outline.

                                                            method notch

                                                            notch: (notchWidth: number) => void;
                                                            • Adds the outline notched selector and updates the notch width calculated based off of notchWidth.

                                                            Package Files (1)

                                                            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/notched-outline.

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