@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
40 lines (39 loc) • 1.79 kB
TypeScript
import '@ui5/webcomponents-fiori/dist/DynamicPageHeader.js';
import type { ReactNode } from 'react';
import type { CommonProps, Ui5DomRef } from '../../types/index.js';
interface DynamicPageHeaderAttributes {
}
interface DynamicPageHeaderDomRef extends Required<DynamicPageHeaderAttributes>, Ui5DomRef {
}
interface DynamicPageHeaderPropTypes extends DynamicPageHeaderAttributes, Omit<CommonProps, 'children'> {
/**
* Defines the content of the Dynamic Page Header.
*/
children?: ReactNode | ReactNode[];
}
/**
* Header of the DynamicPage.
*
* The DynamicPageHeader `DynamicPageHeader` is part of the DynamicPage family
* and is used to serve as header of the `DynamicPage`.
*
* ### Usage
*
* The `DynamicPageHeader` can hold any layout control and has two states - expanded
* and collapsed (snapped). The switching between these states happens when:
* - the user scrolls below its bottom margin
* - the user clicks on the `DynamicPageTitle`
* - through the `DynamicPage` property `headerSnapped`
*
* ### Responsive Behavior
*
* The responsive behavior of the `DynamicPageHeader` depends on the behavior of the
* content that is displayed.
*
* __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
*
* @since [2.0.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents-fiori__.
*/
declare const DynamicPageHeader: import("react").ForwardRefExoticComponent<DynamicPageHeaderPropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<DynamicPageHeaderDomRef>>;
export { DynamicPageHeader };
export type { DynamicPageHeaderDomRef, DynamicPageHeaderPropTypes };