Contents

adamfootdev/FeaturesKit

Add a features list screen to your app in just a few lines of code.

Requirements

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

Integration

Swift Package Manager

FeaturesKit 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/FeaturesKit.git", from: "2.0.0")
]

Usage

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

import FeaturesKit

FKConfiguration

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

let configuration = FKConfiguration(
    title: "Whatʼs New in Example App", 
    titlePosition: position,
    titleStyle: style,
    items: items,
    learnMoreURL: URL(string: "https://example.com")!,
    learnMoreButtonTitle: "About Example App",
    showContinueButton: true, 
    continueButtonTitle: "Continue",
) {
    print("Done")
}

FKTitlePosition

This is an enum used for setting the position of the title. Choose from the following options:

case leading
case center
case trailing

FKTitleStyle

This is an enum used for setting the style of the title. Choose from the following options:

case standard
case large

FKItem

This is a struct containing details relating to items that appear on the feature list screen. It can be created as follows:

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:

FeaturesView(configuration: configuration)

Other Packages

AboutKit

Add an about screen to your app.

HelpKit

Add a help screen to your app.

HapticsKit

Add haptic feedback to your app.

InAppPurchaseKit

Add a subscription screen to your app.

Package Metadata

Repository: adamfootdev/FeaturesKit

Stars: 53

Forks: 0

Open issues: 0

Default branch: main

Primary language: swift

License: MIT

Topics: ios, swiftui, xcode

README: README.md