Skip to content

Commit 6a79d5c

Browse files
authored
docs(DynamicPageTitle): outline supported actions components (#5881)
Closes #5873
1 parent 4ca5396 commit 6a79d5c

File tree

1 file changed

+4
-0
lines changed
  • packages/main/src/components/DynamicPageTitle

1 file changed

+4
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export interface DynamicPageTitlePropTypes extends CommonProps {
2121
* The `DynamicPageTitle` actions.
2222
*
2323
* __Note:__ When clicking on an action in the overflow popover it closes the popover. You can use `event.preventDefault()` to prevent this.
24+
*
25+
* __Note:__ Although this prop accepts all `ReactElements`, it is strongly recommended that you only use components that render a single element in order to preserve the intended design.
2426
*/
2527
actions?: ReactElement | ReactElement[];
2628

@@ -53,6 +55,8 @@ export interface DynamicPageTitlePropTypes extends CommonProps {
5355
* Otherwise, they are rendered in the top-right area, above the actions.
5456
* If a large number of elements(buttons) are used, there could be visual degradations as the space for the `navigationActions` is limited.
5557
*
58+
* __Note:__ Although this prop accepts all `ReactElements`, it is strongly recommended that you only use components that render a single element in order to preserve the intended design.
59+
*
5660
* __Note:__ When clicking on an action in the overflow popover it closes the popover. You can use `event.preventDefault()` to prevent this.
5761
*/
5862
navigationActions?: ReactElement | ReactElement[];

0 commit comments

Comments
 (0)