Vue Data GridCustom Components

You can create your own Custom Components to customise the behaviour of the grid. For example you can customise how cells are rendered, how values are edited and also create your own filters.

The full list of component types you can provide in the grid are as follows:

• Cell Component: To customise the contents of a cell.
• Header Component: To customise the header of a column.
• Inner Header Component: To customise the inner header of a column.
• Header Group Component: To customise the header of a column group.
• Inner HeaderGroup Component: To customise the inner header component of a column group.
• Edit Component: To customise the editing of a cell.
• Filter Component: For custom column filter that appears inside the column menu.
• Floating Filter: For custom column floating filter that appears inside the column menu.
• Date Component: To customise the date selection component in the date filter.
• Menu Item Component: To customise the items within grid menus.
• Loading Component: To customise the loading cell row when using Server Side row model.
• Overlay Component: To customise loading and no rows overlay components.
• Status Bar Component: For custom status bar components.
• Tool Panel Component: For custom tool panel components.
• Tooltip Component: For custom cell tooltip components.

The remainder of this page gives information that is common across all the component types.

Registering Custom Components

import MyCustomerCellEditor from './App.vue'

app.component('MyCustomerCellEditor', MyCustomerCellEditor)

import MyCustomerCellEditor from './App.vue'

export default {
  components: {
    MyCustomerCellEditor
  },
  setup() {
    // ...
  }
}

<template>
  <ag-grid-vue v-model="rowData"
               :columnDefs="columnDefs"
               ...other props
  >
  </ag-grid-vue>
</template>

<script setup>
import MyCustomerCellEditor from './App.vue'

const columnDefs = ref([
    { field: "make", cellEditor: 'MyCustomerCellEditor' }
]);

...other setup

defineExpose({
    MyCustomerCellEditor    // make MyCustomerCellEditor available to the grid
})
</script>

Providing Additional Parameters

Each Custom Component gets a set of parameters from the grid. For example, for Cell Component the grid provides, among other things, the value to be rendered. You can provide additional properties to the Custom Component (e.g. what currency symbol to use) by providing additional parameters specific to your application.

To provide additional parameters, use the property [prop-name]Params, e.g. cellRendererParams.

<ag-grid-vue
    :columnDefs="columnDefs"
    /* other grid options ... */>
</ag-grid-vue>

this.columnDefs = [
    { 
        field: 'price',
        cellRenderer: PriceCellRenderer,
        cellRendererParams: {
            currency: 'EUR'
        }
    },
];

<template>
  <ag-grid-vue :components="components" 
               ...other properties>
  </ag-grid-vue>
</template>

<script>
//...other imports
import {AgGridVue} from "ag-grid-vue3";
import JavascriptComponent from './JavascriptComponent.js';
import VueComponent from './VueComponent.vue';

export default {
  components: {
      AgGridVue,
      // Vue components are registered here
      'vueComponent': VueComponent
  }
  data() {
      return {
          // JavaScript components are registered here, for when looking up component by name
          components: {
              // declare the javascript component
              'javascriptComponent': JavascriptComponent
          },          
          columnDefs: [
               {
                  headerName: "JS Cell",
                  field: "value",
                  cellRenderer: JavascriptComponent,    // reference/use the javascript component directly
              },
              {
                  headerName: "Vue Cell",
                  field: "value",
                  cellRenderer: 'vueComponent',  // reference/use the Vue component
              }
          ]
      }
  }
  //...other properties & methods
}
</script>

Child to Parent Communication

There are a variety of ways to manage component communication in Vue (shared service, local variables etc), but you often need a simple way to let a "parent" component know that something has happened on a "child" component. In this case the simplest route is to use the Grid's context feature to hold a reference to the parent, which the child can then access.

// Parent Grid Component
<template>
  <ag-grid-vue :context="context" ...other properties>
  </ag-grid-vue>
</template>

<script>
//...other imports
import {AgGridVue} from "ag-grid-vue3";
import CubeComponent from './CubeComponent.vue';

export default {
  components: {
      AgGridVue
  }
  data() {
      return {
          context: {}
      }
  },
  beforeMount() {
      this.context = {
          componentParent: this
      }
  },
  methods: {
      parentMethod() {
          // do something
      }
  }
  //...other properties & methods
}
</script>

// Child Grid Component
<template>
  <ag-grid-vue ...other properties>
  </ag-grid-vue>
</template>

<script>
//...other imports

export default {
  methods: {
      doSomethingOnGrid() {
          // the grid component can now be accessed via this.params.context.componentParent
          this.params.context.componentParent.parentMethod()
      }
  }
  //...other properties & methods
}
</script>

Note that although we've used componentParent as the property name here it can be anything - the main point is that you can use the context mechanism to share information between the components.

Component Usage

The below table gives a summary of the components, where they are configured and using what attribute.

Grid Provided Components

The grid comes with pre-registered components that can be used. Each component provided by the grid starts with the namespaces 'ag' to minimise naming conflicts with user provided components. The full list of grid provided components are in the table below.

Overriding Grid Components

It is also possible to override components. Where the grid uses a default value, this means the override component will be used instead. The default components, where overriding makes sense, are as follows:

• agDragAndDropImage: To change the default drag and drop image when dragging grid parts.
• agDateInput: To change the default date selection across all filters.
• agColumnHeader: To change the default column header across all columns.
• agColumnGroupHeader: To change the default column group header across all columns.
• agLoadingCellRenderer: To change the default loading cell renderer for Enterprise Row Model.
• agSkeletonCellRenderer: To change the default skeleton loading cell renderer for Enterprise Row Model.
• agLoadingOverlay: To change the default 'loading' overlay.
• agNoRowsOverlay: To change the default 'no rows' overlay.
• agCellEditor: To change the default cell editor.
• agDetailCellRenderer: To change the default detail panel for master / detail grids.
• agMenuItem: To change the default menu item for column and context menus.

To override the default component, register the custom component in the GridOptions components property under the above name.

const MyApp = {
    // Here is where we specify the components to be used instead of the default
    components: {
        'ag-grid-vue': AgGridVue
        agDateInput: CustomDateComponent,
        agColumnHeader: CustomHeaderComponent
    },