> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IDateFilterOwnProps

- Package: [@gooddata/sdk-ui-filters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-filters/src/DateFilter/DateFilter.tsx

Props of the [DateFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.datefilter/index.md) component.

**Signature:**

```typescript
export interface IDateFilterOwnProps extends IDateFilterStatePropsIntersection 
```
**Extends:** [IDateFilterStatePropsIntersection](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterstatepropsintersection/index.md)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [activeCalendars?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsactivecalendars) |  | [IActiveCalendars](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iactivecalendars/index.md) | **_(ALPHA)_** _(Optional)_ Active calendars configuration from workspace settings. Controls which calendar types (standard/fiscal) are available in the filter. |
| [availableGranularities](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsavailablegranularities) |  | [DateFilterGranularity](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datefiltergranularity/index.md)[] |  |
| [ButtonComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsbuttoncomponent) |  | ComponentType<[IDateFilterButtonProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterbuttonprops/index.md)> | **_(ALPHA)_** _(Optional)_ Specify custom button component |
| [customFilterName?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropscustomfiltername) |  | string | _(Optional)_ |
| [customIcon?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropscustomicon) |  | [IFilterButtonCustomIcon](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.ifilterbuttoncustomicon/index.md) | **_(ALPHA)_** _(Optional)_ Represents a custom icon with associated tooltip information. |
| [customRangeHint?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropscustomrangehint) |  | ReactNode | **_(ALPHA)_** _(Optional)_ Custom content rendered at the end of the hint area of the static period (absolute range) form, after the default date/time format hints. |
| [dateFilterMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsdatefiltermode) |  | [VisibilityMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.visibilitymode/index.md) |  |
| [dateFormat?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsdateformat) |  | string | _(Optional)_ |
| [enableEmptyDateValues?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsenableemptydatevalues) |  | boolean | **_(ALPHA)_** _(Optional)_ Enables empty date values UI (e.g. “Other → Empty values” preset, empty-values handling controls). |
| [FilterConfigurationComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsfilterconfigurationcomponent) |  | ComponentType<[IFilterConfigurationProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.ifilterconfigurationprops/index.md)> | **_(ALPHA)_** _(Optional)_ Represents a custom component for configuration. |
| [filterOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsfilteroptions) |  | [IDateFilterOptionsByType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilteroptionsbytype/index.md) |  |
| [hideDisabledExclude?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropshidedisabledexclude) |  | boolean | **_(ALPHA)_** _(Optional)_ When true, the "Exclude current period" toggle is hidden when it is disabled for the currently selected option. |
| [isAbsoluteDateFilterGranularityEnabled?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsisabsolutedatefiltergranularityenabled) |  | boolean | **_(ALPHA)_** _(Optional)_ Enables Day/Week/Month/Quarter/Year granularity switching for the absolute (static) date filter. |
| [isEditMode?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsiseditmode) |  | boolean | _(Optional)_ |
| [isSecondsForAbsoluteRangeEnabled?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsissecondsforabsoluterangeenabled) |  | boolean | _(Optional)_ If enabled, the absolute date filter form time inputs allow second-level precision (HH:mm:ss) instead of minute precision (HH:mm). Only takes effect together with `isTimeForAbsoluteRangeEnabled`. |
| [isTimeForAbsoluteRangeEnabled?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsistimeforabsoluterangeenabled) |  | boolean | _(Optional)_ |
| [locale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropslocale) |  | string | _(Optional)_ |
| [openOnInit?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsopenoninit) |  | boolean | _(Optional)_ |
| [overlayPositionType?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsoverlaypositiontype) |  | OverlayPositionType | _(Optional)_ Specifies the overlay position type for the date filter dropdown. |
| [showDropDownHeaderMessage?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsshowdropdownheadermessage) |  | boolean | _(Optional)_ |
| [weekStart?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsweekstart) |  | [WeekStart](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.weekstart/index.md) | _(Optional)_ The day weeks start on in the calendars and in the list of weeks. Defaults to Sunday. |
| [withoutApply?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropswithoutapply) |  | boolean | **_(ALPHA)_** _(Optional)_ This enables filter mode without apply button. If true, it is responsibility of a client, to appy filters when needed. Typically uses onSelect callback to catch filter state. Note, onApply callback is not called when this is true. |
| [workingExcludeCurrentPeriod?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsworkingexcludecurrentperiod) |  | boolean | **_(ALPHA)_** _(Optional)_ Working filter exclude current period used for synchronization inner filter state with outer given state. Makes a controlled component state out of this. |
| [workingSelectedFilterOption?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.idatefilterownprops/index.md#idatefilterownpropsworkingselectedfilteroption) |  | [DateFilterOption](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.datefilteroption/index.md) | **_(ALPHA)_** _(Optional)_ Working filter option used for synchronization inner filter state with outer given state. Makes a controlled component state out of this. |

## Property details

### IDateFilterOwnProps.activeCalendars

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Active calendars configuration from workspace settings. Controls which calendar types (standard/fiscal) are available in the filter.

**Signature:**

```typescript
activeCalendars?: IActiveCalendars;
```

#### Remarks

When provided: - `standard: true` enables standard calendar presets - `fiscal: true` enables fiscal calendar presets - `default` determines which tab is selected by default ("STANDARD" or "FISCAL")

When undefined, defaults to standard calendar only.

### IDateFilterOwnProps.availableGranularities

**Signature:**

```typescript
availableGranularities: DateFilterGranularity[];
```

### IDateFilterOwnProps.ButtonComponent

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Specify custom button component

**Signature:**

```typescript
ButtonComponent?: ComponentType<IDateFilterButtonProps>;
```

### IDateFilterOwnProps.customFilterName

**Signature:**

```typescript
customFilterName?: string;
```

### IDateFilterOwnProps.customIcon

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Represents a custom icon with associated tooltip information.

**Signature:**

```typescript
customIcon?: IFilterButtonCustomIcon;
```

### IDateFilterOwnProps.customRangeHint

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Custom content rendered at the end of the hint area of the static period (absolute range) form, after the default date/time format hints.

**Signature:**

```typescript
customRangeHint?: ReactNode;
```

#### Remarks

Use this to surface an application-specific note about the selected range (e.g. that the whole period is always applied). The content is appended after the built-in hints, so their accessibility wiring (`aria-describedby` of the range inputs) is preserved.

### IDateFilterOwnProps.dateFilterMode

**Signature:**

```typescript
dateFilterMode: VisibilityMode;
```

### IDateFilterOwnProps.dateFormat

**Signature:**

```typescript
dateFormat?: string;
```

### IDateFilterOwnProps.enableEmptyDateValues

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Enables empty date values UI (e.g. “Other → Empty values” preset, empty-values handling controls).

**Signature:**

```typescript
enableEmptyDateValues?: boolean;
```

#### Remarks

Defaults to `false` to keep backward compatibility. Dashboard apps should control this via a feature flag and explicitly opt-in.

### IDateFilterOwnProps.FilterConfigurationComponent

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Represents a custom component for configuration.

**Signature:**

```typescript
FilterConfigurationComponent?: ComponentType<IFilterConfigurationProps>;
```

### IDateFilterOwnProps.filterOptions

**Signature:**

```typescript
filterOptions: IDateFilterOptionsByType;
```

### IDateFilterOwnProps.hideDisabledExclude

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

When true, the "Exclude current period" toggle is hidden when it is disabled for the currently selected option.

**Signature:**

```typescript
hideDisabledExclude?: boolean;
```

#### Default Value

false

#### Remarks

By default (false), the toggle remains visible and is rendered disabled when not applicable.

### IDateFilterOwnProps.isAbsoluteDateFilterGranularityEnabled

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Enables Day/Week/Month/Quarter/Year granularity switching for the absolute (static) date filter.

**Signature:**

```typescript
isAbsoluteDateFilterGranularityEnabled?: boolean;
```

#### Remarks

Defaults to `false` to keep backward compatibility. Dashboard apps should control this via a feature flag and explicitly opt-in.

### IDateFilterOwnProps.isEditMode

**Signature:**

```typescript
isEditMode?: boolean;
```

### IDateFilterOwnProps.isSecondsForAbsoluteRangeEnabled

If enabled, the absolute date filter form time inputs allow second-level precision (HH:mm:ss) instead of minute precision (HH:mm). Only takes effect together with `isTimeForAbsoluteRangeEnabled`.

**Signature:**

```typescript
isSecondsForAbsoluteRangeEnabled?: boolean;
```

#### Default Value

false

### IDateFilterOwnProps.isTimeForAbsoluteRangeEnabled

**Signature:**

```typescript
isTimeForAbsoluteRangeEnabled?: boolean;
```

### IDateFilterOwnProps.locale

**Signature:**

```typescript
locale?: string;
```

### IDateFilterOwnProps.openOnInit

**Signature:**

```typescript
openOnInit?: boolean;
```

### IDateFilterOwnProps.overlayPositionType

Specifies the overlay position type for the date filter dropdown.

**Signature:**

```typescript
overlayPositionType?: OverlayPositionType;
```

### IDateFilterOwnProps.showDropDownHeaderMessage

**Signature:**

```typescript
showDropDownHeaderMessage?: boolean;
```

### IDateFilterOwnProps.weekStart

The day weeks start on in the calendars and in the list of weeks. Defaults to Sunday.

**Signature:**

```typescript
weekStart?: WeekStart;
```

### IDateFilterOwnProps.withoutApply

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

This enables filter mode without apply button. If true, it is responsibility of a client, to appy filters when needed. Typically uses onSelect callback to catch filter state. Note, onApply callback is not called when this is true.

**Signature:**

```typescript
withoutApply?: boolean;
```

### IDateFilterOwnProps.workingExcludeCurrentPeriod

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

> Warning: This API is now obsolete.
> 
> dont use. Will be removed in future releases.
> 

Working filter exclude current period used for synchronization inner filter state with outer given state. Makes a controlled component state out of this.

**Signature:**

```typescript
workingExcludeCurrentPeriod?: boolean;
```

### IDateFilterOwnProps.workingSelectedFilterOption

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

> Warning: This API is now obsolete.
> 
> dont use. Will be removed in future releases.
> 

Working filter option used for synchronization inner filter state with outer given state. Makes a controlled component state out of this.

**Signature:**

```typescript
workingSelectedFilterOption?: DateFilterOption;
```