Class IgcFileInputComponent

Element

igc-file-input

Slot

prefix - Renders content before the input.

Slot

suffix - Renders content after input.

Slot

helper-text - Renders content below the input.

Slot

file-selector-text - Renders content for the browse button when input type is file.

Slot

file-missing-text - Renders content when input type is file and no file is chosen.

Slot

value-missing - Renders content when the required validation fails.

Slot

custom-error - Renders content when setCustomValidity(message) is set.

Slot

invalid - Renders content when the component is in invalid state (validity.valid = false).

Fires

igcChange - Emitted when the control's checked state changes.

Fires

igcCancel - Emitted when the control's file picker dialog is canceled.

Csspart

container - The main wrapper that holds all main input elements.

Csspart

input - The native input element.

Csspart

label - The native label element.

Csspart

file-names - The file names wrapper when input type is 'file'.

Csspart

file-selector-button - The browse button when input type is 'file'.

Csspart

prefix - The prefix wrapper.

Csspart

suffix - The suffix wrapper.

Csspart

helper-text - The helper text wrapper.

Hierarchy

EventEmitterInterface<IgcFileInputComponentEventMap, this> & IgcInputBaseComponent<
this,
>
- IgcFileInputComponent

Constructors

constructor

new IgcFileInputComponent(...args: any[]): IgcFileInputComponent
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).constructor
- Defined in src/components/common/mixins/constructor.ts:1
Parameters
- ...args: any[]
Returns IgcFileInputComponent

Properties

accept

accept: string = ''

The accept attribute of the control. Defines the file types as a list of comma-separated values that the file input should accept.

Attr

autofocus

autofocus: boolean

The autofocus attribute of the control.

Attr

disabled

disabled: boolean

The disabled state of the component.

Attr

Default

false

invalid

invalid: boolean

Sets the control into invalid state (visual state only).

Attr

Default

false

label

label: string

The label for the control.

Attr

multiple

multiple: boolean = false

The multiple attribute of the control. Used to indicate that a file input allows the user to select more than one file.

Attr

Default

false

name

name: string

The name attribute of the control.

Attr

outlined

outlined: boolean = false

Whether the control will have outlined appearance.

Attr

Default

false

placeholder

placeholder: string

The placeholder attribute of the control.

Attr

`Static`styles

styles: CSSResult[] = ...

`Static` `Readonly`tagName

tagName: "igc-file-input" = 'igc-file-input'

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

Accessors

defaultValue

get defaultValue(): unknown
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).defaultValue
- Defined in src/components/common/mixins/forms/types.ts:157
Returns unknown
set defaultValue(value: unknown): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).defaultValue
- Defined in src/components/common/mixins/forms/types.ts:156
The initial value of the component.

Parameters
- value: unknown
Returns void

files

get files(): FileList
- Defined in src/components/file-input/file-input.ts:200
Returns the list of selected files.

Returns FileList

form

get form(): HTMLFormElement | null
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).form
- Defined in src/components/common/mixins/forms/types.ts:45
Returns the HTMLFormElement associated with this element.

Returns HTMLFormElement | null

locale

get locale(): string
- Defined in src/components/file-input/file-input.ts:170
Returns string
set locale(value: string): void
- Defined in src/components/file-input/file-input.ts:166
Gets/Sets the locale used for getting language, affecting resource strings.

Attr
locale

Parameters
- value: string
Returns void

required

get required(): boolean
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).required
- Defined in src/components/common/mixins/forms/types.ts:175
Returns boolean
set required(value: boolean): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).required
- Defined in src/components/common/mixins/forms/types.ts:174
When set, makes the component a required field for validation.
Attr
Default
```
false
```
Parameters
- value: boolean
Returns void

resourceStrings

get resourceStrings(): IFileInputResourceStrings
- Defined in src/components/file-input/file-input.ts:157
Returns IFileInputResourceStrings
set resourceStrings(value: IFileInputResourceStrings): void
- Defined in src/components/file-input/file-input.ts:153
The resource strings for localization.

Parameters
- value: IFileInputResourceStrings
Returns void

validationMessage

get validationMessage(): string
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).validationMessage
- Defined in src/components/common/mixins/forms/types.ts:54
A string containing the validation message of this element.

Returns string

validity

get validity(): ValidityState
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).validity
- Defined in src/components/common/mixins/forms/types.ts:51
Returns a ValidityState object which represents the different validity states the element can be in, with respect to constraint validation.

Returns ValidityState

value

get value(): string
Overrides EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).value
- Defined in src/components/file-input/file-input.ts:145
The value attribute of the control. Type varies based on the input type and can be string, Date or null.

Returns string
set value(value: string): void
Overrides EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).value
- Defined in src/components/file-input/file-input.ts:139
The value of the control. Similar to native file input, this property is read-only and cannot be set programmatically.

Attr
Parameters
- value: string
Returns void

willValidate

get willValidate(): boolean
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).willValidate
- Defined in src/components/common/mixins/forms/types.ts:60
A boolean value which returns true if the element is a submittable element that is a candidate for constraint validation.

Returns boolean

Methods

addEventListener

addEventListener<
    K extends string
    | number
    | symbol,
    M extends IgcFileInputComponentEventMap & HTMLElementEventMap,
