The igc-date-range-picker allows the user to select a range of dates.

prefix - Renders content before the input (single input).

prefix-start - Renders content before the start input (two inputs).

prefix-end - Renders content before the end input (two inputs).

suffix - Renders content after the input (single input).

suffix-start - Renders content after the start input (single input).

suffix-end - Renders content after the end input (single input).

helper-text - Renders content below the input.

bad-input - Renders content when the value is in the disabledDates ranges.

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

range-overflow - Renders content when the max validation fails.

range-underflow - Renders content when the min validation fails.

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

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

title - Renders content in the calendar title.

header-date - Renders content instead of the current date/range in the calendar header.

clear-icon - Renders a clear icon template.

clear-icon-start - Renders a clear icon template for the start input (two inputs).

clear-icon-end - Renders a clear icon template for the end input (two inputs).

calendar-icon - Renders the icon/content for the calendar picker.

calendar-icon-start - Renders the icon/content for the calendar picker for the start input (two inputs).

calendar-icon-end - Renders the icon/content for the calendar picker for the end input (two inputs).

calendar-icon-open - Renders the icon/content for the picker in open state.

calendar-icon-open-start - Renders the icon/content for the picker in open state for the start input (two inputs).

calendar-icon-open-end - Renders the icon/content for the picker in open state for the end input (two inputs).

actions - Renders content in the action part of the picker in open state.

separator - Renders the separator element between the two inputs.

separator - The separator element between the two inputs.

ranges - The wrapper that renders the custom and predefined ranges.

label - The label wrapper that renders content above the target input.

calendar-icon - The calendar icon wrapper for closed state (single input).

calendar-icon-start - The calendar icon wrapper for closed state for the start input (two inputs).

calendar-icon-end - The calendar icon wrapper for closed state for the end input (two inputs).

calendar-icon-open - The calendar icon wrapper for opened state (single input).

calendar-icon-open-start - The calendar icon wrapper for opened state for the start input (two inputs).

calendar-icon-open-end - The calendar icon wrapper for opened state for the end input (two inputs).

clear-icon - The clear icon wrapper (single input).

clear-icon-start - The clear icon wrapper for the start input (two inputs).

clear-icon-end - The clear icon wrapper for the end input (two inputs).

actions - The wrapper for the custom actions area.

clear-icon - The clear icon wrapper.

input - The native input element.

prefix - The prefix wrapper.

suffix - The suffix wrapper.

helper-text - The helper-text wrapper that renders content below the target input.

header - The calendar header element.

header-title - The calendar header title element.

header-date - The calendar header date element.

calendar-content - The calendar content element which contains the views and navigation elements.

navigation - The calendar navigation container element.

months-navigation - The calendar months navigation button element.

years-navigation - The calendar years navigation button element.

years-range - The calendar years range element.

navigation-buttons - The calendar navigation buttons container.

navigation-button - The calendar previous/next navigation button.

days-view-container - The calendar days view container element.

days-view - The calendar days view element.

months-view - The calendar months view element.

years-view - The calendar years view element.

days-row - The calendar days row element.

calendar-label - The calendar week header label element.

week-number - The calendar week number element.

week-number-inner - The calendar week number inner element.

date - The calendar date element.

date-inner - The calendar date inner element.

first - The calendar first selected date element in range selection.

last - The calendar last selected date element in range selection.

inactive - The calendar inactive date element.

hidden - The calendar hidden date element.

weekend - The calendar weekend date element.

range - The calendar range selected element.

special - The calendar special date element.

disabled - The calendar disabled date element.

single - The calendar single selected date element.

preview - The calendar range selection preview date element.

month - The calendar month element.

month-inner - The calendar month inner element.

year - The calendar year element.

year-inner - The calendar year inner element.

selected - The calendar selected state for element(s). Applies to date, month and year elements.

current - The calendar current state for element(s). Applies to date, month and year elements.

Callable

  • Returns ReactNode

Events

onChange: (args: CustomEvent<DateRangeValue>) => void

Emitted when the user modifies and commits the elements's value.

Type declaration

onClosed: (args: CustomEvent<void>) => void

Emitted after the calendar dropdown is hidden.

Type declaration

onClosing: (args: CustomEvent<void>) => void

Emitted just before the calendar dropdown is hidden.

Type declaration

onInput: (args: CustomEvent<DateRangeValue>) => void

Emitted when when the user types in the element.

Type declaration

onOpened: (args: CustomEvent<void>) => void

Emitted after the calendar dropdown is shown.

Type declaration

onOpening: (args: CustomEvent<void>) => void

Emitted just before the calendar dropdown is shown.

Type declaration

Methods

  • Clears the input parts of the component of any user input

    Returns void

Properties

activeDate: Date

Gets/Sets the date which is shown in the calendar picker and is highlighted. By default it is the current date.

customRanges: CustomDateRange[]

Renders chips with custom ranges based on the elements of the array.

disabledDates: DateRangeDescriptor[]

Gets/sets disabled dates.

displayFormat: string

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

headerOrientation: ContentOrientation

The orientation of the calendar header.

hideHeader: boolean

Determines whether the calendar hides its header.

hideOutsideDays: boolean

Controls the visibility of the dates that do not belong to the current month.

inputFormat: string

The date format to apply on the inputs. Defaults to the current locale Intl.DateTimeFormat

label: string

The label of the control (single input).

labelEnd: string

The label attribute of the end input.

labelStart: string

The label attribute of the start input.

locale: string

The locale settings used to display the value.

max: Date

The maximum value required for the date range picker to remain valid.

min: Date

The minimum value required for the date range picker to remain valid.

Determines whether the calendar is opened in a dropdown or a modal dialog

nonEditable: boolean

Whether to allow typing in the input.

orientation: ContentOrientation

The orientation of the multiple months displayed in the calendar's days view.

outlined: boolean

Whether the control will have outlined appearance.

placeholder: string

The placeholder attribute of the control (single input).

placeholderEnd: string

The placeholder attribute of the end input.

placeholderStart: string

The placeholder attribute of the start input.

prompt: string

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

readOnly: boolean

Makes the control a readonly field.

resourceStrings: IgcDateRangePickerResourceStrings

The resource strings of the date range picker.

showWeekNumbers: boolean

Whether to show the number of the week in the calendar.

specialDates: DateRangeDescriptor[]

Gets/sets special dates.

usePredefinedRanges: boolean

Whether the control will show chips with predefined ranges.

useTwoInputs: boolean

Use two inputs to display the date range values. Makes the input editable in dropdown mode.

visibleMonths: number

The number of months displayed in the calendar.

weekStart: WeekDays

Sets the start day of the week for the calendar.