philippzagar
commented
9 months ago Hi @PSchmiedmayer,
here is the first draft of the consent export functionality PR. The overall export works reasonably well, see an example exported consent form. However, I'm a bit stuck about the integration in the overall Onboarding API. My ideal usage of the export functionality would be something like:
Export(size: .usLetter, destinationPath: ...) { render in
ConsentView(
...,
action: {
render()
onboardingNavigationPath.nextStep()
}
)
}However, this is prohibited by a multitude of factors, such as the fact that all SwiftUI views are structs, the action closure of the ConsentView is escaping, all data is passed down to the "child" views of the ConsentView (such as the OnboardingActionView) directly in the initializer (including the closures) etc.
This constraints the current export design by quite a lot. I don't want to tear down too much of the existing structure of the Onboarding module without consulting you first.
The goal would be to have a simple usable API as explained above. At the moment it's implemented via a simple hardcoded Button in the ConsentView (to demonstrate the functionality) and only for MD as HTML is a bit trickier to deal with (but not impossible). Also, I plan to give the user the option to easily store the consent form via the adjustments made in the OnboardingActionView to enable horizontal button layouts.
Do you have any design suggestions that would make this functionality nicely integrated, configurable, and extensible for future consent data types? I'm quite stuck here at the moment...
PSchmiedmayer
codecov[bot]
Export Consent Forms (Markdown)
:recycle: Current situation & Problem
Until now, users could view and sign a consent document using the SpeziOnboarding package. However, the package did not offer any provision to save or export the signed consent document. In the medical domain, the consent form collection is especially important in order to serve as legal cover. See #7.
:gear: Release Notes
ConsentViewhas been renamed toOnboardingConsentViewand includes breaking changes to its public API. TheOnboardingConsentViewnow provides an export functionality of the signed form in PDF format to the SpeziStandardand to an iOS share sheet. TheStandardneeds to conform toOnboardingConstraintto handle the exported form.ConsentDocumenthas been introduced, giving developers access to the underlying signature and export functionality of theOnboardingConsentViewenabling more customizations by the developer. The functionality of theConsentDocumentcan be observed and controlled via aConsentViewStatepassed to the view via a SwiftUIBinding.:books: Documentation
Documentation is provided via DocC in-line comments. Additional DocC documentation documents are adjusted and refer to the new export functionality.
:white_check_mark: Testing
UI Test cases written and adapted.
:pencil: Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: