fin-hypergrid - npm Package Compare versions

Comparing version 3.0.2 to 3.0.3

package.json

 {
   "name": "fin-hypergrid",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Canvas-based high-performance grid",
@@ -5,0 +5,0 @@ "main": "src/Hypergrid",

README.md

@@ -11,3 +11,3 @@ [![Build Status](https://travis-ci.org/openfin/fin-hypergrid.svg?branch=develop)](https://travis-ci.org/openfin/fin-hypergrid)
 ## Table of Contents
-* [Current Release](#current-release-301---10-july-2018)
+* [Current Release](#current-release-302---25-September-2018)
 * [Distribution](#distribution)
@@ -21,3 +21,3 @@ * [Demos](#demos)
 
-### Current Release (3.0.1 - 10 July 2018)
+### Current Release (3.0.3 - 25 September 2018)
 
@@ -30,12 +30,24 @@ **Hypergrid 3.0 includes a revised data model with some breaking changes.**
 
-#### npm module
-Published as a CommonJS module to npmjs.org. Specify SEMVER `"fin-hypergrid": "3.0.1"` (or `"^3.0.1"`) in your package.json file, issue the `npm install` command, and let your bundler (wepback, Browserify) do the rest.
+#### npm module _(recommended)_
+Published as a CommonJS module to npmjs.org.
+Specify a <a href="https://semver.org/">SEMVER</a> of `"fin-hypergrid": "3.0.3"` (or `"^3.0.3"`) in your package.json file,
+issue the `npm install` command, and let your bundler (<a target="webpack" href="https://webpack.js.org/">wepback</a>,
+<a target="browserify" href="http://browserify.org/">Browserify</a>) create a single file containing both Hypergrid and your application.
 
-#### Build file
-Published as a pre-bundled build file, which contains a JavaScript [IIFE](https://en.wikipedia.org/wiki/Immediately-invoked_function_expression) that creates (as needed) the global namespace `window.fin` and populates `window.fin.Hypergrid`. See the [CDN index](https://fin-hypergrid.github.io#index) for links.
+#### Build files _(for small and informal examples and proofs-of-concept)_
+Also published as pre-bundled build files (`fin-hypergrid.js` and `fin-hypergrid.min.js`) to the GitHub CDN.
+See the [CDN index](https://fin-hypergrid.github.io#index) for links.
 
-### Hypergrid demos
+Contains a JavaScript [IIFE](https://en.wikipedia.org/wiki/Immediately-invoked_function_expression)
+that creates (as needed) the global namespace `window.fin` and populates `window.fin.Hypergrid`.
+Your application would load one of these pre-bundled build files (in a `<script>` tag),
+plus each of its own modules (or a single bundled build of all of its own its own modules).
 
-The [`fin-hypergrid/build`](https://github.com/fin-hypergrid/build) repo imports (via `require`) Hypergrid to generate the build files. It also hosts the demo source files that test and show off various Hypergrid features. Some of these use the npm module while others use the build file. Working versions of all demos are published to the CDN ([list of links](https://fin-hypergrid.github.io#demos)).
+### Demos
 
+_The [`fin-hypergrid/build`](https://github.com/fin-hypergrid/build) repo generates the build files.
+It also hosts the demo source files that test and show off various Hypergrid features.
+Some of these use the npm module while others use the bundled build file.
+Working versions of all demos are published to the CDN ([list of links](https://fin-hypergrid.github.io#demos))._
+
 #### Testbench
@@ -45,2 +57,6 @@
 
+(This app bundles the npm module plus all of its own modules together into a single file (`testbench.js`).
+For illustrative purposes, [this alternate version](https://fin-hypergrid.github.io/core/demo/hypermods.html) loads
+the pre-bundled build file `fin-hypergrid.js` plus specially IIFE-wrapped versions of each its own modules discretely.)
+
 #### Simple example
@@ -47,0 +63,0 @@

src/behaviors/Behavior.js

@@ -414,3 +414,3 @@ 'use strict';
     /**
-     *
+     * @memberOf Behavior#
      * @param {Object} properties - assignable grid properties
@@ -417,0 +417,0 @@ * @param {boolean} [settingState] - Clear properties object before assignments.

src/cellEditors/CellEditor.js

@@ -296,2 +296,3 @@ /* eslint-env browser */
         this.el.remove();
+        this.grid.takeFocus();
 
@@ -298,0 +299,0 @@ return true;

src/defaults.js

@@ -820,9 +820,13 @@ 'use strict';
      * @summary Mappings for cell navigation keys.
-     * @desc Cell navigation is handled in the {@link CellSelection} "feature". This property gives you control over which keypresses the built-in mechanism will respond to.
+     * @desc Cell navigation is handled in the {@link CellSelection} "feature".
+     * This property gives you control over which key presses the built-in mechanism will respond to.
      *
-     * (If this built-in cell selection logic is insufficient for your needs, you can also listen for the various "fin-key" events and carry out more complex operations in your listeners.)
+     * (If this built-in cell selection logic is insufficient for your needs, you can also listen for
+     * the various "fin-key" events and carry out more complex operations in your listeners.)
      *
-     * The keypress names used here are defined in Canvas.js. Note that all keypresses actually have two names, a normal name and a shifted name. The latter name is used when either **shift** is depressed.
+     * The key press names used here are defined in Canvas.js.
+     * Note that all key presses actually have two names, a normal name and a shifted name.
+     * The latter name is used when **shift** is depressed.
      *
-     * The built-in nav keypresses are as follows:
+     * The built-in nav key presses are as follows:
      * * **`UP`** _(up-arrow key)_ - Replace all selections with a single cell, one row up from the last selection.
@@ -839,9 +843,14 @@ * * **`DOWN`** _(down-arrow key)_ - Replace all selections with a single cell, one row down from the last selection.
      *
-     * A note regarding the other meta keys (**trl**, **option**, and **command**): Although these meta keys can be detected, they do not modify the key names as **shift** does. This is because they are more for system use and generally (with the possibly exception fo **ctrl**) should not be depended upon, as system functions will take priority and your app will never see these key presses.
+     * A note regarding the other meta keys (**ctrl**, **option**, and **command**):
+     * Although these meta keys can be detected, they do not modify the key names as **shift** does.
+     * This is because they are more for system use and generally (with the possibly exception fo **ctrl**) should not
+     * be depended upon, as system functions will take priority and your app will never see these key presses.
      *
      * A special accommodation has been made to the {@link module:defaults.editOnKeydown|editOnKeydown} property:
-     * * If `editOnKeydown` truthy AND mapped character is an actual (non-white-space) character (as opposed to say **tab** or **return**), then navigation requires **ctrl** key to distinguish between nav and data.
+     * * If `editOnKeydown` truthy AND mapped character is an actual (non-white-space) character, as opposed to (say)
+     * **tab** or **return**, then navigation requires the **ctrl** key to distinguish between nav and data.
      * * If `editOnKeydown` falsy, the **ctrl** key is ignored.
      *
-     * So in the last example, if `editOnKeydown` is ON, then `a` (without **ctrl**) would start editing the cell and **ctrl** + `a` would move the selection one column to the left.
+     * So if (say) `a` is mapped to `LEFT` as in the last example below, if `editOnKeydown` is ON, then `a` (without
+     * **ctrl**) would start editing the cell but **ctrl** + `a` would move the selection one column to the left.
      *
@@ -858,3 +867,3 @@ * @example
      * @example
-     * // To map alternative nav keypresses to RETURN and TAB (default mapping):
+     * // To map alternative nav key presses to RETURN and TAB (default mapping):
      * navKeyMap: {
@@ -868,3 +877,3 @@ *     RETURN: 'DOWN',
      * @example
-     * // To map alternative nav keypresses to a/w/d/s and extend select to A/W/D/S:
+     * // To map alternative nav key presses to a/w/d/s and extend select to A/W/D/S:
      * navKeyMap: {
@@ -889,3 +898,3 @@ *     a: 'LEFT', A: 'LEFTSHIFT',
     /** @summary Validation failure feedback.
-     * @desc Validation occurs on {@link CellEditor#stopEditing}, normally called on commit (`TAB`, `ENTER`, or any other keys listed in `navKeyMap`).
+     * @desc Validation occurs on {@link CellEditor#stopEditing|stopEditing}, normally called on commit (`TAB`, `ENTER`, or any other keys listed in `navKeyMap`).
      *
@@ -896,3 +905,3 @@ * On successful validation, the value is saved back to the data source and the editor is closed.
      *
-     * The error effect to use is named in `feedbackEffect
+     * The error effect to use is named in {@link module:defaults.feedbackEffect|feedbackEffect}.
      *
@@ -918,2 +927,3 @@ * The value of this property is the number of times to show the "error effect" on validation failure before showing the detailed explanation.
      * @memberOf module:defaults
+     * @see {@link module:defaults.feedbackCount|feedbackCount}
      */
@@ -920,0 +930,0 @@ feedbackEffect: 'shaker',

src/lib/Localization.js

@@ -82,4 +82,4 @@ /* eslint-env browser */
  * @param {string} [locale=defaultLocale] - Passed to the {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat `Intl.NumberFormat`} constructor.
- * @param {object} [options] - Passed to the `Intl.NumberFormat` constructor.
- * @param {boolean} [options.acceptStandardDigits=false] - Accept standard digits and decimal point interchangeably with localized digits and decimal point. (This option is interpreted here; it is not used by `Intl.NumberFormat`.)
+ * @param {object} [options] - Passed to the {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat `Intl.NumberFormat`} constructor.
+ * @param {boolean} [options.acceptStandardDigits=false] - Accept standard digits and decimal point interchangeably with localized digits and decimal point. (This option is interpreted here; it is not used by {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat `Intl.NumberFormat`}.)
  * @constructor
@@ -204,4 +204,4 @@ * @extends Formatter
  * @param {string} defaultLocale
- * @param {string} [locale=defaultlocale] - Passed to the {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateFormat `Intl.DateFormat`} constructor.
- * @param {object} [options] - Passed to the `Intl.DateFormat` constructor.
+ * @param {string} [locale=defaultlocale] - Passed to the {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat `Intl.DateFormat`} constructor.
+ * @param {object} [options] - Passed to the {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat `Intl.DateFormat`} constructor.
  * @constructor
@@ -208,0 +208,0 @@ * @extends Formatter

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

738320

increased by0.22%

Lines of code

18316

increased by0.07%

Number of lines in readme file

109

increased by17.2%

No dependency changes