hipstersmoothie / next-prefixed

Prefix next links and images. Useful when serving from basePath.

next-prefixed

Prefix next links and images. Useful when serving from basePath.

Read More

Installation

yarn add next-prefixed

Usage

next-prefixed exports components for rendering prefixed links and images. It also exports a function to prefix any url.

To set the prefix for the URLs, set the assetPrefix in your next.config.js.

const debug = process.env.NODE_ENV !== 'production';
const assetPrefix = debug ? '' : '/your_prefix/';

module.exports = withPlugins([withCSS, withMDX, withBlog], {
  assetPrefix,
  publicRuntimeConfig: {
    assetPrefix
  }
});

prefixURL

import { prefixURL } from 'next-prefixed';

prefixURL('/blog'); // => my_prefix/blog

Image

Passes all props to HTML img tag.

import { Image } from 'next-prefixed';

const Example = () => <Image src="pony.png" alt="Valiant Horse" />;

Link

Passes all props to next.js Link component.

import { Link } from 'next-prefixed';

const Example = () => <Link to="/blog" />;

next-prefixed's Issues

Support 'serverless' target

According to the docs, next/config is not supported for target: 'serverless' builds.

The alternative they propose is to use the env build-time config option.

This would mean the way next-prefixed reads the assetPrefix would change to process.env.assetPrefix for this config:

{
  "env": {
    "assetPrefix": "/foo",
  }
}

I'm pretty sure that the process.env.assetPrefix is replaced with the actual value during next's webpack build, so it should work seamlessly for all build targets (on both client + server). But this feels wrong in some way that I can't quite explain.

@hipstersmoothie Thoughts on making this change?