Server actions in Vue Inplace editor component

11 Jun 202413 minutes to read

By passing In-place Editor component value to the server, the primaryKey property value must require, otherwise action not performed for remote data.

If the URL property value is empty, data passing will handled at local and also the actionSuccess event will trigger with null as argument value.

The following arguments are passed to the server when submit actions perform.

Arguments Explanations
value For processing edited value, like DB value updating.
primaryKey For value mapping to the server, like selecting DB.
name For field mapping to the server, like DB column field mapping.

Find the following sample server codes for defining models and controller functions to configure processing data.

    public class SubmitModel
        {
            public string Name { get; set; }
            public string PrimaryKey { get; set; }
            public string Value { get; set; }
        }
public IEnumerable<SubmitModel> UpdateData([FromBody]SubmitModel value)
        {
         // User can process data
          return value;
        }

  • Server actions successfully done, the actionSuccess event will be fired with returned server data.

  • If the server is not responding, the actionFailure event will be fired with data, but value not updated in the Editor.

In the following sample, the actionSuccess event will trigger once the value submitted successfully into the server. In this sample, both actionSuccess and actionFailure were configured and resulted value will be converted to chips.

<template>
    <div class="app">
        <table class="table-section">
            <tr>
                <td>Select frameworks </td>
                <td>
                    <ejs-inplaceeditor ref="tagObj" id="inplace_tag_editor" data-underline='false' mode="Inline"
                        type="MultiSelect" emptyText="Enter your tags" :url="serviceUrl" name='skill'
                        :value="multiValue" :model="selectModel" :actionSuccess="onActionSuccess"
                        :actionFailure="onActionFailure" :popupSettings="tagPopupSettings" adaptor='UrlAdaptor'
                        primaryKey="FrameWork">
                    </ejs-inplaceeditor>
                </td>
            </tr>
        </table>
    </div>
</template>

<script setup>
import { onMounted, provide, ref } from "vue";
import { InPlaceEditorComponent as EjsInplaceeditor, MultiSelect, ActionEventArgs } from "@syncfusion/ej2-vue-inplace-editor";

let multiData = ['Android', 'JavaScript', 'jQuery', 'TypeScript', 'Angular', 'React', 'Vue', 'Ionic'];

const tagObj = ref(null);
const selectModel = {
    mode: 'Box',
    dataSource: multiData,
    placeholder: 'Enter your tags'
};
const serviceUrl = 'https://ej2services.syncfusion.com/development/web-services/api/Editor/UpdateData';
const multiValue = ['TypeScript', 'JavaScript'];
const popupSettings = {
    model: { width: 300 }
};
const tagPopupSettings = {
    model: { width: 'auto' }
};

onMounted(function () {
    chipOnCreate(tagObj.value.ej2Instances.value);
})

const onActionSuccess = function (e) {
    e.value = chipCreation(e.value.split(','), true);
}
const onActionFailure = function (e) {
    e.value = chipCreation(e.value.split(','), false);
}
const chipOnCreate = function () {
    tagObj.value.ej2Instances.element.querySelector('.e-editable-value').innerHTML = chipCreation(tagObj.ej2Instances.value.value);
}
const chipCreation = function (data) {
    let value = '<div class="e-chip-list">';
    [].slice.call(data).forEach((val) => {
        value += '<div class="e-chip"> <span class="e-chip-text"> ' + val + '</span></div>';
    });
    value += '</div>';
    return value;
}

provide('inplaceeditor', [MultiSelect]);

</script>

<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-buttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-dropdowns/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-inputs/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-lists/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-navigations/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-popups/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-richtexteditor/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-splitbuttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-inplace-editor/styles/material.css";

.table-section {
    margin: 0 auto;
}

tr td:first-child {
    text-align: right;
    padding-right: 20px;
}
</style>
<template>
    <div class="app">
        <table class="table-section">
            <tr>
                <td>Select frameworks </td>
                <td>
                    <ejs-inplaceeditor ref="tagObj" id="inplace_tag_editor" data-underline='false' mode="Inline"
                        type="MultiSelect" emptyText="Enter your tags" :url="serviceUrl" name='skill'
                        :value="multiValue" :model="selectModel" :actionSuccess="onActionSuccess"
                        :actionFailure="onActionFailure" :popupSettings="tagPopupSettings" adaptor='UrlAdaptor'
                        primaryKey="FrameWork">
                    </ejs-inplaceeditor>
                </td>
            </tr>
        </table>
    </div>
</template>

<script>
import { InPlaceEditorComponent, MultiSelect, ActionEventArgs } from "@syncfusion/ej2-vue-inplace-editor";

export default {
    name: "App",
    components: {
        "ejs-inplaceeditor": InPlaceEditorComponent
    },
    data() {
        let multiData = ['Android', 'JavaScript', 'jQuery', 'TypeScript', 'Angular', 'React', 'Vue', 'Ionic'];
        return {
            selectModel: {
                mode: 'Box',
                dataSource: multiData,
                placeholder: 'Enter your tags'
            },
            serviceUrl: 'https://ej2services.syncfusion.com/development/web-services/api/Editor/UpdateData',
            multiValue: ['TypeScript', 'JavaScript'],
            popupSettings: {
                model: { width: 300 }
            },
            tagPopupSettings: {
                model: { width: 'auto' }
            },
        };
    },
    mounted: function () {
        this.chipOnCreate(this.$refs.tagObj.ej2Instances.value);
    },
    methods: {
        onActionSuccess: function (e) {
            e.value = this.chipCreation(e.value.split(','), true);
        },
        onActionFailure: function (e) {
            e.value = this.chipCreation(e.value.split(','), false);
        },
        chipOnCreate: function () {
            this.$refs.tagObj.ej2Instances.element.querySelector('.e-editable-value').innerHTML = this.chipCreation(this.$refs.tagObj.ej2Instances.value);
        },
        chipCreation: function (data) {
            let value = '<div class="e-chip-list">';
            [].slice.call(data).forEach((val) => {
                value += '<div class="e-chip"> <span class="e-chip-text"> ' + val + '</span></div>';
            });
            value += '</div>';
            return value;
        },
    },
    provide: {
        "inplaceeditor": [MultiSelect]
    }
}
</script>

<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-buttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-calendars/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-dropdowns/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-inputs/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-lists/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-navigations/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-popups/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-richtexteditor/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-splitbuttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-inplace-editor/styles/material.css";

.table-section {
    margin: 0 auto;
}

tr td:first-child {
    text-align: right;
    padding-right: 20px;
}
</style>

See Also