>(
    type: K,
    listener: (this: HTMLElement, ev: M[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).addEventListener
- Defined in src/components/common/mixins/event-emitter.ts:7
Type parameters
Type Parameters
- K extends string | number | symbol
- M extends IgcFileInputComponentEventMap & HTMLElementEventMap
Parameters
- type: K
- listener: (this: HTMLElement, ev: M[K]) => any
- options: boolean | AddEventListenerOptions
Returns void
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).addEventListener
- Defined in src/components/common/mixins/event-emitter.ts:12
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- options: boolean | AddEventListenerOptions
Returns void
addEventListener<
    K extends string
    | number
    | symbol,
    M extends IgcInputComponentEventMap & HTMLElementEventMap,
>(
    type: K,
    listener: (this: HTMLElement, ev: M[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).addEventListener
- Defined in src/components/common/mixins/event-emitter.ts:7
Type parameters
Type Parameters
- K extends string | number | symbol
- M extends IgcInputComponentEventMap & HTMLElementEventMap
Parameters
- type: K
- listener: (this: HTMLElement, ev: M[K]) => any
- options: boolean | AddEventListenerOptions
Returns void
addEventListener<K extends keyof HTMLElementEventMap>(
    type: K,
    listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:17886
Type parameters
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
- options: boolean | AddEventListenerOptions
Returns void

blur

blur(): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).blur
- Defined in src/components/input/input-base.ts:102
Removes focus from the control.

Returns void

checkValidity

checkValidity(): boolean
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).checkValidity
- Defined in src/components/common/mixins/forms/types.ts:140
Checks for validity of the control and emits the invalid event if it invalid.

Returns boolean

emitEvent

emitEvent<K extends keyof IgcFileInputComponentEventMap, D extends FileList>(
type: K,
eventInitDict?: CustomEventInit<D>,
): boolean
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).emitEvent
- Defined in src/components/common/mixins/event-emitter.ts:30
Type parameters
Type Parameters
- K extends keyof IgcFileInputComponentEventMap
- D extends FileList
Parameters
- type: K
- eventInitDict: CustomEventInit<D>
Returns boolean
emitEvent<K extends keyof IgcInputComponentEventMap, D extends string>(
type: K,
eventInitDict?: CustomEventInit<D>,
): boolean
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).emitEvent
- Defined in src/components/common/mixins/event-emitter.ts:30
Type parameters
Type Parameters
- K extends keyof IgcInputComponentEventMap
- D extends string
Parameters
- type: K
- eventInitDict: CustomEventInit<D>
Returns boolean

focus

focus(options?: FocusOptions): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).focus
- Defined in src/components/input/input-base.ts:96
Sets focus on the control.

Parameters
- options: FocusOptions
Returns void

removeEventListener

removeEventListener<
    K extends string
    | number
    | symbol,
    M extends IgcFileInputComponentEventMap & HTMLElementEventMap,
>(
    type: K,
    listener: (this: HTMLElement, ev: M[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).removeEventListener
- Defined in src/components/common/mixins/event-emitter.ts:17
Type parameters
Type Parameters
- K extends string | number | symbol
- M extends IgcFileInputComponentEventMap & HTMLElementEventMap
Parameters
- type: K
- listener: (this: HTMLElement, ev: M[K]) => any
- options: boolean | EventListenerOptions
Returns void
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).removeEventListener
- Defined in src/components/common/mixins/event-emitter.ts:25
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- options: boolean | EventListenerOptions
Returns void
removeEventListener<
    K extends string
    | number
    | symbol,
    M extends IgcInputComponentEventMap & HTMLElementEventMap,
>(
    type: K,
    listener: (this: HTMLElement, ev: M[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).removeEventListener
- Defined in src/components/common/mixins/event-emitter.ts:17
Type parameters
Type Parameters
- K extends string | number | symbol
- M extends IgcInputComponentEventMap & HTMLElementEventMap
Parameters
- type: K
- listener: (this: HTMLElement, ev: M[K]) => any
- options: boolean | EventListenerOptions
Returns void
removeEventListener<K extends keyof HTMLElementEventMap>(
    type: K,
    listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:17888
Type parameters
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
- options: boolean | EventListenerOptions
Returns void

reportValidity

reportValidity(): boolean
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).reportValidity
- Defined in src/components/common/mixins/forms/types.ts:143
Checks for validity of the control and shows the browser message if it invalid.

Returns boolean

select

select(): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).select
- Defined in src/components/input/input-base.ts:90
Selects all the text inside the input.

Returns void

setCustomValidity

setCustomValidity(message: string): void
Inherited from EventEmitterMixin< IgcFileInputComponentEventMap, AbstractConstructor<IgcInputBaseComponent> >(IgcInputBaseComponent).setCustomValidity
- Defined in src/components/common/mixins/forms/types.ts:149
Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

Parameters
- message: string
Returns void

Class IgcFileInputComponent

Element

Slot

Slot

Slot

Slot

Slot

Slot

Slot

Slot

Fires

Fires

Csspart

Csspart

Csspart

Csspart

Csspart

Csspart

Csspart

Csspart

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

...args: any[]

Returns IgcFileInputComponent

Properties

accept

Attr

autofocus

Attr

disabled

Attr

Default

invalid

Attr

Default

label

Attr

multiple

Attr

Default

name

Attr

outlined

Attr

Default

placeholder

Attr

Staticstyles

Static ReadonlytagName

Accessors

defaultValue

Returns unknown

Parameters

value: unknown

Returns void

files

Returns FileList

form

Returns HTMLFormElement | null

locale

Returns string

Attr

Parameters

value: string

Returns void

required

Returns boolean

Attr

Default

Parameters

value: boolean

Returns void

resourceStrings

`Static`styles

`Static` `Readonly`tagName