refactor: unify tab initailizer naming (#3932)

* refactor: rename dialog to popup * feat: add tabPaneInitializers * refactor: rename TabPaneInitializers to popup:addTab * refactor: rename TabPaneInitializersForCreateFormBlock to popup:addTab * refactor: rename TabPaneInitializersForBulkEditFormBlock to popup:addTab * chore: fix unit tests * chore: fix e2e
2024-11-15 07:38:13 +00:00 · 2024-04-05 23:19:09 +08:00 · 2024-04-05 23:19:09 +08:00 · b750cab942
commit b750cab942
parent 385ac5a488
29 changed files with 61 additions and 35 deletions
--- a/packages/core/client/src/collection-manager/interfaces/properties/index.ts
+++ b/packages/core/client/src/collection-manager/interfaces/properties/index.ts
@ -396,7 +396,7 @@ export const recordPickerViewer = {
      type: 'void',
      'x-component': 'Tabs',
      'x-component-props': {},
-      'x-initializer': 'TabPaneInitializers',
+      'x-initializer': 'popup:addTab',
      properties: {
        tab1: {
          type: 'void',
--- a/packages/core/client/src/modules/actions/add-child/CreateChildInitializer.tsx
+++ b/packages/core/client/src/modules/actions/add-child/CreateChildInitializer.tsx
@ -29,7 +29,10 @@ export const CreateChildInitializer = (props) => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializersForCreateFormBlock',
+            'x-initializer': 'popup:addTab',
+            'x-initializer-props': {
+              gridInitializer: 'popup:addNew:addBlock',
+            },
            properties: {
              tab1: {
                type: 'void',
--- a/packages/core/client/src/modules/actions/add-new/CreateActionInitializer.tsx
+++ b/packages/core/client/src/modules/actions/add-new/CreateActionInitializer.tsx
@ -31,7 +31,10 @@ export const CreateActionInitializer = () => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializersForCreateFormBlock',
+            'x-initializer': 'popup:addTab',
+            'x-initializer-props': {
+              gridInitializer: 'popup:addNew:addBlock',
+            },
            properties: {
              tab1: {
                type: 'void',
--- a/packages/core/client/src/modules/actions/add-record/CustomizeAddRecordActionInitializer.tsx
+++ b/packages/core/client/src/modules/actions/add-record/CustomizeAddRecordActionInitializer.tsx
@ -27,7 +27,7 @@ export const CustomizeAddRecordActionInitializer = () => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializersForCreateFormBlock',
+            'x-initializer': 'popup:addTab',
            'x-initializer-props': {
              gridInitializer: 'popup:addRecord:addBlock',
            },
--- a/packages/core/client/src/modules/actions/view-edit-popup/PopupActionInitializer.tsx
+++ b/packages/core/client/src/modules/actions/view-edit-popup/PopupActionInitializer.tsx
@ -27,7 +27,7 @@ export const PopupActionInitializer = (props) => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializers',
+            'x-initializer': 'popup:addTab',
            properties: {
              tab1: {
                type: 'void',
--- a/packages/core/client/src/modules/actions/view-edit-popup/UpdateActionInitializer.tsx
+++ b/packages/core/client/src/modules/actions/view-edit-popup/UpdateActionInitializer.tsx
@ -27,7 +27,7 @@ export const UpdateActionInitializer = (props) => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializers',
+            'x-initializer': 'popup:addTab',
            properties: {
              tab1: {
                type: 'void',
--- a/packages/core/client/src/modules/actions/view-edit-popup/ViewActionInitializer.tsx
+++ b/packages/core/client/src/modules/actions/view-edit-popup/ViewActionInitializer.tsx
@ -26,7 +26,7 @@ export const ViewActionInitializer = (props) => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializers',
+            'x-initializer': 'popup:addTab',
            properties: {
              tab1: {
                type: 'void',
--- a/packages/core/client/src/modules/dialog/e2e/schemaInitializer.test.ts
+++ b/packages/core/client/src/modules/dialog/e2e/schemaInitializer.test.ts
@ -6,7 +6,7 @@ import {
  oneFormBlockWithRolesFieldBasedUsers,
  test,
 } from '@nocobase/test/e2e';
-import { tableWithRoles, tableWithUsers, tableWithInherit, tableWithInheritWithoutAssociation } from './templatesOfBug';
+import { tableWithInherit, tableWithInheritWithoutAssociation, tableWithRoles, tableWithUsers } from './templatesOfBug';

 test.describe('where to open a popup and what can be added to it', () => {
  test('add new', async ({ page, mockPage }) => {
@ -16,7 +16,7 @@ test.describe('where to open a popup and what can be added to it', () => {
    await page.getByLabel('action-Action-Add new-create-general-table').click();

    // add a tab
-    await page.getByLabel('schema-initializer-Tabs-TabPaneInitializersForCreateFormBlock-general').click();
+    await page.getByLabel('schema-initializer-Tabs-').click();
    await page.getByRole('textbox').click();
    await page.getByRole('textbox').fill('test123');
    await page.getByLabel('action-Action-Submit-general-table').click();
@ -41,7 +41,7 @@ test.describe('where to open a popup and what can be added to it', () => {
    await page.getByLabel('action-Action-Add record-customize:create-general-table').click();

    // add a tab
-    await page.getByLabel('schema-initializer-Tabs-TabPaneInitializersForCreateFormBlock-general').click();
+    await page.getByLabel('schema-initializer-Tabs-').click();
    await page.getByRole('textbox').click();
    await page.getByRole('textbox').fill('test7');
    await page.getByLabel('action-Action-Submit-general-table').click();
@ -70,7 +70,7 @@ test.describe('where to open a popup and what can be added to it', () => {
    await page.getByLabel('action-Action.Link-View-view-general-table-0').click();

    // add a tab
-    await page.getByLabel('schema-initializer-Tabs-TabPaneInitializers-general').click();
+    await page.getByLabel('schema-initializer-Tabs-').click();
    await page.getByRole('textbox').click();
    await page.getByRole('textbox').fill('test8');
    await page.getByLabel('action-Action-Submit-general-table-0').click();
@ -127,7 +127,7 @@ test.describe('where to open a popup and what can be added to it', () => {

    // open dialog
    await page.getByLabel('action-Action-Bulk edit-customize:bulkEdit-general-table').click();
-    await page.getByLabel('schema-initializer-Tabs-TabPaneInitializersForBulkEditFormBlock-general').click();
+    await page.getByLabel('schema-initializer-Tabs-').click();
    await page.getByRole('textbox').click();
    await page.getByRole('textbox').fill('test1');
    await page.getByLabel('action-Action-Submit-general-table').click();
@ -156,7 +156,7 @@ test.describe('where to open a popup and what can be added to it', () => {
      .click();

    // add a tab
-    await page.getByLabel('schema-initializer-Tabs-TabPaneInitializers-general').click();
+    await page.getByLabel('schema-initializer-Tabs-').click();
    await page.getByRole('textbox').click();
    await page.getByRole('textbox').fill('test8');
    await page.getByLabel('action-Action-Submit-general-details').click();
--- a/packages/core/client/src/modules/dialog/e2e/schemaSettings.test.ts
+++ b/packages/core/client/src/modules/dialog/e2e/schemaSettings.test.ts
--- a/packages/core/client/src/modules/dialog/e2e/templatesOfBug.ts
+++ b/packages/core/client/src/modules/dialog/e2e/templatesOfBug.ts
--- a/packages/core/client/src/modules/dialog/e2e/zIndex.test.ts
+++ b/packages/core/client/src/modules/dialog/e2e/zIndex.test.ts
--- a/packages/core/client/src/schema-component/antd/association-field/schema.ts
+++ b/packages/core/client/src/schema-component/antd/association-field/schema.ts
@ -23,7 +23,10 @@ export default {
        type: 'void',
        'x-component': 'Tabs',
        'x-component-props': {},
-        'x-initializer': 'TabPaneInitializersForCreateFormBlock',
+        'x-initializer': 'popup:addTab',
+        'x-initializer-props': {
+          gridInitializer: 'popup:addNew:addBlock',
+        },
        properties: {
          tab1: {
            type: 'void',
@ -98,7 +101,7 @@ export default {
        type: 'void',
        'x-component': 'Tabs',
        'x-component-props': {},
-        'x-initializer': 'TabPaneInitializers',
+        'x-initializer': 'popup:addTab',
        properties: {
          tab1: {
            type: 'void',
--- a/packages/core/client/src/schema-initializer/buttons/TabPaneInitializers.tsx
+++ b/packages/core/client/src/schema-initializer/buttons/TabPaneInitializers.tsx
@ -4,7 +4,7 @@ import { SchemaComponent, useActionContext, useDesignable, useRecord } from '../
 import { SchemaInitializer } from '../../application/schema-initializer/SchemaInitializer';
 import { useGetAriaLabelOfSchemaInitializer } from '../hooks/useGetAriaLabelOfSchemaInitializer';

-export const TabPaneInitializers = (props?: any) => {
+const TabPaneInitializers = (props?: any) => {
  const { designable, insertBeforeEnd } = useDesignable();
  const { isCreate, isBulkEdit, options } = props;
  const { gridInitializer } = options;
@ -130,25 +130,36 @@ export const TabPaneInitializers = (props?: any) => {
  return <SchemaComponent schema={schema} />;
 };

-export const TabPaneInitializersForCreateFormBlock = (props) => {
+const TabPaneInitializersForCreateFormBlock = (props) => {
  return <TabPaneInitializers {...props} isCreate />;
 };

-export const TabPaneInitializersForBulkEditFormBlock = (props) => {
+const TabPaneInitializersForBulkEditFormBlock = (props) => {
  return <TabPaneInitializers {...props} isBulkEdit />;
 };

+const commonOptions = {
+  Component: TabPaneInitializers,
+  popover: false,
+};
+
 /**
 * @deprecated
+ * use `tabPaneInitializers` instead
 */
 export const tabPaneInitializers_deprecated = new SchemaInitializer({
  name: 'TabPaneInitializers',
-  Component: TabPaneInitializers,
-  popover: false,
+  ...commonOptions,
+});
+
+export const tabPaneInitializers = new SchemaInitializer({
+  name: 'popup:addTab',
+  ...commonOptions,
 });

 /**
 * @deprecated
+ * use `tabPaneInitializers` instead
 */
 export const tabPaneInitializersForRecordBlock = new SchemaInitializer({
  name: 'TabPaneInitializersForCreateFormBlock',
@ -158,6 +169,7 @@ export const tabPaneInitializersForRecordBlock = new SchemaInitializer({

 /**
 * @deprecated
+ * use `tabPaneInitializers` instead
 */
 export const tabPaneInitializersForBulkEditFormBlock = new SchemaInitializer({
  name: 'TabPaneInitializersForBulkEditFormBlock',
--- a/packages/core/client/src/schema-initializer/index.ts
+++ b/packages/core/client/src/schema-initializer/index.ts
@ -113,6 +113,7 @@ import {
  recordBlockInitializers_deprecated,
  subTableActionInitializers,
  subTableActionInitializers_deprecated,
+  tabPaneInitializers,
  tabPaneInitializersForBulkEditFormBlock,
  tabPaneInitializersForRecordBlock,
  tabPaneInitializers_deprecated,
@ -225,6 +226,7 @@ export class SchemaInitializerPlugin extends Plugin {
    this.app.schemaInitializerManager.add(tableSelectorInitializers_deprecated);
    this.app.schemaInitializerManager.add(tableSelectorInitializers);
    this.app.schemaInitializerManager.add(tabPaneInitializers_deprecated);
+    this.app.schemaInitializerManager.add(tabPaneInitializers);
    this.app.schemaInitializerManager.add(tabPaneInitializersForRecordBlock);
    this.app.schemaInitializerManager.add(tabPaneInitializersForBulkEditFormBlock);
    this.app.schemaInitializerManager.add(menuItemInitializer_deprecated);
--- a/packages/plugins/@nocobase/plugin-action-bulk-edit/src/client/BulkEditActionInitializer.tsx
+++ b/packages/plugins/@nocobase/plugin-action-bulk-edit/src/client/BulkEditActionInitializer.tsx
@ -27,7 +27,10 @@ export const BulkEditActionInitializer = () => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializersForBulkEditFormBlock',
+            'x-initializer': 'popup:addTab',
+            'x-initializer-props': {
+              gridInitializer: 'popup:bulkEdit:addBlock',
+            },
            properties: {
              tab1: {
                type: 'void',
--- a/packages/plugins/@nocobase/plugin-action-duplicate/src/client/DuplicateActionInitializer.tsx
+++ b/packages/plugins/@nocobase/plugin-action-duplicate/src/client/DuplicateActionInitializer.tsx
@ -26,7 +26,7 @@ export const DuplicateActionInitializer = (props) => {
            type: 'void',
            'x-component': 'Tabs',
            'x-component-props': {},
-            'x-initializer': 'TabPaneInitializers',
+            'x-initializer': 'popup:addTab',
            properties: {
              tab1: {
                type: 'void',
--- a/packages/plugins/@nocobase/plugin-audit-logs/src/client/components/AuditLogsViewActionInitializer.tsx
+++ b/packages/plugins/@nocobase/plugin-audit-logs/src/client/components/AuditLogsViewActionInitializer.tsx
@ -192,7 +192,7 @@ export const AuditLogsViewActionInitializer = () => {
                                                            type: 'void',
                                                            'x-component': 'Tabs',
                                                            'x-component-props': {},
-                                                            'x-initializer': 'TabPaneInitializers',
+                                                            'x-initializer': 'popup:addTab',
                                                            properties: {
                                                              tab1: {
                                                                type: 'void',
--- a/packages/plugins/@nocobase/plugin-calendar/src/client/tests/createCalendarBlockSchema.test.ts
+++ b/packages/plugins/@nocobase/plugin-calendar/src/client/tests/createCalendarBlockSchema.test.ts
@ -55,7 +55,7 @@ describe('createCalendarBlockSchema', () => {
                        "type": "void",
                        "x-component": "Tabs",
                        "x-component-props": {},
-                        "x-initializer": "TabPaneInitializers",
+                        "x-initializer": "popup:addTab",
                        "x-initializer-props": {
                          "gridInitializer": "popup:common:addBlock",
                        },
--- a/packages/plugins/@nocobase/plugin-calendar/src/client/schema-initializer/createCalendarBlockUISchema.ts
+++ b/packages/plugins/@nocobase/plugin-calendar/src/client/schema-initializer/createCalendarBlockUISchema.ts
@ -63,7 +63,7 @@ export const createCalendarBlockUISchema = (options: {
                    type: 'void',
                    'x-component': 'Tabs',
                    'x-component-props': {},
-                    'x-initializer': 'TabPaneInitializers',
+                    'x-initializer': 'popup:addTab',
                    'x-initializer-props': {
                      gridInitializer: 'popup:common:addBlock',
                    },
--- a/packages/plugins/@nocobase/plugin-calendar/src/client/schema-initializer/initializers/CalendarFormActionInitializers.tsx
+++ b/packages/plugins/@nocobase/plugin-calendar/src/client/schema-initializer/initializers/CalendarFormActionInitializers.tsx
@ -101,7 +101,7 @@ export const CalendarFormActionInitializers = new SchemaInitializer({
                    type: 'void',
                    'x-component': 'Tabs',
                    'x-component-props': {},
-                    'x-initializer': 'TabPaneInitializers',
+                    'x-initializer': 'popup:addTab',
                    properties: {
                      tab1: {
                        type: 'void',
--- a/packages/plugins/@nocobase/plugin-gantt/src/client/tests/createGanttBlockSchema.test.ts
+++ b/packages/plugins/@nocobase/plugin-gantt/src/client/tests/createGanttBlockSchema.test.ts
@ -47,7 +47,7 @@ describe('createGanttBlockSchema', () => {
                        "type": "void",
                        "x-component": "Tabs",
                        "x-component-props": {},
-                        "x-initializer": "TabPaneInitializers",
+                        "x-initializer": "popup:addTab",
                      },
                    },
                    "title": "{{ t("View record") }}",
--- a/packages/plugins/@nocobase/plugin-gantt/src/client/createGanttBlockUISchema.tsx
+++ b/packages/plugins/@nocobase/plugin-gantt/src/client/createGanttBlockUISchema.tsx
@ -100,7 +100,7 @@ export const createGanttBlockUISchema = (options: {
                    type: 'void',
                    'x-component': 'Tabs',
                    'x-component-props': {},
-                    'x-initializer': 'TabPaneInitializers',
+                    'x-initializer': 'popup:addTab',
                    properties: {
                      tab1: {
                        type: 'void',
--- a/packages/plugins/@nocobase/plugin-kanban/src/client/tests/createKanbanBlockSchema.test.ts
+++ b/packages/plugins/@nocobase/plugin-kanban/src/client/tests/createKanbanBlockSchema.test.ts
@ -78,7 +78,7 @@ test('createKanbanBlockSchema should return an object with expected properties',
                      "type": "void",
                      "x-component": "Tabs",
                      "x-component-props": {},
-                      "x-initializer": "TabPaneInitializers",
+                      "x-initializer": "popup:addTab",
                    },
                  },
                  "title": "{{ t("View record") }}",
--- a/packages/plugins/@nocobase/plugin-kanban/src/client/createKanbanBlockUISchema.ts
+++ b/packages/plugins/@nocobase/plugin-kanban/src/client/createKanbanBlockUISchema.ts
@ -86,7 +86,7 @@ export const createKanbanBlockUISchema = (options: {
                    type: 'void',
                    'x-component': 'Tabs',
                    'x-component-props': {},
-                    'x-initializer': 'TabPaneInitializers',
+                    'x-initializer': 'popup:addTab',
                    properties: {
                      tab1: {
                        type: 'void',
--- a/packages/plugins/@nocobase/plugin-map/src/client/tests/block/createMapBlockSchema.test.ts
+++ b/packages/plugins/@nocobase/plugin-map/src/client/tests/block/createMapBlockSchema.test.ts
@ -55,7 +55,7 @@ test('createMapBlockSchema should return an object with expected properties', ()
                  "type": "void",
                  "x-component": "Tabs",
                  "x-component-props": {},
-                  "x-initializer": "TabPaneInitializers",
+                  "x-initializer": "popup:addTab",
                },
              },
              "title": "{{ t("View record") }}",
--- a/packages/plugins/@nocobase/plugin-map/src/client/block/createMapBlockUISchema.ts
+++ b/packages/plugins/@nocobase/plugin-map/src/client/block/createMapBlockUISchema.ts
@ -54,7 +54,7 @@ export const createMapBlockUISchema = (options: {
                type: 'void',
                'x-component': 'Tabs',
                'x-component-props': {},
-                'x-initializer': 'TabPaneInitializers',
+                'x-initializer': 'popup:addTab',
                properties: {
                  tab1: {
                    type: 'void',
--- a/packages/plugins/@nocobase/plugin-mobile-client/src/client/core/schema/components/page/Page.Designer.tsx
+++ b/packages/plugins/@nocobase/plugin-mobile-client/src/client/core/schema/components/page/Page.Designer.tsx
@ -75,7 +75,7 @@ export const PageDesigner = (props) => {
              name: 'tabs',
              'x-component': 'Tabs',
              'x-component-props': {},
-              'x-initializer': 'TabPaneInitializers',
+              'x-initializer': 'popup:addTab',
              'x-initializer-props': {
                gridInitializer: 'mobilePage:addBlock',
              },
--- a/packages/plugins/@nocobase/plugin-snapshot-field/src/client/interface.ts
+++ b/packages/plugins/@nocobase/plugin-snapshot-field/src/client/interface.ts
@ -78,7 +78,7 @@ const recordPickerViewer = {
      type: 'void',
      'x-component': 'Tabs',
      'x-component-props': {},
-      // 'x-initializer': 'TabPaneInitializers',
+      // 'x-initializer': 'popup:addTab',
      properties: {
        tab1: {
          type: 'void',
--- a/packages/plugins/@nocobase/plugin-workflow-manual/src/client/instruction/SchemaConfig.tsx
+++ b/packages/plugins/@nocobase/plugin-workflow-manual/src/client/instruction/SchemaConfig.tsx
@ -531,7 +531,7 @@ export function SchemaConfig({ value, onChange }) {
                type: 'void',
                'x-component': 'Tabs',
                'x-component-props': {},
-                'x-initializer': 'TabPaneInitializers',
+                'x-initializer': 'popup:addTab',
                'x-initializer-props': {
                  gridInitializer: 'workflowManual:popup:configureUserInterface:addBlock',
                },