Rename textEditor to renderTextEditor (#3908)

* Rename `textEditor` to `renderTextEditor`

* Cleanup types

* Revret 1 change

* Tweak import

* rename test file

* Combine import

* Combine import statements

Author: amanmahajan7

README.md

@@ -743,20 +743,20 @@ const columns: readonly Column<Row>[] = [
 ];
 ```
 
-#### `textEditor<TRow, TSummaryRow>(props: RenderEditCellProps<TRow, TSummaryRow>)`
+#### `renderTextEditor<TRow, TSummaryRow>(props: RenderEditCellProps<TRow, TSummaryRow>)`
 
 A basic text editor provided for convenience.
 
 **Example:**
 
 ```tsx
-import { textEditor, type Column } from 'react-data-grid';
+import { renderTextEditor, type Column } from 'react-data-grid';
 
 const columns: readonly Column<Row>[] = [
   {
     key: 'title',
     name: 'Title',
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   }
 ];
 ```

src/editors/textEditor.tsx renamed to src/editors/renderTextEditor.tsx

@@ -38,7 +38,7 @@ function autoFocusAndSelect(input: HTMLInputElement | null) {
   input?.select();
 }
 
-export default function textEditor<TRow, TSummaryRow>({
+export default function textTextEditor<TRow, TSummaryRow>({
   row,
   column,
   onRowChange,

src/index.ts

@@ -12,7 +12,7 @@ export { default as Row } from './Row';
 export { default as Cell } from './Cell';
 export * from './Columns';
 export * from './cellRenderers';
-export { default as textEditor } from './editors/textEditor';
+export { default as renderTextEditor } from './editors/renderTextEditor';
 export { default as renderHeaderCell } from './renderHeaderCell';
 export { renderSortIcon, renderSortPriority } from './sortStatus';
 export { useRowSelection, useHeaderRowSelection } from './hooks';
@@ -34,6 +34,7 @@ export type {
   ColumnOrColumnGroup,
   ColumnWidth,
   ColumnWidths,
+  Direction,
   FillEvent,
   RenderCellProps,
   RenderCheckboxProps,

test/browser/TreeDataGrid.test.tsx

@@ -2,7 +2,7 @@ import { useState } from 'react';
 import { page, userEvent } from 'vitest/browser';
 
 import type { Column } from '../../src';
-import { SelectColumn, textEditor, TreeDataGrid } from '../../src';
+import { renderTextEditor, SelectColumn, TreeDataGrid } from '../../src';
 import { focusSinkClassname } from '../../src/style/core';
 import { rowSelected } from '../../src/style/row';
 import {
@@ -40,7 +40,7 @@ const columns: readonly Column<Row, SummaryRow>[] = [
   {
     key: 'country',
     name: 'Country',
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'year',

test/browser/TextEditor.test.tsx renamed to test/browser/renderTextEditor.test.tsx

@@ -1,7 +1,7 @@
 import { useState } from 'react';
 import { page, userEvent } from 'vitest/browser';
 
-import { DataGrid, textEditor } from '../../src';
+import { DataGrid, renderTextEditor } from '../../src';
 import type { Column } from '../../src';
 
 interface Row {
@@ -12,7 +12,7 @@ const columns: readonly Column<Row>[] = [
   {
     key: 'name',
     name: 'Name',
-    renderEditCell: textEditor,
+    renderEditCell: renderTextEditor,
     editorOptions: {
       commitOnOutsideClick: false
     }
@@ -26,7 +26,7 @@ function Test() {
   return <DataGrid columns={columns} rows={rows} onRowsChange={setRows} />;
 }
 
-test('TextEditor', async () => {
+test('renderTextEditor', async () => {
   await page.render(<Test />);
   const cell = page.getByRole('gridcell');
   await expect.element(cell).toHaveTextContent(/^Tacitus Kilgore$/);

website/routes/AllFeatures.tsx

@@ -3,9 +3,9 @@ import { faker } from '@faker-js/faker';
 import { css } from '@linaria/core';
 import clsx from 'clsx';
 
-import { DataGrid, SelectColumn, textEditor } from '../../src';
+import { DataGrid, renderTextEditor, SelectColumn } from '../../src';
 import type { CalculatedColumn, CellCopyArgs, CellPasteArgs, Column, FillEvent } from '../../src';
-import { textEditorClassname } from '../../src/editors/textEditor';
+import { textEditorClassname } from '../../src/editors/renderTextEditor';
 import { useDirection } from '../directionContext';
 
 export const Route = createFileRoute({
@@ -132,71 +132,71 @@ const columns: readonly Column<Row>[] = [
     width: 200,
     resizable: true,
     frozen: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'lastName',
     name: 'Last Name',
     width: 200,
     resizable: true,
     frozen: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'email',
     name: 'Email',
     width: 'max-content',
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'street',
     name: 'Street',
     width: 200,
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'zipCode',
     name: 'ZipCode',
     width: 200,
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'date',
     name: 'Date',
     width: 200,
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'bs',
     name: 'bs',
     width: 200,
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'catchPhrase',
     name: 'Catch Phrase',
     width: 'max-content',
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'companyName',
     name: 'Company Name',
     width: 200,
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   },
   {
     key: 'sentence',
     name: 'Sentence',
     width: 'max-content',
     resizable: true,
-    renderEditCell: textEditor
+    renderEditCell: renderTextEditor
   }
 ];
 

website/routes/Animation.tsx

@@ -1,8 +1,7 @@
 import { useState } from 'react';
 import { css } from '@linaria/core';
 
-import { DataGrid } from '../../src';
-import type { Column } from '../../src';
+import { DataGrid, type Column } from '../../src';
 import { useDirection } from '../directionContext';
 
 export const Route = createFileRoute({

website/routes/ColumnGrouping.tsx

@@ -1,5 +1,4 @@
-import { DataGrid } from '../../src';
-import type { ColumnOrColumnGroup } from '../../src';
+import { DataGrid, type ColumnOrColumnGroup } from '../../src';
 import { renderCoordinates } from '../renderers';
 import { useDirection } from '../directionContext';
 

website/routes/ColumnSpanning.tsx

@@ -1,7 +1,6 @@
 import { css } from '@linaria/core';
 
-import { DataGrid } from '../../src';
-import type { Column } from '../../src';
+import { DataGrid, type Column } from '../../src';
 import { renderCoordinates } from '../renderers';
 import { useDirection } from '../directionContext';
 

website/routes/ColumnsReordering.tsx

@@ -1,7 +1,6 @@
 import { useCallback, useMemo, useState } from 'react';
 
-import { DataGrid } from '../../src';
-import type { Column, ColumnWidths, SortColumn } from '../../src';
+import { DataGrid, type Column, type ColumnWidths, type SortColumn } from '../../src';
 import { startViewTransition } from '../utils';
 import { useDirection } from '../directionContext';