https://github.com/dcwither/react-editable
Decorator for maintaining editing state of React components
https://github.com/dcwither/react-editable
decorators form higher-order-component package react render-props state-management
Last synced: about 1 year ago
JSON representation
Decorator for maintaining editing state of React components
- Host: GitHub
- URL: https://github.com/dcwither/react-editable
- Owner: dcwither
- License: mit
- Created: 2017-10-15T19:42:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-25T01:03:38.000Z (over 3 years ago)
- Last Synced: 2025-03-17T22:06:59.329Z (over 1 year ago)
- Topics: decorators, form, higher-order-component, package, react, render-props, state-management
- Language: TypeScript
- Homepage: https://dcwither.github.io/react-editable
- Size: 8.53 MB
- Stars: 5
- Watchers: 0
- Forks: 1
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Editable
[](https://david-dm.org/dcwither/react-editable)
[](https://codecov.io/gh/dcwither/react-editable)
[](https://dependabot.com)
A component that wraps around a form component to provide an editing state that it maintains. Works with promises returned by the Editable methods.
React Editable can accept anything as its value, making it a generic wrapper for any controlled component that needs a temporary editing state.
## Why Use It?
React Editable factors out the concerns of temporary state and whether to maintain it in a global store like Redux, or in your own component. It passes through its current state so you can render your component differently depending on whether it's inactive, editing, or waiting on a promise.
## Demo & Examples
Live demo: https://dcwither.github.io/react-editable/
```
npm install
npm start
```
Then open [`localhost:6006`](http://localhost:6006) in a browser
## Usage
```js
import React from "react";
import { Editable, useEditableContext } from "@dcwither/react-editable";
function Input() {
const { value, onCommit, onChange, status } = useEditableContext();
handleCommit = () => {
onCommit("SUBMIT");
};
handleChange = evt => {
onChange(evt.target.value);
};
return (
Submit
);
}
// Either wrap in the Editable Component with render props
;
// Or control the flow of your editable props directly with:
const { value, onChange, onCommit } = useEditable({
value,
onChange,
onCommit
});
```
## State Transitions
## Arguments
### `Editable`, `useEditable`
| Property | Type | Required | Description |
| ---------- | --------------------- | -------- | ------------------------------------------------------------- |
| `onCancel` | func(value) | No | Callback for when editing is canceled |
| `onCommit` | func(message, value) | No | Callback for commit changes |
| `value` | child.propTypes.value | No | Unedited value to be passed through to child while presenting |
### `useEditableContext`, `EditableContextConsumer`
**None**
## return value
### `Editable`
**None**
### `useEditable`, `useEditableContext`, `EditableContextConsumer`
| Property | Type | Description |
| ---------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `onStart` | func | Callback that triggers start of editing |
| `onCancel` | func | Callback that triggers cancel editing and clears edited value |
| `onChange` | func(nextValue) | Callback that triggers change in edited value |
| `onCommit` | func(message) | Callback that triggers a commit |
| `status` | 'PRESENTING', 'EDITING', or 'COMMITTING' | Current status of ReactEditable |
| `value` | any | The value passed into Editable if `PRESENTING` or the edited value if `EDITING` or `COMMITING` |
## Commit Event Handler (`onCommit`)
This will be called when the matching callback passed through to the render prop child is called. If it returns a promise, ReactEditable will remain in a `COMITTING` state until the promise resolves. If ReactEditable unmounts before the promise resolves, it will cancel its promise, and avoid a setState.