Skip to content

docs(Toast): add note about Popover API #6667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lukas742 merged 1 commit into from
Nov 29, 2024
Merged

docs(Toast): add note about Popover API #6667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/main/src/components/Modals/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ function showToastFn(props: ToastPropTypes, container?: Element | DocumentFragme
*
* **In order to use these helpers, please make sure to render the `Modals` component somewhere in your application tree.**
*
* __Note:__ The `Toast` component does not currently use the [Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API), which may cause issues like incorrect positioning or alignment. If that's the case, please mount the `Modals` component after all other components, or define a custom container via the `container` parameter.
*
* @since 0.22.2
*/
export function Modals() {
Expand Down Expand Up @@ -257,4 +259,7 @@ Modals.showPopover = showPopoverFn;
Modals.showResponsivePopover = showResponsivePopoverFn;
Modals.showMenu = showMenuFn;
Modals.showMessageBox = showMessageBoxFn;
/**
* __Note:__ The `Toast` component does not currently use the [Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API), which may cause issues like incorrect positioning or alignment. If that's the case, please mount the `Modals` component after all other components, or define a custom container via the `container` parameter.
*/
Modals.showToast = showToastFn;
1 change: 1 addition & 0 deletions packages/main/src/webComponents/Toast/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ interface ToastPropTypes extends ToastAttributes, Omit<CommonProps, keyof ToastA
* - You want users to be able to copy some part of the message text.
*
*
* __Note:__ The `Toast` component does not currently use the [Popover API](https://developer.mozilla.org/en-US/docs/Web/API/Popover_API), which may cause issues like incorrect positioning or alignment. To avoid these side effects, we recommend mounting the `Toast` outside the parents' DOM hierarchy, either directly or by using `React.createPortal`, until the Popover API is integrated into this component as well.
*
* __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
*/
Expand Down
Loading