Skip to content

Commit

Permalink
Release v0.1.0 (#50)
Browse files Browse the repository at this point in the history
* Update CHANGELOG.md

* Include dash_cytoscape_extra[min|dev].js in distribution

* Update package version

* `npm run build:all`

* Update CHANGELOG.md

Co-Authored-By: xhlulu <[email protected]>

* Apply suggestions from code review

Co-Authored-By: xhlulu <[email protected]>

* Changes based on PR reviews
  • Loading branch information
Xing authored Apr 5, 2019
1 parent 7613b94 commit 5d1089b
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 13 deletions.
29 changes: 20 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.1.0] - 2019-04-05

### Added
* `demos/usage-dag-edges.py`: Show different types of edges in a DAG
* `demos/usage-elements-extra.py`: Shows how to load external layouts, otherwise same app as `usage-elements.py`.
* `demos/usage-preset-animation.py`: Example of animating nodes using the preset layout.
* `demos/usage-reset-button.py`: Example of resetting the graph position using a button.
* `dash_cytoscape.load_extra_layouts()`: A new function that can be called before initializing the Dash app (`app = dash.Dash(__name__)`) to load the JS bundle containing the external layouts.
* `webpack.[dev|prod].extra.config.js`: Two new webpack configs for external layouts.
* Four new demos:
* `demos/usage-dag-edges.py`: Example of edges in a directed acyclic graph (DAG). It uses the new `dash_cytoscape.utils.Tree` class.
* `demos/usage-elements-extra.py`: Example of loading external layouts.
* `demos/usage-preset-animation.py`: Example of animating nodes using the preset layout.
* `demos/usage-reset-button.py`: Example of resetting the graph position using a button.
* `demos/usage-remove-selected-elements.py`: Example to show how to remove selected elements with button.
* `dash_cytoscape/dash_cytoscape_extra.[min|dev].js`: New bundles containing the extra layouts. Those bundles are double in size compared to the default bundles. Therefore, they are only loaded when the user uses `load_extra_layouts()` to limit bandwidth usage and maximize loading speed. Please view [fast3g-cytoscape](demos/images/fast3g-cytoscape.PNG) for an example of the impact on loading time.
* `dash_cytoscape._display_default_values()`: A helper function to display the default prop values by reading `metadata.json`. Useful for documentation.
* `dash_cytoscape.load_extra_layouts()`: A function that can be called before initializing the Dash app (`app = dash.Dash(__name__)`) to load the JS bundle containing the external layouts.
* `src/lib/extra_index.js`: Loads external layouts before exporting the `Cytoscape` class. Needed to generate the new bundles.
* `webpack.[dev|prod].extra.config.js`: Two new webpack config files for external layouts.
* Images of new external layouts.
* `dash_cytoscape/dash_cytoscape_extra.[min|dev].js`: New bundles containing the extra layouts. Those bundles are double in size compared to the default bundles. Therefore, they are only loaded when the user uses `load_extra_layouts()` to limit bandwidth usage and maximize loading speed. Please view [fast3g-cytoscape](demos/images/fast3g-cytoscape.PNG) for an example of the impact on loading time.
* `dash_cytoscape._display_default_values()`: A util function to display the default prop values by reading `metadata.json`. Useful for documentation.
* The ability for the user to feed a dictionary with keys `nodes` and `edges` to the `elements` prop of `Cytoscape`, instead of a list. The values corresponding to these keys will be, respectively, lists of nodes and edges in the graph.


### Changed
* `usage-events.py`: Added IDs for the edges in order to pass Percy tests.
* `src/lib/components/Cytoscape.react.js`: Updated docstring to include information about new external layouts and warning about nodes that can't be modified by a callback. Added more default props for a better expected behavior.
* `src/lib/components/Cytoscape.react.js`: Updated component docstring to include information about new external layouts and a warning about nodes that can't be modified by a callback. Added more default props for a better expected behavior.
* `package.json`: Added new builds for the extra layouts, modified `npm build:all` to include new builds. Added external layouts as dependencies.
* `MANIFEST.in`: Included new `dash_cytoscape.[min|dev].js` files.
* `README.md`: Moved images, added more images at the end, added useful links.


### Fixed
* Removing selected elements will now cause the corresponding JSON data to be cleared. Fixed by [PR #49](https://github.com/plotly/dash-cytoscape/pull/49), fixes [issue #45](https://github.com/plotly/dash-cytoscape/issues/45).


## [0.0.5] - 2019-03-08

### Added
Expand Down
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
include dash_cytoscape/dash_cytoscape.min.js
include dash_cytoscape/dash_cytoscape.dev.js
include dash_cytoscape/dash_cytoscape_extra.min.js
include dash_cytoscape/dash_cytoscape_extra.dev.js
include dash_cytoscape/metadata.json
include dash_cytoscape/package.json
include README.md
Expand Down
2 changes: 1 addition & 1 deletion dash_cytoscape/dash_cytoscape.dev.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dash_cytoscape/dash_cytoscape_extra.dev.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dash_cytoscape/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dash-cytoscape",
"version": "0.0.5",
"version": "0.1.0",
"description": "A Component Library for Dash aimed at facilitating network visualization in Python, wrapped around Cytoscape.js",
"main": "build/index.js",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dash-cytoscape",
"version": "0.0.5",
"version": "0.1.0",
"description": "A Component Library for Dash aimed at facilitating network visualization in Python, wrapped around Cytoscape.js",
"main": "build/index.js",
"scripts": {
Expand Down

0 comments on commit 5d1089b

Please sign in to comment.