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

wordpress-query-posts

v1.1.2

Published

A component for fetching WordPress post data from the REST API.

Downloads

11

Readme

WordPress Query Posts

This package contains a query component, along with redux state & selectors for posts pulled from a WordPress site. This uses the node-wpapi package to get your site's data via Query Components (inspired by calypso). The Query Components call the API, which via actions set your site's data into the state.

To use any of these helpers, you'll need to set your Site URL in a global (SiteSettings), so that the API knows what site to connect to. For example:

window.SiteSettings = {
	endpoint: 'url.com/path-to-wordpress',
};

As of version 1.1, the URL should not include /wp_jsonwordpress-rest-api-oauth-1 adds that for us.

Query Posts

Query Posts is a React component used in managing the fetching of posts queries, or single posts by the post slug.

Usage

Used to request a single post, or list of posts, based on either a query object, or post slug.

Render the component, passing in the query or a single postSlug. It does not accept any children, nor does it render any elements to the page. You can use it adjacent to other sibling components which make use of the fetched data made available through the global application state.

import React from 'react';
import QueryPosts from 'wordpress-query-posts';
import MyPostsListItem from './list-item';

export default function MyPostsList( { posts } ) {
	return (
		<div>
			<QueryPosts query={ { search: 'Themes' } } />
			{ posts.map( ( post ) => {
				return (
					<MyPostsListItem
						key={ post.id }
						post={ post } />
				);
			} }
		</div>
	);
}

or for a single post:

import React from 'react';
import QueryPosts from 'wordpress-query-posts';
import SinglePost from './single';

export default function MyPostsList( { post } ) {
	return (
		<div>
			<QueryPosts postSlug="local-development-for-wordcamp-websites" />
			<SinglePost post={ post } />
		</div>
	);
}

Props

query

The query to be used in requesting posts.

postSlug

The post slug of the post to request.

Post Selectors

You can import these into your project by grabbing them from the selectors file:

import { getPost, isRequestingPost } from 'wordpress-query-posts/lib/selectors';

getPost( state, globalId )

getPostsForQuery( state, query )

isRequestingPostsForQuery( state, query )

getTotalPagesForQuery( state, query )

isRequestingPost( state, postSlug )

getPostIdFromSlug( state, slug )

Post State

If you need access to the reducers, action types, or action creators, you can import these from the state file. For example, to use this in your global redux state, mix it into your reducer tree like this:

import posts from 'wordpress-query-posts/lib/state';

let reducer = combineReducers( { ...otherReducers, posts } );

If you need to call an action (the query component should take care of this most of the time), you can pull the action out specifically:

import { requestPost } from 'wordpress-query-posts/lib/state';

View the file itself to see what else is available.