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

SurfaceProducer migration doc should be updated to use new onSurfaceCleanup function #11574

Open
1 task
navaronbracke opened this issue Jan 6, 2025 · 1 comment
Labels
e2-days Effort: < 5 days from.page-issue Reported in a reader-filed concern p2-medium Necessary but not urgent concern. Resolve when possible.

Comments

@navaronbracke
Copy link
Contributor

Page URL

https://docs.flutter.dev/release/breaking-changes/android-surface-plugins

Page source

No response

Describe the problem

When the onSurfaceDestroyed is deprecated in the future, and replaced by onSurfaceCleanup, the migration guide should be updated to reflect this.

There should also be a note that notifies readers that the old API was available in Flutter 3.27, but renamed in a to-be-named subsequent release.

There is prior art for a similar change in the document as of today:

In the upcoming stable release, 3.27, onSurfaceCreated is deprecated, and onSurfaceAvailable and handlesCropAndRotation are added.

so this change will closely follow that pattern.

Expected fix

The migration guide's code sample should be updated to use onSurfaceCleanup instead, and a footnote should be added to clarify how the transition happened, akin to what we did for the change relating to onSurfaceAvailable.

Additional context

The following issue talks about the aforementioned change: flutter/flutter#160933
and the PR that adds the API change is flutter/flutter#160937

I would like to fix this problem.

  • I will try and fix this problem on docs.flutter.dev.
@navaronbracke navaronbracke added the from.page-issue Reported in a reader-filed concern label Jan 6, 2025
@sfshaza2
Copy link
Contributor

@matanlurey, can you weigh in?

@sfshaza2 sfshaza2 added p2-medium Necessary but not urgent concern. Resolve when possible. e2-days Effort: < 5 days labels Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e2-days Effort: < 5 days from.page-issue Reported in a reader-filed concern p2-medium Necessary but not urgent concern. Resolve when possible.
Projects
None yet
Development

No branches or pull requests

2 participants