Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caviarjs/next-block
The official caviar block for next
https://github.com/caviarjs/next-block
caviar caviar-block
Last synced: about 1 month ago
JSON representation
The official caviar block for next
- Host: GitHub
- URL: https://github.com/caviarjs/next-block
- Owner: caviarjs
- License: other
- Created: 2019-05-23T01:26:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-31T11:57:43.000Z (almost 5 years ago)
- Last Synced: 2024-11-16T03:29:48.376Z (2 months ago)
- Topics: caviar, caviar-block
- Language: JavaScript
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/caviarjs/next-block)
[](https://codecov.io/gh/caviarjs/next-block)
# @caviar/next-block
The official caviar block for next.
## Install
```sh
$ npm i @caviar/next-block
```
## Usage
For most scenarios, `@caviar/next-block` is used by a caviar mixer and usually should not be used directly.
### Config
In `[configFile].js`
```js
const CSS = require('@zeit/next-css')
module.exports = {
...otherAnchors,
[nextAnchorName] (compose) {
// The config anchor of next should always returns
// a FUNCTION!
return compose([
CSS
], {
distDir: '.next',
static: {
// Set cache-control for static files as max-age=86400
maxAge: 86400
}
})
},
[nextWebpackAnchorName] (
webpackConfig,
nextOptions,
// The webpack module which `@caviar/next-block` uses
// as the 3rd argument
webpackModule
) {
// Only add the DefinePlugin for client side
if (nextOptions.isServer) {
webpackConfig.plugins.push(
new webpackModule.DefinePlugin({
...
})
)
}
// This method must return an object
return webpackConfig
}
}
```
- **nextAnchorName** `string` the name/key of the config anchor which is defined by the mixer who mixes `@caviar/next-block`
- **nextWebpackAnchorName** `string` the name of the config anchor for next webpack.
### extend(plugins: Array, nextConfigMixins: object): Function
### extend(nextConfigMixins: object): Function
As the first and the only argument of the config anchor function, `extend` is actually the `withPlugins` method of [`next-compose-plugins`](https://www.npmjs.com/package/next-compose-plugins). Method `extend` extends the next config of the underlying caviar [layer], and provides the ability to merge the config from the current layer with the support of next build phases (such as `require('next/constants').PHASE_PRODUCTION_BUILD`).
- **plugins** `Array` Array of next plugin instances. The first parameter of `withPlugins`
- **nextConfigMixins?** `Object={}` the extra config to mix into the current next configuration. The second parameter of `withPlugins`
- **nextConfigMixins.dir** `string` the next dir relative to the current working directory
- **nextConfigMixins.static** `object` the options for [serve-static](https://www.npmjs.com/package/serve-static)
- **nextConfigMixins.staticFilePublicPath** `string=/static` the url pathname prefix to route to static files
## Hooks
### ...builtInBlockHooks
See [Caviar Blocks]
### nextConfig `SyncHook`
Triggered after the next config is generated and before using.
Callback parameters:
- **nextConfig**
- **caviarOptions**
### webpackConfig
Triggered after webpack config is generated and before using.
- **webpackConfig**
- **nextOptions**
- **webpackModule**
- **caviarOptions**
## License
[MIT](LICENSE)