SkeletonUI

Overview of the SkeletonUI Project

The SkeletonUI project brings an innovative approach to UI loading animations with a focus on elegance and simplicity. Instead of traditional loading screens or spinners, it employs "skeletons," which serve as placeholders that mimic the appearance of the final content. This offers users a more visually engaging waiting experience.

System Requirements

To successfully integrate and use SkeletonUI, ensure you have the following:

• Operating System: macOS 10.15 or later
• Development Environment: Xcode 11.0 or later
• Programming Language: Swift 5.0 or later

Supported Platforms

SkeletonUI is versatile and supports various Apple platforms including:

• iOS 13.0 or newer
• tvOS 13.0 or newer
• watchOS 6.0 or newer
• macOS 10.15 or newer

Installation Methods

There are two main ways to integrate SkeletonUI into your projects:

Using Swift Package Manager

Swift Package Manager simplifies the distribution of Swift code. To include SkeletonUI in your project, add the following dependency to your Package.swift:

dependencies: [
  .package(url: "https://github.com/CSolanaM/SkeletonUI.git", .branch("master"))
]

Using CocoaPods

For those who prefer CocoaPods, a centralized dependency manager for Cocoa projects, you can add SkeletonUI to your Podfile:

pod 'SkeletonUI'

Key Features

SkeletonUI is packed with features designed to enhance the development experience through:

• Simple, Declarative Syntax: Utilizes SwiftUI for straightforward coding.
• Ease of Use: Setting it up is quick and hassle-free.
• Universal Compatibility: Works on all Apple devices.
• Customization: Offers high flexibility in customization.
• Lightweight: A compact codebase that doesn’t bloat your project.

How to Use

SkeletonUI provides developers with both basic and advanced customization options:

Basic Usage Example

Here’s a simple way to create a skeleton loading effect using SkeletonUI:

import SkeletonUI
import SwiftUI

struct UsersView: View {
    @State var users = [String]()

    var body: some View {
        Text("Finished requesting \(users.count) users!")
            .skeleton(with: users.isEmpty)
            .onAppear {
                DispatchQueue.main.asyncAfter(deadline: .now() + 5) {
                    self.users = ["John Doe", "Jane Doe", "James Doe", "Judy Doe"]
                }
        }
    }
}

Advanced Customization Example

For more control over the appearance, you can customize the skeleton animation and style:

import SkeletonUI
import SwiftUI

struct User: Identifiable {
    let id = UUID()
    let name: String
}

struct UsersView: View {
    @State var users = [User]()

    var body: some View {
        SkeletonList(with: users, quantity: 6) { loading, user in
            Text(user?.name)
                .skeleton(with: loading,
                          animation: .pulse(),
                          appearance: .solid(color: .red, background: .blue),
                          shape: .rectangle,
                          lines: 3,
                          scales: [1: 0.5])
        }
        .onAppear {
            DispatchQueue.main.asyncAfter(deadline: .now() + 5) {
                self.users = [User(name: "John Doe"),
                              User(name: "Jane Doe"),
                              User(name: "James Doe"),
                              User(name: "Judy Doe")]
            }
        }
    }
}

Contribution and Support

Developers interested in contributing to SkeletonUI can suggest features, report bugs, or propose changes through GitHub. Community involvement is encouraged, and details for contributing are available on the project's repository.

Licensing

SkeletonUI is open-source and distributed under the MIT License, offering flexibility for personal and commercial use.

For further details and updates, SkeletonUI is maintained by CSolanaM, who can be contacted via Twitter or email.