# react-displaceable

> React component for displaceable

Latest version **1.0.1** (published 2018-12-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-displaceable
pnpm add react-displaceable
yarn add react-displaceable
bun add react-displaceable
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-12-10 |
| First published | 2018-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tiaan du Plessis |
| Maintainers | tiaanduplessis |

## Links

- npm: https://www.npmjs.com/package/react-displaceable
- Repository: https://github.com/tiaanduplessis/react-displaceable
- npm.io page: https://npm.io/package/react-displaceable

## Dependencies (1)

- [displaceable](https://npm.io/package/displaceable.md) ^0.4.1

## Recent versions

- 1.0.1 (latest) — 2018-12-10
- 1.0.0 — 2018-12-05

## README

# react-displaceable
[![package version](https://img.shields.io/npm/v/react-displaceable.svg?style=flat-square)](https://npmjs.org/package/react-displaceable)
[![package downloads](https://img.shields.io/npm/dm/react-displaceable.svg?style=flat-square)](https://npmjs.org/package/react-displaceable)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![package license](https://img.shields.io/npm/l/react-displaceable.svg?style=flat-square)](https://npmjs.org/package/react-displaceable)
[![make a pull request](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

> React component for [displaceable](https://github.com/dinohamzic/displaceable)

## Table of Contents

- [react-displaceable](#react-displaceable)
  - [Table of Contents](#table-of-contents)
  - [Install](#install)
  - [Usage](#usage)
  - [Contribute](#contribute)
  - [License](#license)

## Install

This project uses [node](https://nodejs.org) and [npm](https://www.npmjs.com). 

```sh
$ npm install react-displaceable
$ # OR
$ yarn add react-displaceable
```

## Usage

```js
import React from "react";
import ReactDOM from "react-dom";
import Displaceable from "react-displaceable";

import "./styles.css";

function App() {
  return (
    <div className="App">
      <Displaceable
        displaceFactor={5}
        // Other options are also supported
        // See: https://github.com/dinohamzic/displaceable#configuration
      >
        <h1>Hello There!</h1>
      </Displaceable>
    </div>
  );
}

const rootElement = document.getElementById("root");
ReactDOM.render(<App />, rootElement);

```

## Contribute

1. Fork it and create your feature branch: `git checkout -b my-new-feature`
2. Commit your changes: `git commit -am "Add some feature"`
3. Push to the branch: `git push origin my-new-feature`
4. Submit a pull request

## License

MIT

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