MDCTextField | material-components-web

Hierarchy

MDCComponent<MDCTextFieldFoundation>
- MDCTextField

Implements

MDCRippleCapableSurface

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MDCTextField(root: Element, foundation?: FoundationType, ...args: Array<unknown>): MDCTextField

Inherited from MDCComponent.__constructor
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:37
Parameters
- root: Element
- Optional foundation: FoundationType
- Rest ...args: Array<unknown>
Returns MDCTextField

Properties

Protected foundation_

foundation_: MDCTextFieldFoundation

ripple

ripple: MDCRipple | null

root_

root_: HTMLElement

Accessors

disabled

get disabled(): boolean
set disabled(disabled: boolean): void

- Defined in mdc-textfield/component.ts:181
Sets the Text Field disabled or enabled.

Returns boolean
- Defined in mdc-textfield/component.ts:188
Parameters
- disabled: boolean
  
  Sets the Text Field disabled or enabled.
Returns void

helperTextContent

set helperTextContent(content: string): void

- Defined in mdc-textfield/component.ts:288
Sets the helper text element content.

Parameters
- content: string
Returns void

leadingIconAriaLabel

set leadingIconAriaLabel(label: string): void

- Defined in mdc-textfield/component.ts:295
Sets the aria label of the leading icon.

Parameters
- label: string
Returns void

leadingIconContent

set leadingIconContent(content: string): void

- Defined in mdc-textfield/component.ts:302
Sets the text content of the leading icon.

Parameters
- content: string
Returns void

max

get max(): string
set max(max: string): void

- Defined in mdc-textfield/component.ts:263
Sets the input element's max.

Returns string
- Defined in mdc-textfield/component.ts:270
Parameters
- max: string
  
  Sets the input element's max.
Returns void

maxLength

get maxLength(): number
set maxLength(maxLength: number): void

- Defined in mdc-textfield/component.ts:236
Sets the input element's maxLength.

Returns number
- Defined in mdc-textfield/component.ts:243
Parameters
- maxLength: number
  
  Sets the input element's maxLength.
Returns void

min

get min(): string
set min(min: string): void

- Defined in mdc-textfield/component.ts:252
Sets the input element's min.

Returns string
- Defined in mdc-textfield/component.ts:259
Parameters
- min: string
  
  Sets the input element's min.
Returns void

minLength

get minLength(): number
set minLength(minLength: number): void

- Defined in mdc-textfield/component.ts:225
Sets the input element's minLength.

Returns number
- Defined in mdc-textfield/component.ts:232
Parameters
- minLength: number
  
  Sets the input element's minLength.
Returns void

pattern

get pattern(): string
set pattern(pattern: string): void

- Defined in mdc-textfield/component.ts:214
Sets the input element's validation pattern.

Returns string
- Defined in mdc-textfield/component.ts:221
Parameters
- pattern: string
  
  Sets the input element's validation pattern.
Returns void

required

get required(): boolean
set required(required: boolean): void

- Defined in mdc-textfield/component.ts:203
Sets the Text Field to required.

Returns boolean
- Defined in mdc-textfield/component.ts:210
Parameters
- required: boolean
  
  Sets the Text Field to required.
Returns void

step

get step(): string
set step(step: string): void

- Defined in mdc-textfield/component.ts:274
Sets the input element's step.

Returns string
- Defined in mdc-textfield/component.ts:281
Parameters
- step: string
  
  Sets the input element's step.
Returns void

trailingIconAriaLabel

set trailingIconAriaLabel(label: string): void

- Defined in mdc-textfield/component.ts:309
Sets the aria label of the trailing icon.

Parameters
- label: string
Returns void

trailingIconContent

set trailingIconContent(content: string): void

- Defined in mdc-textfield/component.ts:316
Sets the text content of the trailing icon.

Parameters
- content: string
Returns void

useNativeValidation

set useNativeValidation(useNativeValidation: boolean): void

- Defined in mdc-textfield/component.ts:324
Enables or disables the use of native validation. Use this for custom validation.

Parameters
- useNativeValidation: boolean
  
  Set this to false to ignore native input validation.
Returns void

valid

get valid(): boolean
set valid(valid: boolean): void

- Defined in mdc-textfield/component.ts:192
Sets the Text Field valid or invalid.

Returns boolean
- Defined in mdc-textfield/component.ts:199
Parameters
- valid: boolean
  
  Sets the Text Field valid or invalid.
Returns void

value

get value(): string
set value(value: string): void

