MDCCheckbox | material-components-web

Hierarchy

MDCComponent<MDCCheckboxFoundation>
- MDCCheckbox

Implements

MDCRippleCapableSurface

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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 MDCCheckbox

Properties

Protected foundation_

foundation_: MDCCheckboxFoundation

root_

root_: Element

Accessors

checked

get checked(): boolean
set checked(checked: boolean): void

- Defined in mdc-checkbox/component.ts:50
Returns boolean
- Defined in mdc-checkbox/component.ts:54
Parameters
- checked: boolean
Returns void

disabled

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

- Defined in mdc-checkbox/component.ts:66
Returns boolean
- Defined in mdc-checkbox/component.ts:70
Parameters
- disabled: boolean
Returns void

indeterminate

get indeterminate(): boolean
set indeterminate(indeterminate: boolean): void

- Defined in mdc-checkbox/component.ts:58
Returns boolean
- Defined in mdc-checkbox/component.ts:62
Parameters
- indeterminate: boolean
Returns void

ripple

get ripple(): MDCRipple

- Defined in mdc-checkbox/component.ts:46
Returns MDCRipple

value

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

- Defined in mdc-checkbox/component.ts:74
Returns string
- Defined in mdc-checkbox/component.ts:78
Parameters
- value: string
Returns void

Methods

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-checkbox/component.ts:97
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(): MDCCheckboxFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-checkbox/component.ts:105
Returns MDCCheckboxFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-checkbox/component.ts:89
Returns void

initialize

initialize(..._args: Array<unknown>): void

Inherited from MDCComponent.initialize
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:54
Parameters
- Rest ..._args: Array<unknown>
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): MDCCheckbox

Overrides MDCComponent.attachTo
- Defined in mdc-checkbox/component.ts:42
Parameters
- root: Element
Returns MDCCheckbox

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCCheckbox

Properties

Protected foundation_

root_

Accessors

checked

Returns boolean

Parameters

checked: boolean

Returns void

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

indeterminate

Returns boolean

Parameters

indeterminate: boolean

Returns void

ripple

Returns MDCRipple

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 MDCCheckboxFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Rest ..._args: Array<unknown>

Returns void

listen

Type parameters

K: EventType

Parameters

evtType: K

handler: SpecificEventListener<K>

Returns void

Type parameters

E: Event

Parameters

evtType: string

handler: CustomEventListener<E>

Returns void

unlisten

Type parameters

K: EventType

Parameters

evtType: K

handler: SpecificEventListener<K>

Returns void

Type parameters