mirror of
https://github.com/terribleplan/next.js.git
synced 2024-01-19 02:48:18 +00:00
c890dc3573
* Move route loading logic to a common place. * Add router events. * Add EventEmitter's core API methods. * Add example app for loading events and docs. * Fix some typos. * Get rid of Router.ready() * Remove events package. It's already shipping with webpack. * Handling aborting properly. * Expose simple attribute based events listener API. Removed the proposed event listener API from the public API. * Remove error logged when there's an abort error. There are many other ways to capture this error. So, it doesn't look nice to print this always. * Change router events to pass only the current URL as arguments. * Add a section about Cancelled Routes to README.
78 lines
2.3 KiB
JavaScript
78 lines
2.3 KiB
JavaScript
import _Router from './router'
|
|
|
|
const SingletonRouter = {
|
|
router: null, // holds the actual router instance
|
|
readyCallbacks: [],
|
|
ready (cb) {
|
|
if (this.router) return cb()
|
|
if (typeof window !== 'undefined') {
|
|
this.readyCallbacks.push(cb)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Create public properties and methods of the router in the SingletonRouter
|
|
const propertyFields = ['components', 'pathname', 'route', 'query']
|
|
const coreMethodFields = ['push', 'replace', 'reload', 'back']
|
|
const routerEvents = ['routeChangeStart', 'routeChangeComplete', 'routeChangeError']
|
|
|
|
propertyFields.forEach((field) => {
|
|
// Here we need to use Object.defineProperty because, we need to return
|
|
// the property assigned to the actual router
|
|
// The value might get changed as we change routes and this is the
|
|
// proper way to access it
|
|
Object.defineProperty(SingletonRouter, field, {
|
|
get () {
|
|
throwIfNoRouter()
|
|
return SingletonRouter.router[field]
|
|
}
|
|
})
|
|
})
|
|
|
|
coreMethodFields.forEach((field) => {
|
|
SingletonRouter[field] = (...args) => {
|
|
throwIfNoRouter()
|
|
return SingletonRouter.router[field](...args)
|
|
}
|
|
})
|
|
|
|
routerEvents.forEach((event) => {
|
|
SingletonRouter.ready(() => {
|
|
SingletonRouter.router.on(event, (...args) => {
|
|
const eventField = `on${event.charAt(0).toUpperCase()}${event.substring(1)}`
|
|
if (SingletonRouter[eventField]) {
|
|
SingletonRouter[eventField](...args)
|
|
}
|
|
})
|
|
})
|
|
})
|
|
|
|
function throwIfNoRouter () {
|
|
if (!SingletonRouter.router) {
|
|
const message = 'No router instance found.\n' +
|
|
'You should only use "next/router" inside the client side of your app.\n'
|
|
throw new Error(message)
|
|
}
|
|
}
|
|
|
|
// Export the SingletonRouter and this is the public API.
|
|
export default SingletonRouter
|
|
|
|
// INTERNAL APIS
|
|
// -------------
|
|
// (do not use following exports inside the app)
|
|
|
|
// Create a router and assign it as the singleton instance.
|
|
// This is used in client side when we are initilizing the app.
|
|
// This should **not** use inside the server.
|
|
export const createRouter = function (...args) {
|
|
SingletonRouter.router = new _Router(...args)
|
|
SingletonRouter.readyCallbacks.forEach(cb => cb())
|
|
SingletonRouter.readyCallbacks = []
|
|
|
|
return SingletonRouter.router
|
|
}
|
|
|
|
// Export the actual Router class, which is usually used inside the server
|
|
export const Router = _Router
|