Skip to content

Commit 6443706

Browse files
authored
docs(FilterBar): outline hideToolbar behavior better (#7258)
1 parent d4022f1 commit 6443706

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

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

+2
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ const resizeObserverEntryWidth = (entry) => {
4848
* * Desktop: Expanded or collapsed by default
4949
* * Tablet: Collapsed by default
5050
* * Phone: Not displayed. Accessible through filter dialog.
51+
*
52+
* __Note:__ When `hideToolbar` is set to `true`, filters are always visible.
5153
*/
5254
const FilterBar = forwardRef<HTMLDivElement, FilterBarPropTypes>((props, ref) => {
5355
const {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ export interface FilterBarPropTypes extends CommonProps {
9898
/**
9999
* Defines whether the toolbar on top of the filter items is displayed.
100100
*
101-
* __Note__: If set to `true`, `header` and the "Hide/Show FilterBar" button are not available and the rest of the buttons are moved to the bottom right side of the filter area.
101+
* __Note:__ If set to `true`, `header` and the "Hide/Show FilterBar" button are not available, the `filterBarCollapsed` prop has no effect and the rest of the buttons are moved to the bottom right side of the filter area.
102102
*/
103103
hideToolbar?: boolean;
104104
/**

0 commit comments

Comments
 (0)