1.0.5 • Published 6 years ago

wp-react-inline-search v1.0.5

Weekly downloads
5
License
MIT
Repository
github
Last release
6 years ago

wp-react-inline-search

A React component displaying search results from a WordPress REST endpoint.

Demo.

Install

npm install wp-react-inline-search

Or:

yarn add wp-react-inline-search

Usage

Example

import React from 'react';
import ReactDOM from 'react-dom';
import InlineSearch from 'wp-react-inline-search'

const restEndpoint = 'http://my-site.com/wp-json/wp/v2/posts/';
const myElement = document.querySelector('#my-element');

ReactDOM.render(<InlineSearch searchEndpoint={restEndpoint}>, myElement);

Props

searchEndpoint {string} required

A WordPress REST endpoint to provide search results. If using a custom endpoint, it needs to handle search, page, and per_page REST parameters.

perPage {string|number} default = 5

The number of results to display per page.