Skip to content

Repository files navigation

react-revise

Because every app deserves a WYSIWYG.
Message your API through Webhooks whenever you edit your rendered components.

TravisNPMJavaScript Style Guide

Why

How many times have you made an amazing web application only to realize that your clients are going to need ability to change the content?

Or how often do you want to ditch bulky CMSs in favor of single page apps (or PWAs), but find out that implementing a full-fledged CMS in React would take ridiculous amounts of time?

That's why I created react-revise. Simply wrap whatever component you want to be able to edit in WYSIWYG-efficiency with an <EditorHook> and specify the hook parameters. A single <StatusPanel> with a desired styled button is also required in order to display the dialog for saving changes (more customizability is planned).

<EditorHookeditable={true}hook='PUT /api/blog/hello-world'jsonKey='title'><h1>Hello, World!</h1></EditorHook><StatusPanelsaveButton={ButtonComponent}/>

The editable property should be set to according to authentication status.

Install

npm install --save react-revise

Example Usage

importReactfrom'react'import{EditorHook}from'react-revise'import{StatusPanel}from'react-revise'importstyledfrom'styled-components'constMyButton=styled.button` font-size: 1rem; padding: 0.25rem 0.5rem; background: rgba(0, 0, 0, 0); outline: none; border: 1px solid #000;`classAppextendsReact.Component{state={editable: false}render(){return(<div><inputid="checkbox"type="checkbox"onChange={(e)=>this.setState({editable: e.target.checked})}/><labelfor="checkbox"> edit</label><EditorHookeditable={this.state.editable}hook='POST /api/blog/hello-world'jsonKey='title'><h1>Hello, World!</h1></EditorHook><EditorHookeditable={this.state.editable}hook='PUT /api/blog/hello-world'jsonKey='body'><p>
Tempor mollit dolore culpa occaecat labore voluptate Lorem esse. Reprehenderit esse mollit ullamco ullamco fugiat consequat nulla nostrud. Nisi dolore veniam proident ea eiusmod mollit excepteur. Laborum esse minim est proident ex velit ut eu culpa.
</p></EditorHook><StatusPanelsaveButton={MyButton}/></div>)}}exportdefaultApp

License

MIT © Daniel Pendergast

About

Because every app deserves a WYSIWYG.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages