@vaadin/grid-pro 22.0.0-alpha9 → 22.0.0

package/README.md

@@ -1,13 +1,12 @@
-# <vaadin-grid-pro>
+# @vaadin/grid-pro
 
-[Live Demo ↗](https://vaadin.com/components/vaadin-grid-pro/html-examples)
-|
-[API documentation ↗](https://vaadin.com/components/vaadin-grid-pro/html-api)
+An extension of the `vaadin-grid` component that provides inline editing with full keyboard navigation.
 
-[<vaadin-grid-pro>](https://vaadin.com/components/vaadin-grid-pro) is a high quality data grid / data table Web Component with extended functionality, part of the [Vaadin components](https://vaadin.com/components).
+> ℹ️  A commercial Vaadin [subscription](https://vaadin.com/pricing) is required to use Grid Pro in your project.
+
+[Documentation + Live Demo ↗](https://vaadin.com/docs/latest/ds/components/grid-pro)
 
 [![npm version](https://badgen.net/npm/v/@vaadin/grid-pro)](https://www.npmjs.com/package/@vaadin/grid-pro)
-[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-grid-pro)
 [![Discord](https://img.shields.io/discord/732335336448852018?label=discord)](https://discord.gg/PHmkCKC)
 
 ```html
@@ -25,41 +24,48 @@
 </script>
 ```
 
-[<img src="https://raw.githubusercontent.com/vaadin/vaadin-grid-pro/master/screenshot.png" width="900" alt="Screenshot of vaadin-grid-pro">](https://vaadin.com/components/vaadin-grid-pro)
+[<img src="https://raw.githubusercontent.com/vaadin/web-components/master/packages/grid-pro/screenshot.png" width="900" alt="Screenshot of vaadin-grid-pro">](https://vaadin.com/docs/latest/ds/components/grid-pro)
 
 ## Installation
 
-Install `vaadin-grid-pro`:
+Install the component:
 
 ```sh
-npm i @vaadin/vaadin-pro --save
+npm i @vaadin/grid-pro
 ```
 
-Once installed, import it in your application:
+Once installed, import the component in your application:
 
 ```js
-import '@vaadin/grid-pro/vaadin-grid-pro.js';
+import '@vaadin/grid-pro';
+import '@vaadin/grid-pro/vaadin-grid-pro-edit-column.js';
 ```
 
-## Getting started
-
-Vaadin components use the Lumo theme by default.
-
-To use the Material theme, import the correspondent file from the `theme/material` folder.
+## Themes
 
-## Entry points
+Vaadin components come with two built-in [themes](https://vaadin.com/docs/latest/ds/customization/using-themes), Lumo and Material.
+The [main entrypoint](https://github.com/vaadin/web-components/blob/master/packages/grid-pro/vaadin-grid-pro.js) of the package uses the Lumo theme.
 
-- The component with the Lumo theme:
+To use the Material theme, import the components from the `theme/material` folder:
 
-  `theme/lumo/vaadin-grid-pro.js`
+```js
+import '@vaadin/grid-pro/theme/material/vaadin-grid-pro.js';
+import '@vaadin/grid-pro/theme/material/vaadin-grid-pro-edit-column.js';
+```
 
-- The component with the Material theme:
+You can also import the Lumo version of the components explicitly:
 
-  `theme/material/vaadin-grid-pro.js`
+```js
+import '@vaadin/grid-pro/theme/lumo/vaadin-grid-pro.js';
+import '@vaadin/grid-pro/theme/lumo/vaadin-grid-pro-edit-column.js';
+```
 
-- Alias for `theme/lumo/vaadin-grid-pro.js`:
+Finally, you can import the un-themed components from the `src` folder to get a minimal starting point:
 
-  `vaadin-grid-pro.js`
+```js
+import '@vaadin/grid-pro/src/vaadin-grid-pro.js';
+import '@vaadin/grid-pro/src/vaadin-grid-pro-edit-column.js';
+```
 
 ## Contributing
 
@@ -69,4 +75,5 @@ Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/
 
 Commercial Vaadin Developer License 4.0 (CVDLv4). For license terms, see LICENSE.
 
-Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.
+Vaadin collects usage statistics at development time to improve this product.
+For grid-pro and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/grid-pro",
-  "version": "22.0.0-alpha9",
+  "version": "22.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -32,27 +32,28 @@
     "polymer"
   ],
   "dependencies": {
+    "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/checkbox": "22.0.0-alpha9",
-    "@vaadin/component-base": "22.0.0-alpha9",
-    "@vaadin/grid": "22.0.0-alpha9",
-    "@vaadin/item": "22.0.0-alpha9",
-    "@vaadin/list-box": "22.0.0-alpha9",
-    "@vaadin/select": "22.0.0-alpha9",
-    "@vaadin/text-field": "22.0.0-alpha9",
+    "@vaadin/checkbox": "^22.0.0",
+    "@vaadin/component-base": "^22.0.0",
+    "@vaadin/grid": "^22.0.0",
+    "@vaadin/item": "^22.0.0",
+    "@vaadin/list-box": "^22.0.0",
+    "@vaadin/select": "^22.0.0",
+    "@vaadin/text-field": "^22.0.0",
     "@vaadin/vaadin-license-checker": "^2.1.0",
-    "@vaadin/vaadin-lumo-styles": "22.0.0-alpha9",
-    "@vaadin/vaadin-material-styles": "22.0.0-alpha9",
-    "@vaadin/vaadin-themable-mixin": "22.0.0-alpha9"
+    "@vaadin/vaadin-lumo-styles": "^22.0.0",
+    "@vaadin/vaadin-material-styles": "^22.0.0",
+    "@vaadin/vaadin-themable-mixin": "^22.0.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/date-picker": "22.0.0-alpha9",
-    "@vaadin/dialog": "22.0.0-alpha9",
-    "@vaadin/polymer-legacy-adapter": "22.0.0-alpha9",
-    "@vaadin/testing-helpers": "^0.3.0",
+    "@vaadin/date-picker": "^22.0.0",
+    "@vaadin/dialog": "^22.0.0",
+    "@vaadin/polymer-legacy-adapter": "^22.0.0",
+    "@vaadin/testing-helpers": "^0.3.2",
     "lit": "^2.0.0",
     "sinon": "^9.2.1"
   },
-  "gitHead": "6e8c899dc65918f97e3c0acb2076122c4b2ef274"
+  "gitHead": "b668e9b1a975227fbe34beb70d1cd5b03dce2348"
 }

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

@@ -4,8 +4,8 @@
  * This program is available under Commercial Vaadin Developer License 4.0 (CVDLv4).
  * See <a href="https://vaadin.com/license/cvdl-4.0">the website</a> for the complete license.
  */
+import { GridBodyRenderer, GridDefaultItem, GridItemModel } from '@vaadin/grid/src/vaadin-grid.js';
 import { GridColumn } from '@vaadin/grid/src/vaadin-grid-column.js';
-import { GridDefaultItem, GridBodyRenderer, GridItemModel } from '@vaadin/grid/src/vaadin-grid.js';
 
 export type GridProEditorType = 'text' | 'checkbox' | 'select' | 'custom';
 
@@ -70,15 +70,13 @@ declare class GridProEditColumn<TItem = GridDefaultItem> extends GridColumn<TIte
    */
   editorValuePath: string;
 
-  _getEditorTagName(cell: HTMLElement): string;
+  protected _getEditorComponent(cell: HTMLElement): HTMLElement | null;
 
-  _getEditorComponent(cell: HTMLElement): HTMLElement | null;
+  protected _getEditorValue(editor: HTMLElement): unknown | null;
 
-  _getEditorValue(editor: HTMLElement): unknown | null;
+  protected _startCellEdit(cell: HTMLElement, model: GridItemModel<TItem>): void;
 
-  _startCellEdit(cell: HTMLElement, model: GridItemModel<TItem>): void;
-
-  _stopCellEdit(cell: HTMLElement, model: GridItemModel<TItem>): void;
+  protected _stopCellEdit(cell: HTMLElement, model: GridItemModel<TItem>): void;
 }
 
 declare global {

package/src/vaadin-grid-pro-edit-column.js

@@ -4,11 +4,11 @@
  * This program is available under Commercial Vaadin Developer License 4.0 (CVDLv4).
  * See <a href="https://vaadin.com/license/cvdl-4.0">the website</a> for the complete license.
  */
-import { get, set } from '@polymer/polymer/lib/utils/path.js';
-import { GridColumn } from '@vaadin/grid/src/vaadin-grid-column.js';
 import './vaadin-grid-pro-edit-checkbox.js';
 import './vaadin-grid-pro-edit-select.js';
 import './vaadin-grid-pro-edit-text-field.js';
+import { get, set } from '@polymer/polymer/lib/utils/path.js';
+import { GridColumn } from '@vaadin/grid/src/vaadin-grid-column.js';
 
 /**
  * `<vaadin-grid-pro-edit-column>` is a helper element for the `<vaadin-grid-pro>`

package/src/vaadin-grid-pro-edit-select.js

@@ -4,9 +4,9 @@
  * This program is available under Commercial Vaadin Developer License 4.0 (CVDLv4).
  * See <a href="https://vaadin.com/license/cvdl-4.0">the website</a> for the complete license.
  */
-import { Select } from '@vaadin/select/src/vaadin-select.js';
 import '@vaadin/item/src/vaadin-item.js';
 import '@vaadin/list-box/src/vaadin-list-box.js';
+import { Select } from '@vaadin/select/src/vaadin-select.js';
 
 /**
  * An element used internally by `<vaadin-grid-pro>`. Not intended to be used separately.
@@ -44,9 +44,6 @@ class GridProEditSelect extends Select {
     super.ready();
 
     this.setAttribute('theme', 'grid-pro-editor');
-
-    this.__boundOnKeyDown = this.__onOverlayKeyDown.bind(this);
-    this._overlayElement.addEventListener('keydown', this.__boundOnKeyDown);
   }
 
   _onKeyDown(e) {
@@ -61,10 +58,25 @@ class GridProEditSelect extends Select {
     }
   }
 
-  __onOverlayKeyDown(e) {
-    if (e.keyCode === 9) {
-      !this._grid.singleCellEdit && this._grid._switchEditCell(e);
+  /**
+   * Override list-box event listener inherited from `Select`:
+   * - Enter: set flag for moving to next row on value change,
+   * - Tab: switch to next cell when "singleCellEdit" is false.
+   * @param {!KeyboardEvent} event
+   * @protected
+   * @override
+   */
+  _onKeyDownInside(event) {
+    if (event.keyCode === 13) {
+      this._enterKeydown = event;
+    }
+
+    if (event.keyCode === 9) {
+      !this._grid.singleCellEdit && this._grid._switchEditCell(event);
     }
+
+    // Call `super` to close overlay on Tab.
+    super._onKeyDownInside(event);
   }
 
   _valueChanged(value, oldValue) {
@@ -100,13 +112,6 @@ class GridProEditSelect extends Select {
           listBox.appendChild(item);
         });
 
-        // save the "keydown" event for Enter
-        listBox.addEventListener('keydown', (e) => {
-          if (e.keyCode === 13) {
-            this._enterKeydown = e;
-          }
-        });
-
         root.appendChild(listBox);
       };
 

package/src/vaadin-grid-pro-inline-editing-mixin.d.ts

@@ -4,14 +4,13 @@
  * This program is available under Commercial Vaadin Developer License 4.0 (CVDLv4).
  * See <a href="https://vaadin.com/license/cvdl-4.0">the website</a> for the complete license.
  */
+import { Constructor } from '@open-wc/dedupe-mixin';
 
-declare function InlineEditingMixin<T extends new (...args: any[]) => {}>(base: T): T & InlineEditingMixinConstructor;
+export declare function InlineEditingMixin<T extends Constructor<HTMLElement>>(
+  base: T
+): T & Constructor<InlineEditingMixinClass>;
 
-interface InlineEditingMixinConstructor {
-  new (...args: any[]): InlineEditingMixin;
-}
-
-interface InlineEditingMixin {
+export declare class InlineEditingMixinClass {
   /**
    * When true, pressing Enter while in cell edit mode
    * will move focus to the editable cell in the next row
@@ -37,11 +36,7 @@ interface InlineEditingMixin {
    */
   editOnClick: boolean | null | undefined;
 
-  _checkImports(): void;
+  protected _stopEdit(shouldCancel?: boolean, shouldRestoreFocus?: boolean): void;
 
-  _stopEdit(shouldCancel?: boolean, shouldRestoreFocus?: boolean): void;
-
-  _switchEditCell(e: KeyboardEvent): void;
+  protected _switchEditCell(e: KeyboardEvent): void;
 }
-
-export { InlineEditingMixin, InlineEditingMixinConstructor };

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

@@ -4,9 +4,8 @@
  * This program is available under Commercial Vaadin Developer License 4.0 (CVDLv4).
  * See <a href="https://vaadin.com/license/cvdl-4.0">the website</a> for the complete license.
  */
-import { GridDefaultItem, Grid, GridCustomEventMap } from '@vaadin/grid/src/vaadin-grid.js';
-import { InlineEditingMixin } from './vaadin-grid-pro-inline-editing-mixin.js';
-
+import { Grid, GridCustomEventMap, GridDefaultItem } from '@vaadin/grid/src/vaadin-grid.js';
+import { InlineEditingMixinClass } from './vaadin-grid-pro-inline-editing-mixin.js';
 export { GridProEditorType } from './vaadin-grid-pro-edit-column.js';
 
 /**
@@ -76,8 +75,6 @@ export interface GridProEventMap<TItem>
  * @fires {CustomEvent} selected-items-changed - Fired when the `selectedItems` property changes.
  */
 declare class GridPro<TItem = GridDefaultItem> extends Grid<TItem> {
-  static _finalizeClass(): void;
-
   addEventListener<K extends keyof GridProEventMap<TItem>>(
     type: K,
     listener: (this: GridPro<TItem>, ev: GridProEventMap<TItem>[K]) => void,
@@ -91,7 +88,7 @@ declare class GridPro<TItem = GridDefaultItem> extends Grid<TItem> {
   ): void;
 }
 
-interface GridPro extends InlineEditingMixin {}
+interface GridPro extends InlineEditingMixinClass {}
 
 declare global {
   interface HTMLElementTagNameMap {

package/src/vaadin-grid-pro.js

@@ -4,9 +4,9 @@
  * This program is available under Commercial Vaadin Developer License 4.0 (CVDLv4).
  * See <a href="https://vaadin.com/license/cvdl-4.0">the website</a> for the complete license.
  */
+import '@vaadin/vaadin-license-checker/vaadin-license-checker.js';
 import { Grid } from '@vaadin/grid/src/vaadin-grid.js';
 import { InlineEditingMixin } from './vaadin-grid-pro-inline-editing-mixin.js';
-import '@vaadin/vaadin-license-checker/vaadin-license-checker.js';
 
 /**
  *

package/theme/lumo/vaadin-grid-pro-edit-select-styles.js

@@ -1,6 +1,6 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
 import '@vaadin/vaadin-lumo-styles/spacing.js';
 import '@vaadin/vaadin-lumo-styles/typography.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 import { gridProEditor } from './vaadin-grid-pro-editor-styles.js';
 
 const gridProEditSelect = css`

package/theme/lumo/vaadin-grid-pro-edit-text-field-styles.js

@@ -1,4 +1,4 @@
-import { registerStyles } from '@vaadin/vaadin-themable-mixin/register-styles.js';
+import { registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 import { gridProEditor } from './vaadin-grid-pro-editor-styles.js';
 
 registerStyles('vaadin-grid-pro-edit-text-field', gridProEditor, {

package/theme/lumo/vaadin-grid-pro-editor-styles.js

@@ -1,7 +1,7 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
 import '@vaadin/vaadin-lumo-styles/color.js';
 import '@vaadin/vaadin-lumo-styles/spacing.js';
 import '@vaadin/vaadin-lumo-styles/typography.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
 const gridProEditor = css`
   :host([theme~='grid-pro-editor']) {

package/theme/lumo/vaadin-grid-pro-styles.js

@@ -1,5 +1,6 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
 import '@vaadin/vaadin-lumo-styles/color.js';
+import '@vaadin/vaadin-lumo-styles/style.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
 registerStyles(
   'vaadin-grid-pro',
@@ -14,6 +15,41 @@ registerStyles(
       pointer-events: none;
       box-shadow: inset 0 0 0 2px var(--lumo-primary-color-50pct);
     }
+
+    [part~='editable-cell'],
+    [part~='editable-cell'] ::slotted(vaadin-grid-cell-content) {
+      cursor: var(--lumo-clickable-cursor);
+    }
+
+    [part~='editable-cell']:hover,
+    [part~='editable-cell']:focus {
+      background-color: var(--lumo-contrast-5pct);
+      background-clip: padding-box;
+    }
+
+    /* Indicate editable cells */
+
+    :host([theme~='highlight-editable-cells']) [part~='editable-cell'] {
+      background-color: var(--lumo-contrast-5pct);
+      background-clip: border-box;
+    }
+
+    :host([theme~='highlight-editable-cells']) [part~='editable-cell']:hover,
+    :host([theme~='highlight-editable-cells']) [part~='editable-cell']:focus {
+      background-color: var(--lumo-contrast-10pct);
+    }
+
+    /* Indicate read-only cells */
+
+    :host([theme~='highlight-read-only-cells']) [part~='body-cell']:not([part~='editable-cell']) {
+      background-image: repeating-linear-gradient(
+        135deg,
+        transparent,
+        transparent 6px,
+        var(--lumo-contrast-5pct) 6px,
+        var(--lumo-contrast-5pct) 14px
+      );
+    }
   `,
   { moduleId: 'lumo-grid-pro' }
 );

package/theme/material/vaadin-grid-pro-edit-select-styles.js

@@ -1,4 +1,4 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 import { gridProEditor } from './vaadin-grid-pro-editor-styles.js';
 
 const gridProEditSelect = css`

package/theme/material/vaadin-grid-pro-edit-text-field-styles.js

@@ -1,4 +1,4 @@
-import { registerStyles } from '@vaadin/vaadin-themable-mixin/register-styles.js';
+import { registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 import { gridProEditor } from './vaadin-grid-pro-editor-styles.js';
 
 registerStyles('vaadin-grid-pro-edit-text-field', gridProEditor, {

package/theme/material/vaadin-grid-pro-editor-styles.js

@@ -1,4 +1,4 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
 const gridProEditor = css`
   :host([theme~='grid-pro-editor']) {

package/theme/material/vaadin-grid-pro-styles.js

@@ -1,6 +1,6 @@
-import { registerStyles, css } from '@vaadin/vaadin-themable-mixin/register-styles.js';
 import '@vaadin/vaadin-material-styles/color.js';
 import '@vaadin/grid/theme/material/vaadin-grid-styles.js';
+import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 
 registerStyles(
   'vaadin-grid-pro',
@@ -8,6 +8,17 @@ registerStyles(
     :host([navigating]) [part~='cell']:active {
       box-shadow: inset 0 0 0 2px var(--material-primary-color);
     }
+
+    [part~='editable-cell'],
+    [part~='editable-cell'] ::slotted(vaadin-grid-cell-content) {
+      cursor: pointer;
+    }
+
+    [part~='row'] > [part~='editable-cell']:hover,
+    [part~='row'] > [part~='editable-cell']:focus {
+      background-color: var(--material-grid-pro-editable-cell-hover-background-color, rgba(0, 0, 0, 0.04));
+      background-clip: padding-box;
+    }
   `,
   { moduleId: 'material-grid-pro' }
 );