Build & Deploy iOS app

Create Magento App Create ScandiPWA App User Manual GitHub

Search…

You can package Scandi as a native iOS application

To deploy an iOS app, you need to have at least one native feature to be included in the app. We used a barcode scanner to search for items. You can add notifications management or anything else, but you have to add it as native code.
To deploy an iOS application you must have a macOS-powered device.
To display your site in iOS App, you first need to make sure it is deployed online. Then, you can use WebView to display the site inside of an iOS native app. To integrate native feature to the site, we suggest using the following approach:
1.Create a Swift View Controller
2.Display WebView inside of this controller
3.Create a JavaScript file that would be injected into the app
4.Use WebKit message handlers API to establish communication between WebView and native app
Creating an app (step-by-step)
1. Create a new XCode project
2. Select single view template
3. Go to ViewController.swift 
4. Replace its content with the script bellow
1
import UIKit
2
import WebKit
3
​
4
class ViewController: UIViewController, WKUIDelegate, WKScriptMessageHandler {
5
    /// Assuming that the javascript sends message back, this function handles the message
6
    ///
7
    /// - Parameters:
8
    ///   - userContentController: controller
9
    ///   - message: Message. Can be a String or [String:Any] to a single level.
10
    func userContentController(
11
        _ userContentController: WKUserContentController,
12
        didReceive message: WKScriptMessage
13
    ) {
14
        print("something recived");
15
​
16
        let messageBody = message.body as! [String: Any];
17
        let action = messageBody["action"] as! String;
18
            
19
        switch action {
20
        case "barcodeClick":
21
            print("barcode was clicked");
22
            return;
23
        default:
24
            return;
25
        }
26
    }
27
    
28
    lazy var webView: WKWebView = {
29
        let   webCfg:WKWebViewConfiguration = WKWebViewConfiguration()
30
        
31
        // Setup WKUserContentController instance for injecting user script
32
        var userController:WKUserContentController = WKUserContentController()
33
        
34
        var script:String?
35
        
36
        // Get the contents of the file `inject.js`
37
        if let filePath:String = Bundle.main.path(forResource: "inject", ofType:"js") {
38
            script = try! String(contentsOfFile: filePath, encoding: .utf8)
39
        }
40
        
41
        let userScript:WKUserScript =  WKUserScript(source: script!, injectionTime: WKUserScriptInjectionTime.atDocumentStart, forMainFrameOnly: false)
42
        
43
        userController.addUserScript(userScript)
44
        
45
        // Add a script message handler for receiving  "nativeProcess" event notifications posted from the JS document using window.webkit.messageHandlers.nativeProcess.postMessage script message
46
        userController.add(self, name: "nativeProcess")
47
        
48
        // Configure the WKWebViewConfiguration instance with the WKUserContentController
49
        webCfg.userContentController = userController;
50
        
51
        let webView = WKWebView(
52
            frame: CGRect(
53
                x: 0,
54
                y: 0,
55
                width: self.view.frame.width,
56
                height: self.view.frame.height
57
            ),
58
            configuration: webCfg
59
        )
60
        
61
        return webView
62
    }();
63
    
64
    override func viewDidLoad() {
65
        super.viewDidLoad()
66
        
67
        // Do any additional setup after loading the view.
68
        self.navigationItem.title = "ScandiPWA"
69
        self.view.addSubview(webView)
70
        let urlToLoad = URL(string: "https://tech-demo.scandipwa.com")
71
        // Do any additional setup after loading the view.
72
        webView.load(URLRequest(url: urlToLoad!))
73
    }
74
}
75
​
Copied!
5. Create an inject.js file from empty template
6. Replace its content with the script bellow
1
function sendToNative(message) {
2
    // Initiate the handle for Native process
3
    const native = window.webkit.messageHandlers.nativeProcess
4
    native.postMessage(message)
5
}
6
​
7
function onBarcodeClick() {
8
    sendToNative({
9
         action: 'barcodeClick',
10
     });
11
}
12
​
13
const BARCODE_SCANNER_ID = 'barcode-scanner';
14
const SEARCH_FIELD_ID = 'search-field';
15
​
16
function tryRenderingElement() {
17
    setTimeout(() => {
18
               if (document.getElementById(BARCODE_SCANNER_ID)) {
19
               return;
20
               }
21
               
22
               const searchElement = document.getElementById(SEARCH_FIELD_ID);
23
               
24
               const barcodeButton = document.createElement('button');
25
               barcodeButton.id = BARCODE_SCANNER_ID;
26
               barcodeButton.style.width = '30px';
27
               barcodeButton.style.height = '30px';
28
               barcodeButton.style.marginLeft = '1.4rem';
29
               barcodeButton.style.backgroundImage = `url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 480 480'%3E%3Cpath d='M80 48H16C7 48 0 55 0 64v64a16 16 0 0032 0V80h48a16 16 0 000-32zM464 336c-9 0-16 7-16 16v48h-48a16 16 0 000 32h64c9 0 16-7 16-16v-64c0-9-7-16-16-16zM464 48h-64a16 16 0 000 32h48v48a16 16 0 0032 0V64c0-9-7-16-16-16zM80 400H32v-48a16 16 0 00-32 0v64c0 9 7 16 16 16h64a16 16 0 000-32zM64 112h32v256H64zM128 112h32v192h-32zM192 112h32v192h-32zM256 112h32v256h-32zM320 112h32v192h-32zM384 112h32v256h-32zM128 336h32v32h-32zM192 336h32v32h-32zM320 336h32v32h-32z'/%3E%3C/svg%3E")`;
30
               barcodeButton.style.backgroundSize = 'contain';
31
               barcodeButton.onclick = onBarcodeClick;
32
               
33
               const searchFieldWrapper = searchElement.parentNode.parentNode;
34
               searchFieldWrapper.style.display = 'flex';
35
               searchFieldWrapper.style.alignItems = 'center';
36
               searchFieldWrapper.appendChild(barcodeButton);
37
               
38
               const searchField = searchElement.parentNode;
39
               searchField.style.flexGrow = '1';
40
               }, 0);
41
}
42
​
43
const pushState = window.history.pushState;
44
window.history.pushState = function () {
45
    // Track page changes in React
46
    pushState.apply(window.history, arguments);
47
    tryRenderingElement();
48
};
49
​
50
tryRenderingElement();
Copied!
7. Compile and test the application
As you can see injecting scripts into WebView is not that hard. When clicking on the barcode icon, the XCode console logs the barcode was clicked message. You can replace this logic with anything that matches your needs.
We will publish the full app code (including the barcode implementation) soon, so you can use it as a reference.
When the app is done, it's time to publish it!
Publishing the app
To publish an iOS app, you must be signed up for the Apple Developer Program. You can do this on the official site, here. 
1.Login to your App Store Connect​
2.Go to My Apps click +
3.Enter app name, category, privacy, pricing
4.Make screenshots of your application (size guide)
5.Next, build your app with XCode
1.For build platform select: Generic iOS Device
2.Go to Product > Archive and build the app
3.Select newly created archive, click Distribute App, select iOS AppStore
6.Go back to your App Store Connect​
7.Find a version of your app, and click Submit for Review
For a more detailed guide, please see Chris's guide.
The process of review might take up to 10 days and result in refusal. ScandiPWA does not guarantee your app publishing. Please make sure the app you build complies with AppStore guidelines.