{"id":24014863,"url":"https://github.com/adamfootdev/helpkit","last_synced_at":"2025-04-15T11:44:36.917Z","repository":{"id":198252125,"uuid":"697862481","full_name":"adamfootdev/HelpKit","owner":"adamfootdev","description":"Add a help screen to your app in just a few lines of code.","archived":false,"fork":false,"pushed_at":"2024-10-04T11:44:26.000Z","size":74,"stargazers_count":15,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-23T19:39:48.363Z","etag":null,"topics":["ios","swiftui","xcode"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adamfootdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-28T16:13:51.000Z","updated_at":"2025-02-07T09:28:13.000Z","dependencies_parsed_at":"2023-12-18T16:52:17.540Z","dependency_job_id":"0b33307c-af77-4753-a789-3f76af9d7ccf","html_url":"https://github.com/adamfootdev/HelpKit","commit_stats":null,"previous_names":["adamfootdev/helpkit"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamfootdev%2FHelpKit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamfootdev%2FHelpKit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamfootdev%2FHelpKit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamfootdev%2FHelpKit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamfootdev","download_url":"https://codeload.github.com/adamfootdev/HelpKit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249064629,"owners_count":21207137,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ios","swiftui","xcode"],"created_at":"2025-01-08T07:37:49.425Z","updated_at":"2025-04-15T11:44:36.898Z","avatar_url":"https://github.com/adamfootdev.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HelpKit\n\n![Platform](https://img.shields.io/badge/platforms-iOS%2FiPadOS%2015.0%2B%20%7C%20macOS%2013.0%2B%20%7C%20tvOS%2015.0%2B%20%7C%20visionOS%201.0%2B%20%7C%20watchOS%208.0%2B-blue)\n\nHelpKit provides developers for Apple platforms with the ability to add a Help screen to their apps. This built using SwiftUI so can be displayed natively from a SwiftUI app or using a UIHostingController in a UIKit app.\n\nThis has been localised into multiple languages and the buttons will automatically adapt to your appʼs accent color.\n\n1. [Requirements](#requirements)\n2. [Integration](#integration)\n3. [Usage](#usage)\n    - [HKConfiguration](#hkconfiguration)\n    - [HKTopicSection](#hktopicsection)\n    - [HKTopic](#hktopic)\n    - [HKLink](#hklink)\n    - [HelpView](#helpview)\n4. [Other Packages](#other-packages)\n    - [AboutKit](https://github.com/adamfootdev/AboutKit)\n    - [FeaturesKit](https://github.com/adamfootdev/FeaturesKit)\n\n## Requirements\n\n- iOS/iPadOS 15.0+\n- macOS 13.0+\n- tvOS 16.0+\n- visionOS 1.0+\n- watchOS 8.0+\n- Xcode 15.0+\n\n## Integration\n\n### Swift Package Manager\n\nHelpKit can be added to your app via Swift Package Manager in Xcode. Add to your project like so:\n\n```swift\ndependencies: [\n    .package(url: \"https://github.com/adamfootdev/HelpKit.git\", from: \"1.0.0\")\n]\n```\n\n## Usage\n\nTo start using the framework, you'll need to import it first:\n\n```swift\nimport HelpKit\n```\n\n### HKConfiguration\n\nThis is a struct containing all of the relevant details required to configure HelpKit. It can be created like so:\n\n```swift\nlet configuration = HKConfiguration(\n    displayMode: .navigation,\n    topicSections: topicSections\n) {\n    print(\"Get Support\")\n}\n```\n\n### HKTopicSection\n\nThis is a struct containing details about a help topic section. It can be created like so:\n\n```swift\nlet topicSection = HKTopicSection(\n    \"Topic Section\",\n    topics: topics\n)\n```\n\n### HKTopic\n\nThis is a struct containing details about a help topic. It can be created like so:\n\n```swift\nlet topic = HKTopic(\n    \"Topic\",\n    iconSystemImage: \"questionmark.circle\",\n    iconTint: .red,\n    content: \"Some content here…\",\n    contentImage: Image(\"image\"),\n    links: links,\n    keywords: [\"keyword\"]\n)\n```\n\n### HKLink\n\nThis is a struct containing details about a help link. It can be created like so:\n\n```swift\nlet topic = HKLink(\n    \"Website\",\n    url: URL(string: \"https://www.example.com\")!\n)\n```\n\n### HelpView\n\nCreate an instance of the view using the following:\n\n```swift\nHelpView(configuration: configuration)\n```\n\n## Other Packages\n\n### [AboutKit](https://github.com/adamfootdev/AboutKit)\n\nAdd an about screen to your app.\n\n### [FeaturesKit](https://github.com/adamfootdev/FeaturesKit)\n\nAdd a features list screen to your app.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamfootdev%2Fhelpkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamfootdev%2Fhelpkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamfootdev%2Fhelpkit/lists"}