jquery / jquery/jquerymobile.com

Custom Build of 1.3.2 JS Out of Order

Open
#72 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
57
Forks
69
PR merge metrics
No merged PRs in 30d

Description

When building a custom version of 1.3.2, the built JS is not in the correct order, which causes the first JQM page to not initialize properly. The following code needs to be the last item in the JS file and it is not.

(function( $, window, undefined ) {
    var $html = $( "html" ),
    $head = $( "head" ),
    $window = $.mobile.window;

//remove initial build class (only present on first pageshow)
function hideRenderingClass() {
    $html.removeClass( "ui-mobile-rendering" );
}

// trigger mobileinit event - useful hook for configuring $.mobile settings before they're used
$( window.document ).trigger( "mobileinit" );

// support conditions
// if device support condition(s) aren't met, leave things as they are -> a basic, usable experience,
// otherwise, proceed with the enhancements
if ( !$.mobile.gradeA() ) {
    return;
}

// override ajaxEnabled on platforms that have known conflicts with hash history updates
// or generally work better browsing in regular http for full page refreshes (BB5, Opera Mini)
if ( $.mobile.ajaxBlacklist ) {
    $.mobile.ajaxEnabled = false;
}

// Add mobile, initial load "rendering" classes to docEl
$html.addClass( "ui-mobile ui-mobile-rendering" );

// This is a fallback. If anything goes wrong (JS errors, etc), or events don't fire,
// this ensures the rendering class is removed after 5 seconds, so content is visible and accessible
setTimeout( hideRenderingClass, 5000 );

$.extend( $.mobile, {
    // find and enhance the pages in the dom and transition to the first page.
    initializePage: function() {
        // find present pages
        var path = $.mobile.path,
            $pages = $( ":jqmData(role='page'), :jqmData(role='dialog')" ),
            hash = path.stripHash( path.stripQueryParams(path.parseLocation().hash) ),
            hashPage = document.getElementById( hash );

        // if no pages are found, create one with body's inner html
        if ( !$pages.length ) {
            $pages = $( "body" ).wrapInner( "<div data-" + $.mobile.ns + "role='page'></div>" ).children( 0 );
        }

        // add dialogs, set data-url attrs
        $pages.each(function() {
            var $this = $( this );

            // unless the data url is already set set it to the pathname
            if ( !$this.jqmData( "url" ) ) {
                $this.attr( "data-" + $.mobile.ns + "url", $this.attr( "id" ) || location.pathname + location.search );
            }
        });

        // define first page in dom case one backs out to the directory root (not always the first page visited, but defined as fallback)
        $.mobile.firstPage = $pages.first();

        // define page container
        $.mobile.pageContainer = $.mobile.firstPage.parent().addClass( "ui-mobile-viewport" );

        // initialize navigation events now, after mobileinit has occurred and the page container
        // has been created but before the rest of the library is alerted to that fact
        $.mobile.navreadyDeferred.resolve();

        // alert listeners that the pagecontainer has been determined for binding
        // to events triggered on it
        $window.trigger( "pagecontainercreate" );

        // cue page loading message
        $.mobile.showPageLoadingMsg();

        //remove initial build class (only present on first pageshow)
        hideRenderingClass();

        // if hashchange listening is disabled, there's no hash deeplink,
        // the hash is not valid (contains more than one # or does not start with #)
        // or there is no page with that hash, change to the first page in the DOM
        // Remember, however, that the hash can also be a path!
        if ( ! ( $.mobile.hashListeningEnabled &&
            $.mobile.path.isHashValid( location.hash ) &&
            ( $( hashPage ).is( ':jqmData(role="page")' ) ||
                $.mobile.path.isPath( hash ) ||
                hash === $.mobile.dialogHashKey ) ) ) {

            // Store the initial destination
            if ( $.mobile.path.isHashValid( location.hash ) ) {
                $.mobile.urlHistory.initialDst = hash.replace( "#", "" );
            }

            // make sure to set initial popstate state if it exists
            // so that navigation back to the initial page works properly
            if( $.event.special.navigate.isPushStateEnabled() ) {
                $.mobile.navigate.navigator.squash( path.parseLocation().href );
            }

            $.mobile.changePage( $.mobile.firstPage, {
                transition: "none",
                reverse: true,
                changeHash: false,
                fromHashChange: true
            });
        } else {
            // trigger hashchange or navigate to squash and record the correct
            // history entry for an initial hash path
            if( !$.event.special.navigate.isPushStateEnabled() ) {
                $window.trigger( "hashchange", [true] );
            } else {
                // TODO figure out how to simplify this interaction with the initial history entry
                // at the bottom js/navigate/navigate.js
                $.mobile.navigate.history.stack = [];
                $.mobile.navigate( $.mobile.path.isPath( location.hash ) ? location.hash : location.href );
            }
        }
    }
});

// check which scrollTop value should be used by scrolling to 1 immediately at domready
// then check what the scroll top is. Android will report 0... others 1
// note that this initial scroll won't hide the address bar. It's just for the check.
$(function() {
    window.scrollTo( 0, 1 );

    // if defaultHomeScroll hasn't been set yet, see if scrollTop is 1
    // it should be 1 in most browsers, but android treats 1 as 0 (for hiding addr bar)
    // so if it's 1, use 0 from now on
    $.mobile.defaultHomeScroll = ( !$.support.scrollTop || $.mobile.window.scrollTop() === 1 ) ? 0 : 1;

    //dom-ready inits
    if ( $.mobile.autoInitializePage ) {
        $.mobile.initializePage();
    }

    // window load event
    // hide iOS browser chrome on load
    $window.load( $.mobile.silentScroll );

    if ( !$.support.cssPointerEvents ) {
        // IE and Opera don't support CSS pointer-events: none that we use to disable link-based buttons
        // by adding the 'ui-disabled' class to them. Using a JavaScript workaround for those browser.
        // https://github.com/jquery/jquery-mobile/issues/3558

        $.mobile.document.delegate( ".ui-disabled", "vclick",
            function( e ) {
                e.preventDefault();
                e.stopImmediatePropagation();
            }
        );
    }
});
}( jQuery, this ));

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source file, build entry point, or test is named in the issue. Trace the custom-build process and inspect the generated JavaScript ordering, using the shown initialization block as the expected final section. Done means the first jQuery Mobile page initializes correctly in a custom 1.3.2 build.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.