refactor: add notice about limitations related to the form settings e…

…xtension
impress-org · Apr 12, 2024 · 4959039 · 4959039
1 parent 54df761
commit 4959039
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 49 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/FormExtension/FormBuilder/ViewModels/GiveAddonViewModel.php b/src/FormExtension/FormBuilder/ViewModels/GiveAddonViewModel.php
@@ -44,6 +44,7 @@ public function exports(): array
             'colorSettingsUrl' => esc_url_raw(admin_url('edit.php?post_type=give_forms&page=give-addon-color-settings')),
             'globalOptionsUrl' => esc_url_raw(admin_url('edit.php?post_type=give_forms&page=give-settings&tab=give-addon-global-settings')),
             'sampleTags' => $sampleTags,
+            'previewUrl' => esc_url_raw(admin_url('edit.php?post_type=give_forms&page=givewp-form-builder'))
         ];
     }
 }
diff --git a/src/FormExtension/FormBuilder/resources/js/index.tsx b/src/FormExtension/FormBuilder/resources/js/index.tsx
@@ -21,7 +21,7 @@ const addGiveAddonSettings = (settings) => {
     return [
         ...settings,
         {
-            name: __('Give Addon Settings', 'ADDON_TEXTDOMAIN'),
+            name: __('Give Addon Settings Sample', 'ADDON_TEXTDOMAIN'),
             path: 'give-addon-settings',
             element: GiveAddonSettings,
         },

diff --git a/src/FormExtension/FormBuilder/resources/js/interfaces/IGiveAddonFormBuilder.ts b/src/FormExtension/FormBuilder/resources/js/interfaces/IGiveAddonFormBuilder.ts
@@ -1,17 +1,12 @@
-import {colorProps} from '../types/ColorProps.ts.off';
+import {ColorOptionProps} from '../types/ColorOptionProps';
 
 /**
  * @since 1.0.0
  */
 export interface IGiveAddonFormBuilder {
-    colors: colorProps[];
+    colors: ColorOptionProps[];
     colorSettingsUrl: string;
     globalOptionsUrl: string;
     sampleTags: {tag: string; desc: string}[];
     previewUrl: string;
-
-    setPdfPreviewUrl: string;
-    customPdfPreviewUrl: string;
-    templatesPdfTags: string;
-    customPdfTags: string;
 }
diff --git a/src/FormExtension/FormBuilder/resources/js/settings/CustomSettings/index.tsx b/src/FormExtension/FormBuilder/resources/js/settings/CustomSettings/index.tsx
@@ -182,7 +182,9 @@ const CustomSettings = ({addonSettings, updateAddonSettings}: customSettingsProp
             <Button
                 className={'pdf-builder-settings__pdf-builder-btn'}
                 variant={'secondary'}
-                onClick={() => window.open(previewUrl + '&form_id=' + donationFormID, '_blank', 'noopener,noreferrer')}
+                onClick={() =>
+                    window.open(previewUrl + '&donationFormID=' + donationFormID, '_blank', 'noopener,noreferrer')
+                }
             >
                 {__('Preview Template Sample', 'ADDON_TEXTDOMAIN')}
             </Button>

diff --git a/src/FormExtension/FormBuilder/resources/js/settings/index.tsx b/src/FormExtension/FormBuilder/resources/js/settings/index.tsx
@@ -10,9 +10,16 @@ import CustomSettings from './CustomSettings';
  * @since 1.0.0
  */
 export default function GiveAddonSettings({settings, setSettings}) {
+    console.log('settings: ', settings);
     const addonSettings: GiveAddonSettingsProps = settings.addonSettings ?? {};
     const {globalOptionsUrl} = getGiveAddonFormBuilderWindowData();
 
+    /**
+     * This is just a sample demonstrating how to start a Form settings extension, but the values will NOT be updated
+     * because there is no "addonSettings" attribute defined in the core form settings. At this moment, there is no way
+     * to extend the default form settings without changing the core codebase. In the future, we can change this sample
+     * to support updates if a way to extend the form settings is implemented in the core.
+     */
     const updateAddonSettings = (property: string, value: any) => {
         setSettings({
             addonSettings: {
@@ -32,7 +39,7 @@ export default function GiveAddonSettings({settings, setSettings}) {
     return (
         <div className={'give-form-settings__addon-settings'}>
             <SettingsSection
-                title={__('Give Addon Settings', 'ADDON_TEXTDOMAIN')}
+                title={__('Give Addon Settings Sample', 'ADDON_TEXTDOMAIN')}
                 description={__(
                     'This allows you to customize the Add-on settings for just this donation form.',
                     'ADDON_TEXTDOMAIN'
@@ -50,8 +57,16 @@ export default function GiveAddonSettings({settings, setSettings}) {
                 </PanelRow>
             </SettingsSection>
 
-            {addonSettings.enable === 'enabled' && (
+            {addonSettings.enable === 'enabled' ? (
                 <CustomSettings addonSettings={addonSettings} updateAddonSettings={updateAddonSettings} />
+            ) : (
+                <p>
+                    <strong>IMPORTANT:</strong> This is just a sample demonstrating how to start a Form settings
+                    extension, but the values will NOT be updated because there is no "addonSettings" attribute defined
+                    in the core form settings. At this moment, there is no way to extend the default form settings
+                    without changing the core codebase. In the future, we can change this sample to support updates if a
+                    way to extend the form settings is implemented in the core.
+                </p>
             )}
         </div>
     );