Use a Third-Party Angular Editor Template in the Grid for AngularJS

Environment

Product Version	2016.2 504
Product	Progress® Kendo UI® Grid for jQuery

Starting with R2 2022, the Kendo UI team officially drops the support for AngularJS 1.x through Kendo UI for jQuery. The AngularJS related files and functionality are removed from the bundles and distribution in R3 SP1 2023. The last version that contains the files is R3 2023.

Description

I am trying to bind ng-model in an nz-toggle (a double- and triple-state toggle for Angular directive for Booleans) in the Grid but it is not working.

How can I bind the value in the editor of a third-party Angular editor template when working with the Kendo UI Grid?

Solution

1. Bind the third-party Angular editor in the Grid by using the ng-model dataItem.field.
2. Use an event that the third-party library offers so you can mark the dataItem as dirty. As a result, all items which are marked as dirty will be updated at the next sync of the data source.

// grid columns configuration
columns: [
 { field: "Discontinued", width: "130px", template: "<span class='k-dirty' ng-show={{dataItem.dirty}}></span>{{dataItem.Discontinued}}", editor: $scope.discontinuedEditor },
],

// editor declaration - use the on-toggle event handle to mark the dataItem as dirty so you can show the dirty flag in the template above
 $scope.discontinuedEditor = function(container, options) {
   var editor = $("<nz-toggle ng-model='dataItem.Discontinued' on-toggle='dataItem.dirty=true'></nz-toggle>")
   .appendTo(container);
 };

The following example demonstrates the implementation of the suggested approach.

The example loads Kendo UI 2023.3.1010 version.

    <script src="https://kendo.cdn.telerik.com/2023.3.1010/js/angular.min.js"></script>
    <script src="https://kendo.cdn.telerik.com/2023.3.1010/js/kendo.all.min.js"></script>

  <link rel="stylesheet" href="https://rawgit.com/tannerlinsley/nz-toggle/master/dist/nz-toggle.min.css"/>
    <script src="https://rawgit.com/tannerlinsley/nz-toggle/master/dist/nz-toggle.min.js">   </script>
    <div id="example" ng-app="KendoDemos">
      <div ng-controller="MyCtrl">
        <h3>
          This example features:
        </h3>
        <ul>
          <li>
            A Kendo UI DropDownList editor bound with MVVM <code>data-bind</code> attribute</p>
        </li>

      <li>
        A third-party AngularJS editor bound with <code>ng-model</code>
      </li>
      </ul>
    <div kendo-grid="grid" options="mainGridOptions"></div>
    </div>
  </div>

<script>
  angular.module("KendoDemos", [ "kendo.directives", "nzToggle" ])
    .controller("MyCtrl", function($scope, $compile){
    var crudServiceBaseUrl = "https://demos.telerik.com/kendo-ui/service";
    $scope.dataSource = new kendo.data.DataSource({
      transport: {
        read:  {
          url: crudServiceBaseUrl + "/Products",
          dataType: "jsonp"
        },
        update: {
          url: crudServiceBaseUrl + "/Products/Update",
          dataType: "jsonp"
        },
        destroy: {
          url: crudServiceBaseUrl + "/Products/Destroy",
          dataType: "jsonp"
        },
        create: {
          url: crudServiceBaseUrl + "/Products/Create",
          dataType: "jsonp"
        },
        parameterMap: function(options, operation) {
          if (operation !== "read" && options.models) {
            return {models: kendo.stringify(options.models)};
          }
        }
      },
      batch: true,
      pageSize: 20,
      schema: {
        model: {
          id: "ProductID",
          fields: {
            ProductID: { editable: false, nullable: true },
            ProductName: { validation: { required: true } },
            UnitPrice: { type: "number", validation: { required: true, min: 1} },
            Discontinued: { type: "boolean" },
            UnitsInStock: { type: "number", validation: { min: 0, required: true } }
          }
        }
      }
    });

    $scope.ddlDataSource = new kendo.data.DataSource({
      transport: {
        read: {
          dataType: "jsonp",
          url: "https://demos.telerik.com/kendo-ui/service/Products",
        }
      }
    });

    $scope.productsDropDownEditor = function(container, options) {
        var editor = $('<input k-auto-bind=false kendo-drop-down-list required k-data-text-field="\'ProductName\'" k-data-value-field="\'ProductName\'" k-data-source="ddlDataSource" data-bind="value:ProductName"/>')
        .appendTo(container);
    };

    $scope.discontinuedEditor = function(container, options) {
        var editor = $("<nz-toggle ng-model='dataItem.Discontinued' on-toggle='dataItem.dirty=true'></nz-toggle>")
        .appendTo(container);
      };

    $scope.mainGridOptions = {
      dataSource: $scope.dataSource,
      pageable: true,
      height: 550,
      toolbar: ["create", "save"],
      columns: [
        { field:"ProductName",title:"Product Name",editor: $scope.productsDropDownEditor },
        { field: "Discontinued", width: "130px", template: "<span class='k-dirty' ng-show={{dataItem.dirty}}></span>{{dataItem.Discontinued}}", editor: $scope.discontinuedEditor },
        { command: "destroy", title: " ", width: "150px" }],
      editable: true
    };
  })
</script>
<p><small><p>This example is using nz-toggle under the following license: The MIT License (MIT)</p>

  <p>Copyright (c) 2014 Tanner Linsley</p>

  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</small></p>