[bug]: Custom Field requires type: json in schema to save data

Đang mở
  • Có gì không ổn?
#95 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 6 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
full-stack

Hướng nghiên cứu

Start with the custom-field registration example in /admin/src/index.js and compare it with the official custom-fields documentation linked in the issue. Trace how the registered type and the generated schema affect persistence, then determine whether the fix belongs in the SDK behavior or the documentation. Done means complex custom-field data persists correctly or the required json configuration is clearly documented.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

issue: bug
What version of @strapi/sdk-plugin are you using?
  • Npm version: 10.8.2
  • Node.js version: 20.18.3
  • React version: 18.3.1
  • Strapi version: 5.23.3
  • @strapi/sdk-plugin version: 5.3.2
  • Browser: Chrome
What's Wrong?

When using a custom field from any plugin in a content type schema, if the field is defined as:

"myCustomField": {
  "type": "customField",
  "customField": "plugin::<plugin-name>.<custom-field-name>"
}

Strapi does not save the data unless the field type is changed to "json":

"myCustomField": {
  "type": "json",
  "customField": "plugin::<plugin-name>.<custom-field-name>"
}

This is not documented and causes confusion, since the admin panel recognizes the custom field, but the data is not persisted unless the type is set to json.

To Reproduce

  1. Create a content type with a custom field using a local plugin built with the Strapi SDK (e.g. <plugin-name>), where the custom field is registered as type json in the plugin registration.

  2. Add the custom field from the Content-Type Builder to any collection type.

  3. In the schema, define the field as:

    "myCustomField": {
  "type": "customField",
  "customField": "plugin::<plugin-name>.<custom-field-name>"
}

  4. Go to the admin panel and try to save data using the custom field.

  5. Observe that the data is not saved/persisted.

  6. Change the field type to "json":

    "myCustomField": {
  "type": "json",
  "customField": "plugin::<plugin-name>.<custom-field-name>"
}

  7. Now, data is saved correctly.

Expected Behaviour
Actual Behaviour
  • The admin panel recognizes the custom field and allows input, but Strapi does not persist the data unless the type is set to json.
  • This behaviour is not documented in the official docs, which show examples using type: "customField".
Expected Behaviour
  • Strapi should either:
    • Handle custom fields that store arrays/objects without requiring manual change to "json", or
    • Document this requirement clearly for custom field plugin authors and users.
Technical Comparison with Official Documentation
"color": {
  "type": "customField",
  "customField": "plugin::color-picker.color",
  "options": {
    "format": "hex"
  }
}
  • In practice, for custom fields that store complex data (arrays/objects), the type must be set to json for persistence:
"customFieldExample": {
  "type": "json",
  "customField": "plugin::<plugin-name>.<custom-field-name>"
}
  • If type: "customField" is used, the data is not saved.
Custom Field Registration

File: <plugin-path>/admin/src/index.js

app.customFields.register({
  name: '<custom-field-name>',
  pluginId: '<plugin-name>',
  type: 'json', // Required for metadata persistence
  intlLabel: {
    id: '<plugin-name>.<custom-field-name>.label',
    defaultMessage: '<custom-field-name>',
  },
  intlDescription: {
    id: '<plugin-name>.<custom-field-name>.description',
    defaultMessage: 'Select any asset',
  },
  components: {
    Input: async () =>
      import('./components/Input/Input').then((module) => ({
        default: module.Input,
      })),
  },
  options: {
    // declare options here
  },
});
  • The custom field must use type: 'json' for Strapi to persist complex data (arrays/objects).
  • If type: 'customField' is used, data is not saved.
Ngôn ngữ chính
TypeScript
Star
24
Fork
13
Merge trung bình
5 ngày 3 giờ
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của strapi/sdk-plugin

Tất cả issue của strapi/sdk-plugin

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.