Skip to content

Commit 6460cd4

Browse files
committed
docs: update docs
1 parent 054637a commit 6460cd4

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,22 @@ export default App
5151

5252
> All props are optional, that's how you can **fully customize** it!
5353
54-
| Name | Optional | Type | Description |
55-
| ------------------------ | -------- | ------------------- | --------------------------------------------------------------------- |
56-
| containerClassName | ✔️ | `string` | Custom classes for the wrapper div |
57-
| contentEditableClassName | ✔️ | `string` | Custom classes for the input element |
58-
| placeholderClassName | ✔️ | `string` | Custom classes for the placeholder text |
59-
| placeholder | ✔️ | `string` | Input placeholder text |
60-
| disabled | ✔️ | `boolean` | Flag that disables the input element |
61-
| updatedContent | ✔️ | `string` | Text injected from parent element into the input as the current value |
62-
| onContentExternalUpdate | ✔️ | `(content) => void` | Method that emits the injected content by the `updatedContent` prop |
63-
| onChange | ✔️ | `(content) => void` | Method that emits the current content as a string |
64-
| onKeyUp | ✔️ | `(e) => void` | Method that emits the keyUp keyboard event |
65-
| onKeyDown | ✔️ | `(e) => void` | Method that emits the keyDown keyboard event |
66-
| onFocus | ✔️ | `(e) => void` | Method that emits the focus event |
67-
| onBlur | ✔️ | `(e) => void` | Method that emits the blur event |
54+
| Name | Optional | Type | Description |
55+
| ------------------------ | -------- | ------------------- | --------------------------------------------------------------------------- |
56+
| containerClassName | ✔️ | `string` | Custom classes for the wrapper div |
57+
| contentEditableClassName | ✔️ | `string` | Custom classes for the input element |
58+
| placeholderClassName | ✔️ | `string` | Custom classes for the placeholder text |
59+
| charsCounterClassName | ✔️ | `string` | Custom classes for the character counter text (if `maxLength` is specified) |
60+
| placeholder | ✔️ | `string` | Input placeholder text |
61+
| disabled | ✔️ | `boolean` | Flag that disables the input element |
62+
| maxLength | ✔️ | `number` | Indicates the maximum number of characters a user can enter |
63+
| updatedContent | ✔️ | `string` | Text injected from parent element into the input as the current value |
64+
| onContentExternalUpdate | ✔️ | `(content) => void` | Method that emits the injected content by the `updatedContent` prop |
65+
| onChange | ✔️ | `(content) => void` | Method that emits the current content as a string |
66+
| onKeyUp | ✔️ | `(e) => void` | Method that emits the keyUp keyboard event |
67+
| onKeyDown | ✔️ | `(e) => void` | Method that emits the keyDown keyboard event |
68+
| onFocus | ✔️ | `(e) => void` | Method that emits the focus event |
69+
| onBlur | ✔️ | `(e) => void` | Method that emits the blur event |
6870

6971
## Contribution
7072

0 commit comments

Comments
 (0)