Build Neo4j Graph Apps using components and utilities from this graph app kit.
This kit should be considered to be 'under development' and the components in it can have breaking changes (i.e. until version 1.0.0
semver does not apply).
Browse source code and read README:s in sub directories for examples and docs.
Component | Description |
---|---|
<Render> | A declarative toggling component to mount / unmount child components under certain conditions. |
<AsciiTable> | Render your data in an text/ascii table with fixed width font. |
Component | Description |
---|---|
<Cypher> | A simple component to execute a Cypher query and return the result to your render function. |
<DesktopIntegration> | Easy integration for your app into the Neo4j Desktop API. Subscribe to events etc. |
<DriverProvider> | Provide your React application with a neo4j-driver in application context. |
npm install graph-app-kit --registry https://neo.jfrog.io/neo/api/npm/npm
// or
yarn add graph-app-kit --registry https://neo.jfrog.io/neo/api/npm/npm
import { Cypher, DriverProvider } from 'graph-app-kit/utils'
import { Render } from 'graph-app-kit/ui'
There's an interactive playground to view and modify the components.
This is temporarily hosted at https://styleguide-oipiezsosg.now.sh.
Feedback wanted!
To use the playground when developing components: yarn playground
and to generate a static version to deploy: yarn playground:build
(the artifacts end up in styleguide/
)
git clone [email protected]:neo4j-contrib/graph-app-kit.git graph-app-kit
cd graph-app-kit
yarn install
yarn lint
Single run:
yarn test
Continous testing (watch mode):
yarn dev