next-koa
v2.2.0
Published
A koa middleware and some tools for next.js
Downloads
35
Readme
Koa2 & Next.js hydration packages
Usage
- Firstly setup a koa server entry
// server/index.js
const NextKoa = require('next-koa')
const Koa = require('koa')
const Router = require('koa2-router')
const path = require('path')
const app = new Koa()
const router = new Router()
const nextApp = NextKoa({
dev: process.env.NODE_ENV !== 'production',
dir: path.resolve(__dirname, '..')
})
// console nextConfig
console.log(nextApp.nextConfig)
app.use(nextApp.middleware)
app.use((ctx, next) => {
ctx.state.homepage = '/'
return next()
})
app.use(router)
// using renderer of next.js to emit pages/about.tsx
// the state can be captured by next-koa/getstate package
// and is rendered as ctx.state merged by this data
// here data usually is a plain object
router.get('/about', ctx => ctx.render('about', { title: 'about us' }))
// if nextConfig.useFileSystemPublicRoutes is missing or true
// then you can get any page under `pages` by directly fetching
// the pathname without defining the koa routes
app.listen(3000)- Then write your own next.js pages
// pages/about.tsx
import React from 'react'
import Head from 'next/head'
import Link from 'next/link'
import getInitialState from 'next-koa/getstate'
export default class AboutPage extends React.Component {
static async getInitialProps(ctx) {
// getInitalState fetches data both on client/server
const state = await getInitialState(ctx)
// { title: 'about us', homepage: '/' }
return state
}
render() {
return <>
<Head>
<title>{this.props.title}</title>
</Head>
<Link href={this.props.homepage}>
<a>Homepage</a>
</Link>
</>
}
}
- If you want next.js layout feature, just like this
// pages/_app.tsx
import App from 'next-koa/app'
export default class CustomApp extends App {
}- in order to make
next-koa/appbeing packed by webpack,
we should use this plugin to include this module
// next.config.js
const withNextKoaPlugin = require('next-koa/plugin')
module.exports = withNextKoaPlugin({
// ...config
})- Now we can export a Layout
// layout/index.tsx
import React from 'react'
import { withLayout } from 'next-koa/layout'
export default withLayout(({ children }: { children: React.ReactNode }) => {
return <section className='layout'>
<nav>
<ul>
{...}
</ul>
</nav>
<main className='container'>
{children}
</main>
</section>
})- then we can use the layout above to decorate any pages
// pages/index.tsx
import React from 'react'
import withCustomLayout from '../layout'
const IndexPage: React.FC<any> = //...
export default withCustomLayout(IndexPage)