Skip to content

Commit ea29151

Browse files
committed
updated: README.md for dialog box docs
1 parent 74ab0e1 commit ea29151

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ To use the Supercode plugin in TinyMCE, simply:
3838
3. Make changes to your code as needed, utilizing the features provided by Supercode.
3939
4. Click again on the Supercode Toggle button or press escape or use Ctrl+Space shortcut to switch back to visual editing.
4040

41+
## Using Modal Dialog box
42+
43+
Supercode uses [Custom View](https://www.tiny.cloud/docs/tinymce/latest/custom-view/) to view source code in tinymce editor itself. This Custom View is not supported on older version `<=v5` and in `inline` mode. A modal dialog is used as a fallback in case `Custom Views` is not available or `fallbackModal` is set to `true`.
44+
45+
This modal can be customized using following modal related options like `fallbackModal`, `modalPrimaryColor`, `modalSecondaryColor`, `dark`.
4146

4247
## Using as a Markdown Editor
4348

@@ -109,6 +114,11 @@ Here are all the configurations
109114
| `shortcut` | Specifies whether (Ctrl+Space) keyboard shortcuts are enabled. | Boolean |
110115
| `aceCss` | The custom CSS or CSS fonts to customize the appearance of the code editor. | String |
111116
| `fontFamily` | The font family applied to the code editor. | String |
117+
| `fallbackModal` | Set it to true to explicitly use code editor in modal dialog. Defaults to automatic detection. | String |
118+
| `modalPrimaryColor` | Modal Primary color if using custom tinymce skin editor. | String |
119+
| `modalSecondaryColor` | Modal Secondary color if using custom tinymce skin editor. | String |
120+
| `dark` | Set `true` if your modal primary color is dark to add matching border editor. | String |
121+
| `debug` | Set `false` to disable debug warnings. Default `false` editor. | String |
112122

113123
# Editor Themes
114124

0 commit comments

Comments
 (0)