Skip to content

Commit

Permalink
Merge pull request #771 from fin-hypergrid/develop
Browse files Browse the repository at this point in the history
Merge 3.1.0 develop to master
  • Loading branch information
joneit authored Oct 30, 2018
2 parents f57ba4a + bfb75d5 commit fff78e6
Show file tree
Hide file tree
Showing 22 changed files with 206 additions and 177 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Thank you in advance for being a part of this project and for helping to make Hy

## Beginners

We have several beginner [issues](https://github.com/openfin/fin-hypergrid/issues) open for community involvement. Feel free to look all issues, especially those with the label "help wanted". Please ignore those with the label "on-hold" as the scope of these issues may change.
We have several beginner [issues](https://github.com/fin-hypergrid/core/issues) open for community involvement. Feel free to look all issues, especially those with the label "help wanted". Please ignore those with the label "on-hold" as the scope of these issues may change.

## HyperGrid Core vs UserLand

* Please see our [architectural overview](https://github.com/openfin/fin-hypergrid/blob/master/OVERVIEW.md)
* Please see our [architectural overview](https://github.com/fin-hypergrid/core/blob/master/OVERVIEW.md)

## Getting Started

Expand Down Expand Up @@ -52,7 +52,7 @@ $ gulp
problem by making the example concrete and imperative.
```

* Make sure you have added the necessary [tests](https://github.com/openfin/fin-hypergrid/tree/master/test) for your changes.
* Make sure you have added the necessary [tests](https://github.com/fin-hypergrid/core/tree/master/test) for your changes.
* Run _all_ the tests to assure nothing else was accidentally broken.
* Test your changes in all IE10+, Safari, Chrome, Chrome 40, Firefox
* We are evaluating different testing strategies but for the moment, the major considerations are for
Expand All @@ -72,12 +72,12 @@ Code should be as self-explanatory as possible by using well-considered variable
Use comments only to explain any remaining subtleties.

On the other hand, we do believe in good usage of jsdocs _especially_ if your updating a public api call.
Here is an example of a [tutorial](http://openfin.github.io/fin-hypergrid/doc/tutorial-cell-editors.html)
Here is an example of a [tutorial](http://fin-hypergrid.github.io/core/doc/tutorial-cell-editors.html)

## Submitting Changes

* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository in the openfin organization.
* Submit a pull request to the [`core` repository in the `fin-hypergrid` organization](https://github.com/fin-hypergrid/core/compare).
* Do not submit until ready to publish — and then hold off a bit longer until you feel certain you are not submitting prematurely. If you find you absolutely must update a pull request, you must leave an explanatory comment. Updating will delay merging your PR if we have to review it again. Please try to avoid doing this (by not submitting too early; see above).
* The core team looks at Pull Requests on a regular basis within a three-week sprint cycle.
* If your PR is accepted, congratulations!!
Expand Down Expand Up @@ -120,4 +120,4 @@ npm publish

## Additional Resources

Feel free to open [issues](https://github.com/openfin/fin-hypergrid/issues) or email [email protected]
Feel free to open [issues](https://github.com/fin-hypergrid/core/issues/new).
8 changes: 2 additions & 6 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The OpenFin License
MIT License

Copyright (c) 2015 OpenFin Inc.
Copyright (c) 2015-2018 Openfin and The Hypergrid Authors.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -12,10 +12,6 @@ furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

You may not redistribute the software or modifications as part of any
application that can be described as a development toolkit, library or
framework.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Expand Down
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[![Build Status](https://travis-ci.org/openfin/fin-hypergrid.svg?branch=develop)](https://travis-ci.org/openfin/fin-hypergrid)

**fin-hypergrid** is an ultra-fast HTML5 grid presentation layer, achieving its speed by rendering (in a canvas tag) only the currently visible portion of your (virtual) grid, thus avoiding the latency and life-cycle issues of building, walking, and maintaining a complex DOM structure. Please be sure to checkout our [design overview](OVERVIEW.md)

Below is an example custom application built on top of the Hypergrid API tooling.
It also highlights a DOM-based custom external editor triggered via hypergrid events as well as interaction with Hypergrid's column ordering API
It also highlights a DOM-based custom external editor triggered via hypergrid events as well as interaction with Hypergrids column ordering API.

<img src="images/README/gridshot04.gif">

Expand All @@ -17,17 +15,17 @@ It also highlights a DOM-based custom external editor triggered via hypergrid ev
* [Roadmap](#roadmap)
* [Contributing](#contributors)

### Current Release (3.0.3 - 25 September 2018)
### Current Release (3.1.0 - 29 September 2018)

**Hypergrid 3.0 includes a revised data model with some breaking changes.**
**Hypergrid 3.1 includes 3.0’s revised data model with some breaking changes.**

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

### Distribution

#### 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,
Specify a <a href="https://semver.org/">SEMVER</a> of `"fin-hypergrid": "3.1.0"` (or `"^3.1.0"`) 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.

Expand Down Expand Up @@ -69,19 +67,19 @@ The [Perspective](https://github.com/jpmorganchase/perspective) open source proj

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

##### Hyperblotter
##### AdaptableBlotter.JS

[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.
[Openfin](http://openfin.co)’s AdaptableBlotter.JS ([installer](https://install.openfin.co/download/?fileName=adaptable_blotter_openfin&config=http://beta.adaptableblotter.com/app-beta.json)) is a demo app that shows the capabilities of both Openfin and Hypergrid.

![](images/README/Hyperblotter%20Tabled%20Reduced%20Rows.png)
![](images/README/partner-adaptableblotter_image-01@2x-667x375@2x.png)

### Features

![](images/README/Hypergrid%20Features.png)

### Testing

Please use github [issues](https://github.com/fin-hypergrid/core/issues) to report problems
Please use github [issues](https://github.com/fin-hypergrid/core/issues/new) to report problems

We invite everyone to test the alpha branch for changes going into the next release

Expand Down
10 changes: 5 additions & 5 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

### Queue

You can find the current issues queue [here](https://github.com/openfin/fin-hypergrid/projects/5)
You can find the current issues queue [here](https://github.com/fin-hypergrid/core/projects/5)

### JSDOC

Continual Cleanup of API notes on [JSDOC](http://openfin.github.io/fin-hypergrid/doc/Hypergrid.html)
Continual Cleanup of API notes on [JSDOC](http://fin-hypergrid.github.io/core/doc/Hypergrid.html)

## How YOU can help!

- See our [projects backlog](https://github.com/openfin/fin-hypergrid/projects) <sup>[2](#myfootnote2)</sup>
- See our [projects backlog](https://github.com/fin-hypergrid/core/projects) <sup>[2](#myfootnote2)</sup>

<a name="myfootnote1">1</a>:
*Please note that we are dropping support for our treeview, aggregations, grouping, filtering, sorting and analytics services in general. Our reasoning is defined [here](https://github.com/openfin/fin-hypergrid/blob/master/OVERVIEW.md). These existing services are being exported out of Openfin's github domain, but they will still be available for private forking by those interested.*
*Please note that we are dropping support for our treeview, aggregations, grouping, filtering, sorting and analytics services in general. Our reasoning is defined [here](https://github.com/fin-hypergrid/core/blob/master/OVERVIEW.md). These existing services are being exported out of Openfin's github domain, but they will still be available for private forking by those interested.*

<a name="myfootnote2">2</a>:
If you would like to work on on these ideas or suggest your own, feel free to browse through our [github issues](https://github.com/openfin/fin-hypergrid/issues)
If you would like to work on on these ideas or suggest your own, feel free to browse through our [github issues](https://github.com/fin-hypergrid/core/issues)
and read our [contributing guide](./CONTRIBUTING.md).
8 changes: 4 additions & 4 deletions TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We've created an Alpha Branch for the Hypergrid OpenSource project.
### ALPHA

#### STEP 1 - GET IT AND INSTALL
A) Download or Clone branch from https://github.com/openfin/fin-hypergrid/tree/alpha
A) Download or Clone branch from https://github.com/fin-hypergrid/core/tree/alpha
Note: Alpha builds are subject to incremental changes. We will announce when this happens.

> npm install
Expand All @@ -20,17 +20,17 @@ A) Download or Clone branch from https://github.com/openfin/fin-hypergrid/tree/a
B) NPM
Point your package.json to:

> "fin-hypergrid": "[email protected]:openfin/fin-hypergrid.git#alpha"
> "fin-hypergrid": "[email protected]/fin-hypergrid/core.git#alpha"

OR

Via npm install

> npm install git+https://github.com/openfin/fin-hypergrid.git#alpha
> npm install git+https://github.com/fin-hypergrid/core.git#alpha

For more info see the [npm docs](https://docs.npmjs.com/files/package.json#git-urls-as-dependencies)

#### STEP 2 - TEST IT
Validate it works.

Any questions, please contact us at [email protected] or open an [issue](https://github.com/openfin/fin-hypergrid/issues).
Any questions, please open an [issue](https://github.com/fin-hypergrid/core/issues/new).
4 changes: 2 additions & 2 deletions TRANSITION-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Hypergrid developers: You must update your remotes with `git remote` to point to

### CDN

For continuity with existing pages that make requests (via <script> tag) to Hypergrid's legacy "GitHub Pages" CDN (URLs beginning with https://openfin.github.io/fin-hypergrid), we have retained just the build files for v2.0.2 and v1.3.0 in that location. Note that this legacy hosting pertains only to the build files.
For continuity with existing pages that make requests (via <script> tag) to Hypergrid's legacy "GitHub Pages" CDN (URLs beginning with `https://fin-hypergrid.github.io/core`), we have retained just the build files for v2.0.2 and v1.3.0 in that location. Note that this legacy hosting pertains only to the build files.

The current v2.0.2 release can also be found on the new CDN; all new releases will be pushed to the new CDN _only._ See https://fin-hypergrid.github.io for index. **We recommend updating your apps to make requests against the new CDN.**
The current release can also be found on the new CDN; all new releases will be pushed to the new CDN _only._ See https://fin-hypergrid.github.io for index. **We recommend updating your apps to make requests against the new CDN.**

### See also...

Expand Down
53 changes: 0 additions & 53 deletions gh-pages.sh

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions images/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,37 @@ var _ = require('object-iterators');
var images = require('./images'); // this is the file generated by gulpfile.js (and ignored by git)

/**
* <img src="https://raw.githubusercontent.com/openfin/fin-hypergrid/master/images/calendar.png">
* <img src="https://raw.githubusercontent.com/fin-hypergrid/core/master/images/calendar.png">
* @name calendar
* @memberOf module:images
*/

/**
* <img src="https://raw.githubusercontent.com/openfin/fin-hypergrid/master/images/checked.png">
* <img src="https://raw.githubusercontent.com/fin-hypergrid/core/master/images/checked.png">
* @name checked
* @memberOf module:images
*/

/**
* <img src="https://raw.githubusercontent.com/openfin/fin-hypergrid/master/images/unchecked.png">
* <img src="https://raw.githubusercontent.com/fin-hypergrid/core/master/images/unchecked.png">
* @name unchecked
* @memberOf module:images
*/

/**
* <img src="https://raw.githubusercontent.com/openfin/fin-hypergrid/master/images/filter-off.png">
* <img src="https://raw.githubusercontent.com/fin-hypergrid/core/master/images/filter-off.png">
* @name filter-off
* @memberOf module:images
*/

/**
* <img src="https://raw.githubusercontent.com/openfin/fin-hypergrid/master/images/filter-on.png">
* <img src="https://raw.githubusercontent.com/fin-hypergrid/core/master/images/filter-on.png">
* @name filter-on
* @memberOf module:images
*/

/**
* <img src="https://raw.githubusercontent.com/openfin/fin-hypergrid/master/images/up-down.png">
* <img src="https://raw.githubusercontent.com/fin-hypergrid/core/master/images/up-down.png">
* @name up-down
* @memberOf module:images
*/
Expand Down
2 changes: 1 addition & 1 deletion jsdoc-template-hypergrid
12 changes: 9 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
{
"name": "fin-hypergrid",
"version": "3.0.3",
"version": "3.1.0",
"description": "Canvas-based high-performance grid",
"main": "src/Hypergrid",
"repository": {
"type": "git",
"url": "git://github.com/fin-hypergrid/core.git"
},
"author": "SWirts, JEiten, DJones, NMichaud",
"author": "Steve Wirts (https://github.com/stevewirts)",
"contributors": [
"Jonathan Eiten (https://github.com/joneit)",
"Dwayne Jones (https://github.com/dwaynekj)",
"Naveen Michaud-Agrawal (https://github.com/nmichaud)",
"Hugo Nogueira (https://github.com/hugoeanogueira)"
],
"license": "MIT",
"readmeFilename": "README.md",
"gitHead": "",
Expand All @@ -19,7 +25,7 @@
"datasaur-base": "^3.0.0",
"datasaur-local": "^3.0.0",
"extend-me": "^2.7.0",
"finbars": "^1.6.0",
"finbars": "^2.0.0",
"inject-stylesheet-template": "^1.0.1",
"mustache": "^2.3.0",
"object-iterators": "1.3.0",
Expand Down
Loading

0 comments on commit fff78e6

Please sign in to comment.