Skip to content

docs(ObjectPageHeader): avoid confusion with SAPUI5 ObjectPageHeader #8120

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 1 commit into from
Jan 21, 2026
Merged

docs(ObjectPageHeader): avoid confusion with SAPUI5 ObjectPageHeader #8120

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
13 changes: 7 additions & 6 deletions packages/main/src/components/ObjectPage/types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,18 @@ export interface ObjectPagePropTypes extends Omit<CommonProps, 'placeholder'> {
/**
* Defines the upper, always static, title section of the `ObjectPage`.
*
* __Note:__ Although this prop accepts all HTML Elements, it is strongly recommended that you only use `ObjectPageTitle` in order to preserve the intended design.
*
* __Note:__ When the `ObjectPageTitle` is rendered inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
* __Note:__
* - Use the `ObjectPageTitle` component in order to preserve the intended design.
* - When the `ObjectPageTitle` is rendered inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
*/
titleArea?: ReactElement<ObjectPageTitlePropTypes>;
/**
* Defines the `ObjectPageHeader` section of the `ObjectPage`.
*
* __Note:__ Although this prop accepts all HTML Elements, it is strongly recommended that you only use `ObjectPageHeader` in order to preserve the intended design.
*
* __Note:__ When the `ObjectPageHeader` is rendered inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
* __Note:__
* - Use the `ObjectPageHeader` component in order to preserve the intended design.
* - The `ObjectPageHeader` is essentially the `DynamicPageHeader` recommended by SAP Design. It was renamed in v2 to avoid conflicts with the `DynamicPageHeader` from `@ui5/webcomponents`.
* - When the `ObjectPageHeader` is rendered inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
*/
headerArea?: ReactElement<ObjectPageHeaderPropTypes>;
/**
Expand Down
4 changes: 3 additions & 1 deletion packages/main/src/components/ObjectPageHeader/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ export interface InternalProps extends ObjectPageHeaderPropTypes {
/**
* The `ObjectPageHeader` component is used to serve as header section of the `ObjectPage`. It can hold any layout control and has two states - expanded and collapsed.
*
* __Note:__ When used inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
* __Note:__
* - When used inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
* - The `ObjectPageHeader` is essentially the `DynamicPageHeader` recommended by SAP Design. It was renamed in v2 to avoid conflicts with the `DynamicPageHeader` from `@ui5/webcomponents`.
*/
const ObjectPageHeader = forwardRef<HTMLDivElement, InternalProps>((props, ref) => {
const { children, headerPinned, topHeaderHeight, className, style, ...rest } = props;
Expand Down
Loading