-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Docs: Update AASA guidelines to use components #12978
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
Open
sfshaza2
wants to merge
2
commits into
main
Choose a base branch
from
fix/issue-12362-aasa-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+12
−9
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -210,12 +210,9 @@ this file should resemble the following content: | |
| "appIDs": [ | ||
| "S8QB4VV633.com.example.deeplinkCookbook" | ||
| ], | ||
| "paths": [ | ||
| "*" | ||
| ], | ||
| "components": [ | ||
| { | ||
| "/": "/*" | ||
| "/": "*" | ||
| } | ||
| ] | ||
| } | ||
|
|
@@ -232,11 +229,17 @@ this file should resemble the following content: | |
| 1. Set one value in the `appIDs` array to | ||
| `<team id>.<bundle id>`. | ||
|
|
||
| 1. Set the `paths` array to `["*"]`. | ||
| The `paths` array specifies the allowed universal links. | ||
| Using the asterisk, `*` redirects every path to the Flutter app. | ||
| If needed, change the `paths` array value to a setting more | ||
| appropriate to your app. | ||
| 1. Configure the `components` array. | ||
| This field allows you to specify the URL patterns that your app supports. | ||
| In the example above, `{"/": "*"}` allows all paths. | ||
| To exclude specific paths or match complex patterns, using `components` | ||
| is recommended for iOS 13 and later. | ||
|
|
||
| :::note | ||
| For support on iOS 12 and earlier, you must also provide the `paths` array: | ||
| `"paths": ["*"]`. | ||
| If you support both new and old iOS versions, providing both fields is valid. | ||
| ::: | ||
|
Comment on lines
+238
to
+242
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it's ok to include this for a while if you want for developers on older Flutter versions, but https://docs.flutter.dev/reference/supported-platforms does indicate our current iOS minimum is iOS 13. So I think it'd also be fine to remove. |
||
|
|
||
| 1. Host the file at a URL that resembles the following structure. | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better backward compatibility out of the box, I suggest re-adding the
pathsfield to this example. Whilecomponentsis the modern approach, many developers still need to support older iOS versions. Providing an example that works for both modern and legacy versions by default is safer for users who might copy-paste the code without reading the instructions in detail. The accompanying text already does a great job explaining the purpose of each field, and this change would make the code example more robust.