Skip to content

Commit

Permalink
chore(sdk-ui-filters): deprecate working filters props
Browse files Browse the repository at this point in the history
- we will remove them and use regular variants for sync working state instead
- improve changelog message

JIRA: GDP-2938
risk: low
  • Loading branch information
ondrejvelisek committed Mar 11, 2025
1 parent 62b40be commit 87a3d19
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"changes": [
{
"packageName": "@gooddata/sdk-ui-all",
"comment": "Support of new filter mode Apply all at once",
"comment": "Support of new filter mode Apply all at once in Dashboard",
"type": "none"
}
],
Expand Down
5 changes: 5 additions & 0 deletions libs/sdk-ui-filters/api/sdk-ui-filters.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,9 @@ export interface IAttributeFilterCoreProps {
staticElements?: IAttributeElement[];
title?: string;
validateElementsBy?: ObjRef[];
// @alpha
withoutApply?: boolean;
// @alpha @deprecated
workingFilter?: IAttributeFilter;
workspace?: string;
}
Expand Down Expand Up @@ -752,8 +754,11 @@ export interface IDateFilterOwnProps extends IDateFilterStatePropsIntersection {
showDropDownHeaderMessage?: boolean;
// (undocumented)
weekStart?: WeekStart;
// @alpha
withoutApply?: boolean;
// @alpha @deprecated
workingExcludeCurrentPeriod?: boolean;
// @alpha @deprecated
workingSelectedFilterOption?: DateFilterOption;
}

Expand Down
5 changes: 5 additions & 0 deletions libs/sdk-ui-filters/src/AttributeFilter/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ export interface IAttributeFilterCoreProps {
* @remarks
* If provided it will use the provided filter to show currently given working selection (controlled component).
* If not provided this component will use its own internal state (uncontrolled component).
*
* @alpha
* @deprecated dont use. Will be removed in future releases.
*/
workingFilter?: IAttributeFilter;

Expand Down Expand Up @@ -252,6 +255,8 @@ export interface IAttributeFilterCoreProps {
* 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.
*
* @alpha
*/
withoutApply?: boolean;

Expand Down
8 changes: 8 additions & 0 deletions libs/sdk-ui-filters/src/DateFilter/DateFilter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,26 @@ export interface IDateFilterOwnProps extends IDateFilterStatePropsIntersection {
* 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.
*
* @alpha
*/
withoutApply?: boolean;

/**
* Working filter option used for synchronization inner filter state with outer given state.
* Makes a controlled component state out of this.
*
* @alpha
* @deprecated dont use. Will be removed in future releases.
*/
workingSelectedFilterOption?: DateFilterOption;

/**
* Working filter exclude current period used for synchronization inner filter state with outer given state.
* Makes a controlled component state out of this.
*
* @alpha
* @deprecated dont use. Will be removed in future releases.
*/
workingExcludeCurrentPeriod?: boolean;

Expand Down

0 comments on commit 87a3d19

Please sign in to comment.