Skip to content

Commit 2cf6183

Browse files
authored
docs(FilterBar): outline responsive behavior of filter area (#5992)
Fixes #5991
1 parent 5769311 commit 2cf6183

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

packages/main/src/components/FilterBar/index.tsx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,16 @@ const resizeObserverEntryWidth = (entry) => {
4949

5050
/**
5151
* The `FilterBar` displays filters in a user-friendly manner to populate values for a query. It consists of a row containing the `VariantManagement` or a title, the related buttons, and an area underneath displaying the filters. The filters are arranged in a logical row that is divided depending on the space available and the width of the filters. The area containing the filters can be hidden or shown using the "Hide FilterBar / Show FilterBar" button, the "Filters" button shows the filter dialog.
52-
In this dialog, the consumer has full control over the FilterBar. The filters in this dialog are displayed in one column and organized in groups. Each filter can be marked as visible in the FilterBar by selecting the respective checkbox.
53-
54-
__Note:__ We recommend always fully controlling the filters, as otherwise, you may encounter discrepancies between the filters dialog and the FilterBar, especially when using complex or custom filter components.
52+
* In this dialog, the consumer has full control over the FilterBar. The filters in this dialog are displayed in one column and organized in groups. Each filter can be marked as visible in the FilterBar by selecting the respective row.
53+
*
54+
* __Responsiveness:__
55+
* The name of the view or title is always visible. The filter area varies:
56+
*
57+
* * Desktop: Expanded or collapsed by default
58+
* * Tablet: Collapsed by default
59+
* * Phone: Not displayed. Accessible through filter dialog.
60+
*
61+
*__Note:__ We recommend always fully controlling the filters, as otherwise, you may encounter discrepancies between the filters dialog and the FilterBar, especially when using complex or custom filter components.
5562
*/
5663
const FilterBar = forwardRef<HTMLDivElement, FilterBarPropTypes>((props, ref) => {
5764
const {

packages/main/src/components/FilterBar/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export interface FilterBarPropTypes extends CommonProps {
9797
/**
9898
* Defines whether the "Hide/Show Filters" button is displayed in the `FilterBar`.
9999
*
100-
* __Note:__ If `hideToolbar` is `true` this prop has no effect.
100+
* __Note:__ If `hideToolbar` is `true` or the FilterBar is used on mobile, this prop has no effect.
101101
*/
102102
hideToggleFiltersButton?: boolean;
103103
/**

0 commit comments

Comments
 (0)