prop documentation of behavior

elastic · Oct 17, 2024 · ce84874 · ce84874
1 parent 29b913a
commit ce84874
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/eui/src/components/datagrid/data_grid_types.ts b/packages/eui/src/components/datagrid/data_grid_types.ts
@@ -349,6 +349,10 @@ export type CommonGridProps = CommonProps &
     sorting?: EuiDataGridSorting;
     /**
      * A callback for when a column's size changes. Callback receives `{ columnId: string, width: number }`.
+     *
+     * When an `onColumnResize` function is passed, `columns[].initialWidth` behaves like a
+     * controlled (rather than uncontrolled) prop, and can be used to completely manage column
+     * widths even after initial mount.
      */
     onColumnResize?: EuiDataGridOnColumnResizeHandler;
     /**