Align interface to Android #31
Draft
Conversation
This file contains 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
PSchmiedmayer
approved these changes
Oct 21, 2024
There was a problem hiding this comment.
Thank you for working on this @pauljohanneskraft!
I only had minor comments; happy to see this merged 🚀
|
|
||
|
|
||
| /// A type handling the action to be performed by a ContactOption. | ||
| public protocol ContactOptionAction { |
There was a problem hiding this comment.
We should probably enforce that this type is sendable?
|
|
||
|
|
||
| /// Encodes a way to get in contact with an individual and usually connected to a `Contact`. | ||
| /// - Parameters: | ||
| /// - image: The image representing the `ContactOption` in the user interface. | ||
| /// - title: The title representing the `ContactOption` in the user interface. | ||
| /// - action: The action that should be taken when a user chooses to use the `ContactOption`. | ||
| public init(image: Image, title: String, action: @escaping @MainActor () -> Void) { | ||
| public init(image: Image, title: String, action: any ContactOptionAction) { |
There was a problem hiding this comment.
I think we should still keep the closure-base initializer; it would allow us to only tag a minor version increment and might still be useful for a Swift-style API? We could mark it as deprecated in case we don't want to have the same overload for the Android API but at least would make this a non-breaking change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Align interface to Android
♻️ Current situation & Problem
During the implementation of SpeziContact for Android, we discussed the following changes to the interface, where iOS may benefit as well.
See StanfordSpezi/SpeziKt#104
⚙️ Release Notes
Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.
Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.
📚 Documentation
Please ensure that you properly document any additions in conformance to Spezi Documentation Guide.
You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.
✅ Testing
Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.
This section describes important information about the tests and why some elements might not be testable.
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: