refactor: rename hiddenInVersionView to disableVersionDiff

For consistency with disabled, disableListColumn and disableListFiter

Author: franciscolourenco

Diff for: docs/fields/overview.mdx

@@ -440,8 +440,8 @@ The following options are available:
 |    **`disableBulkEdit`**      |    Set `disableBulkEdit` to `true` to prevent fields from appearing in the select options when making edits for multiple documents. Defaults to `true` for UI fields.                                                                  |
 |    **`disableListColumn`**    |    Set `disableListColumn` to `true` to prevent fields from appearing in the list view column selector.                                                                                                                                |
 |    **`disableListFilter`**    |    Set `disableListFilter` to `true` to prevent fields from appearing in the list view filter options.                                                                                                                                 |
+|    **`disableVersionDiff`**   |    Set `disableVersionDiff` to `true` to prevent fields from appearing in the version view.                                                                                                                                           |
 |    **`hidden`**               |    Will transform the field into a `hidden` input type. Its value will still submit with requests in the Admin Panel, but the field itself will not be visible to editors.                                                             |
-|    **`hiddenInVersionView`**  |    Set `hiddenInVersionView` to `true` to prevent fields from appearing in the version view.                                                                                                                                           |
 
 ### Field Descriptions
 

Diff for: packages/next/src/views/Version/RenderFieldsToDiff/utilities/isFieldHiddenInVersionView.ts

@@ -25,9 +25,9 @@ export function isFieldHiddenInVersionView(field: ClientField | Field) {
     return true
   }
 
-  // Don't render fields with admin.hiddenInVersionView, because they are
+  // Don't render fields with admin.disableVersionDiff, because they are
   // supposed to be hidden specifically in the version view.
-  if (field.admin?.hiddenInVersionView) {
+  if (field.admin?.disableVersionDiff) {
     return true
   }
 

Diff for: packages/payload/src/fields/config/types.ts

@@ -347,12 +347,12 @@ type Admin = {
    * @type boolean
    */
   disableListFilter?: boolean
-  hidden?: boolean
   /**
    * Shows / hides fields in the version diff view.
    * @type boolean
    */
-  hiddenInVersionView?: boolean
+  disableVersionDiff?: boolean
+  hidden?: boolean
   position?: 'sidebar'
   readOnly?: boolean
   style?: CSSProperties
@@ -376,12 +376,12 @@ export type AdminClient = {
    * @type boolean
    */
   disableListFilter?: boolean
-  hidden?: boolean
   /**
    * Shows / hides fields in the version diff view.
    * @type boolean
    */
-  hiddenInVersionView?: boolean
+  disableVersionDiff?: boolean
+  hidden?: boolean
   position?: 'sidebar'
   readOnly?: boolean
   style?: { '--field-width'?: CSSProperties['width'] } & CSSProperties

Diff for: test/versions/collections/Diff.ts

@@ -196,10 +196,10 @@ export const Diff: CollectionConfig = {
       },
     },
     {
-      name: 'adminHiddenInVersionView',
+      name: 'adminDisableVersionDiff',
       type: 'text',
       admin: {
-        hiddenInVersionView: true,
+        disableVersionDiff: true,
       },
     },
   ],

Diff for: test/versions/e2e.spec.ts

@@ -1575,14 +1575,12 @@ describe('Versions', () => {
         await expect(adminDisabledField).toBeHidden()
       })
 
-      test('should not render fields with admin.hiddenInVersionView: true', async () => {
+      test('should not render fields with admin.disableVersionView: true', async () => {
         await navigateToVersionFieldsDiff()
 
-        // Fields with admin.hiddenInVersionView should be hidden in the version view
-        const adminHiddenInVersionViewView = page.locator(
-          '[data-field-path="adminHiddenInVersionView"]',
-        )
-        await expect(adminHiddenInVersionViewView).toBeHidden()
+        // Fields with admin.disableVersionDiff should be hidden in the version view
+        const adminDisableVersionDiff = page.locator('[data-field-path="adminDisableVersionDiff"]')
+        await expect(adminDisableVersionDiff).toBeHidden()
       })
     })
   })