Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ozanyurtsever committed Jul 5, 2022
1 parent 21247d4 commit 19a8559
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import {
TextColorPicker,
TextFormatDropdown,
UnderlineButton,
Divider
Divider,
} from 'verbum';

const NoteViewer: FC = () => {
Expand Down Expand Up @@ -83,14 +83,16 @@ Coming soon... -->

`<Editor />`

| Property | Type | | description |
| --------------- | ----------- | -------- | ---------------------------------------------------------------------------------- |
| children | `ReactNode` | optional | Nested child components, like the `ToolbarPlugin` |
| hashtagsEnabled | `boolean` | optional | Enables the automatic hashtag highlighting, default is `false` |
| autoLinkEnabled | `boolean` | optional | Enables the automatic link highlighting, default is `false` |
| emojisEnabled | `boolean` | optional | Replaces the emoji combiniations with its corresponding symbol, default is `false` |
| placeholder | `string` | optional | The default content of the editor when it is first loaded |
| listMaxIndent | `number` | optional | The maximum indent capacity of any listed element, the default is `7` |
| Property | Type | | description |
| ------------------ | --------------- | -------- | ---------------------------------------------------------------------------------- |
| children | `ReactNode` | optional | Nested child components, like the `ToolbarPlugin` |
| hashtagsEnabled | `boolean` | optional | Enables the automatic hashtag highlighting, default is `false` |
| autoLinkEnabled | `boolean` | optional | Enables the automatic link highlighting, default is `false` |
| emojisEnabled | `boolean` | optional | Replaces the emoji combiniations with its corresponding symbol, default is `false` |
| placeholder | `string` | optional | The default content of the editor when it is first loaded |
| listMaxIndent | `number` | optional | The maximum indent capacity of any listed element, the default is `7` |
| initialEditorState | `string` | optional | JSON string to initialize the initial content of the editor. |
| onChange | (state) => void | optional | Accessing the current editor state |

<br />

Expand Down

0 comments on commit 19a8559

Please sign in to comment.