search

flutter / website

Flutter documentation web site
https://docs.flutter.dev
Other
2.84k stars 3.24k forks source link

Web should be included as an add-to-app platform in the docs #10998

Open jmagman opened 3 months ago

jmagman commented 3 months ago

What information needs to be added?

https://docs.flutter.dev/platform-integration/web/embedding-flutter-web exists, but it's not clear in the docs that it's spiritually the same concept as add-to-app (even though it is linked from Add to an existing app > Add to a web app menu).

The docs should be changed to reflect that an existing web app can incrementally add Flutter, not just iOS and Android.

Screenshot 2024-08-05 at 9 44 52 AM

Where should this new content appear?

https://docs.flutter.dev/add-to-app https://docs.flutter.dev/add-to-app/debugging https://docs.flutter.dev/add-to-app/multiple-flutters https://docs.flutter.dev/add-to-app/performance

I would like to fix this problem.

jmagman commented 3 months ago

cc @ditman

ditman commented 3 months ago

I read the add-to-app bits for mobile, and the technical approach looks very different to what we have in web now, which is what would have been called "multi-view". I'm not sure that it's the same thing, and that's why I only added a small link on the "Add to app" section so people reading add to app documentation can find the web embedding.

I don't mind adding more detail to the add to app section, but I don't want to confuse users by "overloading" the feature name too much? :/

jmagman commented 3 months ago

cc @mariamhas what do you think about expanding the concept of add-to-app for the sake of web, in terms of "adding Flutter to an existing web app"? The technical details are pretty different, but I suppose the framing is more of a product question. @craiglabenz I know you were looking into our add-to-app docs, do you have an opinion?

craiglabenz commented 3 months ago

I have long thought of element embedding as web's "add to app", so this makes perfect sense to me.

mariamhas commented 3 months ago

I also thought of element embedding as web's add to app when we first proposed the feature. iframe is also a way to add to app for web so a web add to app section should include both technical approaches since they each have their own use cases as to why a developer may want to use iframe vs element embedding