https://github.com/micheltlutz/mlquestioncheck
A check component for Swift projects
https://github.com/micheltlutz/mlquestioncheck
checkbox checker swift swift4
Last synced: 3 months ago
JSON representation
A check component for Swift projects
- Host: GitHub
- URL: https://github.com/micheltlutz/mlquestioncheck
- Owner: micheltlutz
- License: mit
- Archived: true
- Created: 2018-08-14T12:19:47.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2021-02-09T12:55:17.000Z (about 4 years ago)
- Last Synced: 2025-01-19T14:56:02.477Z (3 months ago)
- Topics: checkbox, checker, swift, swift4
- Language: Swift
- Size: 367 KB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MLQuestionCheck
[](https://cocoapods.org/pods/MLQuestionCheck)
[](https://raw.githubusercontent.com/micheltlutz/MLQuestionCheck/master/LICENSE)
[](https://github.com/apple/swift-package-manager)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/MLQuestionCheck)
[](https://travis-ci.org/micheltlutz/MLQuestionCheck/branches)
A check component for Swift projects
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Requirements
- iOS 10.0+ / tvOS 12.0+
- Xcode 10.0+
## Installation
### Dependency Managers
CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate MLQuestionCheck into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!
pod 'MLQuestionCheck', '~> 1.1.3'
```
Then, run the following command:
```bash
$ pod install
```
Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate MLQuestionCheck into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "micheltlutz/MLQuestionCheck" ~> 1.1.3
```
Swift Package Manager
To use MLQuestionCheck as a [Swift Package Manager](https://swift.org/package-manager/) package just add the following in your Package.swift file.
``` swift
// swift-tools-version:4.1
import PackageDescription
let package = Package(
name: "HelloMLQuestionCheck",
dependencies: [
.package(url: "https://github.com/micheltlutz/MLQuestionCheck.git", .upToNextMajor(from: "1.1.3"))
],
targets: [
.target(name: "HelloMLQuestionCheck", dependencies: ["MLQuestionCheck"])
]
)
```
### Manually
If you prefer not to use either of the aforementioned dependency managers, you can integrate MLQuestionCheck into your project manually.
Git Submodules
- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
```bash
$ git init
```
- Add MLQuestionCheck as a git [submodule](http://git-scm.com/docs/git-submodule) by running the following command:
```bash
$ git submodule add https://github.com/micheltlutz/MLQuestionCheck.git
$ git submodule update --init --recursive
```
- Open the new `MLQuestionCheck` folder, and drag the `MLQuestionCheck.xcodeproj` into the Project Navigator of your application's Xcode project.
> It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.
- Select the `MLQuestionCheck.xcodeproj` in the Project Navigator and verify the deployment target matches that of your application target.
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
- In the tab bar at the top of that window, open the "General" panel.
- Click on the `+` button under the "Embedded Binaries" section.
- You will see two different `MLQuestionCheck.xcodeproj` folders each with two different versions of the `MLQuestionCheck.framework` nested inside a `Products` folder.
> It does not matter which `Products` folder you choose from.
- Select the `MLQuestionCheck.framework`.
- And that's it!
> The `MLQuestionCheck.framework` is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.
Embedded Binaries
- Download the latest release from https://github.com/micheltlutz/MLQuestionCheck/releases
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
- In the tab bar at the top of that window, open the "General" panel.
- Click on the `+` button under the "Embedded Binaries" section.
- Add the downloaded `MLQuestionCheck.framework`.
- And that's it!
## Usage
### You need two image files with named in your Assets
- questionUnchecked
- questionChecked
```swift
import MLQuestionCheck
let question1 = MLQuestionCheck(question: "You are ok?")
question1.didChangeState = { checked in
print("question1 checked? \(checked)")
}
```
### You can Change the image name
```swift
question1.uncheckedImageName = "new image name"
question1.checkedImageName = "new image name"
question1.setupCheck() // to change configuration buttons
```
### Or Custom Font width and Runtime Change Text
```swift
let questionCheckCustom = MLQuestionCheck(question: "I'm iOS Developer?")
questionCheckCustom.widthQuestion = UIScreen.main.bounds.width
questionCheckCustom.font = UIFont.boldSystemFont(ofSize: 17)
questionCheckCustom.fontChecked = UIFont.boldSystemFont(ofSize: 20)
questionCheckCustom.didChangeState = { isChecked in
print("questionCheck.isChecked: \(isChecked)")
}
Timer.scheduledTimer(withTimeInterval: 1.0, repeats: false) { (_) in
self.questionCheckCustom.question = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam."
}
```
## Docs
See [Documentation](http://htmlpreview.github.io/?https://github.com/micheltlutz/MLQuestionCheck/blob/develop/docs/index.html)
MLQuestionCheck Docs (76% documented)
## Contributing
Issues and pull requests are welcome!
## Todo
- [x] Migrate to Swift 4.2 (Thanks [@maclacerda](https://github.com/maclacerda))
- [ ] 100% documented
## Author
Michel Anderson Lutz Teixeira [@michel_lutz](https://twitter.com/michel_lutz)
## Contributions
## License
MLQuestionCheck is released under the MIT license. See [LICENSE](https://github.com/micheltlutz/MLQuestionCheck/blob/master/LICENSE) for details.