Answers

• allan Posts: 65,162Questions: 1Answers: 10,796 Site admin

  October 1

  Hi,

  Interesting one, as one of the points of feedback from the survey was that Editor didn't have complete typing. I could really understand that since all the options and API are fully typed. However, I hadn't considered the point you make about using it to create a field type plugin.

  This is how it is done internally (this is the hidden field type):

  import { triggerChange } from './shared';
  import { IOptions } from '../../field/defaults';
  
  export interface IHiddenOptions extends IOptions {
      /** Create a hidden field */
      type: 'hidden';
  
      /** Set HTML attributes on the input element. */
      attr?: { [name: string]: any };
  
      /** @ignore */
      value?: any;
  }
  
  /** Internal properties used on the configuration object for the field */
  export interface IHiddenConf extends IHiddenOptions {
      /** @ignore */
      _input?: JQuery<HTMLElement>;
  
      /** @ignore */
      _val?: any;
  }
  
  export default {
      create(conf: IHiddenConf) {
          conf._input = $('<input/>');
          conf._val = conf.value;
  
          return null;
      },
  
      get(conf: IHiddenConf) {
          return conf._val;
      },
  
      set(conf: IHiddenConf, val: any) {
          let oldVal = conf._val;
  
          conf._val = val;
          conf._input.val(val);
  
          if (oldVal !== val) {
              triggerChange(conf._input);
          }
      }
  };
  

  I can look at making the IOptions interface external, certainly. Is there any other you need? The Field class is available under Editor.Field from the default import.

  Allan