Fixed settings for 2.0.0 release

Author: nielsdejong

README.md

@@ -38,19 +38,28 @@ To build the app for production:
 All NeoDash charts implement the interface defined in `src/charts/Chart.tsx`. A custom chart must do the same. the following parameter as passed to your chart from the application:
 - `records`: a list of Neo4j Records. This is the raw data returned from the Neo4j driver. 
 - `settings`: a dictionary of settings as defined under "advanced report settings" for each report. You can use these values to customize your visualization based on user input.
+- `selection`: a dictionary with the selection made in the report footer.
+- `dimensions`: an array with the dimensions of the report (mostly not needed, charts automatically fill up space).
+- `queryCallback`: a way for the report to read more data from Neo4j, on interactions.
+- `setGlobalParameter`: a way for the report to set globally available Cypher parameters, on interactions.
 
 Make sure that your component renders a React component. your component will be automatically scaled to the size of the report. See the other charts in `src/charts/` for examples. 
 
 ### 2. Extend the config to make your component selectable
 
 To let users choose your visualization, you must add it to the app's report configuration. This config is located in `src/config/ReportConfig.tsx`, and defined by the dictionary `REPORT_TYPES`.
 
-To add your visualization to the config, add a new entry to the `REPORT_TYPES` dictionary with a unique name. The entry's value is an object which can contain the following fields:
-- type: the React component you created. Mandatory.
-- name: a display name for the visualization. Mandatory.
-- `TODO - add more details here...`
-
-If all works, please consider contributing your code to this repository. The more visualizations, the better!
+To add your visualization to the config, add a new key to the `REPORT_TYPES` dictionary with a unique name. The entry's value is an object which can contain the following fields:
+- `label`: a display name for the visualization. Mandatory.
+- `component`: the React component that renders the visualization. Mandatory.
+- `helperText`: a string that is show under the query box in the report settings. Mandatory.
+- `selection`: a list that contains each of the selection boxes present in the report footer. Optional.
+- `settings`: a list of selection boxes that shows under the advanced settings. Optional.
+- `maxRecords`: a hard limit on the number of records the visualization can handle. Mandatory.
+- `useRecordMapper`: whether to use the in-built record mapper to fix your results in a specific format. Optional.
+- `useNodePropsAsFields`: whether to use the node property selector as a report footer override. Optional.
+
+If all works, please consider contributing your code to this repository.
 
 ## Questions / Suggestions
 If you have any questions about NeoDash, please reach out. For feature requests, consider opening an issue(link) on GitHub.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "neodash",
-  "version": "2.0.0-preview",
+  "version": "2.0.0",
   "description": "NeoDash - Neo4j Dashboard Builder",
   "neo4jDesktop": {
     "apiVersion": "^1.2.0"

src/modal/WelcomeScreenModal.tsx

@@ -12,7 +12,7 @@ import { Tooltip } from '@material-ui/core';
  * Configures setting the current Neo4j database connection for the dashboard.
  */
 export const NeoWelcomeScreenModal = ({ welcomeScreenOpen, setWelcomeScreenOpen,
-    hasCachedDashboard, hasNeo4jDesktopConnection, createConnectionFromDesktopIntegration, resetDashboard, 
+    hasCachedDashboard, hasNeo4jDesktopConnection, createConnectionFromDesktopIntegration, resetDashboard,
     onConnectionModalOpen, onAboutModalOpen }) => {
 
     const [promptOpen, setPromptOpen] = React.useState(false);
@@ -91,13 +91,16 @@ export const NeoWelcomeScreenModal = ({ welcomeScreenOpen, setWelcomeScreenOpen,
                         </Button>}
 
                     <Tooltip title="Try a demo dashboard with a public Neo4j database." aria-label="">
-                        <Button onClick={handleClose}
-                            style={{ marginTop: "10px", width: "100%", backgroundColor: "white", boxShadow: "0px 3px 1px -2px rgb(0 0 0 / 20%), 0px 2px 2px 0px rgb(0 0 0 / 14%), 0px 1px 5px 0px rgb(0 0 0 / 12%)" }}
-                            color="default"
-                            variant="contained"
-                            size="large">
-                            Try a Demo
-                        </Button>
+                        <a style={{textDecoration: "none"}} href="http://localhost:3000/?share&type=file&id=https%3a%2f%2fgist.githubusercontent.com%2fnielsdejong%2ff983b6b6e06e4e10a1f31ae693de6600%2fraw%2f8230a024ee847982d46e198790fcb15fc3c1d06b%2fexample.json&credentials=neo4j%2bs%3a%2f%2ffincen%3afincen%40fincen%3ademo.neo4jlabs.com%3a7687">
+                            <Button
+
+                                style={{ marginTop: "10px", width: "100%", backgroundColor: "white", boxShadow: "0px 3px 1px -2px rgb(0 0 0 / 20%), 0px 2px 2px 0px rgb(0 0 0 / 14%), 0px 1px 5px 0px rgb(0 0 0 / 12%)" }}
+                                color="default"
+                                variant="contained"
+                                size="large">
+                                Try a Demo
+                            </Button>
+                        </a>
                     </Tooltip>
 
                     <Tooltip title="Show information about this application." aria-label="">