From fc4f7574c90ceb6b8265d9ff48dabf36bad19e92 Mon Sep 17 00:00:00 2001 From: Lukas Harbarth Date: Tue, 22 Apr 2025 09:56:10 +0200 Subject: [PATCH] docs(FilterBar): outline `hideToolbar` behavior better --- packages/main/src/components/FilterBar/index.tsx | 2 ++ packages/main/src/components/FilterBar/types.ts | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/main/src/components/FilterBar/index.tsx b/packages/main/src/components/FilterBar/index.tsx index 1a247f26a0c..876eaac0698 100644 --- a/packages/main/src/components/FilterBar/index.tsx +++ b/packages/main/src/components/FilterBar/index.tsx @@ -48,6 +48,8 @@ const resizeObserverEntryWidth = (entry) => { * * Desktop: Expanded or collapsed by default * * Tablet: Collapsed by default * * Phone: Not displayed. Accessible through filter dialog. + * + * __Note:__ When `hideToolbar` is set to `true`, filters are always visible. */ const FilterBar = forwardRef((props, ref) => { const { diff --git a/packages/main/src/components/FilterBar/types.ts b/packages/main/src/components/FilterBar/types.ts index acbeb8aa52b..6d71c218dcb 100644 --- a/packages/main/src/components/FilterBar/types.ts +++ b/packages/main/src/components/FilterBar/types.ts @@ -98,7 +98,7 @@ export interface FilterBarPropTypes extends CommonProps { /** * Defines whether the toolbar on top of the filter items is displayed. * - * __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. + * __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. */ hideToolbar?: boolean; /**