pkp#10444 Update documentation for Modal classes

blesildaramirez · Oct 21, 2024 · c16d971 · c16d971
1 parent a9001b2
commit c16d971
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/classes/form/FormBuilderVocabulary.php b/classes/form/FormBuilderVocabulary.php
@@ -41,7 +41,7 @@
  *   hideCancel (optional): Whether the submit button should be disabled
  *   cancelAction (optional): A LinkAction object to execute when cancel is clicked
  *   cancelUrl (optional): URL to redirect to when cancel is clicked
- *   modalStyle (optional): The modal state/style that should be used. (default is 'default')
+ *   modalStyle (optional): The modal state/style that should be used. (default is 'basic')
  * Form elements are created with {fbvElement type="type"} plus any additional parameters.
  * Each specific element type may have other additional attributes (see their method comments)
  *  Parameters:

diff --git a/classes/linkAction/request/AjaxModal.php b/classes/linkAction/request/AjaxModal.php
@@ -25,7 +25,7 @@ class AjaxModal extends Modal
      *
      * @param string $url The URL of the AJAX resource to load into the modal.
      * @param string $title (optional) The localized modal title.
-     * @param string $modalStyle (optional) The modal state/style to be used.
+     * @param string $modalStyle (optional) The modal state/style to be used. (default is 'basic')
      * @param bool $canClose (optional) Whether the modal will have a close button.
      * @param string $closeOnFormSuccessId (optional) Close the modal when the
      *  form with this id fires a formSuccess event.

diff --git a/classes/linkAction/request/ConfirmationModal.php b/classes/linkAction/request/ConfirmationModal.php
@@ -41,7 +41,7 @@ class ConfirmationModal extends Modal
      * @param string $dialogText The localized text to appear
      *  in the dialog modal.
      * @param string $title (optional) The localized modal title.
-     * @param string $modalStyle (optional) The modal state/style to be used.
+     * @param string $modalStyle (optional) The modal state/style to be used. (default is 'basic')
      * @param string $okButton (optional) The localized text to
      *  appear on the confirmation button.
      * @param string $cancelButton (optional) The localized text to

diff --git a/classes/linkAction/request/JsEventConfirmationModal.php b/classes/linkAction/request/JsEventConfirmationModal.php
@@ -33,7 +33,7 @@ class JsEventConfirmationModal extends ConfirmationModal
      * @param string $event the name of the JS event.
      * @param array $extraArguments (optional) extra information to be passed as JSON data with the event.
      * @param string $title (optional) The localized modal title.
-     * @param string $modalStyle (optional) The modal state/style to be used.
+     * @param string $modalStyle (optional) The modal state/style to be used. (default is 'basic')
      * @param string $okButton (optional) The localized text to
      *  appear on the confirmation button.
      * @param string $cancelButton (optional) The localized text to

diff --git a/classes/linkAction/request/Modal.php b/classes/linkAction/request/Modal.php
@@ -43,7 +43,7 @@ class Modal extends LinkActionRequest
      * Constructor
      *
      * @param string $title (optional) The localized modal title.
-     * @param string $modalStyle (optional) The modal state/style to be used.
+     * @param string $modalStyle (optional) The modal state/style to be used. (default is 'basic')
      * @param bool $canClose (optional) Whether the modal will have a close button.
      * @param string $closeOnFormSuccessId (optional) Close the modal when the
      *  form with this id fires a formSuccess event.

diff --git a/classes/linkAction/request/RedirectConfirmationModal.php b/classes/linkAction/request/RedirectConfirmationModal.php
@@ -28,7 +28,7 @@ class RedirectConfirmationModal extends ConfirmationModal
      * @param string $title (optional) The localized modal title.
      * @param string $remoteUrl (optional) A URL to be
      *  redirected to when the confirmation button is clicked.
-     * @param string $modalStyle (optional) The modal state/style to be used.
+     * @param string $modalStyle (optional) The modal state/style to be used. (default is 'basic')
      * @param string $okButton (optional) The localized text to
      *  appear on the confirmation button.
      * @param string $cancelButton (optional) The localized text to

diff --git a/classes/linkAction/request/RemoteActionConfirmationModal.php b/classes/linkAction/request/RemoteActionConfirmationModal.php
@@ -32,8 +32,7 @@ class RemoteActionConfirmationModal extends ConfirmationModal
      * @param string $title (optional) The localized modal title.
      * @param string $remoteAction (optional) A URL to be
      *  called when the confirmation button is clicked.
-     * @param string $modalStyle (optional) The modal state/style to be used.
-     *  in the modal title bar.
+     * @param string $modalStyle (optional) The modal state/style to be used. (default is 'basic')
      * @param string $okButton (optional) The localized text to
      *  appear on the confirmation button.
      * @param string $cancelButton (optional) The localized text to

diff --git a/templates/linkAction/buttonConfirmationLinkAction.tpl b/templates/linkAction/buttonConfirmationLinkAction.tpl
@@ -12,6 +12,7 @@
  *  buttonSelector: A jQuery selector that designates the button to attach this
  *   link action to.
  *  dialogText: A translation key for the message to be displayed in the dialog.
+ *  modalStyle: The modal state/style that should be used. (default is 'basic')
  *}
 {if !$modalStyle}{assign var="modalStyle" value="basic"}{/if}
 <script>