Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing props of RichTextEditor in README #119

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing props of RichTextEditor in README #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,43 @@ The editor component. Simply place this component in your view hierarchy to rece
* `initialTitleHTML`

HTML that will be rendered in the title section as soon as the component loads.

* `initialContentHTML`

HTML that will be rendered in the content section on load.

* `titlePlaceholder`

Text that will be used as a placeholder when no text is present in the title section.
* `contentPlaceholder `

* `contentPlaceholder`

Text that will be used as a placeholder when no text is present in the content section.
* `customCSS `

Any custom CSS styles that you want to inject to the editor.
* `editorInitializedCallback `
* `editorInitializedCallback`

A function that will be called when the editor has been initialized.

* `customCSS`

Any custom CSS styles that you want to inject to the editor.

* `hiddenTitle`

Whether the title should be displayed.

* `enableOnChange`

Enable the `CONTENT_CHANGE` event.

* `footerHeight`

Height of the footer.

* `contentInset`

Object representing your content inset.


`RichTextEditor` also has methods that can be used on its `ref` to set styling at the current selection or cursor position:

Expand Down