docs: add note about em unit in the column width jsdoc (#7443) (C…

…P: 24.4) (#7444) * docs: add note about `em` unit in the column `width` jsdoc * docs: add mention to the type declaration Co-authored-by: Diego Cardoso <diego@vaadin.com>
vaadin · May 24, 2024 · 0d0e84a · 0d0e84a
1 parent fb43b2d
commit 0d0e84a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/packages/grid/src/vaadin-grid-column-mixin.d.ts b/packages/grid/src/vaadin-grid-column-mixin.d.ts
@@ -118,6 +118,11 @@ export declare class GridColumnMixinClass<
 > extends ColumnBaseMixinClass<TItem, Column> {
   /**
    * Width of the cells for this column.
+   *
+   * Please note that using the `em` length unit is discouraged as
+   * it might lead to misalignment issues if the header, body, and footer
+   * cells have different font sizes. Instead, use `rem` if you need
+   * a length unit relative to the font size.
    */
   width: string | null | undefined;
 

diff --git a/packages/grid/src/vaadin-grid-column-mixin.js b/packages/grid/src/vaadin-grid-column-mixin.js
@@ -852,6 +852,11 @@ export const GridColumnMixin = (superClass) =>
       return {
         /**
          * Width of the cells for this column.
+         *
+         * Please note that using the `em` length unit is discouraged as
+         * it might lead to misalignment issues if the header, body, and footer
+         * cells have different font sizes. Instead, use `rem` if you need
+         * a length unit relative to the font size.
          */
         width: {
           type: String,