Constructors

Section titled "Constructors"

IgcDateTimeInputComponent 

new IgcDateTimeInputComponent(): IgcDateTimeInputComponent

Defined in src/components/date-time-input/date-time-input.base.ts:222

Returns IgcDateTimeInputComponent

Properties

Section titled "Properties"

disabled

Section titled "disabled"

Inherited from: IgcDateTimeInputBaseComponent

The disabled state of the component.

 
disabled: boolean

Defined in src/components/common/mixins/forms/types.ts:29

invalid

Section titled "invalid"

Inherited from: IgcDateTimeInputBaseComponent

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

 
invalid: boolean

Defined in src/components/common/mixins/forms/types.ts:36

label

Section titled "label"

Inherited from: IgcDateTimeInputBaseComponent

The label for the control.

 
label: string

Defined in src/components/date-time-input/date-time-input.base.ts:128

name

Section titled "name"

Inherited from: IgcDateTimeInputBaseComponent

The name attribute of the control.

 
name: string

Defined in src/components/common/mixins/forms/types.ts:42

outlined

Section titled "outlined"

Inherited from: IgcDateTimeInputBaseComponent

Whether the control will have outlined appearance.

 
outlined: boolean = false

Defined in src/components/date-time-input/date-time-input.base.ts:114

placeholder

Section titled "placeholder"

Inherited from: IgcDateTimeInputBaseComponent

The placeholder attribute of the control.

 
placeholder: string

Defined in src/components/date-time-input/date-time-input.base.ts:121

readOnly

Section titled "readOnly"

Inherited from: IgcDateTimeInputBaseComponent

Makes the control a readonly field.

 
readOnly: boolean

Defined in src/components/common/mixins/mask-behavior.ts:53

Optional spinDelta

Section titled "spinDelta"

Inherited from: IgcDateTimeInputBaseComponent

Delta values used to increment or decrement each date part on step actions. All values default to 1.

 
spinDelta: DatePartDeltas

Defined in src/components/date-time-input/date-time-input.base.ts:196

spinLoop

Section titled "spinLoop"

Inherited from: IgcDateTimeInputBaseComponent

Sets whether to loop over the currently spun segment.

 
spinLoop: boolean = true

Defined in src/components/date-time-input/date-time-input.base.ts:203

styles

Section titled "styles" 
styles: CSSResult[]

Defined in src/components/date-time-input/date-time-input.ts:63

tagName

Section titled "tagName" 
tagName: "igc-date-time-input" = 'igc-date-time-input'

Defined in src/components/date-time-input/date-time-input.ts:62

Accessors

Section titled "Accessors"

defaultValue

Section titled "defaultValue"

Inherited from: IgcDateTimeInputBaseComponent 

get defaultValue(): unknown

Defined in src/components/common/mixins/forms/types.ts:163

Returns unknown

The initial value of the component.

 
set defaultValue(value: unknown): void

Defined in src/components/common/mixins/forms/types.ts:162

Parameters

  • value: unknown

Returns void

displayFormat

Section titled "displayFormat"

Inherited from: IgcDateTimeInputBaseComponent 

get displayFormat(): string

Defined in src/components/date-time-input/date-time-input.base.ts:185

Returns string

Format to display the value in when not editing. Defaults to the locale format if not set.

 
set displayFormat(value: string): void

Defined in src/components/date-time-input/date-time-input.base.ts:181

Parameters

  • value: string

Returns void

form

Section titled "form"

Inherited from: IgcDateTimeInputBaseComponent

Returns the HTMLFormElement associated with this element.

 
get form(): HTMLFormElement | null

Defined in src/components/common/mixins/forms/types.ts:45

Returns HTMLFormElement | null

inputFormat

Section titled "inputFormat"

Inherited from: IgcDateTimeInputBaseComponent

The date format to apply on the input.

 
get inputFormat(): string

Defined in src/components/date-time-input/date-time-input.base.ts:135

Returns string 

set inputFormat(val: string): void

Defined in src/components/date-time-input/date-time-input.base.ts:139

