Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yannickl/QRCodeReaderViewController
Simple QRCode reader for iOS 7 and over
https://github.com/yannickl/QRCodeReaderViewController
Last synced: 3 months ago
JSON representation
Simple QRCode reader for iOS 7 and over
- Host: GitHub
- URL: https://github.com/yannickl/QRCodeReaderViewController
- Owner: yannickl
- License: mit
- Created: 2014-07-29T15:43:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-20T22:13:14.000Z (almost 6 years ago)
- Last Synced: 2024-07-18T15:29:46.499Z (4 months ago)
- Language: Objective-C
- Homepage:
- Size: 1.96 MB
- Stars: 629
- Watchers: 30
- Forks: 164
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
The _QRCodeReaderViewController_ was initially a simple QRCode reader but it now lets you the possibility to specify the [format type](https://developer.apple.com/library/ios/documentation/AVFoundation/Reference/AVMetadataMachineReadableCodeObject_Class/index.html#//apple_ref/doc/constant_group/Machine_Readable_Object_Types) you want to decode. It is based on the `AVFoundation` framework from Apple in order to replace ZXing or ZBar for iOS 7 and over.
It provides a default view controller to display the camera view with the scan area overlay and it also provides a button to switch between the front and the back cameras.
Usage • Installation • Contribution • Contact • License
## Usage
Note that in iOS10+, you will need first to reasoning about the camera use. For that you'll need to add the **Privacy - Camera Usage Description** *(NSCameraUsageDescription)* field in your Info.plist:
Now a very simple example how to work with `QRCodeReaderViewController`:
```objective-c
// Create the reader object
QRCodeReader *reader = [QRCodeReader readerWithMetadataObjectTypes:@[AVMetadataObjectTypeQRCode]];
// Instantiate the view controller
QRCodeReaderViewController *vc = [QRCodeReaderViewController readerWithCancelButtonTitle:@"Cancel" codeReader:_reader startScanningAtLoad:YES showSwitchCameraButton:YES showTorchButton:YES];
// Set the presentation style
_vc.modalPresentationStyle = UIModalPresentationFormSheet;
// Define the delegate receiver
_vc.delegate = self;
// Or use blocks
[_reader setCompletionWithBlock:^(NSString *resultAsString) {
NSLog(@"%@", resultAsString);
}];
```
Now when we touch the scan button we need to display the QRCodeReaderViewController:
```objective-c
#pragma mark - Action Methods
- (IBAction)scanAction:(id)sender
{
[self presentViewController:_vc animated:YES completion:NULL];
}
```
And here the delegate methods:
```objective-c
#pragma mark - QRCodeReader Delegate Methods
- (void)reader:(QRCodeReaderViewController *)reader didScanResult:(NSString *)result
{
[self dismissViewControllerAnimated:YES completion:^{
NSLog(@"%@", result);
}];
}
- (void)readerDidCancel:(QRCodeReaderViewController *)reader
{
[self dismissViewControllerAnimated:YES completion:NULL];
}
```
*Note that you should check whether the device supports the reader library by using the `[QRCodeReader isAvailable]` or the `[QRCodeReader supportsMetadataObjectTypes:nil]` methods.*
### Installation
The recommended approach to use _QRCodeReaderViewController_ in your project is using the [CocoaPods](http://cocoapods.org/) package manager, as it provides flexible dependency management and dead simple installation.
#### CocoaPods
Install CocoaPods if not already available:
``` bash
$ [sudo] gem install cocoapods
$ pod setup
```
Go to the directory of your Xcode project, and Create and Edit your Podfile and add _QRCodeReaderViewController_:
``` bash
$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '7.0'
pod 'QRCodeReaderViewController', '~> 4.0.2'
```
Install into your project:
``` bash
$ pod install
```
Open your project in Xcode from the .xcworkspace file (not the usual project file)
``` bash
$ open MyProject.xcworkspace
```
#### Manually
[Download](https://github.com/YannickL/QRCodeReaderViewController/archive/master.zip) the project and copy the `QRCodeReaderViewController` folder into your project and then simply `#import "QRCodeReaderViewController.h"` in the file(s) you would like to use it in.
## Contribution
Contributions are welcomed and encouraged *♡*.
## Contact
Yannick Loriot
- [https://twitter.com/yannickloriot](https://twitter.com/yannickloriot)
- [[email protected]](mailto:[email protected])
## License (MIT)
Copyright (c) 2014-present - Yannick Loriot
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.