Angular 5 + Form.io Custom Component

app.component.ts

import { Component } from '@angular/core';
import { Router } from '@angular/router';
import { FormioAuthService } from 'angular-formio/auth';
import { AppConfig } from '../config';
import { FormioForm } from 'formiojs/full';
import from './CheckMatrix'

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.scss']
})
export class AppComponent {
  title = 'app';
  offlineCount = 0;
  offlineMode: any = null;
  offlineError = '';
  constructor(private auth: FormioAuthService, private router: Router) {
    this.auth.onLogin.subscribe(() => {
      this.router.navigate(['/home']);
    });

    this.auth.onLogout.subscribe(() => {
      this.router.navigate(['/auth/login']);
    });

    this.auth.onRegister.subscribe(() => {
      this.router.navigate(['/home']);
    });

    // Register our custom components.
    FormioForm.registerComponent('checkmatrix', CheckMatrix);
  }
}

CheckMatrix.js

/**
 * This file shows how to create a custom component and register that within an Angular application.
 *
 * Get the base component class by referencing Formio.Components.components map.
 */
import BaseComponent from 'formiojs/components/base/Base';
import TableComponent from 'formiojs/components/table/Table';
import Components from 'formiojs/components/Components';

/**
 * Create a new CheckMatrixComponent "class" using ES5 class inheritance notation.
 * https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Inheritance
 *
 * Here we will derive from the base component which all Form.io form components derive from.
 *
 * @param component
 * @param options
 * @param data
 * @constructor
 */
export default class CheckMatrixComponent extends BaseComponent {

  /**
   * Define what the default JSON schema for this component is. We will derive from the BaseComponent
   * schema and provide our overrides to that.
   * @return {*}
   */
  static schema() {
    return BaseComponent.schema({
      type: 'checkmatrix',
      numRows: 3,
      numCols: 3
    });
  }

  /**
   * Register this component to the Form Builder by providing the "builderInfo" object.
   */
  static get builderInfo() {
    return {
      title: 'Check Matrix',
      group: 'basic',
      icon: 'fa fa-table',
      weight: 70,
      documentation: 'http://help.form.io/userguide/#table',
      schema: CheckMatrixComponent.schema()
    };
  }

  /**
   * Tell the renderer how to build this component using DOM manipulation.
   */
  build() {
    this.element = this.ce('div', {
      class: 'table-responsive'
    });
    this.createLabel(this.element);

    var tableClass = 'table ';
    ['striped', 'bordered', 'hover', 'condensed'].forEach(function(prop) {
      if (this.component[prop]) {
        tableClass += `table-${prop} `;
      }
    }.bind(this));

    var table = this.ce('table', {
      class: tableClass
    });

    // Build the body.
    var tbody = this.ce('tbody');
    this.inputs = [];
    this.checks = [];
    for (let i = 0; i < this.component.numRows; i++) {
      var tr = this.ce('tr');
      this.checks.push([]);
      for (let j = 0; j < this.component.numCols; j++) {
        var td = this.ce('td');
        this.checks[i][j] = this.ce('input', {
          type: 'checkbox'
        });
        this.addInput(this.checks[i][j], td);
        tr.appendChild(td);
      }
      tbody.appendChild(tr);
    }
    table.appendChild(tbody);
    this.element.appendChild(table);
  }

  /**
   * Provide the input element information. Because we are using checkboxes, the change event needs to be
   * 'click' instead of the default 'change' from the BaseComponent.
   *
   * @return {{type, component, changeEvent, attr}}
   */
  elementInfo() {
    const info = super.elementInfo();
    info.changeEvent = 'click';
    return info;
  }

  /**
   * Tell the renderer how to "get" a value from this component.
   *
   * @return {Array}
   */
  getValue() {
    var value = [];
    this.checks.forEach((row, rowIndex) => {
      value[rowIndex] = [];
      row.forEach((col, colIndex) => {
        value[rowIndex][colIndex] = !!col.checked;
      });
    });
    return value;
  }

  /**
   * Tell the renderer how to "set" the value of this component.
   *
   * @param value
   * @return {boolean}
   */
  setValue(value) {
    if (!value) {
      return;
    }
    this.checks.forEach((row, rowIndex) => {
      if (!value[rowIndex]) {
        return false;
      }
      row.forEach((col, colIndex) => {
        if (!value[rowIndex][colIndex]) {
          return false;
        }
        let checked = value[rowIndex][colIndex] ? 1 : 0;
        col.value = checked;
        col.checked = checked;
      });
    });
  }
}

// Use the table component edit form.
CheckMatrixComponent.editForm = TableComponent.editForm;

// Register the component to the Formio.Components registry.
Components.addComponent('checkmatrix', CheckMatrixComponent);

component.json

{
  "type": "checkmatrix",
  "input": true,
  "numRows": 5,
  "numColumns": 5,
  "label": "Check Matrix",
  "key": "checkMatrix"
}

@travist
I cannot seem to get this gist working.

I have installed the latest formiojs from npm.

The line below does not seem to exist anywhere. it is not in "formiojs": "^3.5.3".

import { FormioForm } from 'formiojs/full';

So following recommendations from @Aiso786
I added the following file:

// src/app/typings/index.d.ts
declare module 'formiojs'

Defined path to above file in tsconfig.json

"typeRoots": [
      "node_modules/@types",
      "./src/app/typings/index"
    ],

My error went away.
Now while debugging I see my component added to Formio.Components._components but when rendering the form I get
Unknown component: mycustomcomponent

The issue seems to be angular-formio is using it's own "internal" formiojs ./angular-formio/node_modules/formiojs which is a separate instance from ./myapplicationroot/node_modules/formiojs which I am registering my custom components with.
When trying to use this internal formiojs I get:

core.js:1598 ERROR Error: Uncaught (in promise): TypeError: comp.build is not a function

webpack:///./node_modules/angular-formio/node_modules/formiojs/components/Components.js

Where have I gone wrong here?

Any help is greatly appreciated.

I just updated this gist to now be correct with the latest renderer.

@travist, i want to have a custom component in react using react-formio, how can i do that.
Please help me out.

In the older version of angular-formio(1.18.0) we registered the custom components using Formio.registerComponent() method and it was working perfectly.
Recently we have upgraded our application with latest version of angular-formio (3.9.0) and formiojs version as 2.32.3 after this up-gradation our custom components are not working it is showing error message as "unknown component : mycustomcomponent". Please help.

I'm using successfully custom component in angular6 like described. But i would like to use my custom component on formbuilder edit modal too (technically in Base.edit.logic.js).
Can we do it?

i have same problem. please help

i have same problem. please help

Do you have any sample with Aurelia and Typescript?

Do you have any example on creating check box component using formio

any html code for rendering formio custom component..
I have to render custom formio select drop down component in to my application.For that i created one js file like Select.js and i had taken the Select.js code from https://formio.github.io/formio.js/docs/class/src/components/select/Select.js~SelectComponent.html
and also i registered that component into my custom_formio.component.ts as
Formio.registerComponent('custom_formio', SelectComponent);
where custom_formio is the name of my component which having Select.js file and other ts and html and css files. and SelectComponent is the name of class name which is declared in Select.js file.
So i am getting confusion that which code i have to write in html to render select dropdown into my application

how to disable the popup in check matrix component

@srinvasneelamraju did you find the solution?

@travis I'm trying to override the method createModal so as the build method was, but it's never called. Do you know how to do that?