Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sokratisvidros/react-pencil

A delicate React component that enables single-line and multi-line in-place edits
https://github.com/sokratisvidros/react-pencil

Last synced: 2 months ago
JSON representation

A delicate React component that enables single-line and multi-line in-place edits

Awesome Lists containing this project

README

        

# React Pencil

A delicate React component that enables single-line and multi-line in-place edits. Single-line edits are performed on HTML input whereas multi-line edits are performed on content editable spans.

![](http://g.recordit.co/vzoEKt6pIc.gif)

React-pencil works on modern browsers such as Chrome, Firefox, Safari and IE 11+.

## Installation

```
$ npm i react-pencil
```

## Features

- Single-line in-place edits
- Multi-line in-place edits
- Autosized fields
- Pencil button suffix
- Placeholders
- Error display
- Fully customizable via pass through props
- OnEditDone callback

## Examples

### Single-line editing

```

```

### Multi-line editing

```

```

### Placeholders

#### Single-line
```

```

#### Multi-line

```

```

### Error display

```

```

### Callbacks

```

```

## Future expansions

- Client side validation
- Support for legacy browsers

## Licence

MIT