- Defined in mdc-textfield/component.ts:170
The value to set on the input.

Returns string
- Defined in mdc-textfield/component.ts:177
Parameters
- value: string
  
  The value to set on the input.
Returns void

Methods

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-textfield/component.ts:134
Returns void

emit

emit<T>(evtType: string, evtData: T, shouldBubble?: boolean): void

Inherited from MDCComponent.emit
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:103
Fires a cross-browser-compatible custom event from the component root of the given type, with the given data.

Type parameters
- T: object
Parameters
- evtType: string
- evtData: T
- Default value shouldBubble: boolean = false
Returns void

focus

focus(): void

- Defined in mdc-textfield/component.ts:331
Focuses the input element.

Returns void

getDefaultFoundation

getDefaultFoundation(): MDCTextFieldFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-textfield/component.ts:343
Returns MDCTextFieldFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-textfield/component.ts:166
Initializes the Text Field's internal state based on the environment's state.

Returns void

initialize

initialize(rippleFactory?: MDCRippleFactory, lineRippleFactory?: MDCLineRippleFactory, helperTextFactory?: MDCTextFieldHelperTextFactory, characterCounterFactory?: MDCTextFieldCharacterCounterFactory, iconFactory?: MDCTextFieldIconFactory, labelFactory?: MDCFloatingLabelFactory, outlineFactory?: MDCNotchedOutlineFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-textfield/component.ts:78
Parameters
- Default value rippleFactory: MDCRippleFactory = (el, foundation) => new MDCRipple(el, foundation)
- Default value lineRippleFactory: MDCLineRippleFactory = (el) => new MDCLineRipple(el)
- Default value helperTextFactory: MDCTextFieldHelperTextFactory = (el) => new MDCTextFieldHelperText(el)
- Default value characterCounterFactory: MDCTextFieldCharacterCounterFactory = (el) => new MDCTextFieldCharacterCounter(el)
- Default value iconFactory: MDCTextFieldIconFactory = (el) => new MDCTextFieldIcon(el)
- Default value labelFactory: MDCFloatingLabelFactory = (el) => new MDCFloatingLabel(el)
- Default value outlineFactory: MDCNotchedOutlineFactory = (el) => new MDCNotchedOutline(el)
Returns void

layout

layout(): void

- Defined in mdc-textfield/component.ts:338
Recomputes the outline SVG path for the outline element.

Returns void

listen

listen<K>(evtType: K, handler: SpecificEventListener<K>): void
listen<E>(evtType: string, handler: CustomEventListener<E>): void

Inherited from MDCComponent.listen
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:84
Wrapper method to add an event listener to the component's root element. This is most useful when listening for custom events.

Type parameters
- K: EventType
Parameters
- evtType: K
- handler: SpecificEventListener<K>
Returns void
Inherited from MDCComponent.listen
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:85
Type parameters
- E: Event
Parameters
- evtType: string
- handler: CustomEventListener<E>
Returns void

unlisten

unlisten<K>(evtType: K, handler: SpecificEventListener<K>): void
unlisten<E>(evtType: string, handler: CustomEventListener<E>): void

Inherited from MDCComponent.unlisten
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:94
Wrapper method to remove an event listener to the component's root element. This is most useful when unlistening for custom events.

Type parameters
- K: EventType
Parameters
- evtType: K
- handler: SpecificEventListener<K>
Returns void
Inherited from MDCComponent.unlisten
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:95
Type parameters
- E: Event
Parameters
- evtType: string
- handler: CustomEventListener<E>
Returns void

Static attachTo

attachTo(root: Element): MDCTextField

Overrides MDCComponent.attachTo
- Defined in mdc-textfield/component.ts:57
Parameters
- root: Element
Returns MDCTextField

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCTextField

Properties

Protected foundation_

ripple

root_

Accessors

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

helperTextContent

Parameters

content: string

Returns void

leadingIconAriaLabel

Parameters

label: string

Returns void

leadingIconContent

Parameters

content: string

Returns void

max

Returns string

Parameters

max: string

Returns void

maxLength

Returns number

Parameters

maxLength: number

Returns void

min

Returns string

Parameters

min: string

Returns void

minLength

Returns number

Parameters

minLength: number

Returns void

pattern

Returns string

Parameters

pattern: string

Returns void

required

Returns boolean

Parameters

required: boolean

Returns void

step

Returns string

Parameters

step: string

Returns void

trailingIconAriaLabel

Parameters

label: string

Returns void

trailingIconContent

Parameters

content: string

Returns void

useNativeValidation