react-editables

0.0.1 • Public • Published

react-editables

React-editables is a react component that makes it easy to edit different types of content (Text, Numbers for now).  Use-cases are collaborative apps where users may edit the content, in a controlled way.

NUMBER edition demo: Alt text

TEXT edition demo: Alt text

Installation

npm install react-editables --save-dev

Usage

Import the components you want to use in your app:

import { EditableText, EditableNumber } from 'react-editables'

Editable text

<EditableText value='some value here' placeholder='Write a description' />

Editable numbers

<EditableNumber value={777} onChange={(value) => console.log(value)} />

Common props

Optional

  • value: initial displayed value.
  • validate: a validator function, returning a boolean.
  • placeholder: a default text or number when there is not value.

Hooks

  • onChange: a callback function that will be called after user finish editing.

Contributing

Submit a PR.

Tests

Tests are written with Jest and Enzyme. Run them with:

npm test

To-do

  • Expose customization (styles)
  • EditableLink element
  • EditableTags element
  • Add more tests
  • More content types :)

/react-editables/

    Package Sidebar

    Install

    npm i react-editables

    Weekly Downloads

    5

    Version

    0.0.1

    License

    MIT

    Last publish

    Collaborators

    • niwa