Parameters

  • val: string

Returns void

locale

Section titled "locale"

Inherited from: IgcDateTimeInputBaseComponent 

get locale(): string

Defined in src/components/date-time-input/date-time-input.base.ts:214

Returns string

Gets/Sets the locale used for formatting the display value.

 
set locale(value: string): void

Defined in src/components/date-time-input/date-time-input.base.ts:210

Parameters

  • value: string

Returns void

mask

Section titled "mask"

Inherited from: IgcDateTimeInputBaseComponent

The mask pattern of the component.

 
get mask(): string

Defined in src/components/common/mixins/mask-behavior.ts:59

Returns string 

set mask(value: string): void

Defined in src/components/common/mixins/mask-behavior.ts:60

Parameters

  • value: string

Returns void

max

Section titled "max"

Inherited from: IgcDateTimeInputBaseComponent 

get max(): Date | null

Defined in src/components/date-time-input/date-time-input.base.ts:171

Returns Date | null

The maximum value required for the input to remain valid.

 
set max(value: string | Date | null | undefined): void

Defined in src/components/date-time-input/date-time-input.base.ts:166

Parameters

  • value: string | Date | null | undefined

Returns void

min

Section titled "min"

Inherited from: IgcDateTimeInputBaseComponent 

get min(): Date | null

Defined in src/components/date-time-input/date-time-input.base.ts:157

Returns Date | null

The minimum value required for the input to remain valid.

 
set min(value: string | Date | null | undefined): void

Defined in src/components/date-time-input/date-time-input.base.ts:152

Parameters

  • value: string | Date | null | undefined

Returns void

prompt

Section titled "prompt"

Inherited from: IgcDateTimeInputBaseComponent

The prompt symbol to use for unfilled parts of the mask pattern.

 
get prompt(): string

Defined in src/components/common/mixins/mask-behavior.ts:67

Returns string 

set prompt(value: string): void

Defined in src/components/common/mixins/mask-behavior.ts:68

Parameters

  • value: string

Returns void

required

Section titled "required"

Inherited from: IgcDateTimeInputBaseComponent 

get required(): boolean

Defined in src/components/common/mixins/forms/types.ts:181

Returns boolean

When set, makes the component a required field for validation.

 
set required(value: boolean): void

Defined in src/components/common/mixins/forms/types.ts:180

Parameters

  • value: boolean

Returns void

validationMessage

Section titled "validationMessage"

Inherited from: IgcDateTimeInputBaseComponent

A string containing the validation message of this element.

 
get validationMessage(): string

Defined in src/components/common/mixins/forms/types.ts:54

Returns string

validity

Section titled "validity"

Inherited from: IgcDateTimeInputBaseComponent

Returns a ValidityState object which represents the different validity states the element can be in, with respect to constraint validation.

 
get validity(): ValidityState

Defined in src/components/common/mixins/forms/types.ts:51

Returns ValidityState

value

Section titled "value" 
get value(): Date | null

Defined in src/components/date-time-input/date-time-input.ts:107

Returns Date | null

The value of the input.

 
set value(value: string | Date | null | undefined): void

Defined in src/components/date-time-input/date-time-input.ts:102

Parameters

  • value: string | Date | null | undefined

Returns void

willValidate

Section titled "willValidate"

Inherited from: IgcDateTimeInputBaseComponent

A boolean value which returns true if the element is a submittable element that is a candidate for constraint validation.

 
get willValidate(): boolean

Defined in src/components/common/mixins/forms/types.ts:60

Returns boolean

Methods

Section titled "Methods"

addEventListener

Section titled "addEventListener"

Inherited from: IgcDateTimeInputBaseComponent 

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:7

Parameters

  • type: K
  • listener: object
  • options: boolean | AddEventListenerOptions

Returns void

blur

Section titled "blur"

Inherited from: IgcDateTimeInputBaseComponent

Removes focus from the control.

 
blur(): void

Defined in src/components/date-time-input/date-time-input.base.ts:418

Returns void

