# perfecttense-editor-instant-load

> React editor with instant grammar corrections using PerfectTense

Latest version **1.3.11** (published 2019-10-22) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install perfecttense-editor-instant-load
pnpm add perfecttense-editor-instant-load
yarn add perfecttense-editor-instant-load
bun add perfecttense-editor-instant-load
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.11 |
| Published | 2019-10-22 |
| First published | 2019-10-22 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 17 |
| Unpacked size | 3.4 MB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | Yining Wang |
| Maintainers | averykatko |

## Links

- npm: https://www.npmjs.com/package/perfecttense-editor-instant-load
- npm.io page: https://npm.io/package/perfecttense-editor-instant-load

## Dependencies (17)

- [rxjs](https://npm.io/package/rxjs.md) ^6.2.1
- [axios](https://npm.io/package/axios.md) ^0.18.0
- [react](https://npm.io/package/react.md) ^16.4.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [core-js](https://npm.io/package/core-js.md) ^2.5.7
- [immutable](https://npm.io/package/immutable.md) ^4.0.0-rc.9
- [react-dom](https://npm.io/package/react-dom.md) ^16.4.1
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [css.escape](https://npm.io/package/css.escape.md) ^1.5.1
- [quill-delta](https://npm.io/package/quill-delta.md) ^3.6.3
- [react-icons](https://npm.io/package/react-icons.md) ^2.2.7
- [@emotion/core](https://npm.io/package/@emotion/core.md) ^10.0.14
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.4.4
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^10.0.14
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^2.1.1
- [react-app-polyfill](https://npm.io/package/react-app-polyfill.md) ^1.0.1
- [resize-observer-polyfill](https://npm.io/package/resize-observer-polyfill.md) ^1.5.0

## Recent versions

- 1.3.11 (latest) — 2019-10-22

## README

# Perfect Tense Live Editor

## Install

```bash
npm install --save perfecttense-editor
OR
yarn add perfecttense-editor
```

##Props

| Prop Name    | Required  | Type | Default
| ------------ |:---------:|:--------|:----
| socketUrl    | false | String | `https://io.perfecttense.com`
| onDraftSave  | false | Function | (uid) => {}
| onLoadingStateChanged | false | Function | (bufferSize) => {}
| onGrammarScoreChanged | false | Function | (grammarScore) => {}

## Usage

```jsx
import React, { Component } from 'react'
import PerfectTenseEditor from 'perfecttense-editor'

class Example extends Component {
  render () {
    return (
      <PerfectTenseEditor />
    )
  }
}
```


## Dev Setup

We have our source code for the editor in `src/`, and there are example components in `examples/` that can be used for development purpose. `parcel` is recommended.

Run the following commands from the `root` of the project.

```bash
# create a symlink of the package that can be used in any local project.
yarn link 

# Install dependencies
yarn install

# Start the bundler with watch mode
yarn start
```

Now, go to `examples/parcel` directory(in another tab) and run the following
```bash

# Install dependencies
yarn install

# Symlink previously built dependency for `example` project
yarn link perfecttense-editor

# Start localhost server on port 1234
yarn start
```

## License

MIT © [Cortx]

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