Skip to content
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.

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

[Bug]: Dialog documentation could be clearer #31620

Open
2 tasks done
ccardiasmenosMSFT opened this issue Jun 7, 2024 · 2 comments
Open
2 tasks done

[Bug]: Dialog documentation could be clearer #31620

ccardiasmenosMSFT opened this issue Jun 7, 2024 · 2 comments

Comments

@ccardiasmenosMSFT
Copy link

ccardiasmenosMSFT commented Jun 7, 2024

Library

Web Components (@fluentui/web-components)

System Info

N/A

Are you reporting Accessibility issue?

None

Reproduction

N/A

Bug Description

Actual Behavior

The Dialog documentation found here was a bit confusing. We only show a close button on the non-modal dialog type but then explain later that modal and non-modal dialogs can both have close buttons.: https://fluent2.microsoft.design/components/web/react/dialog/usage

Expected Behavior

It would help to provide visuals that convey that you can interact with the below content in a non-modal dialog rather than have the only difference showing be the close button.

Logs

No response

Requested priority

Normal

Products/sites affected

All

Are you willing to submit a PR to fix?

no

Validations

  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
  • The provided reproduction is a minimal reproducible example of the bug.
@chrisdholt
Copy link
Member

@gouttierre looks like this is for React, can you assign to the right person?

@ccardiasmenosMSFT
Copy link
Author

I updated the description above. This doesn't need to be considered a bug but is a suggestion to improve the documentation. If there's a way to change the issue type, please let me know.

@ccardiasmenosMSFT ccardiasmenosMSFT changed the title [Bug]: Dialog documentation conflicts with itself [Bug]: Dialog documentation could be clearer Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants