---
title: "Large Text Cell Editor"
framework: javascript
version: "36.1.0"
---

# Large Text Cell Editor

Simple editor that uses the standard HTML `textarea`, allowing users to enter text shown over multiple lines.

## Enabling Large Text Cell Editor

Edit any cell in the grid below to see the Large Text Cell Editor.

#### Large Text Editor

```ts
import {
  ClientSideRowModelModule,
  ColDef,
  GridApi,
  GridOptions,
  LargeTextEditorModule,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  LargeTextEditorModule,
]);

const columnDefs: ColDef[] = [
  {
    headerName: "Large Text Editor",
    field: "description",
    cellEditor: "agLargeTextCellEditor",
    cellEditorPopup: true,
  },
];

const data = Array.from(Array(20).keys()).map(() => {
  return {
    description:
      "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
  };
});

let gridApi: GridApi;

const gridOptions: GridOptions = {
  defaultColDef: {
    flex: 1,
    editable: true,
  },
  columnDefs: columnDefs,
  rowData: data,
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);
```

[Live example: Large Text Editor](https://www.ag-grid.com/examples/provided-cell-editors-large-text/large-text-editor/typescript)

Enabled with `agLargeTextCellEditor` and configured with `ILargeTextEditorParams`.

```js
columnDefs: [
    {
        cellEditor: 'agLargeTextCellEditor',
        cellEditorPopup: true,
        cellEditorParams: {
            maxLength: 100
        }
        // ...other props
    }
]
```

## Customisation

### Editor Size

The width and height of the Large Text Cell Editor can be customised. Edit any cell in the grid below to see the editor displayed with a modified size.

#### Large Text Editor Cols and Rows

```ts
import {
  ClientSideRowModelModule,
  ColDef,
  GridApi,
  GridOptions,
  ILargeTextEditorParams,
  LargeTextEditorModule,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  LargeTextEditorModule,
]);

const columnDefs: ColDef[] = [
  {
    headerName: "Large Text Editor",
    field: "description",
    cellEditor: "agLargeTextCellEditor",
    cellEditorPopup: true,
    cellEditorParams: {
      rows: 15,
      cols: 50,
    } as ILargeTextEditorParams,
  },
];

const data = Array.from(Array(20).keys()).map(() => {
  return {
    description:
      "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
  };
});

let gridApi: GridApi;

const gridOptions: GridOptions = {
  defaultColDef: {
    flex: 1,
    editable: true,
  },
  columnDefs: columnDefs,
  rowData: data,
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);
```

[Live example: Large Text Editor Cols and Rows](https://www.ag-grid.com/examples/provided-cell-editors-large-text/large-text-editor-cols-rows/typescript)

To customise the size, there are two options:

- `cols`: The average number of characters displayed.
- `rows`: The number of lines of text displayed.

```js
columnDefs: [
    {
        cellEditor: 'agLargeTextCellEditor',
        cellEditorPopup: true,
        cellEditorParams: {
            rows: 15,
            cols: 50
        }
        // ...other props
    }
]
```

## API Reference

Properties available on the `ILargeTextEditorParams` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `maxLength` | `number` |  | `200` | Max number of characters to allow. |
| `rows` | `number` |  | `10` | Number of character rows to display. |
| `cols` | `number` |  | `60` | Number of character columns to display. |