diff --git a/packages/main/src/components/ObjectPage/types/index.ts b/packages/main/src/components/ObjectPage/types/index.ts index 19e3728ae7e..ccc18f18b0b 100644 --- a/packages/main/src/components/ObjectPage/types/index.ts +++ b/packages/main/src/components/ObjectPage/types/index.ts @@ -32,17 +32,18 @@ export interface ObjectPagePropTypes extends Omit { /** * 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; /** * 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; /** diff --git a/packages/main/src/components/ObjectPageHeader/index.tsx b/packages/main/src/components/ObjectPageHeader/index.tsx index c903f244b2f..4f8be356892 100644 --- a/packages/main/src/components/ObjectPageHeader/index.tsx +++ b/packages/main/src/components/ObjectPageHeader/index.tsx @@ -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((props, ref) => { const { children, headerPinned, topHeaderHeight, className, style, ...rest } = props;