dev/SwiftUI

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: macos-14
     strategy:
       matrix:
-        destination: ['platform=iOS\ Simulator,OS=17.4,name=iPhone\ 15\ Pro']
+        destination: ['platform=iOS\ Simulator,OS=18.0,name=iPhone\ 15\ Pro']
         scheme: ['ResearchKit']
     name: ${{ matrix.scheme }} Unit Tests
     steps:

.swiftlint.yml

@@ -380,6 +380,7 @@ excluded: # paths to ignore during linting. Takes precedence over `included`.
   - docs-standalone
   - ResearchKit
   - ResearchKitActiveTask
+  - ResearchKitSwiftUI
   - ResearchKitUI
   - ResearchKitTests
   - samples

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.10
+// swift-tools-version: 6.0
 
 import class Foundation.ProcessInfo
 import PackageDescription
@@ -13,15 +13,17 @@ let swiftConcurrency: SwiftSetting = .enableUpcomingFeature("StrictConcurrency")
 
 let package = Package(
     name: "ResearchKit",
+    defaultLocalization: "en",
     platforms: [
-        .iOS(.v17),
+        .iOS(.v18),
         .visionOS(.v1)
     ],
     products: [
         .library(name: "ResearchKit", targets: ["ResearchKit"]),
         .library(name: "ResearchKitUI", targets: ["ResearchKitUI"]),
         .library(name: "ResearchKitActiveTask", targets: ["ResearchKitActiveTask"]),
-        .library(name: "ResearchKitSwiftUI", targets: ["ResearchKitSwiftUI"])
+        .library(name: "ResearchKitSwiftUI", targets: ["ResearchKitSwiftUI"]),
+        .library(name: "ResearchKitSwiftUIBridge", targets: ["ResearchKitSwiftUIBridge"])
     ],
     dependencies: [] + swiftLintPackage(),
     targets: [
@@ -40,14 +42,18 @@ let package = Package(
         .target(
             name: "ResearchKitSwiftUI",
             dependencies: [
-                .target(name: "ResearchKit"),
-                .target(name: "ResearchKitUI"),
-                .target(name: "ResearchKitActiveTask", condition: .when(platforms: [.iOS]))
+                .target(name: "ResearchKit")
             ],
-            swiftSettings: [
-                swiftConcurrency
-            ],
-            plugins: [] + swiftLintPlugin()
+            path: "ResearchKitSwiftUI"
+        ),
+        .target(
+             name: "ResearchKitSwiftUIBridge",
+             dependencies: [
+                 .target(name: "ResearchKit"),
+                 .target(name: "ResearchKitUI"),
+                 .target(name: "ResearchKitActiveTask", condition: .when(platforms: [.iOS]))
+             ],
+             plugins: [] + swiftLintPlugin()
         )
     ]
 )

README.md

@@ -1,3 +1,5 @@
+![ResearchKit](https://github.com/user-attachments/assets/0384c1a6-ec67-45d3-be68-136a2e4cacff)
+
 ResearchKit Framework
 ===========
 
@@ -86,6 +88,78 @@ The height question is presented in the figure below.
 |---|---|
 | ![height-question](https://github.com/ResearchKit/ResearchKit/assets/29615893/4f425329-83b7-45c3-84f9-58cdbcaf2529) | ![height-question-2](https://github.com/ResearchKit/ResearchKit/assets/29615893/2cc0dc2c-5c2a-4b50-a4be-834363fb64b5) |
 
+### ResearchKit SwiftUI 
+
+We are excited to announce the release of a new beta API for surveys in ResearchKit. This API is designed to enhance the flexibility, customization, and cross-platform compatibility of surveys in your ResearchKit apps. Below are the key features and usage details.
+
+New Form APIs offer an easily configurable and flexible UI, with the same look and feel of `ORKFormStep`: 
+* `ResearchForm`
+    * Manages the navigation between steps in a survey.
+* `ResearchFormStep`
+    *  Represents a step in a survey and lays out the header and questions on one page. Question numbers (e.g. 1 of 3) are automatically added at the top of each question to denote progress in a step.
+* `ResearchFormCompletion`
+    * Represents the context for a survey's completion
+* `ResearchFormResult`
+    * Represents responses for the different kinds of questions.
+* `StepHeader`
+    * A step header containing an image, title, and subtitle.
+* `QuestionHeader`
+    * A question header containing a title and detail.
+* `InstructionBodyItem`
+    * Displays an image and text side by side.
+* `questionRequired` (`ViewModifier`)
+    * Designates a question as required or optional.
+
+#### Survey Question Types:
+* `MultipleChoiceQuestion`
+* `HeightQuestion`
+* `WeightQuestion`
+* `SliderQuestion`
+* `TextQuestion`
+* `DateTimeQuestion`
+* `NumericQuestion`
+* `ImageChoiceQuestion`    
+
+The example below shows how to create a `ResearchForm` to present a text question for the participant to answer, and then save their results. 
+
+```swift
+import ResearchKitSwiftUI
+
+ResearchForm(
+    id: "SurveyTask",
+    steps: {
+        ResearchFormStep(
+            title: "Demographics",
+            subtitle: "Tell us about yourself",
+            content: {
+                TextQuestion(
+                    id: "textQuestion",
+                    title: "What is your name?",
+                    prompt: "Enter your name here",
+                    lineLimit: .singleLine,
+                    characterLimit: 0
+                )
+                .questionRequired(true)
+            }
+        )
+    },
+    onResearchFormCompletion: { completion in
+        switch completion {
+        case .completed(let results):
+            save(results)
+        case .discarded:
+            cancel()
+        default:
+            cancel()
+        }
+    }
+)
+```
+
+#### Install as an embedded framework
+
+Download the project source code and drag in the *ResearchKitSwiftUI* folder. In the dialog that pops up, choose to copy files to destination and create folders. Then hit the finish button. Finally, embed the *ResearchKitSwiftUI* framework in your app by adding it to the "Frameworks, Libraries, and Embedded Content" section for your target.
+
 # Consent <a name="consent"></a>
 
 The *ResearchKit framework* provides classes that you can customize to explain the

RELEASE-NOTES.md

@@ -1,5 +1,24 @@
 # ResearchKit Release Notes
 
+## ResearchKit 3.1 Release Notes
+In addition to general stability and performance improvements, ResearchKit 3.1 includes the following updates:
+
+- **ORKFamilyHistoryStep**
+The `ORKFamilyHistoryStep` can be configured to present a Family Health History survey.
+
+- **ORKColorChoiceAnswerFormat**
+The `ORKColorChoiceAnswerFormat` presents the user with a list of color choices.
+
+- **ORKAgeAnswerFormat**
+The `ORKAgeAnswerFormat` presents a age picker that presents birth year or current age options depending on how you configure it.
+
+- **CLLocation Flag**
+A compiler flag that prevents your app from being flagged during app store submission if your app doesn't require location services.
+
+- **HealthKit Flag**
+A compiler flag that prevents your app from being flagged during app store submission if your app doesn't use HealthKit.
+
+
 ## ResearchKit 3.0.1 Release Notes
 In addition to general stability and performance improvements, ResearchKit 3.0.1 includes the following updates:
 

ResearchKit.podspec

@@ -0,0 +1,34 @@
+Pod::Spec.new do |s|
+  s.name         = 'ResearchKit'
+  s.version      = '3.0.1'
+  s.summary      = 'ResearchKit is an open source software framework that makes it easy to create apps for medical research or for other research projects.'
+  s.homepage     = 'https://www.github.com/ResearchKit/ResearchKit'
+  s.documentation_url = 'http://researchkit.github.io/docs/'
+  s.license      = { :type => 'BSD', :file => 'LICENSE' }
+  s.author       = { 'researchkit.org' => 'http://researchkit.org' }
+  s.source       = { :git => 'https://github.com/ResearchKit/ResearchKit.git', :tag => s.version.to_s }
+
+  s.default_subspec = "ResearchKitAllTargets"
+
+  s.subspec 'ResearchKitCore' do |ss|
+    ss.vendored_frameworks = 'xcframework/ResearchKit.xcframework'
+  end
+
+  s.subspec 'ResearchKitUI' do |ss|
+    ss.vendored_frameworks = 'xcframework/ResearchKitUI.xcframework'
+    ss.dependency 'ResearchKit/ResearchKitCore'
+  end
+
+  s.subspec 'ResearchKitActiveTask' do |ss|
+    ss.vendored_frameworks = 'xcframework/ResearchKitActiveTask.xcframework'
+    ss.dependency 'ResearchKit/ResearchKitUI'
+    ss.dependency 'ResearchKit/ResearchKitCore'
+  end
+
+  s.subspec 'ResearchKitAllTargets' do |ss|
+    ss.dependency 'ResearchKit/ResearchKitCore'
+    ss.dependency 'ResearchKit/ResearchKitUI'
+    ss.dependency 'ResearchKit/ResearchKitActiveTask'
+  end
+end
+