UnitIntervalPropertyWrapper

main

A Swift Property Wrapper for automatically clamping floating-point values within a closed range of [0,1].
CypherPoet/UnitIntervalPropertyWrapper

UnitInterval: A Swift Property Wrapper

Twitter: @cypher_poet

A Swift Property Wrapper for automatically clamping floating-point values within a closed range of [0,1].

Installation

Xcode Projects

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

Swift Package Manager Projects

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

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

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

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

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

Usage

Basic Usage Example:

import UnitIntervalPropertyWrapper

struct AwesomePhoto {
    @UnitInterval
    public var opacity: Double

    @UnitInterval
    public var animationProgress: Double = 0.0
}

var photo = AwesomePhoto(opacity: 100)

photo.opacity             // 1.0
photo.animationProgress   // 0.0

photo.animationProgress = -2.2

photo.animationProgress  // 0.0

Also, feel free to use this project's Xcode Playground to explore things further.

Contributing

Contributions to UnitIntervalPropertyWrapper 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

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

Description

  • Swift Tools 5.4.0
View More Packages from this Author

Dependencies

Last updated: Tue Nov 29 2022 15:10:11 GMT-0500 (GMT-05:00)