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]: missing docs - preventDismissOnResize is deprecated, usage of replacement is unclear #30431

Open
2 tasks done
jeffersoneagley opened this issue Jan 30, 2024 · 5 comments · May be fixed by #33493
Open
2 tasks done

Comments

@jeffersoneagley
Copy link

Library

React / v8 (@fluentui/react)

System Info

System:
    OS: Windows 11 10.0.22635
    CPU: (16) x64 AMD EPYC 7763 64-Core Processor
    Memory: 41.19 GB / 63.95 GB
  Browsers:
    Edge: Chromium (121.0.2277.83)
    Internet Explorer: 11.0.22621.1

Are you reporting Accessibility issue?

None

Reproduction

https://developer.microsoft.com/en-us/fluentui#/controls/web/callout#ICalloutProps

Bug Description

Actual Behavior

I'm looking at the following doc:
https://developer.microsoft.com/en-us/fluentui#/controls/web/callout#ICalloutProps

preventDismissOnResize is deprecated. The suggested replacement is preventDismissOnEvent. There's no actual explanation of how to replicate the behavior of preventDismissOnResize with preventDismissOnEvent. I know it's probably easy, but it's unclear and a time-burner.

Side note: there's also not a clear path to submit feedback on the docs themselves.

Logs

No response

Requested priority

Normal

Products/sites affected

https://developer.microsoft.com/en-us/fluentui#/controls/web/callout#ICalloutProps

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.
@github-actions github-actions bot added Fluent UI react (v8) Issues about @fluentui/react (v8) Needs: Triage 🔍 labels Jan 30, 2024
@ValentinaKozlova
Copy link
Contributor

Hello @jeffersoneagley , before assigning this issue to an appropriate team I need more information from you. Because it doesn't look like a bug, it's more like a feature or question. You wrote it's probably easy, but it's unclear and a time-burner. Have you tried to understand how it works? If not, could you please invest some time and if it's still unclear, I'll assign it to an appropriate team

@jeffersoneagley
Copy link
Author

@ValentinaKozlova This isn't a code issue, it's just a gap in the documentation. I don't really want to go fishing through the type definitions for the function.

This issue has not had activity for over 180 days! We're adding Soft close label and will close it soon for house-keeping purposes.
Still require assistance? Please add comment - "keep open".

@ValentinaKozlova
Copy link
Contributor

keep open

@ValentinaKozlova ValentinaKozlova removed the Resolution: Soft Close Soft closing inactive issues over a certain period label Sep 2, 2024
@behowell
Copy link
Contributor

I created a PR to remove the deprecated warning from those props. We have no plans to remove them from v8, and it seems fine to have a simpler API for common use cases.

But for the record, if you wanted to replicate preventDismissOnScroll with the new prop, you could use:

preventDismissOnEvent={(ev) => ev.type === 'scroll'}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants