Swiftpack.co -  CypherPoet/ClampedPropertyWrapper as Swift Package
Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
CypherPoet/ClampedPropertyWrapper
A Swift Property Wrapper for automatically clamping Comparable values within a closed range.
.package(url: "https://github.com/CypherPoet/ClampedPropertyWrapper.git", from: "0.1.0")

Clamped: A Swift Property Wrapper

Twitter: @cypher_poet

A Swift Property Wrapper for automatically clamping Comparable values within a closed range.

Installation

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/ClampedPropertyWrapper.

Swift Package Manager Projects

You can add ClampedPropertyWrapper as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(url: "https://github.com/CypherPoet/ClampedPropertyWrapper", .upToNextMinor(from: "0.1.0")),
    ],
    //...
)

From there, refer to ClampedPropertyWrapper as a "target dependency" in any of your package's targets that need it.

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
          "ClampedPropertyWrapper",
        ],
        ...
    ),
    ...
]

Then simply import ClampedPropertyWrapper wherever you’d like to use it.

Usage

Basic Example:

import ClampedPropertyWrapper

struct Player {
    @Clamped(within: 0.0...Double.infinity)
    var xp: Double = 0.0

    @Clamped(within: 1...100)
    var level: Int = 1

    @Clamped(within: "A"..."Z")
    var firstInitial: Character = "A"
}

Taking it a bit further in this project's Xcode Playground:

Playground Example

Contributing

Contributions to ClampedPropertyWrapper are most welcome. Check out some of the issue templates for more info.

💻 Developing

Requirements

  • Xcode 12.5+ (Recommended)

📜 Generating Documentation

Documentation is generated by Jazzy. Installation instructions can be found here, and as soon as you have it set up, docs can be generated simply by running jazzy from the command line.

📝 Note that this will only generate the docs folder for you to view locally. This folder is being ignored by git, as an action exists to automatically generate docs at the root level and serve them on the project's gh-pages branch.

🏷 License

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

GitHub

link
Stars: 0
Last commit: 4 weeks ago

Ad: Job Offers

iOS Software Engineer @ Perry Street Software
Perry Street Software is Jack’d and SCRUFF. We are two of the world’s largest gay, bi, trans and queer social dating apps on iOS and Android. Our brands reach more than 20 million members worldwide so members can connect, meet and express themselves on a platform that prioritizes privacy and security. We invest heavily into SwiftUI and using Swift Packages to modularize the codebase.

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API