# @jswork/react-inline-edit

> Inline editing for react.

Latest version **1.0.5** (published 2021-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jswork/react-inline-edit
pnpm add @jswork/react-inline-edit
yarn add @jswork/react-inline-edit
bun add @jswork/react-inline-edit
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-12-20 |
| First published | 2021-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | afeiship |
| Keywords | react, inline, edit, editing |

## Links

- npm: https://www.npmjs.com/package/@jswork/react-inline-edit
- Repository: https://github.com/afeiship/react-inline-edit
- Homepage: https://js.work
- Issues: https://github.com/afeiship/react-inline-edit/issues
- npm.io page: https://npm.io/package/@jswork/react-inline-edit

## Dependencies (3)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [@jswork/noop](https://npm.io/package/@jswork/noop.md) ^1.0.0
- [react-input-autosize](https://npm.io/package/react-input-autosize.md) ^3.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2021-12-20
- 1.0.4 — 2021-12-20
- 1.0.3 — 2021-12-20
- 1.0.2 — 2021-12-20
- 1.0.1 — 2021-12-20
- 1.0.0 — 2021-12-20

## README

# react-inline-edit
> Inline editing for react.

[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]

## installation
```shell
npm install -S @jswork/react-inline-edit
```

## usage
1. import css
  ```scss
  @import "~@jswork/react-inline-edit/dist/style.css";

  // or use sass
  @import "~@jswork/react-inline-edit/dist/style.scss";

  // customize your styles:
  $react-inline-edit-options: ()
  ```
2. import js
  ```js
  import React, { useState, useEffect } from 'react';
  import ReactInlineEdit from '@jswork/react-inline-edit';
  import styled from 'styled-components';
  import '../../src/components/style.scss';

  const Container = styled.div`
    width: 80%;
    margin: 30px auto 0;
  `;

  export default () => {
    const [value, setValue] = useState('Hello inline edit');

    useEffect(() => {
      console.log('value changed:', value);
    }, [value]);

    return (
      <Container>
        <ReactInlineEdit value={value} onChange={(e) => setValue(e.target.value)} />
      </Container>
    );
  };

  ```

## preview
- https://afeiship.github.io/react-inline-edit/

## license
Code released under [the MIT license](https://github.com/afeiship/react-inline-edit/blob/master/LICENSE.txt).

[version-image]: https://img.shields.io/npm/v/@jswork/react-inline-edit
[version-url]: https://npmjs.org/package/@jswork/react-inline-edit

[license-image]: https://img.shields.io/npm/l/@jswork/react-inline-edit
[license-url]: https://github.com/afeiship/react-inline-edit/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/react-inline-edit
[size-url]: https://github.com/afeiship/react-inline-edit/blob/master/dist/react-inline-edit.min.js

[download-image]: https://img.shields.io/npm/dm/@jswork/react-inline-edit
[download-url]: https://www.npmjs.com/package/@jswork/react-inline-edit

---
_Source: https://npm.io/package/@jswork/react-inline-edit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._