@vaadin/grid 24.2.0-dev.f254716fe → 24.3.0-alpha2

package/src/vaadin-grid-sorter.js

@@ -4,23 +4,10 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
-
-const template = document.createElement('template');
-
-template.innerHTML = `
-  <style>
-    @font-face {
-      font-family: 'vaadin-grid-sorter-icons';
-      src: url(data:application/font-woff;charset=utf-8;base64,d09GRgABAAAAAAQwAA0AAAAABuwAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABGRlRNAAAEFAAAABkAAAAcfep+mUdERUYAAAP4AAAAHAAAAB4AJwAOT1MvMgAAAZgAAAA/AAAAYA8TBPpjbWFwAAAB7AAAAFUAAAFeF1fZ4mdhc3AAAAPwAAAACAAAAAgAAAAQZ2x5ZgAAAlgAAABcAAAAnMvguMloZWFkAAABMAAAAC8AAAA2C5Ap72hoZWEAAAFgAAAAHQAAACQGbQPHaG10eAAAAdgAAAAUAAAAHAoAAABsb2NhAAACRAAAABIAAAASAIwAYG1heHAAAAGAAAAAFgAAACAACwAKbmFtZQAAArQAAAECAAACZxWCgKhwb3N0AAADuAAAADUAAABZCrApUXicY2BkYGAA4rDECVrx/DZfGbhZGEDgyqNPOxH0/wNMq5kPALkcDEwgUQBWRA0dAHicY2BkYGA+8P8AAwMLAwgwrWZgZEAFbABY4QM8AAAAeJxjYGRgYOAAQiYGEICQSAAAAi8AFgAAeJxjYGY6yziBgZWBgWkm0xkGBoZ+CM34msGYkZMBFTAKoAkwODAwvmRiPvD/AIMDMxCD1CDJKjAwAgBktQsXAHicY2GAAMZQCM0EwqshbAALxAEKeJxjYGBgZoBgGQZGBhCIAPIYwXwWBhsgzcXAwcAEhIwMCi+Z/v/9/x+sSuElA4T9/4k4K1gHFwMMMILMY2QDYmaoABOQYGJABUA7WBiGNwAAJd4NIQAAAAAAAAAACAAIABAAGAAmAEAATgAAeJyNjLENgDAMBP9tIURJwQCMQccSZgk2i5fIYBDAidJjycXr7x5EPwE2wY8si7jmyBNXGo/bNBerxJNrpxhbO3/fEFpx8ZICpV+ghxJ74fAMe+h7Ox14AbrsHB14nK2QQWrDMBRER4mTkhQK3ZRQKOgCNk7oGQqhhEIX2WSlWEI1BAlkJ5CDdNsj5Ey9Rncdi38ES+jzNJo/HwTgATcoDEthhY3wBHc4CE+pfwsX5F/hGe7Vo/AcK/UhvMSz+mGXKhZU6pww8ISz3oWn1BvhgnwTnuEJf8Jz1OpFeIlX9YULDLdFi4ASHolkSR0iuYdjLak1vAequBhj21D61Nqyi6l3qWybGPjySbPHGScGJl6dP58MYcQRI0bts7mjebBqrFENH7t3qWtj0OuqHnXcW7b0HOTZFnKryRGW2hFX1m0O2vEM3opNMfTau+CS6Z3Vx6veNnEXY6jwDxhsc2gAAHicY2BiwA84GBgYmRiYGJkZmBlZGFkZ2djScyoLMgzZS/MyDQwMwLSrpYEBlIbxjQDrzgsuAAAAAAEAAf//AA94nGNgZGBg4AFiMSBmYmAEQnYgZgHzGAAD6wA2eJxjYGBgZACCKyoz1cD0o087YTQATOcIewAAAA==) format('woff');
-      font-weight: normal;
-      font-style: normal;
-    }
-  </style>
-`;
-
-document.head.appendChild(template.content);
+import { GridSorterMixin } from './vaadin-grid-sorter-mixin.js';
 
 /**
  * `<vaadin-grid-sorter>` is a helper element for the `<vaadin-grid>` that provides out-of-the-box UI controls,
@@ -61,51 +48,15 @@ document.head.appendChild(template.content);
  * @fires {CustomEvent} direction-changed - Fired when the `direction` property changes.
  * @fires {CustomEvent} sorter-changed - Fired when the `path` or `direction` property changes.
  *
+ * @customElement
  * @extends HTMLElement
+ * @mixes GridSorterMixin
+ * @mixes ThemableMixin
+ * @mixes DirMixin
  */