checkValidity

Section titled "checkValidity"

Inherited from: IgcDateTimeInputBaseComponent

Checks for validity of the control and emits the invalid event if it invalid.

 
checkValidity(): boolean

Defined in src/components/common/mixins/forms/types.ts:146

Returns boolean

clear

Section titled "clear"

Clears the input element of user input.

 
clear(): void

Defined in src/components/date-time-input/date-time-input.ts:344

Returns void

emitEvent

Section titled "emitEvent"

Inherited from: IgcDateTimeInputBaseComponent 

emitEvent(type: K, eventInitDict: CustomEventInit<D>): boolean

Defined in src/components/common/mixins/event-emitter.ts:30

Parameters

  • type: K
  • eventInitDict: CustomEventInit<D>

Returns boolean

focus

Section titled "focus"

Inherited from: IgcDateTimeInputBaseComponent

Sets focus on the control.

 
focus(options: FocusOptions): void

Defined in src/components/date-time-input/date-time-input.base.ts:412

Parameters

  • options: FocusOptions

Returns void

hasDateParts

Section titled "hasDateParts"

Checks whether the current format includes date parts (day, month, year).

 
hasDateParts(): boolean

Defined in src/components/date-time-input/date-time-input.ts:354

Returns boolean

hasTimeParts

Section titled "hasTimeParts"

Checks whether the current format includes time parts (hours, minutes, seconds).

 
hasTimeParts(): boolean

Defined in src/components/date-time-input/date-time-input.ts:363

Returns boolean

removeEventListener

Section titled "removeEventListener"

Inherited from: IgcDateTimeInputBaseComponent 

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:17

Parameters

  • type: K
  • listener: object
  • options: boolean | EventListenerOptions

Returns void

reportValidity

Section titled "reportValidity"

Inherited from: IgcDateTimeInputBaseComponent

Checks for validity of the control and shows the browser message if it invalid.

 
reportValidity(): boolean

Defined in src/components/common/mixins/forms/types.ts:149

Returns boolean

select

Section titled "select"

Inherited from: IgcDateTimeInputBaseComponent

Selects all the text inside the input.

 
select(): void

Defined in src/components/date-time-input/date-time-input.base.ts:406

Returns void

setCustomValidity

Section titled "setCustomValidity"

Inherited from: IgcDateTimeInputBaseComponent

Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

 
setCustomValidity(message: string): void

Defined in src/components/common/mixins/forms/types.ts:155

Parameters

  • message: string

Returns void

setRangeText

Section titled "setRangeText"

Inherited from: IgcDateTimeInputBaseComponent

Replaces the selected text in the control and re-applies the mask.

 
setRangeText(replacement: string, start: number, end: number, selectMode: RangeTextSelectMode): void

Defined in src/components/common/mixins/mask-behavior.ts:94

Parameters

Returns void

setSelectionRange

Section titled "setSelectionRange"

Inherited from: IgcDateTimeInputBaseComponent

Sets the text selection range of the control.

 
setSelectionRange(start: number, end: number, direction: SelectionRangeDirection): void

Defined in src/components/common/mixins/mask-behavior.ts:87

Parameters

Returns void

stepDown

Section titled "stepDown"

Decrements a date/time portion.

 
stepDown(datePart: DatePart, delta: number): void

Defined in src/components/date-time-input/date-time-input.ts:339

Parameters

Returns void

stepUp

Section titled "stepUp"

Increments a date/time portion.

 
stepUp(datePart: DatePart, delta: number): void

Defined in src/components/date-time-input/date-time-input.ts:334

Parameters

Returns void

register

Section titled "register" 
register(): void

Defined in src/components/date-time-input/date-time-input.ts:66

Returns void

Events

Section titled "Events"

igcChange

Section titled "igcChange" 
igcChange: CustomEvent<unknown>

Defined in src/components/date-time-input/date-time-input.base.ts:55

igcInput

Section titled "igcInput" 
igcInput: CustomEvent<string>

Defined in src/components/input/input-base.ts:18