Skip to content

Commit

Permalink
Merge pull request #737 from fin-hypergrid/develop
Browse files Browse the repository at this point in the history
Merge develop (Hypergrid 3.0.0) to master
  • Loading branch information
joneit authored Jul 7, 2018
2 parents 3c90bc8 + da3ad6e commit f39fa11
Show file tree
Hide file tree
Showing 123 changed files with 3,340 additions and 16,504 deletions.
2 changes: 1 addition & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
"no-script-url": 2,
"no-sequences": 2,
"no-unused-expressions": 2,
"yoda": 2,
"yoda": 0,
"no-delete-var": 2,
"no-label-var": 2,
"no-shadow-restricted-names": 2,
Expand Down
15 changes: 12 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# unfortunate mac OS garbage
.DS_Store

# WebStorm (IntelliJ) folder
/.idea

# folder generated by jsdoc
/doc
/node_modules*
build

# folder generated by npm
/node_modules

# ignore possible garbage left behind by MS Office
~*.*x
/v*.*.*

/package-lock.json
2 changes: 1 addition & 1 deletion .jsdoc.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"dictionaries": ["jsdoc","closure"]
},
"source": {
"include": ["src", "images"]
"include": ["src", "images", "src/jsdoc/README.md"]
},
"plugins": ["plugins/markdown"],
"markdown": {
Expand Down
17 changes: 6 additions & 11 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,28 +1,23 @@
.*
*.css
*.html
~*.*x

/[0-9]*
/demo
/doc
build
/html/*.html
/images/**
!/images/images.js
!/images/index.js
/jsdoc-template-hypergrid
/src/jsdoc
/test

/favicon.ico
/package-lock.json
/gulpfile.js
/*.sh
/*.md

index.js
!/index.js
!/css/index.js
!/images/index.js
!/src/cellRenderers/index.js
!/src/cellEditors/index.js
!/src/dataModels/index.js
!/src/renderer/index.js
!/src/features/index.js
/src/behaviors/index.js
/src/lib/index.js
41 changes: 32 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,54 @@ It also highlights a DOM-based custom external editor triggered via hypergrid ev
<img src="images/README/gridshot04.gif">

## Table of Contents
* [Current Release](#current-release-2115---29-june-2018)
* [Current Release](#current-release-300---7-july-2018)
* [Distribution](#distribution)
* [Demos](#demos)
* [Features](#features)
* [Testing](#testing)
* [Documentation](#developer-documentation)
* [Roadmap](#roadmap)
* [Contributing](#contributors)

### Current Release (2.1.15 - 29 June 2018)
### Current Release (3.0.0 - 7 July 2018)

**Hypergrid 2.1.15** includes bug fixes and new features.
**Hypergrid 3.0.0 includes a revised data model with some breaking changes.**

_For a complete list of changes, see the [release notes](https://github.com/fin-hypergrid/core/releases)._

### Demos
### Distribution

##### Sample demo
#### npm module
Published as a CommonJS module to npmjs.org. Specify SEMVER `"fin-hypergrid": "3.0.0"` (or `"^3.0.0"`) in your package.json file, issue the `npm install` command, and let your bundler (wepback, Browserify) do the rest.

Our [dev testbed](https://fin-hypergrid.github.io/core) demos various features.
#### 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.

##### Hyperblotter
### Hypergrid demos

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)).

#### Testbench

The [default](https://fin-hypergrid.github.io/core) demo is the Hypergrid [dev testbench](https://fin-hypergrid.github.io/core/demo/index.html) ([source](https://github.com/fin-hypergrid/build/tree/master/testbench)).

#### Simple example

See `example.html` for a very simple example ([repo](https://github.com/fin-hypergrid/build/blob/master/demo/example.html), [demo](https://fin-hypergrid.github.io/core/demo/example.html)):

Hyperblotter is a demo app that shows the capabilities of both OpenFin and Hypergrid.
![](images/README/simple.png)

#### Who else is using Hypergrid?

##### Perspective

The [Perspective](https://github.com/jpmorganchase/perspective) open source project uses Hypergrid v3 (demo links in the README) and does a lot more than Hypergrid alone, such as table pivots and charting.

![](images/README/perspective.png)

##### Hyperblotter

Check out the Table view on Hyperblotter on a Windows machine via [this installer](https://dl.openfin.co/services/download?fileName=Hyperblotter&config=http://cdn.openfin.co/demos/hyperblotter/app.json).
[Openfin](http://openfin.co)'s Hyperblotter ([installer](https://dl.openfin.co/services/download?fileName=Hyperblotter&config=http://cdn.openfin.co/demos/hyperblotter/app.json)) is a demo app that shows the capabilities of both OpenFin and Hypergrid.

![](images/README/Hyperblotter%20Tabled%20Reduced%20Rows.png)

Expand Down
45 changes: 0 additions & 45 deletions demo/basic.html

This file was deleted.

43 changes: 0 additions & 43 deletions demo/computed-column.html

This file was deleted.

163 changes: 0 additions & 163 deletions demo/css/demo.css

This file was deleted.

Loading

0 comments on commit f39fa11

Please sign in to comment.