Skip to content

Conversation

@cyanglaz
Copy link
Contributor

Updates the iOS app extension document to reflect the latest support.
Fixes flutter/flutter#124293

Presubmit checklist

@cyanglaz cyanglaz changed the title Update iOS app extension document [Draft] Update iOS app extension document Oct 24, 2023
draft 2

draft 3

draft 4
@cyanglaz cyanglaz marked this pull request as ready for review October 24, 2023 18:12
@cyanglaz cyanglaz requested a review from leighajarett October 24, 2023 18:12
@cyanglaz
Copy link
Contributor Author

@leighajarett I moved the related information from my google dochttps://docs.google.com/document/d/1mWpg1qmCGWG1RreFrOI8-Y3p9usV50MHsECbeoQzDHk/edit) to this doc. Please take a look.

@atsansone atsansone marked this pull request as draft October 24, 2023 22:24
@parlough parlough added the review.tech Awaiting Technical Review label Oct 25, 2023
@leighajarett
Copy link
Contributor

@cyanglaz Looks good to me, besides a few minor comments.

When you're ready for tech writers to review, can you assign to @atsansone?

@parlough
Copy link
Member

@leighajarett You mentioned "a few minor comments" but I don't see them on the PR. Is your review still a draft?

@atsansone atsansone added the st.WIP Issue in progress label Oct 27, 2023
@cyanglaz
Copy link
Contributor Author

@leighajarett Friendly ping :)

Some app extensions display a user interface.
For example, iMessage extensions allow users to access your app's
content directly from the **Messages** app.
For example, Share Extensions allow users to conveniently share content with other apps. One example of Share Extension is to share a picture and post a comment on a social media app.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the share extension always accessed from the Photos app @cyanglaz?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, Photo app is just an example but it can be accessed from other apps, for example safari

To create the UI for
an app extension using Flutter, you must compile
a custom engine and embed the `FlutterViewController`
Starting from this [commit](https://github.com/flutter/flutter/commit/3ad9998cf07098d58429aeac242e47a0156ae29c) Flutter supports
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@atsansone do we usually reference commits for new features or Flutter versions?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stable flutter versions :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will update it to 3.16.0

The Flutter team cautions that only advanced users
should try to create a custom build.
To learn more, check out [Compiling the engine][].
Due to the memory limits of app extensions, it is only recommanded to use Flutter to build app extension UI for extension types that have memory limits larger than 100mb, Share Extensions for example, which has a 120mb memory limit. In addition, Flutter uses extra memories in debug mode. Thus Flutter does not fully support running app extension in debug mode on physical devices when used to build extension UI. Alternatively, use simulator to test in debug mode.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cyanglaz do you know where developers could find the memory limitations of app extensions? Might be good to let me people know

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, there is no official doc listing all the memory limitations. Developers have to do some research on the extension they want to use. :(

@leighajarett
Copy link
Contributor

Sorry I missed your ping! You're right, I never clicked to submit the review. Submitted now! Let me know if you have any questions

@leighajarett
Copy link
Contributor

Oh also heads up to tech writers, this goes out in the next stable so ideally we wouldn't push the docs until then

@cyanglaz
Copy link
Contributor Author

cyanglaz commented Nov 8, 2023

@leighajarett Could you add a "request change" in this PR so it is locked from merging. You can then approve the PR when 3.16.0 moves to stable.

@itsjustkevin
Copy link
Contributor

Oh also heads up to tech writers, this goes out in the next stable so ideally we wouldn't push the docs until then

We would still need these changes to land before the blog goes out as it is linked directly there. Would really like to avoid dead links if possible.

CC @parlough

@parlough
Copy link
Member

parlough commented Nov 10, 2023

I think we can land this one a bit early. The version change is specifically called out and I doubt it will be pulled at this point.

I'll review this shortly.

@parlough parlough marked this pull request as ready for review November 10, 2023 17:41
@parlough parlough assigned parlough and unassigned leighajarett Nov 10, 2023
@parlough parlough removed the st.WIP Issue in progress label Nov 10, 2023
@leighajarett
Copy link
Contributor

Okay - I'll refrain from locking for now then

@flutter-website-bot
Copy link
Collaborator

flutter-website-bot commented Nov 14, 2023

Visit the preview URL for this PR (updated for commit 6c83a2a):

https://flutter-docs-prod--pr9698-share-extension-584d9f0l.web.app

@parlough parlough changed the title [Draft] Update iOS app extension document Update iOS app extension document Nov 15, 2023
Copy link
Member

@parlough parlough left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

I pushed a few minor copy and formatting fixes, but otherwise looks good.

@parlough parlough merged commit 4568dfe into flutter:main Nov 15, 2023
@cyanglaz cyanglaz deleted the share-extension branch November 15, 2023 14:49
@sfshaza2 sfshaza2 removed the review.tech Awaiting Technical Review label Nov 22, 2023
atsansone pushed a commit to atsansone/website that referenced this pull request Dec 11, 2023
Updates the iOS app extension document to reflect the latest support.
Fixes flutter/flutter#124293

---------

Co-authored-by: Parker Lougheed <parlough@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[app_extension_safe] update documents for instructions on how to use app-extension-safe framework

7 participants