+44 (203) 695-03-80
« Back to List

Creating Custom Field Type

Field Definition

Create a file /custom/Espo/Custom/Resources/metadata/fields/{field-type}.json with needed parameters.

{
   "view": "custom:views/fields/{field-type}"`
}

Use out-of-the-box field types as examples: /application/Espo/Resources/metadata/fields.

Translation

The label is used in Entity Manager can be set in custom/Espo/Custom/Resources/i18n/en_US/Admin.json in section fieldTypes. If you need to add translation to other language, use needed language language code_country code instead of en_US. In data/config.php in section languageList you can find the list of included languages.

View

Create the view for the field client/custom/src/views/fields/{field-type}.js and define its templates

Espo.define('custom:views/fields/[field-type]', 'views/fields/base', function (Dep) {

    return Dep.extend({

    });
});

Use out-of-the-box field types as examples:

  • /client/src/views/fields - views;
  • /client/res/templates/fields - templates.

Then you need to run rebuild at the administration panel.