Add data-cy prop (#3643)

* Add `aria-description` * Add support for specifying data attributes * Merge conflict * Rest props are not safe * Update test
adazzle · Jan 7, 2025 · fc63ace · fc63ace
1 parent 071dd8f
commit fc63ace
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/src/DataGrid.tsx b/src/DataGrid.tsx
@@ -205,6 +205,7 @@ export interface DataGridProps<R, SR = unknown, K extends Key = Key> extends Sha
   /** @default 'ltr' */
   direction?: Maybe<Direction>;
   'data-testid'?: Maybe<string>;
+  'data-cy'?: Maybe<string>;
 }
 
 /**
@@ -264,7 +265,8 @@ function DataGrid<R, SR, K extends Key>(
     'aria-description': ariaDescription,
     'aria-describedby': ariaDescribedBy,
     'aria-rowcount': rawAriaRowCount,
-    'data-testid': testId
+    'data-testid': testId,
+    'data-cy': dataCy
   } = props;
 
   /**
@@ -1122,6 +1124,7 @@ function DataGrid<R, SR, K extends Key>(
       onScroll={handleScroll}
       onKeyDown={handleKeyDown}
       data-testid={testId}
+      data-cy={dataCy}
     >
       <DataGridDefaultRenderersProvider value={defaultGridComponents}>
         <HeaderRowSelectionChangeProvider value={selectHeaderRowLatest}>

diff --git a/test/browser/label.test.ts b/test/browser/label.test.ts
@@ -7,12 +7,16 @@ test('should set label and description', () => {
     'aria-label': 'label',
     'aria-labelledby': 'labelledby',
     'aria-description': 'description',
-    'aria-describedby': 'describedby'
+    'aria-describedby': 'describedby',
+    'data-testid': 'testid',
+    'data-cy': 'cy'
   });
 
   const grid = getGrid().element();
   expect(grid).toHaveAttribute('aria-label', 'label');
   expect(grid).toHaveAttribute('aria-labelledby', 'labelledby');
   expect(grid).toHaveAttribute('aria-description', 'description');
   expect(grid).toHaveAttribute('aria-describedby', 'describedby');
+  expect(grid).toHaveAttribute('data-testid', 'testid');
+  expect(grid).toHaveAttribute('data-cy', 'cy');
 });