scrivito-swipeable/README.md

A swipeable header React component/Scrivito widget for the Scrivito CMS.

# Scrivito Swipeable Header
[![CMS: Scrivito](https://img.shields.io/badge/CMS-Scrivito-brightgreen.svg)](https://scrivito.com) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

A swipeable header React component/Scrivito widget for the Scrivito CMS.

## Screenshot

![Screenshot](https://raw.githubusercontent.com/mdwp/scrivito-swipeable/master/swipeable-screenshot.png)

## Installation

Open your terminal.

`$ cd` to your Scrivito project

```shell
$ npm install scrivito-swipeable
```

Import the widget in your javascript `src/Widgets/index.js`.

Add this line to your index.js:

```js
import "scrivito-swipeable";
```

## Features
Renders a swipable slider.

## Widget properties

In the widget properties you can set:
- Image
  - Title
  - Text

or
- Video