1.3.11 • Published 6 years ago
perfecttense-editor-instant-load v1.3.11
Perfect Tense Live Editor
Install
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
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.
# 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 startNow, go to examples/parcel directory(in another tab) and run the following
# Install dependencies
yarn install
# Symlink previously built dependency for `example` project
yarn link perfecttense-editor
# Start localhost server on port 1234
yarn startLicense
MIT © Cortx
1.3.11
6 years ago