Skip to content

feat(ObjectPage): introduce preserveHeaderStateOnClick prop #6049

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
merged 1 commit into from
Jul 9, 2024
Merged

feat(ObjectPage): introduce preserveHeaderStateOnClick prop #6049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions packages/main/src/components/ObjectPage/ObjectPage.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,28 @@ describe('ObjectPage', () => {
cy.findByText('ObjectPageHeader').should('be.visible');
cy.get('@toggleSpy').should('have.been.calledWith', true);
cy.get('@toggleSpy').should('have.callCount', 4);

cy.mount(
<ObjectPage
headerTitle={<ObjectPageTitle header="Heading" subHeader="SubHeading" />}
headerContent={<ObjectPageHeader>ObjectPageHeader</ObjectPageHeader>}
onToggleHeaderContent={toggle}
hidePinButton
preserveHeaderStateOnClick
>
<ObjectPageSection id="section" titleText="Section">
Content
</ObjectPageSection>
</ObjectPage>
);

cy.findByText('Heading').click();
cy.findByText('ObjectPageHeader').should('be.visible');
cy.get('@toggleSpy').should('have.callCount', 4);

cy.get('[data-component-name="ObjectPageTitle"]').click();
cy.findByText('ObjectPageHeader').should('be.visible');
cy.get('@toggleSpy').should('have.callCount', 4);
});

it('pin header', () => {
Expand Down
21 changes: 13 additions & 8 deletions packages/main/src/components/ObjectPage/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ export interface ObjectPagePropTypes extends Omit<CommonProps, 'placeholder'> {
* Defines if the pin button for the `headerContent` is hidden.
*/
hidePinButton?: boolean;
/**
* Determines whether the user can switch between the expanded/collapsed states of the `ObjectPageHeader` by clicking on the `ObjectPageTitle`.
*
* __Note:__ Per default the header is toggleable.
*/
preserveHeaderStateOnClick?: boolean;
/**
* Defines internally used accessibility properties/attributes.
*/
Expand Down Expand Up @@ -192,6 +198,7 @@ const ObjectPage = forwardRef<HTMLDivElement, ObjectPagePropTypes>((props, ref)
headerPinned: headerPinnedProp,
headerContent,
hidePinButton,
preserveHeaderStateOnClick,
accessibilityAttributes,
placeholder,
onSelectedSectionChange,
Expand Down Expand Up @@ -598,13 +605,11 @@ const ObjectPage = forwardRef<HTMLDivElement, ObjectPagePropTypes>((props, ref)
}
}, [isAfterScroll]);

const onTitleClick = useCallback(
(e) => {
e.stopPropagation();
const onTitleClick = (e) => {
e.stopPropagation();
if (!preserveHeaderStateOnClick)
onToggleHeaderContentVisibility(enrichEventWithDetails(e, { visible: headerCollapsed }));
},
[onToggleHeaderContentVisibility, headerCollapsed]
);
};

const snappedHeaderInObjPage = headerTitle && headerTitle.props.snappedContent && headerCollapsed === true && !!image;

Expand Down Expand Up @@ -743,7 +748,7 @@ const ObjectPage = forwardRef<HTMLDivElement, ObjectPagePropTypes>((props, ref)
data-component-name="ObjectPageTopHeader"
ref={topHeaderRef}
role={accessibilityAttributes?.objectPageTopHeader?.role}
data-not-clickable={false}
data-not-clickable={!!preserveHeaderStateOnClick}
aria-roledescription={accessibilityAttributes?.objectPageTopHeader?.ariaRoledescription ?? 'Object Page header'}
className={classNames.header}
onClick={onTitleClick}
Expand All @@ -760,7 +765,7 @@ const ObjectPage = forwardRef<HTMLDivElement, ObjectPagePropTypes>((props, ref)
cloneElement(headerTitle as ReactElement<ObjectPageTitlePropsWithDataAttributes>, {
className: clsx(headerTitle?.props?.className),
onToggleHeaderContentVisibility: onTitleClick,
'data-not-clickable': false,
'data-not-clickable': !!preserveHeaderStateOnClick,
'data-header-content-visible': headerContent && headerCollapsed !== true,
'data-is-snapped-rendered-outside': snappedHeaderInObjPage
})}
Expand Down
Loading