Installation

Installation

NotebookFlowKit is distributed as a Swift Package.

Requirements

• iOS 16+
• macOS 13+
• Swift Package Manager
• SwiftUI

NotebookFlowKit has no external dependencies.

Add With Xcode

1. Open your app project in Xcode.
2. Choose File > Add Package Dependencies.
3. Enter the repository URL:

https://github.com/ChiefVenzox/NotebookFlowKit.git

4. Add the NotebookFlowKit product to your app target.

Add With Package.swift

dependencies: [
    .package(url: "https://github.com/ChiefVenzox/NotebookFlowKit.git", from: "0.1.0")
]

Then add the product to your target:

.target(
    name: "YourApp",
    dependencies: [
        .product(name: "NotebookFlowKit", package: "NotebookFlowKit")
    ]
)

Add JSON Files To Your App

Flow JSON files should be included in your app target bundle.

For example, add starter_flow.json to your Xcode project and make sure it is included in Target Membership for the app.

Then load it by file name:

NotebookFlowView(fileName: "starter_flow") { result in
    print(result.answers)
}

The .json extension is optional when loading by file name.