MDCSelect | material-components-web

Hierarchy

MDCComponent<MDCSelectFoundation>
- MDCSelect

Implements

MDCRippleCapableSurface

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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 MDCSelect

Properties

Protected foundation_

foundation_: MDCSelectFoundation

ripple

ripple: MDCRipple | null

root_

root_: HTMLElement

Accessors

disabled

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

- Defined in mdc-select/component.ts:268
Returns boolean
- Defined in mdc-select/component.ts:273
Parameters
- disabled: boolean
Returns void

helperTextContent

set helperTextContent(content: string): void

- Defined in mdc-select/component.ts:291
Sets the text content of the helper text.

Parameters
- content: string
Returns void

leadingIconAriaLabel

set leadingIconAriaLabel(label: string): void

- Defined in mdc-select/component.ts:277
Parameters
- label: string
Returns void

leadingIconContent

set leadingIconContent(content: string): void

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

Parameters
- content: string
Returns void

required

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

- Defined in mdc-select/component.ts:327
Returns whether the select is required.

Returns boolean
- Defined in mdc-select/component.ts:312
Sets the control to the required state.

Parameters
- isRequired: boolean
Returns void

selectedIndex

get selectedIndex(): number
set selectedIndex(selectedIndex: number): void

- Defined in mdc-select/component.ts:253
Returns number
- Defined in mdc-select/component.ts:264
Parameters
- selectedIndex: number
Returns void

valid

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

- Defined in mdc-select/component.ts:305
Checks if the select is in a valid state.

Returns boolean
- Defined in mdc-select/component.ts:298
Sets the current invalid state of the select.

Parameters
- isValid: boolean
Returns void

value

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

- Defined in mdc-select/component.ts:245
Returns string
- Defined in mdc-select/component.ts:249
Parameters
- value: string
Returns void

Methods

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-select/component.ts:212
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

getDefaultFoundation

getDefaultFoundation(): MDCSelectFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-select/component.ts:342
Returns MDCSelectFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-select/component.ts:146
Initializes the select's event listeners and internal state based on the environment's state.

Returns void

initialize

initialize(labelFactory?: MDCFloatingLabelFactory, lineRippleFactory?: MDCLineRippleFactory, outlineFactory?: MDCNotchedOutlineFactory, menuFactory?: MDCMenuFactory, iconFactory?: MDCSelectIconFactory, helperTextFactory?: MDCSelectHelperTextFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-select/component.ts:82
Parameters
- Default value labelFactory: MDCFloatingLabelFactory = (el) => new MDCFloatingLabel(el)
- Default value lineRippleFactory: MDCLineRippleFactory = (el) => new MDCLineRipple(el)
- Default value outlineFactory: MDCNotchedOutlineFactory = (el) => new MDCNotchedOutline(el)
- Default value menuFactory: MDCMenuFactory = (el) => new MDCMenu(el)
- Default value iconFactory: MDCSelectIconFactory = (el) => new MDCSelectIcon(el)
- Default value helperTextFactory: MDCSelectHelperTextFactory = (el) => new MDCSelectHelperText(el)
Returns void

layout

layout(): void

- Defined in mdc-select/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): MDCSelect

Overrides MDCComponent.attachTo
- Defined in mdc-select/component.ts:47
Parameters
- root: Element
Returns MDCSelect

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCSelect

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

required

Returns boolean

Parameters

isRequired: boolean

Returns void

selectedIndex

Returns number

Parameters

selectedIndex: number

Returns void

valid

Returns boolean

Parameters

isValid: boolean

Returns void

value

Returns string

Parameters

value: string

Returns void

Methods

destroy

Returns void

emit

Type parameters

T: object

Parameters

evtType: string

evtData: T

Default value shouldBubble: boolean = false

Returns void

getDefaultFoundation

Returns MDCSelectFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Default value labelFactory: MDCFloatingLabelFactory = (el) => new MDCFloatingLabel(el)

Default value lineRippleFactory: MDCLineRippleFactory = (el) => new MDCLineRipple(el)

Default value outlineFactory: MDCNotchedOutlineFactory = (el) => new MDCNotchedOutline(el)

Default value menuFactory: MDCMenuFactory = (el) => new MDCMenu(el)

Default value iconFactory: MDCSelectIconFactory = (el) => new MDCSelectIcon(el)

Default value helperTextFactory: MDCSelectHelperTextFactory = (el) => new MDCSelectHelperText(el)

Returns void