package.src.vaadin-grid-sort-column.d.ts Maven / Gradle / Ivy

Go to download
/**
 * @license
 * Copyright (c) 2016 - 2023 Vaadin Ltd.
 * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
 */
import type { GridDefaultItem } from './vaadin-grid.js';
import type { GridColumn, GridColumnMixin } from './vaadin-grid-column.js';
import type { GridSortColumnEventMap, GridSortColumnMixinClass } from './vaadin-grid-sort-column-mixin.js';

export * from './vaadin-grid-sort-column-mixin.js';

/**
 * `` is a helper element for the ``
 * that provides default header renderer and functionality for sorting.
 *
 * #### Example:
 * ```html
 * 
 *  
 *
 *  
 *    ...
 * ```
 */
declare class GridSortColumn extends HTMLElement {}

interface GridSortColumn
  extends GridSortColumnMixinClass,
    GridColumnMixin>,
    GridColumn {
  addEventListener(
    type: K,
    listener: (this: GridSortColumn, ev: GridSortColumnEventMap[K]) => void,
    options?: AddEventListenerOptions | boolean,
  ): void;

  removeEventListener(
    type: K,
    listener: (this: GridSortColumn, ev: GridSortColumnEventMap[K]) => void,
    options?: EventListenerOptions | boolean,
  ): void;
}

declare global {
  interface HTMLElementTagNameMap {
    'vaadin-grid-sort-column': GridSortColumn;
  }
}

export { GridSortColumn };