Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README about 'alterChangeState' #250

Merged
merged 1 commit into from
Feb 12, 2016
Merged

Updated README about 'alterChangeState' #250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 247,21 @@ $('#main').smoothState({
});
```

### `alterChangeState`

A function to alter a history entry's state object before it is modified or added to the browser's history. This can be used to attach serializable data to the history entry, for example.

```js
// Default
$('#main').smoothState({
// Param `state` is an `Object` that contains the container ID, by default
alterChangeState: function(state) {
// Must return a serializable `Object` that is associated with the history entry
return state;
}
});
```

### `onBefore`

The function to run before a page load is started.
Expand Down