-class GridSorter extends ThemableMixin(DirMixin(PolymerElement)) {
+class GridSorter extends GridSorterMixin(ThemableMixin(DirMixin(PolymerElement))) {
   static get template() {
     return html`
-      <style>
-        :host {
-          display: inline-flex;
-          cursor: pointer;
-          max-width: 100%;
-        }
-
-        [part='content'] {
-          flex: 1 1 auto;
-        }
-
-        [part='indicators'] {
-          position: relative;
-          align-self: center;
-          flex: none;
-        }
-
-        [part='order'] {
-          display: inline;
-          vertical-align: super;
-        }
-
-        [part='indicators']::before {
-          font-family: 'vaadin-grid-sorter-icons';
-          display: inline-block;
-        }
-
-        :host(:not([direction])) [part='indicators']::before {
-          content: '\\e901';
-        }
-
-        :host([direction='asc']) [part='indicators']::before {
-          content: '\\e900';
-        }
-
-        :host([direction='desc']) [part='indicators']::before {
-          content: '\\e902';
-        }
-      </style>
-
       <div part="content">
         <slot></slot>
       </div>
@@ -118,133 +69,8 @@ class GridSorter extends ThemableMixin(DirMixin(PolymerElement)) {
   static get is() {
     return 'vaadin-grid-sorter';
   }
-
-  static get properties() {
-    return {
-      /**
-       * JS Path of the property in the item used for sorting the data.
-       */
-      path: String,
-
-      /**
-       * How to sort the data.
-       * Possible values are `asc` to use an ascending algorithm, `desc` to sort the data in
-       * descending direction, or `null` for not sorting the data.
-       * @type {GridSorterDirection | undefined}
-       */
-      direction: {
-        type: String,
-        reflectToAttribute: true,
-        notify: true,
-        value: null,
-      },
-
-      /**
-       * @type {number | null}
-       * @protected
-       */
-      _order: {
-        type: Number,
-        value: null,
-      },
-
-      /** @private */
-      _isConnected: {
-        type: Boolean,
-        observer: '__isConnectedChanged',
-      },
-    };
-  }
-
-  static get observers() {
-    return ['_pathOrDirectionChanged(path, direction)'];
-  }
-
-  /** @protected */
-  ready() {
-    super.ready();
-    this.addEventListener('click', this._onClick.bind(this));
-  }
-
-  /** @protected */
-  connectedCallback() {
-    super.connectedCallback();
-    this._isConnected = true;
-  }
-
-  /** @protected */
-  disconnectedCallback() {
-    super.disconnectedCallback();
-    this._isConnected = false;
-
-    if (!this.parentNode && this._grid) {
-      this._grid.__removeSorters([this]);
-    }
-  }
-
-  /** @private */
-  _pathOrDirectionChanged() {
-    this.__dispatchSorterChangedEvenIfPossible();
-  }
-
-  /** @private */
-  __isConnectedChanged(newValue, oldValue) {
-    if (oldValue === false) {
-      return;
-    }
-
-    this.__dispatchSorterChangedEvenIfPossible();
-  }
-
-  /** @private */
-  __dispatchSorterChangedEvenIfPossible() {
-    if (this.path === undefined || this.direction === undefined || !this._isConnected) {
-      return;
-    }
-
-    this.dispatchEvent(
-      new CustomEvent('sorter-changed', {
-        detail: { shiftClick: Boolean(this._shiftClick), fromSorterClick: Boolean(this._fromSorterClick) },
-        bubbles: true,
-        composed: true,
-      }),
-    );
-    // Cleaning up as a programatically sorting can be done after some user interaction
-    this._fromSorterClick = false;
-    this._shiftClick = false;
-  }
-
-  /** @private */
-  _getDisplayOrder(order) {
-    return order === null ? '' : order + 1;
-  }
-
-  /** @private */
-  _onClick(e) {
-    if (e.defaultPrevented) {
-      // Something else has already handled the click event, do nothing.
-      return;
-    }
-
-    const activeElement = this.getRootNode().activeElement;
-    if (this !== activeElement && this.contains(activeElement)) {
-      // Some focusable content inside the sorter was clicked, do nothing.
-      return;
-    }
-
-    e.preventDefault();
-    this._shiftClick = e.shiftKey;
-    this._fromSorterClick = true;
-    if (this.direction === 'asc') {
-      this.direction = 'desc';
-    } else if (this.direction === 'desc') {
-      this.direction = null;
-    } else {
-      this.direction = 'asc';
-    }
-  }
 }
 
-customElements.define(GridSorter.is, GridSorter);
+defineCustomElement(GridSorter);
 
 export { GridSorter };

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

@@ -0,0 +1,19 @@
+/**
+ * @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 { Constructor } from '@open-wc/dedupe-mixin';
+import type { GridColumn } from './vaadin-grid-column.js';
+
+export declare function GridTreeColumnMixin<TItem, T extends Constructor<GridColumn>>(
+  superclass: T,
+): Constructor<GridTreeColumnMixinClass<TItem>> & T;
+
+export declare class GridTreeColumnMixinClass<TItem> {
+  /**
+   * JS Path of the property in the item used as text content for the tree toggle.
+   */
+  path: string | null | undefined;
+}

package/src/vaadin-grid-tree-column-mixin.js

@@ -0,0 +1,92 @@
+/**
+ * @license
+ * Copyright (c) 2016 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { get } from '@vaadin/component-base/src/path-utils.js';
+
+/**
+ * @polymerMixin
+ */
+export const GridTreeColumnMixin = (superClass) =>
+  class extends superClass {
+    static get properties() {
+      return {
+        /**
+         * JS Path of the property in the item used as text content for the tree toggle.
+         */
+        path: String,
+      };
+    }
+
+    static get observers() {
+      return ['_onRendererOrBindingChanged(_renderer, _cells, _bodyContentHidden, _cells.*, path)'];
+    }
+
+    constructor() {
+      super();
+
+      this.__boundOnExpandedChanged = this.__onExpandedChanged.bind(this);
+    }
+
+    /**
+     * Renders the grid tree toggle to the body cell
+     *
+     * @private
+     */
+    __defaultRenderer(root, _column, { item, expanded, level }) {
+      let toggle = root.firstElementChild;
+      if (!toggle) {
+        toggle = document.createElement('vaadin-grid-tree-toggle');
+        toggle.addEventListener('expanded-changed', this.__boundOnExpandedChanged);
+        root.appendChild(toggle);
+      }
+
+      toggle.__item = item;
+      toggle.__rendererExpanded = expanded;
+      toggle.expanded = expanded;
+      toggle.leaf = this.__isLeafItem(item, this._grid.itemHasChildrenPath);
+      toggle.textContent = this.__getToggleContent(this.path, item);
+      toggle.level = level;
+    }
+
+    /**
+     * The tree column doesn't allow to use a custom renderer
+     * to override the content of body cells.
+     * It always renders the grid tree toggle to body cells.
+     *
+     * @override
+     */
+    _computeRenderer() {
+      return this.__defaultRenderer;
+    }
+
+    /**
+     * Expands or collapses the row once the tree toggle is switched.
+     * The listener handles only user-fired events.
+     *
+     * @private
+     */
+    __onExpandedChanged(e) {
+      // Skip if the state is changed by the renderer.
+      if (e.detail.value === e.target.__rendererExpanded) {
+        return;
+      }
+
+      if (e.detail.value) {
+        this._grid.expandItem(e.target.__item);
+      } else {
+        this._grid.collapseItem(e.target.__item);
+      }
+    }
+
+    /** @private */
+    __isLeafItem(item, itemHasChildrenPath) {
+      return !item || !item[itemHasChildrenPath];
+    }
+
+    /** @private */
+    __getToggleContent(path, item) {
+      return path && get(path, item);
+    }
+  };

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

@@ -4,7 +4,8 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import type { GridDefaultItem } from './vaadin-grid.js';
-import { GridColumn } from './vaadin-grid-column.js';
+import type { GridColumn, GridColumnMixin } from './vaadin-grid-column.js';
+import type { GridTreeColumnMixinClass } from './vaadin-grid-tree-column-mixin.js';
 
 /**
  * `<vaadin-grid-tree-column>` is a helper element for the `<vaadin-grid>`
@@ -19,12 +20,13 @@ import { GridColumn } from './vaadin-grid-column.js';
  *    ...
  * ```
  */
-declare class GridTreeColumn<TItem = GridDefaultItem> extends GridColumn<TItem> {
-  /**
-   * JS Path of the property in the item used as text content for the tree toggle.
-   */
-  path: string | null | undefined;
-}
+
+declare class GridTreeColumn<TItem = GridDefaultItem> extends HTMLElement {}
+
+interface GridTreeColumn<TItem = GridDefaultItem>
+  extends GridTreeColumnMixinClass<TItem>,
+    GridColumnMixin<TItem, GridTreeColumn<TItem>>,
+    GridColumn<TItem> {}
 
 declare global {
   interface HTMLElementTagNameMap {

package/src/vaadin-grid-tree-column.js

@@ -4,7 +4,9 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import './vaadin-grid-tree-toggle.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { GridColumn } from './vaadin-grid-column.js';
+import { GridTreeColumnMixin } from './vaadin-grid-tree-column-mixin.js';
 
 /**
  * `<vaadin-grid-tree-column>` is a helper element for the `<vaadin-grid>`
@@ -18,93 +20,16 @@ import { GridColumn } from './vaadin-grid-column.js';
  *  <vaadin-grid-column>
  *    ...
  * ```
+ * @customElement
+ * @extends GridColumn
+ * @mixes GridTreeColumnMixin
  */
-class GridTreeColumn extends GridColumn {
+class GridTreeColumn extends GridTreeColumnMixin(GridColumn) {
   static get is() {
     return 'vaadin-grid-tree-column';
   }
-
-  static get properties() {
-    return {
-      /**
-       * JS Path of the property in the item used as text content for the tree toggle.
-       */
-      path: String,
-    };
-  }
-
-  static get observers() {
-    return ['_onRendererOrBindingChanged(_renderer, _cells, _bodyContentHidden, _cells.*, path)'];
-  }
-
-  constructor() {
-    super();
-
-    this.__boundOnExpandedChanged = this.__onExpandedChanged.bind(this);
-  }
-
-  /**
-   * Renders the grid tree toggle to the body cell
-   *
-   * @private
-   */
-  __defaultRenderer(root, _column, { item, expanded, level }) {
-    let toggle = root.firstElementChild;
-    if (!toggle) {
-      toggle = document.createElement('vaadin-grid-tree-toggle');
-      toggle.addEventListener('expanded-changed', this.__boundOnExpandedChanged);
-      root.appendChild(toggle);
-    }
-
-    toggle.__item = item;
-    toggle.__rendererExpanded = expanded;
-    toggle.expanded = expanded;
-    toggle.leaf = this.__isLeafItem(item, this._grid.itemHasChildrenPath);
-    toggle.textContent = this.__getToggleContent(this.path, item);
-    toggle.level = level;
-  }
-
-  /**
-   * The tree column doesn't allow to use a custom renderer
-   * to override the content of body cells.
-   * It always renders the grid tree toggle to body cells.
-   *
-   * @override
-   */
-  _computeRenderer() {
-    return this.__defaultRenderer;
-  }
-
-  /**
-   * Expands or collapses the row once the tree toggle is switched.
-   * The listener handles only user-fired events.
-   *
-   * @private
-   */
-  __onExpandedChanged(e) {
-    // Skip if the state is changed by the renderer.
-    if (e.detail.value === e.target.__rendererExpanded) {
-      return;
-    }
-
-    if (e.detail.value) {
-      this._grid.expandItem(e.target.__item);
-    } else {
-      this._grid.collapseItem(e.target.__item);
-    }
-  }
-
-  /** @private */
-  __isLeafItem(item, itemHasChildrenPath) {
-    return !item || !item[itemHasChildrenPath];
-  }
-
-  /** @private */
-  __getToggleContent(path, item) {
-    return path && this.get(path, item);
-  }
 }
 
-customElements.define(GridTreeColumn.is, GridTreeColumn);
+defineCustomElement(GridTreeColumn);
 
 export { GridTreeColumn };

package/src/vaadin-grid-tree-toggle.js

@@ -4,6 +4,7 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 import { isFocusable } from './vaadin-grid-active-item-mixin.js';
@@ -71,6 +72,7 @@ document.head.appendChild(template.content);
  *
  * @fires {CustomEvent} expanded-changed - Fired when the `expanded` property changes.
  *
+ * @customElement
  * @extends HTMLElement
  * @mixes ThemableMixin
  */
@@ -207,6 +209,6 @@ class GridTreeToggle extends ThemableMixin(DirMixin(PolymerElement)) {
   }
 }
 
-customElements.define(GridTreeToggle.is, GridTreeToggle);
+defineCustomElement(GridTreeToggle);
 
 export { GridTreeToggle };