adamfootdev/HelpKit

Requirements

• iOS/iPadOS 16.0+
• macOS 13.0+
• tvOS 16.0+
• visionOS 1.0+
• watchOS 9.0+
• Xcode 26.0+

Integration

Swift Package Manager

HelpKit can be added to your app via Swift Package Manager in Xcode. Add to your project like so:

dependencies: [
    .package(url: "https://github.com/adamfootdev/HelpKit.git", from: "2.0.0")
]

Usage

To start using the framework, you'll need to import it first:

import HelpKit

HKConfiguration

This is a struct containing all of the relevant details required to configure HelpKit. It can be created like so:

let configuration = HKConfiguration(
    displayMode: .navigation,
    topicSections: topicSections
) {
    print("Get Support")
}

HKTopicSection

This is a struct containing details about a help topic section. It can be created like so:

let topicSection = HKTopicSection(
    "Topic Section",
    topics: topics
)

HKTopic

This is a struct containing details about a help topic. It can be created like so:

let topic = HKTopic(
    "Topic",
    iconSystemImage: "questionmark.circle",
    iconTint: .red,
    content: "Some content here…",
    contentImage: Image("image"),
    links: links,
    keywords: ["keyword"]
)

HKLink

This is a struct containing details about a help link. It can be created like so:

let topic = HKLink(
    "Website",
    url: URL(string: "https://www.example.com")!
)

HelpView

Create an instance of the view using the following:

HelpView(configuration: configuration)

Other Packages

AboutKit

Add an about screen to your app.

FeaturesKit

Add a features list screen to your app.

HapticsKit

Add haptic feedback to your app.

InAppPurchaseKit

Add a subscription screen to your app.

Package Metadata

Repository: adamfootdev/HelpKit

Stars: 33

Forks: 1

Open issues: 0

Default branch: main

Primary language: swift

License: MIT

Topics: ios, swiftui, xcode

README: README.md