Skip to content

Commit

Permalink
docs(DynamicPageTitle): outline supported actions components (#5881)
Browse files Browse the repository at this point in the history
Closes #5873
  • Loading branch information
Lukas742 authored Jun 3, 2024
1 parent 4ca5396 commit 6a79d5c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/main/src/components/DynamicPageTitle/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export interface DynamicPageTitlePropTypes extends CommonProps {
* The `DynamicPageTitle` actions.
*
* __Note:__ When clicking on an action in the overflow popover it closes the popover. You can use `event.preventDefault()` to prevent this.
*
* __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.
*/
actions?: ReactElement | ReactElement[];

Expand Down Expand Up @@ -53,6 +55,8 @@ export interface DynamicPageTitlePropTypes extends CommonProps {
* Otherwise, they are rendered in the top-right area, above the actions.
* If a large number of elements(buttons) are used, there could be visual degradations as the space for the `navigationActions` is limited.
*
* __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.
*
* __Note:__ When clicking on an action in the overflow popover it closes the popover. You can use `event.preventDefault()` to prevent this.
*/
navigationActions?: ReactElement | ReactElement[];
Expand Down

0 comments on commit 6a79d5c

Please sign in to comment.