fluentui
fluentui copied to clipboard
[Docs]: Disabling motion in the Dialog component
Area
React Components (https://react.fluentui.dev)
What kind of documentation issue are you reporting?
- [ ] Reporting a typo
- [x] Reporting a documentation bug
- [x] Documentation improvement
- [x] Documentation feedback
Is there a specific documentation page you are reporting?
https://react.fluentui.dev/?path=/docs/motion-motion-slot--docs#disable-motion
Description
The examples and information provided in the docs are confusing when a user tries to find out how motion can be disabled in the Dialog component.
The correct answer is to pass null to surfaceMotion in Dialog and backdropMotion in DialogSurface, but the examples are quite confusing from this point of view:
- In the Dialog > DialogSurface docs the backdropMotion prop is mentioned and linked to the Motion docs page
- On the Motion page > Disabling animation
backdropMotionis not used to showcase how motion can be disabled, butbackdropis used instead to fully disable the backdrop.
I think the documentation should be improved to showcase examples of disabling animation using backdropMotion specifically.
Validations
- [x] Check that there isn't already an issue that requests the same feature to avoid creating a duplicate.