iOS - Using native pages in hybrid applications

improve this page | report issue


This tutorial explains how to integrate native and web "pages" in an iOS application by using the API to open a native page from JavaScript.

With this method, you can have data sent from JavaScript to the open native page, and specify a callback to be called after the native page closes.

This tutorial covers the following topics:

Connecting to the plugin from the JavaScript code

  1. Implement the method to open the native page:

    function openNativePage(){
        var params = {
            nameParam : $('#nameInput').val()
        };, backFromNativePage, params);

    • nativePageClassName: The name of a native iOS UIViewController instance to start.
    • backFromNativePage: A callback function to call when the native page closes.
    • params: Optional custom parameters object to pass to the native code.
  2. To handle the callback function, write the following code:

    function backFromNativePage(data){
        alert("Received phone number is: " + data.phoneNumber);

    The backFromNativePage(data) parameter can pass data back to the web part of an application after the native closes.

Creating a native page

To manage a native page, proceed as follows:

  1. Open the generated iOS projects in Xcode.
  2. Add a new Cocoa Touch Class file, make sure that it is a subclass of UIViewController and save the file in the Classes folder of the Xcode project.

    If you work with existing .m and .h files, reference the files while in Xcode.
    Placing the .m and .h files only in the iphone\native\Classes folder in Eclipse is not sufficient, because these files are not referenced in the Xcode project unless they have been added in Xcode.

  3. To retrieve custom data parameters that are passed from the web view, use the setDataFromWebView:(NSDictionary*)data method:

        self.nameParam = (NSString*)[data valueForKey:@"nameParam"];

Returning control to the web view

When the native page switches back to the web view, a call to the [NativePage showWebView:] method is necessary.
To pass data back to the web view, use the NSDictionary object. For example:


    NSString *phone = [phoneNumber text];
    NSDictionary *returnedData = [NSDictionary dictionaryWithObject:phone forKey:@"phoneNumber"];
    [NativePage showWebView:returnedData];


function backFromNativePage(data){
    alert("Received phone number is: " + data.phoneNumber);

Sample application

Click to download the MobileFirst project.


Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.
Last modified on November 09, 2016