Skip to content
1.2kb drop-in "PJAX" solution for fluid, smooth transitions between pages.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
README.md
index.js
package-lock.json
package.json

README.md

operator

1.2kb 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

npm i operator --save

Usage

Basically zero config by default, just specify a root DOM node to attach to.

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.

operator('#root', [
  {
    path: '/',
    handler (state) {
      console.log(state)
    }
  }
])

Routes handlers can also return Promises, and they support params, optional params, and wildcards.

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)
    }
  }
])

Route Caching

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:

operator('#root', [
  {
    'path': '/',
    cache: false
  }
])

Ignoring Routes

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:

operator('#root', [
  {
    'path': '/',
    ignore: true
  }
])

Lifecycle

Any function passed to the route config will be called on every route change, kind of like middleware.

const app = operator('#root', [
  state => console.log(state)
])

Operator also emits some helpful events.

app.on('navigate', state => {}) // on valid link click
app.on('before', state => {}) // before render
app.on('after', state => {}) // after render

History state

Operator does not manage History or page title, for maximum flexibility to the user. Most people should probably just use this snippet:

app.on('after', ({ title, pathname }) => {
  document.title = title
  window.history.pushState({}, '', pathname)
})

API

go(path)

app.go('/about')

load(path)

Use this for prefetching pages.

app.load('/about')

state (getter)

app.state // => { title, pathname, location, params, hash, search, handler }

Recipes

Redirects

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

Transition animation

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

v1.2.0

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

You can’t perform that action at this time.