operator !npm 

1.8kb drop-in "PJAX" solution for fluid, smooth transitions between pages. Zero stress.

Features

1. Advanced routing via matchit
2. Client-side redirects
3. Async-by-default, easy data loading between routes
4. Pages are cached after initial visit
5. Pre-fetch select pages, as needed

Install

``bash
npm i operator --save
`

Usage

Basically zero config by default, just specify a root DOM node to attach to.
`javascript
import operator from 'operator'

operator('#root')
`

Defining routes


To define custom handlers for a given route, pass an object with a path
property and handler method.
`javascript
operator('#root', [
{
path: '/',
handler (state) {
console.log(state)
}
}
])
`

Routes handlers can also return Promises, and they support params, optional
params, and wildcards.
`javascript
operator('#root', [
{
path: '/',
handler (state) {
console.log(state)
}
},
{
path: '/products',
handler (state) {
return getProducts() // Promise
}
},
{
path: '/products/:category/:slug?',
handler ({ params }) {
const reqs = [ getProductCategory(params.category) ]
if (params.slug) reqs.push(getProductBySlug(params.slug))
return Promise.all(reqs)
}
}
])
`

$3


Routes are cached by default, so on subsequent visits, no data will be loaded.
To follow links to pages via AJAX, but fetch fresh content on each navigation
action, set cache to false:
`javascript
operator('#root', [
{
'path': '/',
cache: false
}
])
`

$3

Sometimes you need to navigate to a page without AJAX, perhaps to load some sort
of iframe content. To do so, set ignore to true:
`javascript
operator('#root', [
{
'path': '/',
ignore: true
}
])
`

Lifecycle

Any function passed to the route config will be called on every route change,
kind of like middleware.
`javascript
const app = operator('#root', [
state => console.log(state)
])
`

Operator also emits some helpful events.
`javascript
app.on('navigate', state => {}) // on valid link click
app.on('before', state => {}) // before render
app.on('after', state => {}) // after render
app.on('hash', state => {}) // when the URL contains a hash
`

$3


Operator does not manage History or page title, for maximum flexibility to the
user. Most people should probably just use this snippet:
`javascript
app.on('after', ({ previousDocument, location }) => {
document.title = previousDocumnt.title
window.history.pushState({}, '', location)
})
`

If you want to ignore things like query strings or hashes, use pathname:
`javascript
app.on('after', ({ previousDocumnt, pathname }) => {
document.title = previousDocumnt.title
window.history.pushState({}, '', pathname)
})
`

$3


When a hash is encountered – whether on a navigate action between pages, or
for scroll-anchors on the same page - Operator will emit a hash event. *It's
up to you to handle scrolling.*

For most sites, this should work:
`javascript
app.on('hash', ({ hash }) => {
const target = document.getElementById(hash)

if (target) {
const scroll = target.getBoundingClientRect().top + window.pageYOffset
window.scrollTo(0, scroll)
}
})
`

Smooth scrolling is also pretty easy:
`javascript
import sscroll from 'sscroll'

app.on('hash', ({ hash }) => {
const target = document.getElementById(hash)
target && sscroll(target, { duration: 500 })
})
`

API

$3

`javascript
app.go('/about')
`

$3

Use this for prefetching pages.
`javascript
app.load('/about')
`

$3

`javascript
app.state // => { previousDocument, pathname, location, params, hash, search, handler }
`

Recipes

$3

`javascript
app.on('before', ({ pathname }) => {
if (/redirect/.test(pathname)) {
app.go('/') // redirect
}
})
`

$3

`javascript
import wait from 'w2t'

operator('#root', [
state => {
return wait(600, [
const root = document.documentElement.classList
return new Promise(res => {
root.add('is-transitioning')
setTimeout(() => {
root.remove('is-transitioning')
res()
}, 600)
})
])
}
])
`

Changelog

$3

Removed default scroll handling. This should be moved to user-space in the event
the user doesn't want the page to reset to the top.

$3

Added previousDocument (a complete cloned document object) to the state
object. Replaces state.title via previousDocument.title.

$3

- Implemented hash event, see docs
- Fix bad mailto and tel regex, thanks @gabrielloeb!

$3

Slight update to the API, will require brief migration to new syntax for most
users.
- Deprecated Array format for route configs in favor of more flexible Object
syntax
- Add ignore and cache` options

License

MIT License © Eric Bailey