Skip to content

fix(Toolbar - compat): prevent empty overflow popover #7185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lukas742 merged 2 commits into from
Apr 7, 2025
Merged

fix(Toolbar - compat): prevent empty overflow popover #7185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82eebb3
fix(Toolbar - compat): prevent empty overflow popover
Lukas742 Apr 3, 2025
df41142
Merge branch 'main' into fix/toolbar-compat-spacer-separator-children
Lukas742 Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions packages/compat/src/components/Toolbar/Toolbar.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,45 @@ describe('Toolbar', () => {
cy.get('[data-component-name="ToolbarOverflowPopoverContent"]').should('have.attr', 'role', 'menu');
});

it('no overflow button for spacer- or separator-only children', () => {
cy.mount(
<Toolbar style={{ width: '0px' }}>
<ToolbarSpacer />
<Button>Button</Button>
<ToolbarSeparator />
</Toolbar>,
{ strict: false }
);
cy.get('[data-component-name="ToolbarOverflowButtonContainer"]').should('exist');

cy.mount(
<Toolbar style={{ width: '0px' }}>
<ToolbarSpacer />
<ToolbarSeparator />
</Toolbar>,
{ strict: false }
);
cy.get('[data-component-name="ToolbarOverflowButtonContainer"]').should('not.exist');
cy.mount(
<Toolbar style={{ width: '0px' }}>
<ToolbarSpacer />
<ToolbarSpacer />
<ToolbarSpacer />
</Toolbar>,
{ strict: false }
);
cy.get('[data-component-name="ToolbarOverflowButtonContainer"]').should('not.exist');
cy.mount(
<Toolbar style={{ width: '0px' }}>
<ToolbarSeparator />
<ToolbarSeparator />
<ToolbarSeparator />
</Toolbar>,
{ strict: false }
);
cy.get('[data-component-name="ToolbarOverflowButtonContainer"]').should('not.exist');
});

mountWithCustomTagName(Toolbar);
cypressPassThroughTestsFactory(Toolbar);
});
20 changes: 18 additions & 2 deletions packages/compat/src/components/Toolbar/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ export interface ToolbarPropTypes extends Omit<CommonProps, 'onClick' | 'childre
* __Note:__ Although this prop accepts all `ReactNode` types, it is strongly recommended to not pass `string`, `number` or a React Portal to it.
*
* __Note:__ Only components displayed inside the Toolbar are supported as children, i.e. elements positioned outside the normal flow of the document (like dialogs or popovers), can cause undesired behavior.
*
* __Note:__ If only `ToolbarSpacer`s or `ToolbarSeparator`s are added to the Toolbar, the components will not be rendered.
*/
children?: ReactNode | ReactNode[];
/**
Expand Down Expand Up @@ -188,14 +190,20 @@ const Toolbar = forwardRef<HTMLDivElement, ToolbarPropTypes>((props, ref) => {
const childrenWithRef = useMemo(() => {
controlMetaData.current = [];

return flatChildren.map((item, index) => {
let hasOnlySpacersOrSeparators = true;
const enrichedChildren = flatChildren.map((item, index) => {
const itemRef: RefObject<HTMLDivElement> = createRef();
// @ts-expect-error: if type is not defined, it's not a spacer
const isSpacer = item?.type?.displayName === 'ToolbarSpacer';
// @ts-expect-error: if type is not defined, it's not a separator
const isSeparator = item?.type?.displayName === 'ToolbarSeparator';
controlMetaData.current.push({
ref: itemRef,
isSpacer
});
if (!isSpacer && !isSeparator) {
hasOnlySpacersOrSeparators = false;
}
if (isSpacer) {
return item;
}
Expand All @@ -210,7 +218,15 @@ const Toolbar = forwardRef<HTMLDivElement, ToolbarPropTypes>((props, ref) => {
</div>
);
});
}, [flatChildren, controlMetaData, classNames.childContainer]);

if (hasOnlySpacersOrSeparators) {
return enrichedChildren.filter(
// @ts-expect-error: if type is not defined, it's not a separator or spacer
(item) => item?.type?.displayName !== 'ToolbarSpacer' && item?.type?.displayName === 'ToolbarSeparator'
);
}
return enrichedChildren;
}, [flatChildren, controlMetaData]);

const overflowNeeded =
(lastVisibleIndex || lastVisibleIndex === 0) &&
Expand Down
Loading