• Stars
    star
    628
  • Rank 71,541 (Top 2 %)
  • Language
    Objective-C
  • License
    MIT License
  • Created over 10 years ago
  • Updated almost 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Simple QRCode reader for iOS 7 and over

QRCodeReaderViewController

Supported Platforms Version Build status

The QRCodeReaderViewController was initially a simple QRCode reader but it now lets you the possibility to specify the format type 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.

screenshot

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:

privacy - camera usage description

Now a very simple example how to work with QRCodeReaderViewController:

// 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:

#pragma mark - Action Methods

- (IBAction)scanAction:(id)sender
{
  [self presentViewController:_vc animated:YES completion:NULL];
}

And here the delegate methods:

#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 package manager, as it provides flexible dependency management and dead simple installation.

CocoaPods

Install CocoaPods if not already available:

$ [sudo] gem install cocoapods
$ pod setup

Go to the directory of your Xcode project, and Create and Edit your Podfile and add QRCodeReaderViewController:

$ 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:

$ pod install

Open your project in Xcode from the .xcworkspace file (not the usual project file)

$ open MyProject.xcworkspace

Manually

Download 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

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.

More Repositories

1

DynamicColor

Yet another extension to manipulate colors easily in Swift and SwiftUI
Swift
3,030
star
2

QRCodeReader.swift

Simple QRCode reader in Swift
Swift
1,328
star
3

YLProgressBar

UIProgressView replacement with an highly and fully customizable animated progress bar in pure Core Graphics
Objective-C
1,277
star
4

DynamicButton

Yet another animated flat buttons in Swift
Swift
1,170
star
5

Splitflap

A simple split-flap display for your Swift applications
Swift
1,081
star
6

FlowingMenu

Interactive view transition to display menus with flowing and bouncing effects in Swift
Swift
974
star
7

AwaitKit

The ES8 Async/Await control flow for Swift
Swift
750
star
8

YLMoment

Parsing, validating, manipulating, and formatting dates easily in Objective-C (API inspired by moment.js)
Objective-C
707
star
9

Reactions

Fully customizable Facebook reactions like control
Swift
584
star
10

SnappingStepper

An elegant alternative to the UIStepper written in Swift
Swift
428
star
11

Perspective

Powerful scrolling and motion parallax for iOS
Swift
268
star
12

CCControlExtension

Collection of classes to make the design of controls easier for Cocos2d-for-iPhone
Objective-C
208
star
13

Box2D-Examples

Box2D examples (Ragdoll, Buoyancy, etc.) for Cocos2D for iPhone
Objective-C
70
star
14

Petal

Beautiful activity indicator to show that a task is in progress
Swift
67
star
15

YLFlowingMenu

The Objective-C counterpart of FlowingMenu
Objective-C
28
star
16

YLTCPBroadcaster

Fast and easy-to-use network scanner to locate every host with a given open port
Objective-C
18
star
17

DynamicFont

Yet another extension to manipulate fonts easily in Swift
Swift
8
star
18

VLCRemoteKit

Remote control for VLC using the HTTP interface in Swift (Under Development)
Swift
3
star
19

Cocarde

Under development
Swift
1
star
20

RSSReaderDemonstrationApp

RSS Reader application for education purpose
Objective-C
1
star