In-Website Preview

When working in the writing room, authors can preview their new content on their website without having to publish the document.

1. Include the Prismic Toolbar javascript file

First you need to include the following scripts on every page of your website. Make sure to update <your-repo-name> with the name of the endpoint for your repository.

Copy
<script>
  window.prismic = {
    endpoint: 'https://<your-repo-name>.prismic.io/api/v2'
  };
</script>
<script type="text/javascript" src="//static.cdn.prismic.io/prismic.min.js"></script>

Note for Sharable Previews

To guarantee that Sharable Previews work properly you must ensure that these scripts are included on every page of your website, including your 404/Page Not Found page. Otherwise the Shareable Preview might not work.

2. Setup a preview environment

In your repository, head to the Settings / Previews. Add a site name and the domain for your website where you wish to preview your content. You can also add an optional Link Resolver route which you will learn more about in the next section.

Note that you can also enter localhost domains such as:

Copy
http://localhost:3000

If you are using our official Prismic javascript development kit (prismic-javascript), then that is all you need to do to gain the basic functionality of the Preview feature! If you are not using this kit to make your queries, then refer to the "Use the correct ref" section below.

With the basic functionality of the Preview feature, when you click on the preview button, you will be taken to the homepage of your preview domain. From here you can navigate to the page you are trying to preview.

Next we will show you how to add a Link Resolver endpoint so that you will be taken directly to the page you are trying to preview.

In order to be taken directly to the page you are previewing instead of the homepage, you need to add a Link Resolver endpoint. A typical example of this would be:

Copy
http://{yoursite}/preview

In your preview settings add this endpoint to the optional Link Resolver field.

Using the official Prismic React.js starter project?

If you are using the official Prismic React.js starter project, then you should already have all the code in place you need for In-website previews. That's as much as you need to do!

If you're not using the official Prismic project, then follow the rest of the steps below.

Now you need to add the Link Resolver endpoint route to your website router.

Copy
import React from 'react';
import {
  BrowserRouter as Router,
  Route,
  Switch,
} from 'react-router-dom';
import Preview from './Preview';
import NotFound from './NotFound';

const App = (props) => (
  <Router>
    <Switch>
      {/* Add the new preview route here */}
      <Route exact path="/preview" render={routeProps => <Preview {...routeProps} />} />
      <Route component={NotFound} />
    </Switch>
  </Router>
);

export default App;

You can see that when the "/preview" route is called, it will use the Preview component. Let's create this component now.

Add the Preview component

The Preview component must do the following:

  • Retrieve the preview token from the token parameter in the query string
  • Call the Prismic development kit with this token and the Link Resolver will retrieve the correct URL for the document being previewed
  • Redirect to the given URL

The Preview Token

Note that the preview token will be a URL. You DO NOT need to follow this url. All you need to do is pass this token into the previewSession method as shown below.

Here is an example of what the Preview component might look like.

Copy
import React from 'react';
import qs from 'qs';
import Prismic from 'prismic-javascript';
import linkResolver from './path/to/the/link-resolver.js';

const apiEndpoint = 'http://your-repo-name.prismic.io/api/v2';

export default class Preview extends React.Component {
  
  componentWillMount() {
    this.preview(this.props);
  }

  preview(props) {
    const params = qs.parse(this.props.location.search.slice(1))
    Prismic.getApi(apiEndpoint)
      .then(api => { api.previewSession(params.token, linkResolver, '/')
      .then(url => {
        props.history.push(url);
      });
    });
  }

  render() {
    return <p>Loading previews...</p>;
  }
}

This requires the use of a Link Resolver function so that the preview endpoint knows where to redirect to. You can learn more about link resolving by checking out the Link Resolving page.

You either need to define the Link Resolver in the Preview component or import it.

4. Use the correct reference

Are you using the prismic-javascript library?

This last step is only required if you are not using the prismic-javascript library to retrieve your API object.

If you are using the Prismic.getApi method to retrieve your API object, then the correct reference will automatically be used and this last step is not necessary. If you are not using this method, then do the following:

When you preview your website, a preview cookie is generated that contains the preview token. This token can be used as a valid ref to make Prismic API queries. For any query you make on your website, make sure to check for the Preview cookie and use this preview ref in the query options if the preview cookie exists.

Here is how to retrieve the correct ref:

Copy
import Cookies from 'js-cookie';
import Prismic from 'prismic-javascript';

const previewRef = Cookies.get(Prismic.previewCookie);
const masterRef = api.refs.find(ref => { return ref.isMasterRef === true }).ref;
const ref = previewRef || masterRef;

Then here is an example that shows how to use this ref in your query:

Copy
	
// Then in your query, specify the ref like this
api.query(
  Prismic.Predicates.at('document.type', 'blog_post'),
  { ref }
).then(function(response) {
  // response is the response object, response.results holds the documents
});

And you're all set!

The preview functionality should now be all set on your project.

It's worth noting that the examples on this page are meant to be as simple as possible for this explanation. There are best practices that you can follow to better organize your project. We suggest exploring our React Starter Project to see how you might better set up your Preview functionality.