@material/floating-label

method attachTo

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

method float

float: (shouldFloat: boolean) => void;

• Styles the label to float/dock.

  Parameter shouldFloat

  If true, floats the label by adding a CSS class; otherwise, docks it by removing the class.

method getDefaultFoundation

getDefaultFoundation: () => MDCFloatingLabelFoundation;

method getWidth

getWidth: () => number;

method setRequired

setRequired: (isRequired: boolean) => void;

• Styles the label as required.

  Parameter isRequired

  If true, adds an asterisk to the label, indicating that it is required.

method shake

shake: (shouldShake: boolean) => void;

• Styles the label to produce the label shake for errors.

  Parameter shouldShake

  If true, shakes the label by adding a CSS class; otherwise, stops shaking by removing the class.

constructor

constructor(adapter?: Partial<MDCFloatingLabelAdapter>);

property cssClasses

static readonly cssClasses: {
    LABEL_FLOAT_ABOVE: string;
    LABEL_REQUIRED: string;
    LABEL_SHAKE: string;
    ROOT: string;
};

property defaultAdapter

static readonly defaultAdapter: MDCFloatingLabelAdapter;

• See MDCFloatingLabelAdapter for typing information on parameters and return types.

method destroy

destroy: () => void;

method float

float: (shouldFloat: boolean) => void;

• Styles the label to float or dock.

  Parameter shouldFloat

  If true, adds the float CSS class; otherwise, removes float and shake classes to dock the label.

method getWidth

getWidth: () => number;

• Returns the width of the label element.

method init

init: () => void;

method setRequired

setRequired: (isRequired: boolean) => void;

• Styles the label as required.

  Parameter isRequired

  If true, adds an asterisk to the label, indicating that it is required.

method shake

shake: (shouldShake: boolean) => void;

• Styles the label to produce a shake animation to indicate an error.

  Parameter shouldShake

  If true, adds the shake CSS class; otherwise, removes shake class.

method addClass

addClass: (className: string) => void;

• Adds a class to the label element.

method deregisterInteractionHandler

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

• Deregisters an event listener on the root element for a given event.

method getWidth

getWidth: () => number;

• Returns the width of the label element.

method registerInteractionHandler

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

• Registers an event listener on the root element for a given event.

method removeClass

removeClass: (className: string) => void;

• Removes a class from the label element.