Documentation of options object

[davecranwell]

The documentation doesn't really cover how to use this plugin in a variety of situations. It appears to suggest that the only way of implementing this is if you're able to modify headers in your server.

I tried implementing with just the following code on a static site:
$(document).pjax('nav a', '#content-main');

However it doesn't seem to do anything, no errors, but no action either. Changing it to the following, and it works fine:

$(document).pjax('nav a', '#content-main', {fragment: '#content-main'});

It would be nice if you could document the options a bit further, giving examples of the situations in which you might use them.

(I note that the readme in the 'allow-body-fragment' branch contains much of the missing documentation)

[jfrux]

+1 for sure.
The way this plugin is implemented seems a bit backwards compared to other jquery plugins.

Naturally I would think I could do something like the following...

$(document).ready(function() {
     $(".nav a").pjax({
         'container':'#content-main',
         'click': (would be default or overwrite with a function),
         'success':<default or> function(xhr,response,options) {
               options.container.html(response);
         },
         'title':function() {
              return $(this).attr('data-title')
          }
     });
});

So instead of pjax being an "ajax" alternative it would be almost a "click" alternative or "event" alternative I guess...
or you could even make them options such as click, etc.
I could be wrong, and I'm sure the original developer probably had reasons for design decisions.

Needless to say, I'm having trouble implementing it as well.
I do get it to "work" but I'm not sure where I should specify navigation UI element state changes...
Right now my implementation is this:

$(document).pjax('.js-profile-menu > div > div > ul a', '.content-inner')

However, upon pjax:success I want to overwrite the target clicked link's parent's class with active.
I haven't done this yet but I plan to do it via binding to the pjax:success.

[lachezar]

+1 I have been using pjax for one project 1-2 years ago and I decided to use it again for a new project of mine. Guess how much surprised I was when I saw 1 ajax request + 1 http request on a click of a link, because noone mentioned anything about the options and especially the fragment.

It is important to offer proper documentation for every cool project with so many users!

[mislav]

Fixed in #433. Sorry about the confusion!