Skip to content
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

feat(ObjectPage): introduce preserveHeaderStateOnClick prop #6049

Merged
merged 1 commit into from
Jul 9, 2024
+35 −8
Merged

feat(ObjectPage): introduce preserveHeaderStateOnClick prop #6049

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
Original file line number Diff line number Diff line change
@@ -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', () => {
21 changes: 13 additions & 8 deletions packages/main/src/components/ObjectPage/index.tsx
View file
Original file line number Diff line number Diff line change
@@ -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.
*/
@@ -192,6 +198,7 @@ const ObjectPage = forwardRef<HTMLDivElement, ObjectPagePropTypes>((props, ref)
headerPinned: headerPinnedProp,
headerContent,
hidePinButton,
preserveHeaderStateOnClick,
accessibilityAttributes,
placeholder,
onSelectedSectionChange,
@@ -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;

@@ -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}
@@ -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
})}

Unchanged files with check annotations Beta

View file
packages/base/src/Device/index.cy.tsx
function ResizeTestComponent({ onChange }: { onChange: (event: { width: number; height: number }) => void }) {
useEffect(() => {
attachResizeHandler(onChange);
}, []);

Check warning on line 12 in packages/base/src/Device/index.cy.tsx

GitHub Actions / lint 

React Hook useEffect has a missing dependency: 'onChange'. Either include it or remove the dependency array
const unregister = () => {
detachResizeHandler(onChange);
}) {
useEffect(() => {
attachOrientationChangeHandler(onChange);
}, []);

Check warning on line 32 in packages/base/src/Device/index.cy.tsx

GitHub Actions / lint 

React Hook useEffect has a missing dependency: 'onChange'. Either include it or remove the dependency array
const unregister = () => {
detachOrientationChangeHandler(onChange);
View file
packages/charts/src/components/BarChart/BarChart.tsx
* @param measure {IChartMeasure} Current measure object
* @param dataElement {object} Current data element
*/
highlightColor?: (value: number, measure: MeasureConfig, dataElement: Record<string, any>) => CSSProperties['color'];

Check warning on line 79 in packages/charts/src/components/BarChart/BarChart.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
}
interface DimensionConfig extends IChartDimension {
? dataKeys.findIndex((key) => key === chartConfig.secondYAxis?.dataKey)
: 0;
const [componentRef, chartRef] = useSyncRef<any>(ref);

Check warning on line 189 in packages/charts/src/components/BarChart/BarChart.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
const onItemLegendClick = useLegendItemClick(onLegendClick);
const labelFormatter = useLabelFormatter(primaryDimension);
View file
packages/charts/src/components/BarChart/Placeholder.tsx
speed={2}
backgroundColor={ThemingParameters.sapContent_ImagePlaceholderBackground}
foregroundColor={ThemingParameters.sapContent_ImagePlaceholderForegroundColor}
backgroundOpacity={ThemingParameters.sapContent_DisabledOpacity as any}

Check warning on line 15 in packages/charts/src/components/BarChart/Placeholder.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
>
<rect x="20" y="10" width="1" height="135" />
<rect x="20" y="20" width="85" height="15" />
View file
packages/charts/src/components/BulletChart/BulletChart.tsx
* @param measure {IChartMeasure} Current measure object
* @param dataElement {object} Current data element
*/
highlightColor?: (value: number, measure: MeasureConfig, dataElement: Record<string, any>) => CSSProperties['color'];

Check warning on line 69 in packages/charts/src/components/BulletChart/BulletChart.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
}
interface DimensionConfig extends IChartDimension {
...rest
} = props;
const [componentRef, chartRef] = useSyncRef<any>(ref);

Check warning on line 149 in packages/charts/src/components/BulletChart/BulletChart.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
const chartConfig: BulletChartProps['chartConfig'] = {
yAxisVisible: false,
);
} else {
onDataPointClick(
enrichEventWithDetails({} as any, {

Check warning on line 228 in packages/charts/src/components/BulletChart/BulletChart.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
value: eventOrIndex.value,
dataKey: eventOrIndex.dataKey,
dataIndex: eventOrIndex.index,
{chartConfig.xAxisVisible &&
dimensions.map((dimension, index) => {
let AxisComponent;
const axisProps: any = {

Check warning on line 304 in packages/charts/src/components/BulletChart/BulletChart.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
dataKey: dimension.accessor,
interval: dimension?.interval ?? (isBigDataSet ? 'preserveStart' : 0),
tickLine: index < 1,
/>
)}
{sortedMeasures?.map((element, index) => {
const chartElementProps: any = {

Check warning on line 442 in packages/charts/src/components/BulletChart/BulletChart.tsx

GitHub Actions / lint 

Unexpected any. Specify a different type
isAnimationActive: !noAnimation
};
let labelPosition = 'top';