From 8dbe7553b9c910fcc24edba8aec9f7e8777d321b Mon Sep 17 00:00:00 2001 From: Robin North Date: Wed, 30 May 2018 03:23:23 +0100 Subject: [PATCH] Document `refresh` and `reload` methods (#160) --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 037db2d..c056a03 100644 --- a/README.md +++ b/README.md @@ -200,6 +200,24 @@ pjax.handleResponse = function(responseText, request, href) { } ``` + +#### `refresh([el])` + +Use this method to bind Pjax to children of a DOM element that didn't exist when Pjax was initialised e.g. content inserted dynamically by another library or script. If called with no arguments, Pjax will parse the entire document again to look for newly-inserted elements. + +```js +// Inside a callback or Promise that runs after new DOM content has been inserted +var newContent = document.querySelector(".new-content"); + +pjax.refresh(newContent); +``` + + +#### `reload()` + +A helper shortcut for `window.location.reload()`. Used to force a page reload. + + ### Options ##### `elements` (String, default: `"a[href], form[action]"`)