Skip to content

Commit 050d491

Browse files
committed
docs: update README.md
1 parent 91b8a7a commit 050d491

1 file changed

Lines changed: 3 additions & 9 deletions

File tree

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,11 @@ or yarn
1818
yarn add react-basic-contenteditable
1919
```
2020

21-
<br>
22-
2321
## Usage
2422

2523
Live **demo** at: [https://chrisuser.github.io/react-basic-contenteditable/](https://chrisuser.github.io/react-basic-contenteditable/)
2624

27-
## Example
25+
### Example
2826

2927
```javascript
3028
import ContentEditable from "react-basic-contenteditable"
@@ -49,7 +47,7 @@ const App = () => {
4947
export default App
5048
```
5149

52-
## Props
50+
### Props
5351

5452
> All props except `onChange` are optional.
5553
@@ -62,21 +60,17 @@ export default App
6260
| disabled | ✔️ | `boolean` | Flag that disables the input element |
6361
| updatedContent | ✔️ | `string` | Text injected from parent element into the input as the current value |
6462
| onContentExternalUpdate | ✔️ | `(content) => void` | Method that emits the injected content by the `updatedContent` prop |
65-
| onChange || `(content) => {}` | Method that emits the current content as a string |
63+
| onChange || `(content) => void` | Method that emits the current content as a string |
6664
| onKeyUp | ✔️ | `(e) => void` | Method that emits the keyUp keyboard event |
6765
| onKeyDown | ✔️ | `(e) => void` | Method that emits the keyDown keyboard event |
6866
| onFocus | ✔️ | `(e) => void` | Method that emits the focus event |
6967
| onBlur | ✔️ | `(e) => void` | Method that emits the blur event |
7068

71-
<br>
72-
7369
## Contribution
7470

7571
If you have a suggestion that would make this component better feel free to fork the project and open a pull request or create an issue for any idea or bug you find.\
7672
Remeber to follow the [Contributing Guidelines](https://github.com/ChrisUser/.github/blob/main/CONTRIBUTING.md).
7773

78-
<br>
79-
8074
## Licence
8175

8276
React Basic Contenteditable is [MIT licensed](https://github.com/ChrisUser/react-basic-contenteditable/blob/master/LICENSE).

0 commit comments

Comments
 (0)