menu

Class IgcFormComponent

The form is a component used to collect user input from interactive controls.

Element

igc-form

Slot

Default slot for the form.

Fires

igcSubmit - Emitted when the form is submitted.

Fires

igcReset - Emitted when the form is reset.

Deprecated

since version 4.4.0 Use the native <form> element instead.

Hierarchy

EventEmitterInterface<IgcFormEventMap, this> & LitElement<this>
- IgcFormComponent

Index

Constructors

Properties

novalidate styles tagName

Methods

emitEvent getFormData reportValidity reset submit

Constructors

constructor

new IgcFormComponent(): IgcFormComponent
Returns IgcFormComponent
Overrides EventEmitterMixin< IgcFormEventMap, Constructor<LitElement> >(LitElement).constructor
- Defined in src/components/form/form.ts:66

Properties

novalidate

novalidate: boolean = false

Specifies if form data validation should be skipped on submit.

`Static` styles

styles: CSSResult = ...

`Static` `Readonly` tagName

tagName: "igc-form" = 'igc-form'

Methods

emitEvent

emitEvent<K, D>(type: K, eventInitDict?: CustomEventInit<D>): boolean
Type Parameters
- K extends keyof IgcFormEventMap
- D extends any
Parameters
- type: K
- Optional eventInitDict: CustomEventInit<D>
Returns boolean
Inherited from EventEmitterMixin< IgcFormEventMap, Constructor<LitElement> >(LitElement).emitEvent
- Defined in src/components/common/mixins/event-emitter.ts:30

getFormData

getFormData(): FormData
Retrieves the data from the form in the format of a FormData object.

Returns FormData
- Defined in src/components/form/form.ts:135

reportValidity

reportValidity(): boolean
Checks for validity of the form.

Returns boolean
- Defined in src/components/form/form.ts:168

reset

reset(): void
Resets the form.

Returns void
- Defined in src/components/form/form.ts:85

submit

submit(): boolean
Submits the form.

Returns boolean
- Defined in src/components/form/form.ts:73