<p align="center"> <img src="Resources/Icon-Badge.png" alt="Project Icon" width="250" /> </p> <p align="center"> <img src="https://img.shields.io/github/v/release/danielsaidi/DeckKit?color=%2300550&sort=semver" alt="Version" /> <img src="https://img.shields.io/badge/Swift-6.1-orange.svg" alt="Swift 6.1" /> <a href="https://danielsaidi.github.io/DeckKit"><img src="https://img.shields.io/badge/documentation-web-blue.svg" alt="Documentation" /></a> <img src="https://img.shields.io/github/license/danielsaidi/DeckKit" alt="MIT License" /> </p>

DeckKit

DeckKit is a SwiftUI library that makes it easy to create deck-based apps. It has a DeckView that can render any list of items, with support for swipe gestures, edge swipes, shuffling, etc.

<p align="center"> <img src="Resources/Demo.gif" width=300 alt="Demo video" /> </p>

DeckKit can be customized to great extent. You can change colors, fonts, etc. and use completely custom views. It also has tools to manage favorites.

Installation

DeckKit can be installed with the Swift Package Manager:

https://github.com/danielsaidi/DeckKit.git

Getting started

With DeckKit, you can create a deck of cards with any type that conforms to Identifiable:

struct Hobby: Identifiable {
    
    var name: String
    var text: String

    var id: String { name }
}

struct MyView: View {

    @State 
    var hobbies: [Hobby] = ...

    var body: some View {
        DeckView($hobbies) { hobby in
            RoundedRectangle(cornerRadius: 25.0)
                .fill(.blue)
                .overlay(Text(hobby.name))
                .shadow(radius: 10)
        }
    }
}

DeckKit has several view components for presenting decks, e.g. DeckView and DeckPageView.

See the online getting started guide for more information.

Documentation

The online documentation has more information, articles, code examples, etc.

Demo Application

The Demo folder has an app that lets you explore the library on iOS, macOS, and visionOS.

Support My Work

Maintaining my various open-source tools takes significant time and effort. You can become a sponsor to help me dedicate more time to creating, maintaining, and improving these projects. Every contribution, no matter the size, makes a real difference in keeping these tools free and actively developed. Thank you for considering!

Contact

Feel free to reach out if you have questions or want to contribute in any way:

• Website: danielsaidi.com
• E-mail: daniel.saidi@gmail.com
• Bluesky: @danielsaidi@bsky.social
• Mastodon: @danielsaidi@mastodon.social

License

DeckKit is available under the MIT license. See the LICENSE file for more info.