diff --git a/CHANGELOG.md b/CHANGELOG.md index d71263e2d..8445a209a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ # Change Log +- docs api: the editorConfig.customization.submitForm parameter can now be used as an object - docs api: the editorConfig.customization.compactToolbar parameter is now available for the viewer - docs api: added the editorConfig.customization.pointerMode parameter - docs api: updated the WOPI section diff --git a/site/assets/images/editor/submitForm-message.png b/site/assets/images/editor/submitForm-message.png new file mode 100644 index 000000000..589e27bce Binary files /dev/null and b/site/assets/images/editor/submitForm-message.png differ diff --git a/site/pages/Docs/Docs API/More Information/Changelog/index.md b/site/pages/Docs/Docs API/More Information/Changelog/index.md index d2b0a146d..8dc9a8fa6 100644 --- a/site/pages/Docs/Docs API/More Information/Changelog/index.md +++ b/site/pages/Docs/Docs API/More Information/Changelog/index.md @@ -2,8 +2,8 @@ The list of changes of ONLYOFFICE Docs API. ## Version 8.3 +- The [editorConfig.customization.submitForm](../../Usage%20API/Config/Editor/Customization/index.md#submitform) parameter can now be used as an object. - The [editorConfig.customization.compactToolbar](../../Usage%20API/Config/Editor/Customization/index.md#compacttoolbar) parameter is now available for the viewer. - - Added the [editorConfig.customization.pointerMode](../../Usage%20API/Config/Editor/Customization/index.md#pointermode) parameter. ## Version 8.2 diff --git a/site/pages/Docs/Docs API/Usage API/Advanced parameters/index.md b/site/pages/Docs/Docs API/Usage API/Advanced parameters/index.md index 5fd3a7b09..55bd6b607 100644 --- a/site/pages/Docs/Docs API/Usage API/Advanced parameters/index.md +++ b/site/pages/Docs/Docs API/Usage API/Advanced parameters/index.md @@ -206,7 +206,10 @@ const config = { trackChanges: true, hoverMode: false, }, - submitForm: true, + submitForm: { + visible: true, + resultMessage: "text", + }, toolbarHideFileName: false, uiTheme: "theme-dark", unit: "cm", diff --git a/site/pages/Docs/Docs API/Usage API/Config/Editor/Customization/index.md b/site/pages/Docs/Docs API/Usage API/Config/Editor/Customization/index.md index 3936a0ca6..f7337b400 100644 --- a/site/pages/Docs/Docs API/Usage API/Config/Editor/Customization/index.md +++ b/site/pages/Docs/Docs API/Usage API/Config/Editor/Customization/index.md @@ -1306,13 +1306,34 @@ Example: true ## submitForm -Defines if the **Complete & Submit** button is displayed or hidden on the top toolbar. Button will only be available for the *pdf* format. The default value is **false**. +Starting from version 8.3, defines the **Complete & Submit** button settings. If this parameter is a boolean value, then it specifies whether the **Complete & Submit** button will be displayed or hidden on the top toolbar. Button will only be available for the *pdf* format. The default value is **true**. -Type: boolean +Type: object or boolean Example: true ![Submit button](/assets/images/editor/submitForm.png) +![Submit button](/assets/images/editor/submitForm-message.png) + +### submitForm.visible + +Defines whether the **Complete & Submit** button will be displayed or hidden on the top toolbar. Button will only be available for the *pdf* format. The default value is **true**. + +Type: boolean + +Example: true + +### submitForm.resultMessage + +Defines a message displayed after forms are submitted. The following values are available: + +- **""** - the message will not be displayed; +- **null / undefined** - the default message will be displayed; +- **"text"** - any text that the user specifies will be displayed. + +Type: string + +Example: "text" ## toolbar @@ -1531,7 +1552,10 @@ const docEditor = new DocsAPI.DocEditor("placeholder", { trackChanges: true, hoverMode: false, }, - submitForm: true, + submitForm: { + visible: true, + resultMessage: "text", + }, toolbarHideFileName: false, uiTheme: "theme-dark", unit: "cm",