shortcut / shortcut-swiftui-ios

ShortcutUI

Contains common utility functions and extensions.

Features

• List features here

Requirements

• iOS 13+
• Xcode 13+

Style Guide

Following our style guide should:

• Make it easier to read and begin understanding the unfamiliar code.
• Make code easier to maintain.
• Reduce simple programmer errors.
• Reduce cognitive load while coding.
• Keep discussions on diffs focused on the code's logic rather than its style.

Note that brevity is not a primary goal.

Official Style Guide

Installation

Using as a dependency

// swift-tools-version: 5.6

import PackageDescription

let package = Package(
  name: "YourTestProject",
  dependencies: [
    .package(url: "[e-mail]:shortcut/shortcut-swiftui-ios.git", from: "0.0.1")
  ],
  targets: [
    .target(name: "YourTestProject", dependencies: ["ShortcutUI"])
  ]
)

And then import wherever needed: import ShortcutUI

Adding it to an existent iOS Project via Swift Package Manager

1. Using Xcode 11 or greater go to File > Swift Packages > Add Package Dependency
2. Paste the project URL: [e-mail]:shortcut/shortcut-swiftui-ios.git
3. Click on next and select the project target

If you have doubts, please, check the following links:

How to use

Creating Swift Packages

After successfully retrieved the package and added it to your project, just import ShortcutUI and you can get the full benefits of it.

Usage example

import ShortcutUI

...

Contributing to the library

1. Clone the repository
2. Create your feature branch
3. Open the Package.swift file
4. Perform your changes, debug, run the unit tests
5. Make sure that all the tests pass and there are no Xcode warnings or lint issues
6. Open a pull request