Skip to content

Commit 447f0b1

Browse files
authored
docs(ObjectPage): outline when to use subsections (#6899)
Closes #6644
1 parent 9172f2f commit 447f0b1

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ export interface ObjectPageSectionPropTypes extends CommonProps {
1717
id: string;
1818
/**
1919
* Defines the content of the `ObjectPageSection`.
20+
*
21+
* __Note:__ Only use subsections if more than one is available. Otherwise, add the content of the section directly as `child`.
2022
*/
2123
children: ReactNode | ReactNode[];
2224
/**

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ export interface ObjectPageSubSectionPropTypes extends CommonProps {
5151
}
5252

5353
/**
54-
* Second-level information container of an `ObjectPage`.<br />
54+
* Second-level information container of an `ObjectPage`.
55+
*
5556
* __Note:__ This component should only be used inside an `ObjectPageSection` component.
57+
*
58+
* __Note:__ Only use subsections if more than one is available. Otherwise, add the content of the section directly as `child` of the `ObjectPageSection`.
5659
*/
5760
const ObjectPageSubSection = forwardRef<HTMLDivElement, ObjectPageSubSectionPropTypes>((props, ref) => {
5861
const {

0 commit comments

Comments
 (0)