Skip to main content

IDateRangePreset

Admin Docs

Interface: IDateRangePreset

Defined in: src/types/shared-components/DateRangePicker/interface.ts:52

IDateRangePreset

Configuration for a preset date range button.

Param​

Optional reference date for relative presets. Defaults to the current date if not provided.

Example​

{
  key: 'last7days',
  label: 'Last 7 Days',
  getRange: (refDate = new Date()) => ({
    startDate: dayjs(refDate).subtract(7, 'day').toDate(),
    endDate: refDate,
  }),
}

Properties​

getRange()​

getRange: (refDate?) => IDateRangeValue

Defined in: src/types/shared-components/DateRangePicker/interface.ts:55

Parameters​

refDate?​

Date

Returns​

IDateRangeValue

key​

key: string

Defined in: src/types/shared-components/DateRangePicker/interface.ts:53

label​

label: string

Defined in: src/types/shared-components/DateRangePicker/interface.ts:54