Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamfootdev/featureskit
Add a features list screen to your app in just a few lines of code.
https://github.com/adamfootdev/featureskit
ios swiftui xcode
Last synced: about 21 hours ago
JSON representation
Add a features list screen to your app in just a few lines of code.
- Host: GitHub
- URL: https://github.com/adamfootdev/featureskit
- Owner: adamfootdev
- License: mit
- Created: 2023-08-03T16:16:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-04T11:41:51.000Z (3 months ago)
- Last Synced: 2024-12-30T23:24:46.323Z (9 days ago)
- Topics: ios, swiftui, xcode
- Language: Swift
- Homepage:
- Size: 238 KB
- Stars: 33
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# FeaturesKit
FeaturesKit provides developers for Apple platforms with the ability to display a list of configured features in their apps. This is built using SwiftUI so can be displayed natively from a SwiftUI app or using a UIHostingController in a UIKit app, and has been designed to mimic the style of built-in Apple screens.
This has been localised into multiple languages and the buttons will automatically adapt to your appʼs accent color.
1. [Requirements](#requirements)
2. [Integration](#integration)
3. [Usage](#usage)
- [FKConfiguration](#fkconfiguration)
- [FKItem](#fkitem)
- [FeaturesView](#featuresview)
4. [Other Packages](#other-packages)
- [AboutKit](https://github.com/adamfootdev/AboutKit)
- [HelpKit](https://github.com/adamfootdev/HelpKit)
## Requirements
- iOS/iPadOS 15.0+
- macOS 13.0+
- tvOS 15.0+
- visionOS 1.0+
- watchOS 8.0+
- Xcode 15.0+
## Integration
### Swift Package Manager
FeaturesKit can be added to your app via Swift Package Manager in Xcode. Add to your project like so:
```swift
dependencies: [
.package(url: "https://github.com/adamfootdev/FeaturesKit.git", from: "1.0.0")
]
```
## Usage
To start using the framework, you'll need to import it first:
```swift
import FeaturesKit
```
### FKConfiguration
This is a struct containing all of the relevant details required to configure FeaturesKit. It can be created like so:
```swift
let configuration = FKConfiguration(
title: "What's New in Example App",
items: items,
showContinueButton: true,
continueButtonTitle: "Continue",
) {
print("Done")
}
```
### FKItem
This is a struct containing details relating to items that appear on the feature list screen. It can be created as follows:
```swift
let item = FKItem(
title: "New Feature",
description: "This is a cool new feature!",
systemImage: "checkmark.circle",
imageTint: .green
)
```
The systemImage value is optional and will be hidden if a value is not provided. The imageTint value is also optional and will default to the accent color if not provided.
### FeaturesView
The features view allows you to display a list of features that are available in your app with a custom title at the top. Create an instance of the view using the following:
```swift
FeaturesView(configuration: configuration)
```
## Other Packages
### [AboutKit](https://github.com/adamfootdev/AboutKit)
Add an about screen to your app.
### [HelpKit](https://github.com/adamfootdev/HelpKit)
Add a help screen to your app.