cmmn-js-properties-panel/lib/provider/cmmn/parts/implementation/NameProp.js

A simple properties panel for cmmn-js

'use strict';

var entryFactory = require('../../../../factory/EntryFactory');

/**
 * Create an entry to modify the name of an an element.
 *
 * @param  {djs.model.Base} element
 * @param  {Function} translate
 * @param  {Object} options
 * @param  {string} options.id the id of the entry
 * @param  {string} options.label the label of the entry
 *
 * @return {Array<Object>} return an array containing
 *                         the entry to modify the name
 */
module.exports = function(element, translate, options) {

  options = options || {};

  var id = options.id || 'name',
      label = options.label || translate('Name'),
      modelProperty = options.modelProperty || 'name',
      reference = options.reference;

  var nameEntry = entryFactory.textBox({
    id: id,
    label: label,
    modelProperty: modelProperty,
    reference: reference,
    get: options.get,
    set: options.set,
    validate: options.validate
  });

  return [ nameEntry ];

};