Giter Club home page Giter Club logo

diagram's Introduction

Diagram is the tool for making node based systems. Define your own behaviour of this react based diagram system and create your tool. Visual programming is trending right now so this is a good basis.

Project Page

Live demo

Here is Live Demo of diagram used to create node based graphql system

Development using sandbox

$ npm run sandbox

Sandbox is a development mode that allows you to review live changes while modifying diagram's code in a hot-reload fashion. After running the command above, you can fool around with component's code in /src/ directory and see immediate results in the browser after navigating to http://localhost:8080.

Add to your project

$ npm install @slothking-online/diagram

Develop & Contribute

$ git clone https://github.com/slothking-online/diagram
$ npm install
$ npm run start

Define spacebar menu actions

import { Graph } from '@slothking-online/diagram';
import * as React from 'react';
let allCategories = [
  {
    name: 'middlewares',
    items: [
      {
        name: 'middleware',
        type: 'middleware',
        inputs: [
          {
            name: ''
          }
        ],
        outputs: [
          {
            name: ''
          }
        ]
      }
    ]
  }
];

export const MyGraphComponent = () => <Graph categories={allCategories} />;

Now if you press spacebar when mouse is on the graph you get this menu, which creates nodes.

Serialization of data

<Graph
  categories={allCategories}
  serialize={(nodes, links) => {
    //here you receive nodes and links after every graph change
  }}
  validate={(node1, node2) => {
    // not necessary but you can add custom validation function between every node
  }}
/>

Controls

  • Create - press and hold Spacebar and choose category -> node and Left Mouse Button click
  • Pan - press and hold Left Mouse Button and move mouse
  • Move - press and hold Left Mouse Button on node
  • Rename - To rename node simply start typing when one node is selected
  • Connect - Click and hold desired node output and move it to other node's output then release mouse button IMPORTANT: Every node is connectable only if it creates valid schema. Experiment to test
  • Node Properties - Click right mouse button on node
  • CMD/CTRL + Left Mouse Button Click - select multiple nodes
  • Delete - Click delete button when node/nodes are selected or right click -> delete

Keyboard shortcuts

  • CMD/CTRL + Mouse Click - Select multiple nodes
  • CMD/CTRL + L - Beautify diagram
  • CMD/CTRL + Z - Undo
  • CMD/CTRL + Y - Redo
  • CMD/CTRL + D - Duplicate Nodes
  • CMD/CTRL + F - Find nodes
  • ALT/OPTION + V - Find duplicate definitions(Validate)
  • ALT/OPTION + LMB on cloned node - navigate to definition
  • RIGHT MOUSE CLICK on node - node actions

Contribute

Feel free to contact us and contribute in graphql editor project. [email protected]

  1. fork this repo
  2. Create your feature branch: git checkout -b feature-name
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

diagram's People

Contributors

aexol avatar hzub avatar palid avatar hubertzubsh avatar mike-dax avatar tknickman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.