Skip to content

Commit 7c3ae45

Browse files
authored
docs(ObjectPageHeader): avoid confusion with SAPUI5 ObjectPageHeader (#8120)
Related to #8119
1 parent 19745ff commit 7c3ae45

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

packages/main/src/components/ObjectPage/types/index.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,18 @@ export interface ObjectPagePropTypes extends Omit<CommonProps, 'placeholder'> {
3232
/**
3333
* Defines the upper, always static, title section of the `ObjectPage`.
3434
*
35-
* __Note:__ Although this prop accepts all HTML Elements, it is strongly recommended that you only use `ObjectPageTitle` in order to preserve the intended design.
36-
*
37-
* __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!
35+
* __Note:__
36+
* - Use the `ObjectPageTitle` component in order to preserve the intended design.
37+
* - 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!
3838
*/
3939
titleArea?: ReactElement<ObjectPageTitlePropTypes>;
4040
/**
4141
* Defines the `ObjectPageHeader` section of the `ObjectPage`.
4242
*
43-
* __Note:__ Although this prop accepts all HTML Elements, it is strongly recommended that you only use `ObjectPageHeader` in order to preserve the intended design.
44-
*
45-
* __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!
43+
* __Note:__
44+
* - Use the `ObjectPageHeader` component in order to preserve the intended design.
45+
* - The `ObjectPageHeader` is essentially the `DynamicPageHeader` recommended by SAP Design. It was renamed in v2 to avoid conflicts with the `DynamicPageHeader` from `@ui5/webcomponents`.
46+
* - 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!
4647
*/
4748
headerArea?: ReactElement<ObjectPageHeaderPropTypes>;
4849
/**

packages/main/src/components/ObjectPageHeader/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export interface InternalProps extends ObjectPageHeaderPropTypes {
2828
/**
2929
* 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.
3030
*
31-
* __Note:__ When used inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
31+
* __Note:__
32+
* - When used inside a custom component, it's essential to pass through all props, as otherwise the component won't function as intended!
33+
* - The `ObjectPageHeader` is essentially the `DynamicPageHeader` recommended by SAP Design. It was renamed in v2 to avoid conflicts with the `DynamicPageHeader` from `@ui5/webcomponents`.
3234
*/
3335
const ObjectPageHeader = forwardRef<HTMLDivElement, InternalProps>((props, ref) => {
3436
const { children, headerPinned, topHeaderHeight, className, style, ...rest } = props;

0 commit comments

Comments
 (0)