symbiote-library/silverstripe-pagejax

Adds partial page loading using ajax

IMPORTANT

This module is no longer actively maintained, however, if you're interested in adopting it, please let us know!, _(*1)

Pagejax module for SilverStripe

Adds partial page loading using ajax., _(*2)

Installation

Follow the standard SilverStripe module installation procedure, _(*3)

Requirements

You must have jquery included in your page, _(*4)

Usage

Cuurently we need to modify Page_Controller and add the following method, _(*5)

    public function getViewer($action) {
        $viewer = parent::getViewer($action);
        $this->extend('updateViewer', $action, $viewer);
        return $viewer;
    }

Modify your main Page.ss template and change, _(*6)

    $Layout

to, _(*7)

    <div class="pagejax-container">$Layout</div>

Then, any link you want to loaded internally needs to have the pagejax class applied, ie, _(*8)

    <a href="some/internal/page" class="pagejax">Internal page</a>

To customise the way the page transitions in and out, you can bind to the window.pagejaxStart and window.pagejaxComplete events, eg, _(*9)

    $(window).bind('pagejaxStart', function () { });

To change the page title on each refresh, specify an ajaxTitle() method on your Page_Controller class; otherwise, the page title will not be chanaged., _(*10)

The module does take into account CSS and JS added using Requirements:: by parsing out relevant headers, _(*11)