Cell edit template using Multiline Textbox in Vue Grid

1 min read

By default, the TextBox control will be used as a default editor control for the string column in Vue Grid. You can customize the editor control using Multiline Textbox by rendering it as a custom component in the Grid edit form.

You can use the cellEditTemplate feature of Grid to render the Multiline TextBox component in the Grid edit form. The cell edit template is used to add a custom component for a particular column by invoking the create, write, read, and destroy functions.

dpParams: {
     create: () => {
         elemContent = document.createElement("textarea");
         return elemContent;
      },
       read: () => {
           return textEditor.value;
       },
       destroy: () => {
           textEditor.destroy();
       }, 
       write: (args) => {
           textEditor = new TextBox({
               multiline: true,
               value: args.rowData[args.column.field],
               floatLabelType: "Auto"
        });
          textEditor.appendTo(elemContent);
        }
      }

Using the valueAccessor feature of Grid, you can split the value into multiple lines in the Grid column.

Note:

When editing a particular cell in the Grid, you can prevent the ENTER key’s functionality using the created event in the Grid.

  methods: {
    created(args) {
      this.$refs.grid.ej2Instances.keyConfigs.enter = "";
    },
    valueAccessor: function (field, data, column) {
        var value = data[field];
        if (value !== undefined) {
            return value.split("\n").join("<br>");
         } else {
            return "";
         }
      }
  }