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

@micyo/react-wp-query

v1.3.0

Published

WordPress REST API React implementations

Downloads

290

Readme

@micyo/react-wp-query

With the @micyo/react-wp-query library, you can develop web pages and applications within a few hours using the WordPress REST API. Thanks to the existing hooks and helper components in the library, you can easily make your customizations. All that’s left for you is to apply styling to your web page.

Project Objective

  • Enhancing code readability by making WordPress REST API calls using the React Hook method
  • Quickly creating interface elements by combining helper components

Installation

The package can be installed via npm

npm install @micyo/react-wp-query --save

or via yarn

yarn add @micyo/react-wp-query

Configuration

Wrap your project with the WPProvider component and pass the WordPress REST API URL you want to connect to as the api prop to the component. With the clickEvent prop, you can handle virtual routing for post meta clicks. You can adjust the date format for all date components on the pages using the formatDate prop. The links are set up in this way to allow you to work with any react framework or library you prefer.

import { useCallback } from 'react';
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { WPProvider } from '@micyo/react-wp-query';

const queryClient = new QueryClient();

const App = ({ children }) => {
  const clickEvent = useCallback(({ event, values, type }) => {
    event.preventDefault();
    //
    if (type === 'author') {
      // redirect author page with **values** arguments
    }
  }, []);

  const formatDate = useCallback((date) => {
    // format your date here
    return date;
  }, []);

  return (
    <WPProvider
      api="https://wordpress.org/news/wp-json/"
      clickEvent={clickEvent}
      formatDate={formatDate}>
      <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
    </WPProvider>
  );
};

export default App;

Using Axios for Requests (Custom Fetch Handler)

The example below uses a custom fetch handler for making all the requests with axios.

import apiFetch from '@wordpress/api-fetch';
import axios from 'axios';

apiFetch.setFetchHandler( ( options ) => {
	const { url, path, data, method } = options;

	return axios( {
		url: url || path,
		method,
		data,
	} );
} );

Hooks

Get posts with usePosts Hook

import { usePosts, Post, Title, Meta, Excerpt } from '@micyo/react-wp-query';

const LatestNews = () => {
  const [page, setPage] = React.useState(1);
  const { posts, pagination } = usePosts({
    queryArgs: {
      page
    }
  });

  return posts?.isLoading ? (
    <>Loading...</>
  ) : (
    <>
      {Array.isArray(posts?.data) &&
        posts?.data?.map((post) => (
          <Post key={`posts-${post.id}`} post={post}>
            <Title />
            <Meta />
            <Excerpt />
          </Post>
        ))}

      <button onClick={() => setPage((p) => p - 1)} disabled={!pagination.hasPrev}>
        Prev Page
      </button>
      <button onClick={() => setPage((p) => p + 1)} disabled={!pagination.hasNext}>
        Next Page
      </button>
    </>
  );
};

export default LatestNews;

License

Copyright (c) 2024 themesama and individual contributors. Licensed under MIT license, see LICENSE for the full license.