UNPKG

@ui5/webcomponents-react

Version:

React Wrapper for UI5 Web Components and additional components

52 lines (51 loc) 2.39 kB
import type TitleLevel from '@ui5/webcomponents/dist/types/TitleLevel.js'; import type { ReactNode } from 'react'; import type { CommonProps } from '../../types/index.js'; export interface ObjectPageSubSectionPropTypes extends CommonProps { /** * Defines the ID of the `ObjectPageSubSection`. */ id: string; /** * Defines the content of the `ObjectPageSubSection`. */ children: ReactNode | ReactNode[]; /** * Defines the title of the `ObjectPageSubSection`. */ titleText: string; /** * Actions available for this subsection. * * __Note:__ Keep in mind that the components set in the actions prop do NOT have overflow behavior. If the available space is not enough, the components will be displayed on more lines. * * __Note:__ Although this prop accepts all HTML Elements, it is strongly recommended that you only use simple input components like `Button` or `Switch` to preserve the intended design. */ actions?: ReactNode | ReactNode[]; /** * Determines whether to display the SubSection `titleText` or not. */ hideTitleText?: boolean; /** * Determines the ARIA level of the ObjectPageSubSection `titleText`. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation. * * __Note:__ Defining a `titleTextLevel` will add aria-level attribute from 1 to 6, instead of changing the ObjectPageSectionBase title HTML tag from H1 to H6. * For example: if titleTextLevel is TitleLevel.H1, it will result as aria-level of 1 added to the ObjectPageSection title. * * @default TittleLevel.H4 */ titleTextLevel?: TitleLevel | keyof typeof TitleLevel; /** * Defines whether the title is always displayed in uppercase. */ titleTextUppercase?: boolean; } /** * Second-level information container of an `ObjectPage`. * * __Note:__ This component should only be used inside an `ObjectPageSection` component. * * __Note:__ Only use subsections if more than one is available. Otherwise, add the content of the section directly as `child` of the `ObjectPageSection`. */ declare const ObjectPageSubSection: import("react").ForwardRefExoticComponent<ObjectPageSubSectionPropTypes & import("react").RefAttributes<HTMLDivElement>>; export { ObjectPageSubSection };