# wp-story-slider

> A horizontal slider displaying posts (with featured images and excerpts) from a WordPress REST endpoint.

Latest version **1.0.6** (published 2018-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install wp-story-slider
pnpm add wp-story-slider
yarn add wp-story-slider
bun add wp-story-slider
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2018-03-19 |
| First published | 2018-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | John Watkins |
| Maintainers | johnwatkins0 |

## Links

- npm: https://www.npmjs.com/package/wp-story-slider
- Repository: https://github.com/ColbyCommunications/wp-story-slider
- Homepage: https://github.com/ColbyCommunications/wp-story-slider#readme
- Issues: https://github.com/ColbyCommunications/wp-story-slider/issues
- npm.io page: https://npm.io/package/wp-story-slider

## Dependencies (5)

- [react](https://npm.io/package/react.md) ^16.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.2.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [react-slick](https://npm.io/package/react-slick.md) ^0.18.1
- [styled-components](https://npm.io/package/styled-components.md) ^2.4.0

## Recent versions

- 1.0.6 (latest) — 2018-03-19
- 1.0.5 — 2018-03-08
- 1.0.4 — 2018-03-08
- 1.0.3 — 2018-03-08
- 1.0.2 — 2018-02-21
- 1.0.1 — 2018-02-21

## README

# wp-story-slider

A horizontal slider displaying posts (with featured images and excerpts) from a WordPress REST endpoint. Includes a shortcode.

[Demo](https://colbycommunications.github.io/wp-story-slider/demo/).

## Install

```
npm install wp-story-slider
```

Or:

```
yarn add wp-story-slider
```

### WordPress shortcode

Installing through NPM does not make the WordPress shortcode available. The shortcode requires installation through Composer with `composer require colbycomms/wp-story-slider`. Alternatively, clone this repository into your WordPress plugins directory and activate it through the WP admin.

If this package is installed by either of these means, its compiled Javascript file will load automatically and will hook into the shortcode output. The script can be dequeued -- e.g., if you're using this package as an ES6 module -- with the `colbycomms__story_slider__enqueue_script` WordPress filter. Simply provide a callback to that filter returning `false`, e.g.:

```PHP
add_filter( 'colbycomms__story_slider__enqueue_script', function() {
  return false;
} );
```

## Usage

### In Javascript

#### Example

```Javascript
import React from 'react';
import ReactDOM from 'react-dom';
import StorySlider from 'wp-story-slider'

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

ReactDOM.render(<StorySlider postsEndpoint={postsEndpoint} mediaEndpoint={mediaEndpoint} />, myElement);
```

#### Props

##### `postsEndpoint` {string} **required**

A WordPress REST endpoint to query the most recent posts from. Custom endpoints need to handle the `per_page` REST parameter.

##### `mediaEndpoint` {string} **default = null**

A WordPress media endpoint. If the prop is not set, no media will be shown. Custom endpoints need to support the `include` and `per_page` REST parameters.

##### `totalPosts` {string|number} **default = 10**

The number of posts to request.

##### `mediaSize` {string} **default = large**

The WordPress image size to use.

##### `mediaBackupSize` {string} **default = medium**

The image size to use if a request file doesn't have `mediaSize`. If the image has neither the `mediaSize` nor the `mediaBackupSize`, it will not show.

##### `sliderSettings` {object}

Settings to pass to the underlying [`react-slick`](https://github.com/akiran/react-slick) component. See that package's documentation for options. The defaults used here are:

```Javascript
{
  dots: false,
  speed: 500,
  infinite: false,
  autoplay: false,
  arrows: true,
  nextArrow: <NextArrow />,
  prevArrow: <PrevArrow />,
  accessibility: true,
  slidesToShow: 3,
  slidesToScroll: 3,
  responsive: [
    { breakpoint: 767, settings: { slidesToScroll: 1, slidesToShow: 1 } },
    { breakpoint: 991, settings: { slidesToScroll: 2, slidesToShow: 2 } },
  ],
}
```

### WordPress shortcode

The WordPress shortcode is `story-slider`. Example:

```HTML
[story-slider posts-endpoint="http://my-site.com/wp-json/wp/v2/posts/" media-endpoint="http://my-site.com/wp-json/wp/v2/media/"]
```

#### Shortcode attributes

##### `posts-endpoint` (required)

The REST endpoint to retreive posts from.

##### `media-endpoint`

The REST endpoint to retreive media from.

---
_Source: https://npm.io/package/wp-story-slider · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
