Merge pull request #40 from formio/FIO-7245-migrate-resource-to-contrib

FIO-7245: Moved Resource component to the contrib library

Author: travist

src/components/index.ts

@@ -1,7 +1,8 @@
 import checkmatrix from './CheckMatrix/CheckMatrix';
+import resource from './resource/Resource';
 import tree from './tree/Tree';
-
 export default {
   checkmatrix,
+  resource,
   tree,
 };

src/components/resource/Resource.form.ts

@@ -0,0 +1,11 @@
+import { Components } from 'formiojs';
+import ResourceEditDisplay from './editForm/Resource.edit.display';
+
+export default function(...extend) {
+  return Components.baseEditForm([
+    {
+      key: 'display',
+      components: ResourceEditDisplay
+    },
+  ], ...extend);
+}

src/components/resource/Resource.ts

@@ -0,0 +1,45 @@
+import { Components } from 'formiojs';
+const SelectComponent = (Components.components as any).select;
+import editForm from './Resource.form';
+
+export default class ResourceComponent extends SelectComponent {
+  static editForm = editForm;
+
+  static schema(...extend) {
+    return SelectComponent.schema({
+      type: 'resource',
+      label: 'Resource',
+      key: 'resource',
+      dataSrc: 'resource',
+      resource: '',
+      project: '',
+      template: '<span>{{ item.data }}</span>',
+    }, ...extend);
+  }
+
+  static get builderInfo() {
+    return {
+      title: 'Resource',
+      icon: 'files-o',
+      weight: 90,
+      documentation: '/userguide/form-building/form-components#resource',
+      schema: ResourceComponent.schema(),
+    };
+  }
+
+  constructor(...args) {
+    super(...args);
+  }
+
+  init() {
+    super.init();
+    this.component.dataSrc = 'resource';
+    this.component.data = {
+      resource: this.component.resource,
+    };
+  }
+
+  get defaultSchema() {
+    return ResourceComponent.schema();
+  }
+}

src/components/resource/editForm/Resource.edit.display.ts

@@ -0,0 +1,100 @@
+export default [
+  {
+    key: 'resourceInfo',
+    weight: -10,
+    type: 'htmlelement',
+    tag: 'div',
+    className: 'alert alert-danger',
+    content: 'This component has been deprecated and will be removed in a future version of Formio.js.',
+  },
+  {
+    type: 'select',
+    input: true,
+    dataSrc: 'url',
+    data: {
+      url: '/form?type=resource&limit=1000000&select=_id,title',
+    },
+    authenticate: true,
+    template: '<span>{{ item.title }}</span>',
+    valueProperty: '_id',
+    label: 'Resource',
+    key: 'resource',
+    weight: 50,
+    tooltip: 'The resource to be used with this field.',
+  },
+  {
+    type: 'tags',
+    input: true,
+    key: 'selectFields',
+    label: 'Select Fields',
+    tooltip: 'The properties on the resource to return as part of the options. If left blank, all properties will be returned.',
+    placeholder: 'Enter the fields to select.',
+    weight: 51,
+  },
+  {
+    type: 'tags',
+    input: true,
+    key: 'searchFields',
+    label: 'Search Fields',
+    tooltip: 'A list of search filters based on the fields of the resource. See the <a target=\'_blank\' href=\'https://github.com/travist/resourcejs#filtering-the-results\'>Resource.js documentation</a> for the format of these filters.',
+    placeholder: 'The fields to query on the server',
+    weight: 52,
+  },
+  {
+    type: 'textfield',
+    input: true,
+    key: 'filter',
+    label: 'Filter Query',
+    weight: 53,
+    description: 'The filter query for results.',
+    tooltip: 'Use this to provide additional filtering using query parameters.',
+  },
+  {
+    type: 'textfield',
+    input: true,
+    key: 'sort',
+    label: 'Sort Query',
+    weight: 53,
+    description: 'The sort query for results',
+    tooltip: 'Use this to provide additional sorting using query parameters',
+  },
+  {
+    type: 'textarea',
+    input: true,
+    key: 'template',
+    label: 'Item Template',
+    editor: 'ace',
+    as: 'html',
+    rows: 3,
+    weight: 53,
+    tooltip: 'The HTML template for the result data items.',
+  },
+  {
+    type: 'checkbox',
+    input: true,
+    weight: 54,
+    key: 'addResource',
+    label: 'Add Resource',
+    tooltip: 'Allows to create a new resource while entering a submission.',
+    conditional: {
+      json: { '===': [{ var: 'data.dataSrc' }, 'resource'] },
+    },
+  },
+  {
+    type: 'textfield',
+    label: 'Add Resource Label',
+    key: 'addResourceLabel',
+    tooltip: 'Set the text of the Add Resource button.',
+    placeholder: 'Add Resource',
+    weight: 55,
+    input: true,
+    conditional: {
+      json: {
+        and: [
+          { '===': [{ var: 'data.dataSrc' }, 'resource'] },
+          { '!!': { var: 'data.addResource' } },
+        ],
+      },
+    },
+  },
+];