# Editors

**index**

* [Inline Editors](#how-to-use-inline-editors)
  * [Demo with Float Editor & Dollar Formatter](#demo-with-float-editor-and-dollar-currency-formatter)
  * [Editor `outputType` and `saveOutputType`](#editor-output-type--save-output-type)
  * [Custom Editor](#custom-inline-editor)
* [Perform an Action after Inline Edit](#perform-an-action-after-inline-edit)
* [How to prevent Editor from going to the next bottom cell](#how-to-prevent-editor-from-going-to-the-next-bottom-cell)
* [onClick Action Editor (icon click)](#onclick-action-editor-icon-click)
* [AutoComplete Editor](#autocomplete-editor)
* [Select (single/multi) Editors](#select-editors)
  * [Editor Options (multipleSelectOption interface)](#editor-options-multipleselectoption-interface)
  * [Collection Async Load](#collection-async-load)
  * [Collection Label Prefix/Suffix](#collection-label-prefixsuffix)
  * [Collection Label Render HTML](#collection-label-render-html)
  * [`multiple-select.js` Options](#multiple-selectjs-options)
* [Editor Options](#editor-options)
* [Validators](#validators)
  * [Custom Validator](#custom-validator)
* [Disabling specific cell Edit](#disabling-specific-cell-edit)
* [Editors on Mobile Phone](#editors-on-mobile-phone)
* [Dynamically Change Column Editor](#dynamically-change-column-editor)

### Description

`slickgrid-vue` ships with a few default inline editors (checkbox, dateEditor, float, integer, text, longText). You can see the full list [here](https://github.com/ghiscoding/slickgrid-universal/blob/master/ghiscoding/slickgrid-vue/tree/master/src/slickgrid-vue/editors/README.md).

**Note:** For the Float Editor, you can provide decimal places with `params: { decimalPlaces: 2 }` to your column definition else it will be 0 decimal places by default.

#### Required Grid Option

Editors won't work without these 2 flags `enableCellNavigation: true` and `editable: true` enabled in your Grid Options, so make sure to always to always defined them. Also note that you can toggle the grid to read only (not editable) via the `editable` grid option flag.

#### Demo

**with plain JavaScript**

[Demo Page](https://ghiscoding.github.io/slickgrid-vue-demos/#/Example3) / [Demo ViewModel](https://github.com/ghiscoding/slickgrid-universal/blob/master/demos/vue/src/components/Example3.vue)

**with Vue Custom Components**

[Demo](https://ghiscoding.github.io/slickgrid-vue/#/slickgrid) / [Demo ViewModel](https://github.com/ghiscoding/slickgrid-universal/blob/master/demos/vue/src/components/Example26.vue)

#### How to use Inline Editors

Simply call the editor in your column definition with the `Editors` you want, as for example (`editor: { model: Editors.text }`). Here is an example with a full column definition:

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
    { id: 'title', name: 'Title', field: 'title', editor: { model: Editors.longText } },
    { id: 'duration', name: 'Duration (days)', field: 'duration', type: 'number', editor: { model: Editors.text } },
    { id: 'complete', name: '% Complete', field: 'percentComplete', type: 'number', editor: { model: Editors.integer } },
    { id: 'start', name: 'Start', field: 'start', type: 'date', editor: { model: Editors.date } },
    {
      id: 'finish', name: 'Finish', field: 'finish', type: 'date',
      editor: {
        model: Editors.date,

        // you can also add an optional placeholder
        placeholder: 'choose a date'
      }
    },
    {
      id: 'effort-driven', name: 'Effort Driven', field: 'effortDriven', formatter: Formatters.checkmarkMaterial,
      type: 'number', editor: { model: Editors.checkbox }
    }
  ];

  gridOptions.value = {
    enableCellNavigation: true, // <<-- VERY IMPORTANT, it won't work without this flag enabled
    editable: true,
  };
}
</script>
```

**Demo with Float Editor and Dollar Currency Formatter**

This probably comes often, so here's all the setting you would need for displaying & editing a dollar currency value with 2 decimal places.

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
    {
      id: 'cost', name: 'Cost', field: 'cost',
      type: 'float',
      formatter: Formatters.dollar, // the Dollar Formatter will default to 2 decimals unless you provide a minDecimal/maxDecimal
      // params: { minDecimal: 2, maxDecimal: 4, }, // optionally provide different decimal places

      // the float editor has its own settings, `decimal` that will be used only in the editor
      // note: that it has nothing to do with the Dollar Formatter
      editor: { model: Editors.float, decimal: 2 },
    },
  ];
}
</script>
```

**Editor Output Type & Save Output Type**

You could also define an `outputType` and a `saveOutputType` to an inline editor. There is only 1 built-in Editor with this functionality for now which is the `dateEditor`. For example, on a date field, we can call this `outputType: 'dateIso'` (by default it uses `dateUtc` as the output):

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
   {
     id: 'start', name: 'Start', field: 'start',
     type: 'date',
     editor: { model: Editors.date },
     type: 'date',              // dataset cell input format
     // outputType: 'dateUs',   // date picker format
     saveOutputType: 'dateUtc', // save output date format
    }
  ];
}
</script>
```

So to make it more clear, the `saveOutputType` is the format that will be sent to the `onCellChange` event, then the `outputType` is how the date will show up in the date picker (Vanilla-Calendar) and finally the `type` is basically the input format (coming from your dataset). Note however that each property are cascading, if 1 property is missing it will go to the next one until 1 is found... for example, on the `onCellChange` if you aren't defining `saveOutputType`, it will try to use `outputType`, if again none is provided it will try to use `type` and finally if none is provided it will use `'dateIso'` as the default.

### Perform an action After Inline Edit

**Recommended way**

What is ideal is to bind to a SlickGrid Event, for that you can take a look at this [Wiki - On Events](../events/grid-dataview-events)

**Not recommended**

You could also, perform an action after the item changed event with `onCellChange`. However, this is not the recommended way, since it would require to add a `onCellChange` on every every single column definition.

### Custom Inline Editor

To create a Custom Editor, you need to create a `class` that will extend the [`Editors` interface](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/common/src/interfaces/editor.interface.ts) and then use it in your grid with `editor: { model: myCustomEditor }` and that should be it.

**To use dependency injection with an `Editor` make sure your Vue dependencies are before the `args` constructor parameter. `args` must be the last parameter in your constructor because we wrap all `Editors` in Vue's `Factory` resolver so DI can work with slickgrid `Editors`**

Once you are done with the class, just reference it's class name as the `editor`, for example:

**Class implementing Editor**

```ts
export class IntegerEditor implements Editor {
  constructor(private args: any) {
    init();
  }

  init(): void {}
  destroy() {}
  focus() {}
  loadValue(item: any) {}
  serializeValue() {}
  applyValue(item: any, state: any) {}
  isValueChanged() {}
  validate() {}
}
```

**Use it in your Column Definition**

For Custom Editor class example, take a look at [custom-inputEditor.ts](https://github.com/ghiscoding/slickgrid-universal/blob/master/demos/vue/src/components/custom-inputEditor.ts)

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
    {
      id: 'title2', name: 'Title, Custom Editor', field: 'title',
      editor: {
        model: CustomInputEditor // reference your custom editor class
      },
    }
  ];
}
</script>
```

### How to prevent Editor from going to the next bottom cell?

The default behavior or SlickGrid is to go to the next cell at the bottom of the current cell that you are editing. You can change and remove this behavior by enabling `autoCommitEdit` which will save current editor and remain in the same cell

```vue
<script setup lang="ts">
function defineGrid() {
  gridOptions.value = {
    autoCommitEdit: true,
    editable: true,
  }
}
</script>
```

### OnClick Action Editor (icon click)

Instead of an inline editor, you might want to simply click on an edit icon that could call a modal window, or a redirect URL, or whatever you wish to do. For that you can use the inline `onCellClick` event and define a callback function for the action (you could also create your own [Custom Formatter](formatters)).

* The `Formatters.editIcon` will give you a pen icon, while a `Formatters.deleteIcon` is an "x" icon

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
     {
        id: 'edit', field: 'id',
        formatter: Formatters.editIcon,
        maxWidth: 30,
        onCellClick: (args: OnEventArgs) => {
          console.log(args);
        }
     },
     // ...
  ];
}
</script>
```

The `args` returned to the `onCellClick` callback is of type `OnEventArgs` which is the following:

```ts
export interface OnEventArgs {
  row: number;
  cell: number;
  columnDef: Column;
  dataContext: any;
  dataView: any;
  grid: any;
  gridDefinition: GridOption;
}
```

### AutoComplete Editor

The AutoComplete Editor has the same configuration (except for the `model: Editors.autoComplete`) as the AutoComplete Filter, so you can refer to the [AutoComplete Filter - Docs](filter-intro/autocomplete-filter) for more info on how to use it.

### Select Editors

The library ships with two select editors: [singleSelectEditor](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/common/src/editors/singleSelectEditor.ts) and the [multipleSelectEditor](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/common/src/editors/multipleSelectEditor.ts). Both support the [multiple-select-vanilla](https://github.com/ghiscoding/multiple-select-vanilla) library, but fallback to the bootstrap form-control style if you decide to exclude this library from your build. These editors will work with a list of foreign key values (custom structure not supported) and can be displayed properly with the [collectionFormatter](https://github.com/ghiscoding/slickgrid-universal/blob/master/packages/common/src/formatters/collectionEditorFormatter.ts). [example 3](https://ghiscoding.github.io/slickgrid-vue-demos/#/Example3) has all the details for you to get started with these editors.

Here's an example with a `collection`, `collectionFilterBy` and `collectionSortBy`

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
    {
      id: 'prerequisites', name: 'Prerequisites', field: 'prerequisites',
      editor: {
        model: Editors.multipleSelect,
        collection: Array.from(Array(12).keys()).map(k => ({ value: `Task ${k}`, label: `Task ${k}` })),
        collectionSortBy: {
          property: 'label',
          sortDesc: true
        },
        collectionFilterBy: {
          property: 'label',
          value: 'Task 2'
        }
      }
    }
  ];
}
</script>
```

#### Editor Options (`MultipleSelectOption` interface)

All the available options that can be provided as editor `options` to your column definitions can be found under this [MultipleSelectOption](https://github.com/ghiscoding/multiple-select-vanilla/blob/main/packages/multiple-select-vanilla/src/models/multipleSelectOption.interface.ts) interface and you should cast your editor `options` to that interface to make sure that you use only valid options of the `multiple-select.js` library.

```ts
editor: {
  model: Editors.SingleSelect,
  // previously known as `editorOptions` for < 9.0
  options: {
    maxHeight: 400
  } as MultipleSelectOption
}
```

#### Collection Async Load

You can also load the collection asynchronously, but for that you will have to use the `collectionAsync` property, which expect a Promise to be passed (it actually accepts 3 types: `HttpClient`, `FetchClient` or regular `Promise`).

**Load the collection through an Http call**

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
      {
      id: 'prerequisites', name: 'Prerequisites', field: 'prerequisites',
      filterable: true,
      editor: {
        collectionAsync: fetch('api/data/pre-requisites'),
        model: Editors.multipleSelect,
      }
    }
  ];
}
</script>
```

**Modifying the collection afterward**

If you want to modify the collection afterward, you simply need to find the associated Column reference from the Column Definition and modify the `collection` property (not `collectionAsync` since that is only meant to be used on page load).

For example

```vue
<script setup lang="ts">
function addItem() {
  const lastRowIndex = dataset.length;
  const newRows = mockData(1, lastRowIndex);

  // wrap into a timer to simulate a backend async call
  setTimeout(() => {
    const requisiteColumnDef = columnDefinitions.find((column: Column) => column.id === 'prerequisites');
    if (requisiteColumnDef) {
      const editorCollection = requisiteColumnDef.editor.collection;

      if (Array.isArray(collection )) {
        // add the new row to the grid
        vueGrid.gridService.addItemToDatagrid(newRows[0]);

        // then refresh the Filter "collection", we have 2 ways of doing it

        // 1- Push to the Filter "collection"
        editorCollection.push({ value: lastRowIndex, label: lastRowIndex, prefix: 'Task' });

        // or 2- replace the entire "collection"
        // editorCollection = [...collection, ...[{ value: lastRowIndex, label: lastRowIndex }]];
      }
    }
  }, 250);
}
</script>
```

#### Collection Label Prefix/Suffix

You can use `labelPrefix` and/or `labelSuffix` which will concatenate the multiple properties together (`labelPrefix` + `label` + `labelSuffix`) which will used by each Select Filter option label. You can also use the property `separatorBetweenTextLabels` to define a separator between prefix, label & suffix.

**Note**\
If `enableTranslateLabel` flag is set to `True`, it will also try to translate the Prefix / Suffix / OptionLabel texts.

For example, say you have this collection

```ts
const currencies = [
  { symbol: '$', currency: 'USD', country: 'USA' },
  { symbol: '$', currency: 'CAD', country: 'Canada' }
];
```

You can display all of these properties inside your dropdown labels, say you want to show (symbol with abbreviation and country name). Now you can.

So you can create the `multipleSelect` Filter with a `customStructure` by using the symbol as prefix, and country as suffix. That would make up something like this:

* $ USD USA
* $ CAD Canada

with a `customStructure` defined as

```ts
editor: {
  collection: currencies,
  customStructure: {
    value: 'currency',
    label: 'currency',
    labelPrefix: 'symbol',
    labelSuffix: 'country',
  collectionOptions: {
    separatorBetweenTextLabels: ' ', // add white space between each text
    includePrefixSuffixToSelectedValues: true // should the selected value include the prefix/suffix in the output format
  },
  model: Editors.multipleSelect
}
```

#### Collection Label Render HTML

By default HTML is not rendered and the `label` will simply show HTML as text. But in some cases you might want to render it, you can do so by enabling the `enableRenderHtml` flag.

**NOTE:** this is currently only used by the Editors that have a `collection` which are the `MultipleSelect` & `SingleSelect` Editors.

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
    {
      id: 'effort-driven', name: 'Effort Driven', field: 'effortDriven',
      formatter: Formatters.checkmarkMaterial,
      type: 'boolean',
      editor: {
        // display checkmark icon when True
        enableRenderHtml: true,
        collection: [{ value: '', label: '' }, { value: true, label: 'True', labelPrefix: `<i class="mdi mdi-check"></i> ` }, { value: false, label: 'False' }],
        model: Editors.singleSelect
      }
    }
  ];
}
</script>
```

#### `multiple-select` Options

You can use any options from [Multiple-Select-Vanilla](https://github.com/ghiscoding/multiple-select-vanilla) and add them to your editor `options` property.

Couple of small options were added to suit slickgrid-vue needs, which is why it points to `slickgrid-vue/lib` folder (which is our customized version of the original). This lib is required if you plan to use `multipleSelect` or `singleSelect` Filters. What was customized to (compare to the original) is the following:

* `okButton` option was added to add an OK button for simpler closing of the dropdown after selecting multiple options.
  * `okButtonText` was also added for locale (i18n)
* `offsetLeft` option was added to make it possible to offset the dropdown. By default it is set to 0 and is aligned to the left of the select element. This option is particularly helpful when used as the last right column, not to fall off the screen.
* `autoDropWidth` option was added to automatically resize the dropdown with the same width as the select filter element.
* `autoAdjustDropHeight` (defaults to true), when set will automatically adjust the drop (up or down) height
* `autoAdjustDropPosition` (defaults to true), when set will automatically calculate the area with the most available space and use best possible choise for the drop to show (up or down)
* `autoAdjustDropWidthByTextSize` (defaults to true), when set will automatically adjust the drop (up or down) width by the text size (it will use largest text width)
* to extend the previous 3 autoAdjustX flags, the following options can be helpful
  * `minWidth` (defaults to null, to use when `autoAdjustDropWidthByTextSize` is enabled)
  * `maxWidth` (defaults to 500, to use when `autoAdjustDropWidthByTextSize` is enabled)
  * `adjustHeightPadding` (defaults to 10, to use when `autoAdjustDropHeight` is enabled), when using `autoAdjustDropHeight` we might want to add a bottom (or top) padding instead of taking the entire available space
  * `maxHeight` (defaults to 275, to use when `autoAdjustDropHeight` is enabled)

**Code**

```vue
<script setup lang="ts">
function defineGrid() {
  columnDefinitions.value = [
    {
      id: 'isActive', name: 'Is Active', field: 'isActive',
      filterable: true,
      editor: {
        collection: [{ value: '', label: '' }, { value: true, label: 'true' }, { value: false, label: 'false' }],
        model: Editors.singleSelect,
        elementOptions: {
          // add any multiple-select.js options (from original or custom version)
          autoAdjustDropPosition: false, // by default set to True, but you can disable it
          position: 'top'
        }
      }
    }
  ];
}
</script>
```

### Editor Options

**Column Editor `options`**

Some of the Editors could receive extra options, which is mostly the case for Editors using external dependencies (e.g. `autocompleter`, `date`, `multipleSelect`, ...) you can provide options via the editor `options`, for example

```ts
columnDefinitions.value = [{
  id: 'start', name: 'Start Date', field: 'start',
  editor: {
    model: Editors.date,
    // previously known as `editorOptions` for < 9.0
    options: { displayDateMin: 'today' } as VanillaCalendarOption
  }
}];
```

**Grid Option \`defaultEditorOptions**

You could also define certain options as a global level (for the entire grid or even all grids) by taking advantage of the `defaultEditorOptions` Grid Option. Note that they are set via the editor type as a key name (`autocompleter`, `date`, ...) and then the content is the same as editor `options` (also note that each key is already typed with the correct editor option interface), for example

```ts
gridOptions.value = {
  defaultEditorOptions: {
    autocompleter: { debounceWaitMs: 150 }, // typed as AutocompleterOption
    date: { displayDateMin: 'today' }, // typed as VanillaCalendarOption,
    longText: { cols: 50, rows: 5 }
  }
}
```

### Validators

Each Editor needs to implement the `validate()` method which will be executed and validated before calling the `save()` method. Most Editor will simply validate that the value passed is correctly formed. The Float Editor is one of the more complex one and will first check if the number is a valid float then also check if `minValue` or `maxValue` was passed and if so validate against them. If any errors is found it will return an object of type `EditorValidatorOutput` (see the signature on top).

#### Custom Validator

If you want more complex validation then you can implement your own Custom Validator as long as it implements the following signature.

```ts
export type EditorValidator = (value: any, args?: EditorArgs) => EditorValidatorOutput;
```

So the `value` can be anything but the `args` is interesting since it provides multiple properties that you can hook into, which are the following

```ts
export interface EditorArgs {
  column: Column;
  container: any;
  grid: any;
  gridPosition: ElementPosition;
  item: any;
  position: ElementPosition;
  cancelChanges?: () => void;
  commitChanges?: () => void;
}
```

And finally the Validator Output has the following signature

```ts
export interface EditorValidatorOutput {
  valid: boolean;
  msg?: string | null;
}
```

So if we take all of these informations and we want to create our own Custom Editor to validate a Title field, we could create something like this:

```ts
const myCustomTitleValidator: EditorValidator = (value: any, args: EditorArgs) => {
  // you can get the Editor Args which can be helpful, e.g. we can get the Translate Service from it
  const grid = args && args.grid;
  const gridOptions = (grid && grid.getOptions) ? grid.getOptions() : {};
  const i18n = gridOptions.i18n;

  if (value == null || value === undefined || !value.length) {
    return { valid: false, msg: 'This is a required field' };
  } else if (!/^Task\s\d+$/.test(value)) {
    return { valid: false, msg: 'Your title is invalid, it must start with "Task" followed by a number' };
    // OR use the Translate Service with your custom message
    // return { valid: false, msg: i18n.tr('YOUR_ERROR', { x: value }) };
  } else {
    return { valid: true, msg: '' };
  }
};
```

and use it in our Columns Definition like this:

```ts
columnDefinition.value = [
  {
    id: 'title', name: 'Title', field: 'title',
    editor: {
      model: Editors.longText,
      validator: myCustomTitleValidator, // use our custom validator
    },
    onCellChange: (e: Event, args: OnEventArgs) => {
      // do something
      console.log(args.dataContext.title);
    }
  }
];
```

### Disabling specific cell edit

This can be answered by searching on Stack Overflow Stack Overflow and this is the best [answer](https://stackoverflow.com/questions/10491676/disabling-specific-cell-edit-in-slick-grid) found.

More info can be found in this [Docs - Grid & DataView Events](../events/grid-dataview-events).

With that in mind and the code from the SO answer, we end up with the following code.

**View**

```vue
<script setup lang="ts">
import { type Column, Filters, Formatters, OperatorType, SlickgridVue, SortDirection } from 'slickgrid-vue';
import { onBeforeMount, type Ref } from 'vue';

const gridOptions = ref<GridOption>();
const columnDefinitions: Ref<Column[]> = ref([]);
const dataset = ref<any[]>([]);
const isAutoEdit = ref(false);
let vueGrid: SlickgridVueInstance;

onBeforeMount(() => {
  defineGrid();
});

function defineGrid() {
}

/** Change dynamically `autoEdit` grid options */
function setAutoEdit(autoEdit) {
  isAutoEdit.value = autoEdit;
  vueGrid.slickGrid.setOptions({ autoEdit: autoEdit }); // change the grid option dynamically
  return true;
}
</script>

<template>
  <slickgrid-vue
    grid-id="grid1"
    v-model:columns="columnDefinitions"
    v-model:options="gridOptions"
    v-model:data="dataset"
    @onvueGridCreated="vueGridReady($event.detail)"
  ></slickgrid-vue>
</template>
```

#### Editors on Mobile Phone

If your grid uses the `autoResize` and you use Editors in your grid on a mobile phone, Android for example, you might have undesired behaviors. It might call a grid resize (and lose input focus) since the touch keyboard appears. This in term, is a bad user experience to your user, but there is a way to avoid this, you could use the `pauseResizer`

**Component**

```vue
<script setup lang="ts">
function vueGridReady(vueGrid: SlickgridVueInstance) {
  vueGrid = vueGrid;
}

function onAfterEditCell($event) {
  // resume autoResize feature,  and after leaving cell editing mode
  // force a resize to make sure the grid fits the current dimensions
  vueGrid.resizerService.pauseResizer(false);
  vueGrid.resizerService.resizeGrid();
}

function onBeforeEditCell($event) {
  vueGrid.resizerService.pauseResizer(true);
}
</script>

<template>
  <slickgrid-vue
    grid-id="grid3"
    v-model:columns="columnDefinitions"
    v-model:options="gridOptions"
    v-model:data="dataset"
    @onvueGridCreated="vueGridReady(e.detail)"
    @onBeforeEditCell="onBeforeEditCell($event.detail.eventData, $event.detail.args)"
    @onBeforeCellEditorDestroy="onAfterEditCell($event.detail.eventData, $event.detail.args)"
    @onCellChange="onCellChanged(e.detail.eventData, e.detail.args)"
    @onClick="onCellClicked(e.detail.eventData, e.detail.args)"
    @onValidationError="onCellValidationError(e.detail.eventData, e.detail.args)"
    ></slickgrid-vue>
</template>
```

### Turning individual rows into edit mode

Using the [Row Based Editing Plugin](../grid-functionalities/row-based-edit) you can let the user toggle either one or multiple rows into edit mode, keep track of cell changes and either discard or save them on an individual basis using a custom `onBeforeRowUpdated` hook.

### Dynamically change Column Editor

You can dynamically change a column editor by taking advantage of the `onBeforeEditCell` event and change the editor just before the cell editor opens. However please note that the library keeps 2 references and you need to update both references as shown below.

With the code sample shown below, we are using an input checkbox to toggle the Editor between `Editors.longText` to `Editors.text` and vice/versa

```ts
function changeToInputTextEditor(checked: boolean) {
    isInputTextEditor = checked;
}

function handleOnBeforeEditCell(args: CustomEvent<OnBeforeEditCellEventArgs>) {
  const args = event?.detail?.args;
  const { grid, column } = args;
  column.editor.model = isInputTextEditor ? Editors.text : Editors.longText;
  column.editorClass = column.editor.model;
  return true;
}
```
