@vaadin/grid 24.2.3 → 24.3.0-alpha10

package/src/vaadin-grid-column.d.ts

@@ -3,92 +3,17 @@
  * Copyright (c) 2016 - 2023 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import type { Constructor } from '@open-wc/dedupe-mixin';
-import type { GridDefaultItem, GridItemModel } from './vaadin-grid.js';
 
-export type GridBodyRenderer<TItem> = (
-  root: HTMLElement,
-  column: GridColumn<TItem>,
-  model: GridItemModel<TItem>,
-) => void;
+import type { GridDefaultItem } from './vaadin-grid.js';
+import type {
+  GridBodyRenderer as GridMixinBodyRenderer,
+  GridColumnMixin,
+  GridHeaderFooterRenderer as GridMixinHeaderFooterRenderer,
+} from './vaadin-grid-column-mixin.js';
 
-export type GridColumnTextAlign = 'center' | 'end' | 'start' | null;
-
-export type GridHeaderFooterRenderer<TItem> = (root: HTMLElement, column: GridColumn<TItem>) => void;
-
-export declare function ColumnBaseMixin<TItem, T extends Constructor<HTMLElement>>(
-  base: T,
-): Constructor<ColumnBaseMixinClass<TItem>> & T;
-
-export declare class ColumnBaseMixinClass<TItem> {
-  /**
-   * When set to true, the column is user-resizable.
-   */
-  resizable: boolean | null | undefined;
-
-  /**
-   * When true, the column is frozen. When a column inside of a column group is frozen,
-   * all of the sibling columns inside the group will get frozen also.
-   */
-  frozen: boolean;
-
-  /**
-   * When true, the column is frozen to end of grid.
-   *
-   * When a column inside of a column group is frozen to end, all of the sibling columns
-   * inside the group will get frozen to end also.
-   *
-   * Column can not be set as `frozen` and `frozenToEnd` at the same time.
-   * @attr {boolean} frozen-to-end
-   */
-  frozenToEnd: boolean;
-
-  /**
-   * When true, the cells for this column will be rendered with the `role` attribute
-   * set as `rowheader`, instead of the `gridcell` role value used by default.
-   *
-   * When a column is set as row header, its cells will be announced by screen readers
-   * while navigating to help user identify the current row as uniquely as possible.
-   *
-   * @attr {boolean} row-header
-   */
-  rowHeader: boolean;
-
-  /**
-   * When set to true, the cells for this column are hidden.
-   */
-  hidden: boolean;
-
-  /**
-   * Text content to display in the header cell of the column.
-   */
-  header: string | null | undefined;
-
-  /**
-   * Aligns the columns cell content horizontally.
-   * Supported values: "start", "center" and "end".
-   * @attr {start|center|end} text-align
-   */
-  textAlign: GridColumnTextAlign | null | undefined;
-
-  /**
-   * Custom function for rendering the header content.
-   * Receives two arguments:
-   *
-   * - `root` The header cell content DOM element. Append your content to it.
-   * - `column` The `<vaadin-grid-column>` element.
-   */
-  headerRenderer: GridHeaderFooterRenderer<TItem> | null | undefined;
-
-  /**
-   * Custom function for rendering the footer content.
-   * Receives two arguments:
-   *
-   * - `root` The footer cell content DOM element. Append your content to it.
-   * - `column` The `<vaadin-grid-column>` element.
-   */
-  footerRenderer: GridHeaderFooterRenderer<TItem> | null | undefined;
-}
+export * from './vaadin-grid-column-mixin.js';
+export type GridBodyRenderer<TItem = GridDefaultItem> = GridMixinBodyRenderer<TItem, GridColumn<TItem>>;
+export type GridHeaderFooterRenderer<TItem = GridDefaultItem> = GridMixinHeaderFooterRenderer<TItem, GridColumn<TItem>>;
 
 /**
  * A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`
@@ -97,61 +22,9 @@ export declare class ColumnBaseMixinClass<TItem> {
  * See [`<vaadin-grid>`](#/elements/vaadin-grid) documentation for instructions on how
  * to configure the `<vaadin-grid-column>`.
  */
-declare class GridColumn<TItem = GridDefaultItem> extends HTMLElement {
-  /**
-   * Width of the cells for this column.
-   */
-  width: string | null | undefined;
-
-  /**
-   * Flex grow ratio for the cell widths. When set to 0, cell width is fixed.
-   * @attr {number} flex-grow
-   */
-  flexGrow: number;
-
-  /**
-   * Custom function for rendering the cell content.
-   * Receives three arguments:
-   *
-   * - `root` The cell content DOM element. Append your content to it.
-   * - `column` The `<vaadin-grid-column>` element.
-   * - `model` The object with the properties related with
-   *   the rendered item, contains:
-   *   - `model.index` The index of the item.
-   *   - `model.item` The item.
-   *   - `model.expanded` Sublevel toggle state.
-   *   - `model.level` Level of the tree represented with a horizontal offset of the toggle button.
-   *   - `model.selected` Selected state.
-   *   - `model.detailsOpened` Details opened state.
-   */
-  renderer: GridBodyRenderer<TItem> | null | undefined;
-
-  /**
-   * Path to an item sub-property whose value gets displayed in the column body cells.
-   * The property name is also shown in the column header if an explicit header or renderer isn't defined.
-   */
-  path: string | null | undefined;
-
-  /**
-   * Automatically sets the width of the column based on the column contents when this is set to `true`.
-   *
-   * For performance reasons the column width is calculated automatically only once when the grid items
-   * are rendered for the first time and the calculation only considers the rows which are currently
-   * rendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell
-   * content changes, the column width might not match the contents anymore.
-   *
-   * Hidden columns are ignored in the calculation and their widths are not automatically updated when
-   * you show a column that was initially hidden.
-   *
-   * You can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.
-   *
-   * The column width may still grow larger when `flexGrow` is not 0.
-   * @attr {boolean} auto-width
-   */
-  autoWidth: boolean;
-}
+declare class GridColumn<TItem = GridDefaultItem> extends HTMLElement {}
 
-interface GridColumn<TItem = GridDefaultItem> extends ColumnBaseMixinClass<TItem> {}
+interface GridColumn<TItem = GridDefaultItem> extends GridColumnMixin<TItem, GridColumn<TItem>>, HTMLElement {}
 
 declare global {
   interface HTMLElementTagNameMap {