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

@hmn/wp-dataprovider

v1.1.0-rc10

Published

Core logic for fetching data from WP api

Downloads

37

Readme

WP API data provider

Core logic for fetching data from WP API.

Includes

  • components - shared components like Providers
  • controllers - "smart" components containing business logic
  • helpers
  • hooks - collection of specific hooks
  • services - includes services for backend communication

Usage

Installation

npm install @hmn/wp-dataprovider --save

Importing

import { DataProviderConfig, ListingController, SingleItemController } from '@hmn/wp-dataprovider'

Setting URL of a WP based page

Make sure to wrap root of your app with DataProviderConfig.

const App = () => {
    return (
        <DataProviderConfig baseUrl="http://example.com/wp-json">
            <div />
        </DataProviderConfig>
    )
}

Example of fetching data for a post

const SinglePost = () => {
    return (
        <SingleItemController resource="posts" id="5238">
            {({ data, ...rest }) =>
                <div item={data} {...rest}>
                    <h3> {item.title.rendered} </h3>
                </div>
            }
        </SingleItemController>
    )
}

Example of fetching data for a listing

const PostsListing = () => {
    const [perPage, setPerPage] = useState('10')
    return (
        <ListingController args={{ perPage }} resource="posts">
            {({ data, ...rest }) => (
                <div>
                    {data.map(item => (
                        <div key={item.id}>
                            <h3> {item.title.rendered} </h3>
                        </div>
                    ))}
                </div>               
            )}
        </ListingController>
    )
}

Example of using with Next.js

const Components = ({ singlePost, ssrPosts }) => {
    return (
        <div>
            <h3> {singlePost.title.rendered} </h3>

            <ListingController resource="posts" args={{ order: 'asc' }}>
                {({ data, ...rest }) => {
                    const posts = data.length ? data : ssrPosts

                return posts.map(item => (
                    <div key={item.id}>
                        <h3> {item.title.rendered} </h3>
                    </div>
                  ))
                }}
            </ListingController>
        </div>
    )
}

Components.getInitialProps = async () => {
    const singlePost = await BackendService.fetch('posts', { id: 5215 })
    const { items } = await BackendService.fetch('posts', {})
    return {
        singlePost,
        ssrPosts: items || [],
        namespacesRequired: ['common']
    }
}
const About = ({ data }) => <h1>{item.title.rendered}</h1>

const ControlledComponent = ({ ssrData, ...props }) => {
    <SingleItemController resource="posts" id="46">
        {({ data = ssrData, ...controllerProps }) => (
            <About data={data} {...props} {...controllerProps} />
        )}
    </SingleItemController>
}

ControlledComponent.getInitialProps = async () => {
    const post = await BackendService.fetch('posts', {id: 5215} )

    return {
        ssrData: post,
        namespacesRequired: [common, navigation]
    }
}

Pagination support

Two ways of pagination are built in: numbered pagination and infinite scroll / load more type.

Using infinite scroll / load more (default)

<ListingController args={{ perPage }} resource="media">
    {({ onLoadMore, ...rest }) => (
        <>
            <div>
                {data.map(item => (
                    <div key={item.id}>
                        <h3> {item.title.rendered} </h3>
                    </div>
                ))}
            </div>
            <br />
            <button type="button" onClick={onLoadMore}>
                Load more
            </button>
        </>
    )}
</ListingController>

Using numeric pagination (add .Pagination)

<ListingController.Pagination
    args={{
        perPage,
        search
    }}
    resource="posts">
    {({ onPrev, onNext, onPage, ...rest }) => (
        <>
            <div>
                {data.map(item => (
                    <div key={item.id}>
                        <h3> {item.title.rendered} </h3>
                    </div>
                ))}
            </div>
            <br />
            <button type="button" onClick={onPrev}>
                Prev
            </button>
            <button type="button" onClick={() => onPage(2)}>
                2
            </button>
            <button type="button" onClick={() => onPage(3)}>
                3
            </button>
            <button type="button" onClick={onNext}>
                Next
            </button>
        </>
    )}
</ListingController.Pagination>

Example of refetching data manually

const PostsListing = () => {
    const [perPage, setPerPage] = useState('10')
    return (
        <ListingController args={{ perPage }} resource="posts">
            {({ data, refetch, ...rest }) => (
                <div>
                    <button onClick={refetch}>Refresh</button>
                    {data.map(item => (
                        <div key={item.id}>
                            <h3> {item.title.rendered} </h3>
                        </div>
                    ))}
                </div>               
            )}
        </ListingController>
    )
}

Currently supported resources (endpoints):

For Custom Post Types set customs like this:

const customs = {
    speakers: 'posts',
    awards: 'posts',
    news: 'posts'
}

BackendService.customTypes = customs

Each package is available from main export. Check index.js for structure.

Develop

For further development of package follow setup:

Clone package.

npm install
npm run watch

Auto builds on each change to /lib folder.

Publishing

Increment version.

npm version <version>
npm run build
npm pack
npm publish