npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ryanhefner/next-prismic

v0.1.3

Published

Compose Prismic queries into your Next.js projects.

Downloads

5

Readme

next-prismic

npm NPM npm

React library for integrating @ryanhefner/react-prismic into the server-side rendering of your Next.js app.

Install

Via npm

npm install --save @ryanhefner/next-prismic

Via Yarn

yarn add @ryanhefner/next-prismic

How to use

To use next-prismic, just set the parameters that will be used by the PrismicClient from @ryanhefner/react-prismic and wraps your Next.js app in a PrismicProvider and handles initiating both the PrismicClient for both SSR/requests and the browser client.

Any PrismicQuery instance that appear in your React tree will be queued and requested server-side and included in the initial state to make reduce the requests being made by the client and results in your Next/React app rendering faster client-side.

Here’s an example of how it is used:

import App, { Container } from 'next/app';
import React from 'react';
import { withPrismic } from 'next-prismic';

// Prismic config properties
// This is name that is before `.prismic.io` when you are looking at your repo
// in Prismic. (ex. `your-repo.prismic.io`, the `repo` would be `your-repo`)
const repo = '[PRISMIC REPO PREFIX]';

class MyApp extends App {
  static async getInitialProps({ Component, ctx, router }) {
    let pageProps = {};

    if (Component.getInitialProps) {
      pageProps = await Component.getInitialProps({ ctx });
    }

    return { pageProps };
  }

  render() {
    const {
      Component,
      pageProps,
      store,
    } = this.props;

    return (
      <Container>
        <Component {...pageProps} />
      </Container>
    );
  }
}

export default withPrismic({
  repo,
})(MyApp);

withPrismic

Higher-order component that takes the options provided, wraps your app within a PrimicProvider (from @ryanhefner/react-prismic) and performs the necessary server-side rendering logic to deliver your React app with all your Prismic data pre-requested/compiled into it.

Options

  • repo: string - The name of the Prismic repo you plan on querying.

This is name that is before .prismic.io when you are looking at your repo in Prismic.

repo should be good for 94.6% of instances when using this class. If you want to get fancy, the following props are also available for you.

  • api: PrismicApi - If you’re already initialzing an instance of the Prismic API outside of the PrismicProvider, you can pass that in to keep using that same one.

If you have a reason to override the Prismic API witth your own logic, like hitting your own custom endpoint, it should be assumed that your instance of the Prismic API matches the interface of the original.

  • client: PrismicClient - Client that will be used to make requests against Prismic.

  • cache: Cache | iterable | string - Cache instance to initialize the client cache with.

License

MIT © Ryan Hefner