Code Monkey home page Code Monkey logo

graphy-ng's Introduction

GitHub license npm version PRs Welcome

graphy-ng logo

graphy-ng is a library for rendering directed graphs in Angular. Under the hood, Dagre is used as a layout engine and the graph is drawn using SVGs.

The library is compiled with Ivy and requires Angular 12+

๐Ÿ“š Documentation

Interactive example

A simple interactive demo can be found on StackBlitz. It showcases how nodes and edges can be added dynamically and some features like making use of custom templates, re-rendering on create/update, and navigating the graph through panning or zooming.

โšก StackBlitz link

demo-recording

Installation

Using npm:

$ npm i graphy-ng && npm i -D @types/d3-shape

Using yarn:

$ yarn add graphy-ng && yarn add -D @types/d3-shape

Basic usage

Import GraphyModule into your feature module.

family-tree.module.ts

@NgModule({
  imports: [GraphyModule],
  ...
})
export class FamilyTreeModule {}

Consume graphy-ng in your component, providing templates for how nodes and edges should be rendered.

family-tree.component.html

<p>Here's my pretty graph:</p>
<graphy-ng>
  <ng-container *defsTemplate>
    <svg:marker
      id="arrow"
      viewBox="0 -5 10 10"
      refX="8"
      refY="0"
      markerWidth="4"
      markerHeight="4"
      orient="auto"
    >
      <svg:path d="M0,-5L10,0L0,5" />
    </svg:marker>
  </ng-container>

  <ng-container *nodeTemplate="let node; nodes: nodes">
    <svg:circle cx="25" cy="25" r="25" />
    <svg:text fill="blue" transform="translate(0 30)">{{ node.data.name }}</svg:text>
  </ng-container>

  <ng-container *edgeTemplate="let edge; edges: edges">
    <svg:path marker-end="url(#arrow)" [attr.d]="edge.pathDefinition"></svg:path>
  </ng-container>
</graphy-ng>

family-tree.component.ts

@Component({
  ...
})
export class FamilyTreeComponent {
  nodes: InputNode<{ name: string }>[] = [
    { id: '1', data: { name: 'Carl' } },
    { id: '2', data: { name: 'Robin' } },
    { id: '3', data: { name: 'Jeremy' } },
  ];

  edges: InputEdge[] = [
    { sourceId: '1', targetId: '3', },
    { sourceId: '2', targetId: '3', },
  ];
}

Comparison vs. ngx-graph

Pros:

  • Significantly more lightweight. Production bundle size of a fresh Angular app decreased from 490kb to 255kb by switching libraries (47% overall decrease in app size).
  • Input nodes and edges are not modified by the library.
  • Avoids requiring certain CSS classes to be hard-coded when using custom templates.
  • Full TypeScript support when using custom templates.

Cons:

  • Lacks more advanced and niche features โ€” namely clusters, custom/force-directed layouts, and graph minimaps.

License

graphy-ng is licensed under the terms of the MIT License.

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.